|
2 | 2 | sidebar_position: 11
|
3 | 3 | ---
|
4 | 4 |
|
5 |
| -# Input and Output Formats |
| 5 | +:::caution |
6 | 6 |
|
7 |
| -This page gives an overview of the format and length restrictions for all input parameters used in the PoS V10 API. |
| 7 | +Please notice that as part of the merger between MobilePay and Norwegian Vipps, we will consolidate products on one joint platform. |
| 8 | +This product is now closed. Please visit our new developer documentation to see the new APIs we offer https://developer.vippsmobilepay.com/ |
8 | 9 |
|
9 |
| -## HTTP Headers |
10 |
| - |
11 |
| -For more information about the http headers, see [API principles](/docs/pos/api-principles). |
12 |
| - |
13 |
| -| Name | Format | Description | |
14 |
| -|------|-------------|-------------| |
15 |
| -| `x-ibm-client-id` | Guid | Identifies an application created through MobilePay Developer Portal. | |
16 |
| -| `x-mobilepay-merchant-vat-number` | Valid VAT number: IsoCountryCodeVATNumber - Example: DK12345678 | Identifies the merchant the integrator is calling on behalf of | |
17 |
| -| `x-mobilepay-client-system-version` | Valid Client-Version: Major.Minor.Build - Example: 1.2.1 | Identifies the [version of the integrator system](/docs/pos/api-principles#client-versioning) calling the API. | |
18 |
| -| `x-mobilepay-idempotency-key` | String with at most 36 valid characters | Used to allow calls to be [safely retried](/docs/pos/api-principles#error-handling) in case of errors. | |
19 |
| - |
20 |
| -## Brands |
21 |
| - |
22 |
| -For more information about brands, see [PoS Management](/docs/pos/pos-management). |
23 |
| - |
24 |
| -| Name | Format | Description | |
25 |
| -|------|-------------|-------------| |
26 |
| -| `merchantBrandId` | MPPOSXXXXX <br/> POSDKXXXXX <br/> POSFIXXXXX | Identifies a Brand in MobilePay. | |
27 |
| -| `brandName` | String | The name of the brand. | |
28 |
| - |
29 |
| -## Stores |
30 |
| - |
31 |
| -For more information about stores, see [PoS Management](/docs/pos/pos-management). |
32 |
| - |
33 |
| -| Name | Format | Description | |
34 |
| -|------|-------------|-------------| |
35 |
| -| `storeId` | Guid | Identifies a Store in MobilePay. | |
36 |
| -| `merchantLocationId` | String with exactly 5 valid characters | MobilePay location ID. Together with a `merchantBrandId`, this identifies a Store in MobilePay. | |
37 |
| - |
38 |
| -## Point-of-Sales |
39 |
| - |
40 |
| -For more information about a PoS, see [PoS Management](/docs/pos/pos-management). |
41 |
| - |
42 |
| -| Name | Format | Description | |
43 |
| -|------|-------------|-------------| |
44 |
| -| `posId` | Guid | Identifies a PoS in MobilePay. | |
45 |
| -| `merchantPosId` | String with at most 36 valid characters | Merchant defined PoS ID. There can be at most one active PoS with a given `merchantPosId` for a given integrator and merchant. | |
46 |
| -| `posName` | 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. | |
47 |
| -| `callbackAlias` | String with at most 36 valid characters | Only for clients that use the [notification service](/docs/pos/notification-service) to detect MobilePay payments. The `callbackAlias` is a key that identifies which notification endpoint to call for the given PoS. | |
48 |
| -| `beaconId` | A GUID or 15 digits | ID 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`. | |
49 |
| -| `requirePaymentBeforeCheckin` | Boolean | When 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](/docs/pos/pos-management#preventing-checkin-before-payment). |
50 |
| -| `supportedBeaconTypes` | `QR` / `NFC` / `Bluetooth`| 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. | |
51 |
| - |
52 |
| -## Payments |
53 |
| - |
54 |
| -For more information about payments, see [Payment Flows](/docs/pos/payment-flows). |
55 |
| - |
56 |
| -| Name | Format | Description | |
57 |
| -|------|-------------|-------------| |
58 |
| -| `paymentId` | GUID | MobilePay defined Payment ID. | |
59 |
| -| `orderId` | String with at most 36 valid characters | Merchant defined payment order ID. There is no uniqueness requirement for the `orderId`, but it is highly recommended to use unique order IDs. | |
60 |
| -| `amount` | Valid positive amount | Total amount of the payment. | |
61 |
| -| `currencyCode` | `DKK` / `EUR` | Currency code for the currency of the payment. | |
62 |
| -| `merchantPaymentLabel` | 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 | |
63 |
| -| `plannedCaptureDelay` | `None` / `LessThan24Hours` / `LessThan14Days`| How long time the client expects to wait after receiving a reservation before capturing. See [Specify planned capture delay](/docs/pos/best-practices#specify-planned-capture-delay). | |
64 |
| -| `restrictions` | Json object with one or more parameters | A way to define restrictions on how a payment can be completed. See [Payment Restrictions](/docs/pos/input-and-output-formats#payment-restrictions) for possible restriction parameters | |
65 |
| - |
66 |
| -### Payment Restrictions |
67 |
| - |
68 |
| -| Name | Format | Description | |
69 |
| -|------|-------------|-------------| |
70 |
| -| `debitCardDisallowed` | Boolean | When `debitCardDisallowed` is set to true, debit cards cannot be used for this payment | |
71 |
| -| `creditCardDisallowed` | Boolean | When `creditCardDisallowed` is set to true, credit cards cannot be used for this payment | |
72 |
| - |
73 |
| -## Valid characters |
74 |
| - |
75 |
| -Valid characters for PoS V10 API request fields are: |
76 |
| - |
77 |
| -* 0 - 9 |
78 |
| -* a-zA-Z |
79 |
| -* æÆøØåÅ |
80 |
| -* äÄöÖšŠžŽâÂàÀáÁãÃéÉêÊëËèÈíÍîÎïÏìÌüÜûÛùÙúÚôÔòÒóÓõÕÿýÝñÑ |
81 |
| -* !"#$%&'()*+,-./":;<=>?@[\]^_\`{\|}~¦¯¨´× |
82 |
| -* «»ðþçߤǵÐÞ±°ªº©§¶¼½¾¬®¢£¥¡¿¹²³ |
83 |
| -* (space) |
| 10 | +::: |
0 commit comments