Skip to main content

PointOfSale

Point of sale of the account (Settings > Points of sale in the dashboard). It groups payments, can belong to a store, and holds the payment settings of its QR codes. A user restricted to a point of sale sees only its payments, and a payment the user creates gets its ID. See PointOfSaleType.

type PointOfSale {
  id: ID!
  storeId: ID
  number: Int!
  name: String
  description: String
  manualAmount: Boolean
  requireEmail: Boolean
  requireTaxId: Boolean
  fixedAmount: Int
  includeQRCode: Boolean
  fixedCurrency: Currencies
  enabled: Boolean
  qrCodeText: String
  paymentCallbackUrl: String
  currentPaymentId: ID
  type: PointOfSaleType
  transactionType: TransactionTypes
  paymentMethods: [PaymentMethods!]
  deviceId: String
  pendingSetup: Boolean
  c60Emisora: String
  c60AllowedModalities: [Modality!]
}

Fields​

PointOfSale.id ● ID! non-null scalar​

Point of sale ID. Shown as ID.

PointOfSale.storeId ● ID scalar​

ID of the store of the point of sale, shown as Store. Null when it belongs to no store. A payment created at this point of sale gets this store ID, unless the request names a store.

PointOfSale.number ● Int! non-null scalar​

Sequential number, shown as # in the list and as Number in the details. At creation it is one more than the highest number ever given in the same store, or among the points of sale without a store. Numbers are not reused.

PointOfSale.name ● String scalar​

Name, shown as Name. The payment that a fixed-amount scan creates gets it as description.

PointOfSale.description ● String scalar​

Description, shown as Description. MONEI does not copy it to payments.

PointOfSale.manualAmount ● Boolean scalar​

Payment flow of a QR_CODE point of sale, shown as Payment Flow. true is "Manual Amount": after a scan, the customer enters the amount on the payment page, and the payment is a SALE in the account's default currency that offers all payment methods of the account. false is "Fixed Amount" (see fixedAmount). A fixedAmount greater than 0 takes precedence.

PointOfSale.requireEmail ● Boolean scalar​

Whether the payment page asks the customer for an email address before payment, shown as Require Email. Applies to every payment of this point of sale.

PointOfSale.requireTaxId ● Boolean scalar​

Whether the payment page asks the customer for a tax ID (NIF/CIF) before payment, shown as Require Tax ID. Applies to every payment of this point of sale.

PointOfSale.fixedAmount ● Int scalar​

Fixed amount in the smallest currency unit (cents for EUR), shown as Fixed Amount. When greater than 0, each scan of a code of this point of sale creates a payment of this amount in fixedCurrency, with the transactionType and paymentMethods of the point of sale and its name as description.

PointOfSale.includeQRCode ● Boolean scalar​

Whether the receipt email of a succeeded or authorized payment of this point of sale shows a QR code of the order ID. Shown as "Include Order QR in Email".

PointOfSale.fixedCurrency ● Currencies enum​

Currency of fixedAmount, shown as Currency. ISO 4217. A scan uses EUR when it is empty.

PointOfSale.enabled ● Boolean scalar​

Whether the point of sale is enabled, shown as Enabled. A scan of a code of a disabled point of sale fails. Null counts as enabled. The flag applies to code scans only.

PointOfSale.qrCodeText ● String scalar​

Text next to the order QR code in the receipt email when includeQRCode is true, shown as QR Code Text. A default text is used when it is empty.

PointOfSale.paymentCallbackUrl ● String scalar​

Callback URL, shown as Callback URL. A payment created at this point of sale without its own callbackUrl uses it: MONEI sends the payment to it in an HTTP POST when the payment first reaches AUTHORIZED, SUCCEEDED, FAILED, CANCELED or PAID_OUT.

PointOfSale.currentPaymentId ● ID scalar​

ID of the last payment created at this point of sale, through any channel. A scan of a code of a point of sale without fixedAmount, without manualAmount and not of type C60 opens this payment when it is PENDING and at most 3 minutes old; otherwise the customer sees a page that waits for the merchant.

PointOfSale.type ● PointOfSaleType enum​

Type of the point of sale, shown as Type. See PointOfSaleType. It cannot change after creation.

PointOfSale.transactionType ● TransactionTypes enum​

Transaction type of the payment that a fixed-amount scan creates. AUTH is "Manually capture payment" in the dashboard (Manual capture in the details): the funds are held and captured later. Defaults to SALE. A manual-amount payment is always a SALE. See TransactionTypes.

PointOfSale.paymentMethods ● [PaymentMethods!] list enum​

Payment methods offered on the payment that a fixed-amount scan creates, shown as Allowed Payment Methods. Null or empty means all payment methods of the account. A manual-amount payment ignores it.

PointOfSale.deviceId ● String scalar​

Device ID of a MONEI_POD terminal. Required at creation when type is MONEI_POD. A device ID can belong to one point of sale only.

PointOfSale.pendingSetup ● Boolean scalar​

true for a MONEI_PAY point of sale until its card terminal is activated, shown as "Pending Setup" in the dashboard. The activation sets it to false and enables the point of sale. updatePointOfSale cannot change it.

PointOfSale.c60Emisora ● String scalar​

AEB Cuaderno 60 Emisora code, shown as Emisora: 6 digits, the last one a module-11 control digit. Set only when type is C60.

PointOfSale.c60AllowedModalities ● [Modality!] list enum​

AEB Cuaderno 60 modalities that this point of sale accepts, shown as Allowed Modalities. Set only when type is C60. See Modality.

Returned By​

createPointOfSale mutation ● pointOfSale query ● updatePointOfSale mutation

Member Of​

PointsOfSaleConnection object

Last updated on