Create a payment session

Deprecated

POST

/paymentSession

Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction.

For more information, refer to How it works.

Request

Header Params

Body Params application/json

Examples

Responses

🟢200OK - the request has succeeded.

application/json

Body

🟠400Bad Request - a problem reading or understanding the request.

🟠401Unauthorized - authentication required.

🟠403Forbidden - insufficient permissions to process the request.

🟠422Unprocessable Entity - a request validation error.

🔴500Internal Server Error - the server could not process the request.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/paymentSession' \
--header 'Content-Type: application/json' \
--data-raw ''

Response Example

200 - Example 1

{
    "paymentSession": "string",
    "recurringDetails": [
        {
            "brand": "string",
            "brands": [
                "string"
            ],
            "configuration": {
                "property1": "string",
                "property2": "string"
            },
            "fundingSource": "debit",
            "group": {
                "name": "string",
                "paymentMethodData": "string",
                "type": "string"
            },
            "inputDetails": [
                {
                    "configuration": {
                        "property1": "string",
                        "property2": "string"
                    },
                    "details": [
                        {
                            "configuration": {
                                "property1": "string",
                                "property2": "string"
                            },
                            "items": [
                                {
                                    "id": "string",
                                    "name": "string"
                                }
                            ],
                            "key": "string",
                            "optional": true,
                            "type": "string",
                            "value": "string"
                        }
                    ],
                    "inputDetails": [
                        {
                            "configuration": {
                                "property1": "string",
                                "property2": "string"
                            },
                            "items": [
                                {
                                    "id": "string",
                                    "name": "string"
                                }
                            ],
                            "key": "string",
                            "optional": true,
                            "type": "string",
                            "value": "string"
                        }
                    ],
                    "itemSearchUrl": "string",
                    "items": [
                        {
                            "id": "string",
                            "name": "string"
                        }
                    ],
                    "key": "string",
                    "optional": true,
                    "type": "string",
                    "value": "string"
                }
            ],
            "issuers": [
                {
                    "disabled": false,
                    "id": "string",
                    "name": "string"
                }
            ],
            "name": "string",
            "recurringDetailReference": "string",
            "storedDetails": {
                "bank": {
                    "bankAccountNumber": "string",
                    "bankCity": "string",
                    "bankLocationId": "string",
                    "bankName": "string",
                    "bic": "string",
                    "countryCode": "string",
                    "iban": "string",
                    "ownerName": "string",
                    "taxId": "string"
                },
                "card": {
                    "cvc": "string",
                    "expiryMonth": "st",
                    "expiryYear": "stri",
                    "holderName": "string",
                    "issueNumber": "st",
                    "number": "string",
                    "startMonth": "st",
                    "startYear": "stri"
                },
                "emailAddress": "string"
            },
            "type": "string"
        }
    ]
}

Modified at 2023-08-15 09:16:27

Update the status of a payment link

Verify a payment result