Get a list of available payment methods

POST

/paymentMethods

Queries the available payment methods for a transaction based on the transaction context (like amount, country, and currency). Besides giving back a list of the available payment methods, the response also returns which input details you need to collect from the shopper (to be submitted to /payments).

Although we highly recommend using this endpoint to ensure you are always offering the most up-to-date list of payment methods, its usage is optional. You can, for example, also cache the /paymentMethods response and update it once a week.

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 '/paymentMethods' \
--header 'Content-Type: application/json' \
--data-raw ''

Response Example

200 - Example 1

{
    "paymentMethods": [
        {
            "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",
            "type": "string"
        }
    ],
    "storedPaymentMethods": [
        {
            "brand": "string",
            "expiryMonth": "string",
            "expiryYear": "string",
            "holderName": "string",
            "iban": "string",
            "id": "string",
            "lastFour": "string",
            "name": "string",
            "networkTxReference": "string",
            "ownerName": "string",
            "shopperEmail": "string",
            "supportedShopperInteractions": [
                "string"
            ],
            "type": "string"
        }
    ]
}

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

Start a transaction for donations

Start a transaction