List the customer's payout-currency configuration sections.

GET

/api/external/v1/onboarding/currencies

Lists the customer's payout-currency configuration sections (one per provider), each with its enabled state and KYC/provider status.

Prerequisites: customerId must already exist on your platform (created outside this API).

Notes: returns one section per provider/currency-group, each with its status (see the Onboarding tag description for the full list) so you can tell an unconfigured section apart from one that's enabled, disabled, or waiting on KYC. Call this before POST or PUT to discover the section id to enable.

Related: enable a section with POST /api/external/v1/onboarding/currencies or PUT /api/external/v1/onboarding/currencies/{id}.

Request

Query Params

Header Params

Responses

🟠401

application/json

Unauthorized

Bodyapplication/json

🟠403

🟠429

Request Example

Shell

JavaScript

Java

Swift

curl --location '/api/external/v1/onboarding/currencies?customerId=c1f4a9d2-6b3e-4a7c-9f1d-2e8b5c0a7d31' \
--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

401 - Success

{
    "error": {
        "code": "UNAUTHORIZED",
        "message": "Signature mismatch.",
        "details": []
    }
}

Modified at 2026-09-22 10:35:55

List the accepted beneficiary relationship codes.

Enable a payout-currency section for the customer.