Skip to main content

API getting started

The CashXChain API is a REST API for payments, FX quotes, accounts, balances, beneficiaries, statements, and webhooks.

Base URLs​

Sandbox:    https://api.sandbox.cashxchain.com/v1
Production: https://api.cashxchain.com/v1

Use sandbox for development and testing. Production access requires account approval and product enablement.

Authentication​

Send your API key as a bearer token.

curl https://api.sandbox.cashxchain.com/v1/accounts \
  -H "Authorization: Bearer $CXC_API_KEY"

Create your first quote​

curl -X POST https://api.sandbox.cashxchain.com/v1/fx/quotes \
  -H "Authorization: Bearer $CXC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "source_currency": "EUR",
    "target_currency": "USD",
    "source_amount": "1000.00",
    "beneficiary_country": "US"
  }'

Create your first payment​

curl -X POST https://api.sandbox.cashxchain.com/v1/payments \
  -H "Authorization: Bearer $CXC_API_KEY" \
  -H "X-Idempotency-Key: demo-payment-001" \
  -H "Content-Type: application/json" \
  -d '{
    "source_account_id": "acct_sandbox_123",
    "beneficiary_id": "bnf_sandbox_123",
    "quote_id": "fxq_sandbox_123",
    "amount": "1000.00",
    "currency": "EUR",
    "purpose": "supplier_payment",
    "reference": "DEMO-001"
  }'

API conventions​

  • JSON request and response bodies.
  • ISO 8601 timestamps in UTC.
  • Amounts as decimal strings.
  • ISO 4217 currency codes where applicable.
  • Cursor-based pagination for lists.
  • Idempotency keys for payment creation.
  • Stable resource IDs with prefixes such as acct_, pay_, fxq_, evt_.

Next steps​

  1. Read Authentication.
  2. Configure Webhooks.
  3. Follow the Integration Quickstart.
  4. Review Errors and Rate limits.