List the accepted payment purpose codes for a payee.

GET

/api/v1/payments/payee/purposes

Prerequisites: none.

Notes: walletCode and country narrow the result to what a specific wallet/corridor accepts; omit either to get the broader default set.

Related: pass the chosen code as payment.purpose on POST /payee.

📤 Response Fields

200 response:

Field	Type	Nullable	Description
`data`	array of LookupItem	Yes	—
`requestId`	string	Yes	—
`timestamp`	string (date-time)	No	—

Request

Query Params

Header Params

Responses

🟢200

application/json

Bodyapplication/json

🟠401

🟠403

🟠429

Request Example

Shell

JavaScript

Java

Swift

curl --location '/api/v1/payments/payee/purposes?walletCode=EUR_WALLET&country=Germany' \
--header 'X-API-Key: ak_live_8f3a9b2c7e1d4f6a9b0c2d5e8f1a3b6c' \
--header 'X-Signature: kZ3fQeT2m7xVvC9pR1sLdY8bN0hU4jK6oW5aE2gI7cQ=' \
--header 'X-Timestamp: 1758556800' \
--header 'X-Nonce: 3fa85f64-5717-4562-b3fc-2c963f66afa6' \
--header 'X-Body-Hash: 47DEQpj8HBSa+/TImW+5JCeuQeRkm5NMpJWZG3hSuFU='

Response Example

200 - Success

{
    "data": [
        {
            "code": "payment_for_services",
            "name": "Payment for services"
        },
        {
            "code": "advance_from_shareholder",
            "name": "Advance from shareholder"
        }
    ],
    "requestId": "req_9c2e7a1f4b8d3c6a0e9f2b7d1a8c3f6e",
    "timestamp": "2026-09-22T14:03:11Z"
}

Modified at 2026-09-23 04:45:39

List the currencies a payee can be created in.

List the countries a payee can be created in.

List the accepted payment purpose codes for a payee.

📤 Response Fields#

Request

Responses

📤 Response Fields