Skip to main content

PointOfSale

Point of sale belonging to an account, optionally scoped to a store. 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
}

Fields​

PointOfSale.id ● ID! non-null scalar​

Unique POS identifier.

PointOfSale.storeId ● ID scalar​

Parent store ID. Null when the POS is attached directly to the account.

PointOfSale.number ● Int! non-null scalar​

Sequential POS number, unique within the parent store/account.

PointOfSale.name ● String scalar​

Display name.

PointOfSale.description ● String scalar​

Free-form description.

PointOfSale.manualAmount ● Boolean scalar​

Allow the operator to enter an arbitrary amount at charge time. Mutually exclusive with fixedAmount.

PointOfSale.requireEmail ● Boolean scalar​

Require the customer to provide an email address before paying.

PointOfSale.requireTaxId ● Boolean scalar​

Require the customer to provide a tax ID before paying.

PointOfSale.fixedAmount ● Int scalar​

Pre-set amount in the smallest currency unit (e.g. cents). Charged when manualAmount is false.

PointOfSale.includeQRCode ● Boolean scalar​

Embed a QR code with the payment link in the customer's confirmation email.

PointOfSale.fixedCurrency ● Currencies enum​

Currency for fixedAmount. ISO 4217.

PointOfSale.enabled ● Boolean scalar​

Whether the POS is enabled. Disabled POS reject new charges.

PointOfSale.qrCodeText ● String scalar​

Caption rendered next to the QR code in the confirmation email when includeQRCode is true.

PointOfSale.paymentCallbackUrl ● String scalar​

Server-to-server HTTP POST URL invoked when a charge succeeds at this POS.

PointOfSale.currentPaymentId ● ID scalar​

ID of the charge currently in progress at the terminal, if any.

PointOfSale.type ● PointOfSaleType enum​

POS type. See PointOfSaleType.

PointOfSale.transactionType ● TransactionTypes enum​

Default transaction type for charges created at this POS. See TransactionTypes.

PointOfSale.paymentMethods ● [PaymentMethods!] list enum​

Allow-list of payment methods accepted at this POS. Null/empty means all methods enabled on the account.

PointOfSale.deviceId ● String scalar​

Hardware device identifier set by the device-pairing flow. Required at creation when type is MONEI_POD.

PointOfSale.pendingSetup ● Boolean scalar​

Set to true on create for MONEI_PAY POS that have not yet been paired with a device. Cleared by the external device-pairing flow (not by updatePointOfSale).

Returned By​

createPointOfSale mutation ● pointOfSale query ● updatePointOfSale mutation

Member Of​

PointsOfSaleConnection object