Enable or disable a payout-currency section.

PUT

/api/external/v1/onboarding/currencies/{id}

Enables or disables a payout-currency section for the customer. The section is identified by the route id (a ProductPairs.Id).

Prerequisites: id must be a section already returned by GET currencies for this customer — this endpoint toggles state, it does not create a new section.

Async vs sync: synchronous.

Related: to enable a currency section for the first time, use POST /api/external/v1/onboarding/currencies instead.

⚠️ Required Fields

Field	Type	Description	Constraints
`isEnabled`	boolean	—	—

Optional Fields

None — every field on this request body is required; see above.

Request

Path Params

Query Params

Header Params

Body Params

application/json-patch+json

Examples

Responses

🟠401

application/json

Unauthorized

Bodyapplication/json

🟠403

🟠429

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT '/api/external/v1/onboarding/currencies/5f8a2d1c-9e4b-4a7f-8c3d-2b6e9f1a0d75?customerId=c1f4a9d2-6b3e-4a7c-9f1d-2e8b5c0a7d31' \
--header 'X-Idempotency-Key: 6f1a9c0e-2b7d-4c31-9f8a-1d5e7c3b0a42' \
--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=' \
--header 'Content-Type: application/json-patch+json' \
--data '{
    "isEnabled": true
}'

Response Example

401 - Success

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

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

Get the customer's terms-of-service acceptance status.

List the currencies a beneficiary can be paid in under a product.

Enable or disable a payout-currency section.

⚠️ Required Fields#

Optional Fields#

Request

Responses

⚠️ Required Fields

Optional Fields