Skip to main content

Input and Output Formats

This page gives an overview of the format and length restrictions for all input parameters used in the PoS V10 API.

HTTP Headers

For more information about the http headers, see API principles.

x-ibm-client-idGuidIdentifies an application created through MobilePay Developer Portal.
x-mobilepay-merchant-vat-numberValid VAT number: IsoCountryCodeVATNumber - Example: DK12345678Identifies the merchant the integrator is calling on behalf of
x-mobilepay-client-system-versionValid Client-Version: Major.Minor.Build - Example: 1.2.1Identifies the version of the integrator system calling the API.
x-mobilepay-idempotency-keyString with at most 36 valid charactersUsed to allow calls to be safely retried in case of errors.


For more information about brands, see PoS Management.

Identifies a Brand in MobilePay.
brandNameStringThe name of the brand.


For more information about stores, see PoS Management.

storeIdGuidIdentifies a Store in MobilePay.
merchantLocationIdString with exactly 5 valid charactersMobilePay location ID. Together with a merchantBrandId, this identifies a Store in MobilePay.


For more information about a PoS, see PoS Management.

posIdGuidIdentifies a PoS in MobilePay.
merchantPosIdString with at most 36 valid charactersMerchant defined PoS ID. There can be at most one active PoS with a given merchantPosId for a given integrator and merchant.
posNameString with at most 36 valid charactersMerchant defined PoS name.< The name is visible in the app, after the customer has checked in on the PoS.
callbackAliasString with at most 36 valid charactersOnly for clients that use the notification service to detect MobilePay payments. The callbackAlias is a key that identifies which notification endpoint to call for the given PoS.
beaconIdA GUID or 15 digitsID of the Beacon. In case of physical device such as the MobilePay WhiteBox or a terminal the beaconId is a 15 digit string. In case of no physical device (QR) the beaconId is not provided during PoS creation. MobilePay will generate a string containing a random GUID as the beaconId.
requirePaymentBeforeCheckinBooleanWhen set to true, a user will not be allowed to check-in before a payment is created on this PoS. See Preventing checkin before payment.
supportedBeaconTypesQR / NFC / BluetoothBeacon broadcast type. Identifies an option for how a customer can check in on a PoS. During the creation of a PoS, a list of Beacon Types has to be provided.


For more information about payments, see Payment Flows.

paymentIdGUIDMobilePay defined Payment ID.
orderIdString with at most 36 valid charactersMerchant defined payment order ID. There is no uniqueness requirement for the orderId, but it is highly recommended to use unique order IDs.
amountValid positive amountTotal amount of the payment.
currencyCodeDKK / EURCurrency code for the currency of the payment.
merchantPaymentLabelString with at most 36 valid charactersLabel for the payment. This is a way for the merchant to tag a payment with a label that will be visible in the transaction reporting section on the MobilePay Portal
plannedCaptureDelayNone / LessThan24Hours / LessThan14DaysHow long time the client expects to wait after receiving a reservation before capturing. See Specify planned capture delay.
restrictionsJson object with one or more parametersA way to define restrictions on how a payment can be completed. See Payment Restrictions for possible restriction parameters

Payment Restrictions

debitCardDisallowedBooleanWhen debitCardDisallowed is set to true, debit cards cannot be used for this payment
creditCardDisallowedBooleanWhen creditCardDisallowed is set to true, credit cards cannot be used for this payment

Valid characters

Valid characters for PoS V10 API request fields are:

  • 0 - 9
  • a-zA-Z
  • æÆøØåÅ
  • äÄöÖšŠžŽâÂàÀáÁãÃéÉêÊëËèÈíÍîÎïÏìÌüÜûÛùÙúÚôÔòÒóÓõÕÿýÝñÑ
  • !"#$%&'()*+,-./":;<=>?@[]^_`{|}~¦¯¨´×
  • «»ðþçߤǵÐÞ±°ªº©§¶¼½¾¬®¢£¥¡¿¹²³
  • (space)