1. Onboarding
Artha All Module Api's
  • Introduction
  • Authentication
  • KYC/KYB Requirements
  • API Setup Guide
  • Products
    • List Products
      GET
    • Get Product
      GET
    • Get Customer Product Status
      GET
  • Customers
    • Create Customer
      POST
    • List Customers
      GET
    • Get Customer
      GET
    • Submit Applicant (KYC/KYB)
      POST
    • Create Onboarding Session
      POST
  • Wallets
    • Beneficiary
      • Create Crypto Beneficiary
      • Update Crypto Beneficiary
      • List Crypto Withdraw Beneficiaries
    • Create Wallet
      POST
    • Get Wallet Address
      GET
    • Get Customer Balances
      GET
    • List Wallets
      GET
    • List Withdrawals
      GET
    • List Withdrawal Networks
      GET
    • Preview Withdrawal Summary
      POST
    • Create Crypto Withdrawal
      POST
  • Cards
    • Issuance
      • Issue Card
      • List Cards
      • List Customer Cards
      • Get Card Details
      • Get Sensitive Card Details
    • Funding
      • Top Up Card
      • Get Card Balance
      • Get Top-Up Status
      • List Top-Up History
    • Operations
      • Resend Activation Code
      • Activate Card
      • Set Card PIN
      • Change Card PIN
      • Update Card Limits
      • Freeze Card
      • Unfreeze Card
      • Replace Card
      • Cancel Card
      • Get Card Limits
      • Show Card PIN Details
      • Get PIN View Iframe URL
      • Get PIN Change Iframe URL
      • Get PIN Set Iframe URL
      • Get Card View Iframe URL
      • Show Card PIN
  • Payees
    • Create a payee for a customer.
    • List a customer's payees.
    • Update a payee.
    • Retrieve a payee by id.
    • Look up an existing payee.
    • List the currencies a payee can be created in.
    • List the accepted payment purpose codes for a payee.
    • List the countries a payee can be created in.
    • List currency/country pairings for payees.
    • List the accepted beneficiary relationship codes.
  • Payments
    • Onboarding
      • List the customer's payout-currency configuration sections.
        GET
      • Enable a payout-currency section for the customer.
        POST
      • Get the customer's terms-of-service acceptance status.
        GET
      • Enable or disable a payout-currency section.
        PUT
    • Quote
      • List the currencies a beneficiary can be paid in under a product.
      • List the payout rails available for a product and beneficiary.
      • Create an FX quote giving the rate and fee for a cross-currency payout.
    • Order
      • Submit a payout order to send money to a beneficiary.
      • Retrieve the on-chain address to fund an order.
      • Retrieve the status and settlement detail of a payout order.
    • Lookups
      • List the accepted payment purpose codes for a payout.
      • List the accepted source-of-funds codes for a payout.
      • List the document types accepted on a payout order.
  • Banks
    • Accounts
      • Create Bank Account
      • Get Account Details
      • Get Account Issuance Status
    • Withdraw
      • Create Withdrawal Quote
      • List Withdrawal Purposes
      • Get Payment Schemes
      • Execute Withdrawal
  • Exchange
    • Quote
      • Get Exchange Rate
      • Create Price Quote
    • Order
      • Place Exchange Order
  • Transactions
    • List Transactions
    • Get Transaction Details
  • Utilities
    • List Currencies
    • List Countries
    • Get Fee Schedule
    • List Product Occupations
    • List Product Industry Codes
    • Upload File
  • Webhook's
    • Wallets Webhooks
    • Banks Webhooks
    • Payments Webhooks
    • Exchange Webhooks
    • Card Webhooks
  1. Onboarding

Enable a payout-currency section for the customer.

POST
/api/external/v1/onboarding/currencies
Enables a payout-currency section for the customer, saving the payment configuration. The body carries the section id (a ProductPairs.Id from the GET response); the provider and its full currency set are resolved server-side.
Prerequisites: customerId must exist; configurationId must be an id returned by GET currencies for that customer.
Important: you only send the section id — the provider and its full currency set are resolved server-side from that id. Sending an id belonging to a different customer's section is rejected.
Async vs sync: synchronous — the section is enabled (or moved to pending_kyc) before the response returns.
Related: discover ids with GET /api/external/v1/onboarding/currencies; toggle an already-configured section instead with PUT .../currencies/{id}.

⚠️ Required Fields#

FieldTypeDescriptionConstraints
configurationIdstring (uuid)The configuration section to enable. Renamed from the legacy "id": a body field called "id" that in fact identifies a different resource read no better than an unnamed value.—

Optional Fields#

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

Request

Query Params

Header Params

Body Params
application/json-patch+json

Examples

Responses

🟠401
application/json
Unauthorized
Bodyapplication/json

🟠403
🟠429
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/api/external/v1/onboarding/currencies?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 '{
    "configurationId": "5f8a2d1c-9e4b-4a7f-8c3d-2b6e9f1a0d75"
}'
Response Response Example
401 - Success
{
    "error": {
        "code": "UNAUTHORIZED",
        "message": "Signature mismatch.",
        "details": []
    }
}
Modified at 2026-09-22 10:35:55
Previous
List the customer's payout-currency configuration sections.
Next
Get the customer's terms-of-service acceptance status.
Built with