CreatePointOfSaleInput

Input for createPointOfSale.

input CreatePointOfSaleInput {
  storeId: ID
  name: String
  description: String
  manualAmount: Boolean
  requireEmail: Boolean
  requireTaxId: Boolean
  fixedAmount: Int
  fixedCurrency: Currencies
  enabled: Boolean
  includeQRCode: Boolean
  qrCodeText: String
  paymentCallbackUrl: String
  type: PointOfSaleType!
  transactionType: TransactionTypes
  paymentMethods: [PaymentMethods!]
  deviceId: String
}

Fields

CreatePointOfSaleInput.storeId ● ID scalar

Parent store ID. Omit to attach directly to the account.

CreatePointOfSaleInput.name ● String scalar

Display name. Defaults to <account name> POS <number> when omitted.

CreatePointOfSaleInput.description ● String scalar

Free-form description.

CreatePointOfSaleInput.manualAmount ● Boolean scalar

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

CreatePointOfSaleInput.requireEmail ● Boolean scalar

Require the customer to provide an email address.

CreatePointOfSaleInput.requireTaxId ● Boolean scalar

Require the customer to provide a tax ID.

CreatePointOfSaleInput.fixedAmount ● Int scalar

Pre-set amount in the smallest currency unit. Used when manualAmount is false.

CreatePointOfSaleInput.fixedCurrency ● Currencies enum

Currency for fixedAmount. ISO 4217.

CreatePointOfSaleInput.enabled ● Boolean scalar

Enabled state. Defaults to true.

CreatePointOfSaleInput.includeQRCode ● Boolean scalar

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

CreatePointOfSaleInput.qrCodeText ● String scalar

Caption rendered next to the QR code in the confirmation email.

CreatePointOfSaleInput.paymentCallbackUrl ● String scalar

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

CreatePointOfSaleInput.type ● PointOfSaleType! non-null enum

POS type. See PointOfSaleType.

CreatePointOfSaleInput.transactionType ● TransactionTypes enum

Default transaction type for charges created at this POS.

CreatePointOfSaleInput.paymentMethods ● [PaymentMethods!] list enum

Allow-list of payment methods. Null means all methods enabled on the account.

CreatePointOfSaleInput.deviceId ● String scalar

Hardware device identifier. Required when type is MONEI_POD.

Member Of

createPointOfSale mutation