Payment Menu v2

Corporate Limited Menu

Limit the menu to what is supported by corporate payment methods.

Corporate Limited Menu

Corporate Limited Menu allows you to limit the payment methods available when your customers pays through the menu. Please note that the payment method in question needs to support corporate payment methods and have the feature enabled during the contract setup to be shown in the menu.

If you don’t invoke the restriction in your payment order request, every valid payment method will show up as usual in the payment menu. This is done by setting corporateMode to true. In this example the payment method is set to card.

Request 



1
2
3
4



POST /psp/paymentorders HTTP/1.1
Host: api.externalintegration.payex.com
Authorization: Bearer <AccessToken>
Content-Type: application/json;version=3.x/2.0      // Version optional for 3.0 and 2.0





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



{
    "paymentorder": {
        "corporateMode": "true",
        "instrument": "CreditCard",
        "operation": "Purchase",
        "currency": "SEK",
        "amount": 1500,
        "vatAmount": 375,
        "description": "Test Purchase",
        "userAgent": "Mozilla/5.0...",
        "language": "sv-SE",
        "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
Required
paymentOrder object check
The payment order object.
corporateMode bool check
Determines if the menu should only show payment methods that support corporate payment methods and has been enabled in your contracts.
instrument string check
The payment methods you want to restrict to in corporate mode. Selected by using 3-D Secure 2 .
operation string check

Determines the initial operation, defining the type of payment order created. Possible options are Purchase, Abort Verify, Unscheduled, Recur and Payout.

currency string check
The currency of the payment.
amount integer check

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 check

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 check
The description of the payment order.
userAgent string check

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 check
The language of the payer.
urls object check
The urls object, containing the URLs relevant for the payment order.
hostUrls array check
The array of valid host URLs.
completeUrl string check

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 check

The URL that Swedbank Pay will perform an HTTP POST against every time a transaction is created on the payment order. See callback for details.

termsOfServiceUrl string check

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 check

With permission and activation on your contract (if you are using Seamless View), 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. The logo must be a picture with maximum 50px height and 400px width. Requires HTTPS. Read more about this in Custom Logo .

payeeInfo object check

The payeeInfo object, containing information about the payee (the recipient of the money). See payeeInfo for details.

payeeId string check
The ID of the payee, usually the merchant ID.
payeeReference string(30) check

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 to the acquirer and the payeeReference must be in the format of A-Za-z0-9 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.