Payment Menu – Corporate Limited Menu

Corporate Limited Menu allows you to limit what payment instruments shows up when your customers pays through the menu. Do note that both the instrument in question needs to support corporate payment methods and have the feature enabled during the contract setup to be shown in the menu.

Do note that if you were to not invoke the restriction, every valid payment method will show up as usual in the payment menu. Only when you restrict the payment menu to corporate-supported instruments AND have instruments set to be restricted will other instruments be hidden.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

POST /psp/paymentorders HTTP/1.1
Host: api.externalintegration.payex.com
Authorization: Bearer <AccessToken>
Content-Type: application/json

{
    "paymentorder": {
        "operation": "Purchase",
        "currency": "SEK",
        "amount": 1500,
        "vatAmount": 375,
        "description": "Test Purchase",
        "userAgent": "Mozilla/5.0...",
        "language": "sv-SE",
        "instrument": null,
        "corporateMode": "false",
        "urls": {
            "hostUrls": [ "https://example.com", "https://example.net" ],
            "completeUrl": "https://example.com/payment-completed",
            "callbackUrl": "https://api.example.com/payment-callback",
            "termsOfServiceUrl": "https://example.com/termsandconditions.pdf",
            "logoUrl": "https://example.com/logo.png"
        },
        "payeeInfo": {
            "payeeId": "5cabf558-5283-482f-b252-4d58e06f6f3b",
            "payeeReference": "AB832"
        }
    }
}

Field	Type	Description
`paymentorder`	`object`	The payment order object.
└➔ `operation`	`string`	The operation that the payment order is supposed to perform.
└➔ `currency`	`string`	The currency of the payment.
└➔ `amount`	`integer`	The transaction amount (including VAT, if any) entered in the lowest monetary unit of the selected currency. E.g.: `10000` = `100.00` SEK, `5000` = `50.00` SEK.
└➔ `vatAmount`	`integer`	The payment’s VAT (Value Added Tax) `amount`, entered in the lowest monetary unit of the selected currency. E.g.: `10000` = `100.00` SEK, `5000` = `50.00` SEK. The `vatAmount` entered will not affect the `amount` shown on the payment page, which only shows the total `amount`. This field is used to specify how much of the total `amount` the VAT will be. Set to `0` (zero) if there is no VAT `amount` charged.
└➔ `description`	`string`	The description of the payment order.
└➔ `instrument`	`string`	The payment instrument used. Selected by using the Instrument Mode.
└➔ `userAgent`	`string`	The user agent of the payer. Should typically be set to the value of the `User-Agent` header sent by the payer’s web browser.
└➔ `language`	`string`	The language of the payer.
└➔ `corporateMode`	`bool`	Determines if the menu should only show instruments that supports corporate payment methods and has been enabled in your contracts.
└➔ `urls`	`object`	The `urls` object, containing the URLs relevant for the payment order.
└─➔ `hostUrls`	`array`	The array of URLs valid for embedding of Swedbank Pay Seamless Views.
└─➔ `completeUrl`	`string`	The URL that Swedbank Pay will redirect back to when the payer has completed their interactions with the payment. This does not indicate a successful payment, only that it has reached a final (complete) state. A `GET` request needs to be performed on the payment order to inspect it further. See `completeUrl` for details.
└─➔ `callbackUrl`	`string`	The URL to the API endpoint receiving `POST` requests on transaction activity related to the payment order.
└─➔ `termsOfServiceUrl`	`string`	The URL to the terms of service document which the payer must accept in order to complete the payment. HTTPS is a requirement.
└─➔ `logoUrl`	`string`	With permission and activation on your contract, sending in a `logoUrl` will replace the Swedbank Pay logo with the logo sent in. If you do not send in a `logoUrl`, then no logo and no text is shown. Without permission or activation on your contract, sending in a `logoUrl` has no effect. Read more about this in Custom Logo.
└➔ `payeeInfo`	`string`	The `payeeInfo` object, containing information about the payee (the recipient of the money). See `payeeInfo` for details.
└─➔ `payeeId`	`string`	The ID of the payee, usually the merchant ID.
└─➔ `payeeReference`	`string`	A unique reference from the merchant system. Set per operation to ensure an exactly-once delivery of a transactional operation. Length and content validation depends on whether the `transaction.number` or the `payeeReference` is sent to the acquirer. If Swedbank Pay handles the settlement, the `transaction.number` is sent and the `payeeReference` must be in the format of `A-Za-z0-9` (including `-`) and `string(30)`. If you handle the settlement, Swedbank Pay will send the `payeeReference` and it will be limited to the format of `string(12)`. All characters must be digits. In Invoice Payments `payeeReference` is used as an invoice/receipt number, if the `receiptReference` is not defined.