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.
For more information about the http headers, see API principles.
|Guid||Identifies an application created through MobilePay Developer Portal.|
|Valid VAT number: IsoCountryCodeVATNumber - Example: DK12345678||Identifies the merchant the integrator is calling on behalf of|
|Valid Client-Version: Major.Minor.Build - Example: 1.2.1||Identifies the version of the integrator system calling the API.|
|String with at most 36 valid characters||Used to allow calls to be safely retried in case of errors.|
For more information about brands, see PoS Management.
|Identifies a Brand in MobilePay.|
|String||The name of the brand.|
For more information about stores, see PoS Management.
|Guid||Identifies a Store in MobilePay.|
|String with exactly 5 valid characters||MobilePay location ID. Together with a |
For more information about a PoS, see PoS Management.
|Guid||Identifies a PoS in MobilePay.|
|String with at most 36 valid characters||Merchant defined PoS ID. There can be at most one active PoS with a given |
|String with at most 36 valid characters||Merchant defined PoS name.< The name is visible in the app, after the customer has checked in on the PoS.|
|String with at most 36 valid characters||Only for clients that use the notification service to detect MobilePay payments. The |
|A GUID or 15 digits||ID of the Beacon. In case of physical device such as the MobilePay WhiteBox or a terminal the |
|Boolean||When set to |
|Beacon 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.
|GUID||MobilePay defined Payment ID.|
|String with at most 36 valid characters||Merchant defined payment order ID. There is no uniqueness requirement for the |
|Valid positive amount||Total amount of the payment.|
|Currency code for the currency of the payment.|
|String with at most 36 valid characters||Label 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|
|How long time the client expects to wait after receiving a reservation before capturing. See Specify planned capture delay.|
|Json object with one or more parameters||A way to define restrictions on how a payment can be completed. See Payment Restrictions for possible restriction parameters|
Valid characters for PoS V10 API request fields are:
- 0 - 9