List a customer's payees.

GET

/api/v1/payments/payee

Prerequisites: customerId should normally be supplied to scope the list; omitting it is provider-dependent behaviour and best avoided.

Notes: paginated — limit defaults to 20, offset to 0. currency optionally filters to payees set up for that currency.

Related: create a payee with POST /payee; find one without paging with GET /payee/lookup.

📤 Response Fields

200 response:

Field	Type	Nullable	Description
`data`	array of PayeeResponse	Yes	—
`pagination`	object	No	—
`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?customerId=c1f4a9d2-6b3e-4a7c-9f1d-2e8b5c0a7d31&currency=EUR&limit=20&offset=0' \
--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": [
        {
            "id": "4d8f2a7c-9b1e-4c6d-8a3f-7e2b0c9d1a56",
            "customerId": "c1f4a9d2-6b3e-4a7c-9f1d-2e8b5c0a7d31",
            "favouriteName": "Acme Supplier — EUR",
            "currency": "EUR",
            "status": "active",
            "beneficiary": {
                "business": {
                    "name": "Acme Trading GmbH"
                },
                "contact": {
                    "email": "payments@acmetrading.example",
                    "phone": {
                        "countryCode": "+49",
                        "number": "3012345678"
                    }
                }
            },
            "address": {
                "line1": "Friedrichstrasse 123",
                "city": "Berlin",
                "state": null,
                "postalCode": "10117",
                "country": "Germany"
            },
            "kycDetails": {
                "businessType": "gmbh",
                "businessRegistrationNumber": "HRB123456B"
            },
            "bankAccount": {
                "accountType": null,
                "bankName": "Deutsche Bank",
                "bankCountry": "Germany",
                "bankCode": null,
                "accountNumber": null,
                "iban": "DE89370400440532013000",
                "swiftBic": "DEUTDEFF",
                "routingNumber": null,
                "sortCode": null,
                "branchCode": null
            },
            "payment": {
                "type": "bank_transfer",
                "purpose": "payment_for_services",
                "providerFields": null
            },
            "createdAt": "2026-09-20T09:12:00Z",
            "updatedAt": "2026-09-22T14:02:00Z"
        },
        {
            "id": "9a2e7c1f-4b8d-4c6a-9e0f-2b7d1a8c3f65",
            "customerId": "c1f4a9d2-6b3e-4a7c-9f1d-2e8b5c0a7d31",
            "favouriteName": "Jane Contractor — GBP",
            "currency": "GBP",
            "status": "active",
            "beneficiary": {
                "individual": {
                    "firstName": "Jane",
                    "middleName": null,
                    "lastName": "Contractor"
                },
                "contact": {
                    "email": "jane@example.com",
                    "phone": {
                        "countryCode": "+44",
                        "number": "7700900123"
                    }
                }
            },
            "address": {
                "line1": "Friedrichstrasse 123",
                "city": "Berlin",
                "state": null,
                "postalCode": "10117",
                "country": "Germany"
            },
            "kycDetails": {
                "businessType": "gmbh",
                "businessRegistrationNumber": "HRB123456B"
            },
            "bankAccount": {
                "accountType": null,
                "bankName": "Barclays",
                "bankCountry": "United Kingdom",
                "bankCode": null,
                "accountNumber": "12345678",
                "iban": null,
                "swiftBic": "BARCGB22",
                "routingNumber": null,
                "sortCode": "20-00-00",
                "branchCode": null
            },
            "payment": {
                "type": "bank_transfer",
                "purpose": "advance_from_shareholder",
                "providerFields": null
            },
            "createdAt": "2026-09-20T09:12:00Z",
            "updatedAt": "2026-09-22T14:02:00Z"
        }
    ],
    "pagination": {
        "total": 2,
        "limit": 20,
        "offset": 0,
        "hasMore": false
    },
    "requestId": "req_2b7d1a8c3f6e9c2e7a1f4b8d3c6a0e9f",
    "timestamp": "2026-09-22T14:03:11Z"
}

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

Create a payee for a customer.

Update a payee.

List a customer's payees.

📤 Response Fields#

Request

Responses

📤 Response Fields