Developers

One API. Every corridor. Every leg of the trade.

REST + webhooks, idempotency keys, signed payloads, deterministic states. Sandbox keys turn around in 24 hours.

Create a settlement

curl -X POST https://api.askpay.ca/v1/settlements \
  -H "Authorization: Bearer $ASKPAY_KEY" \
  -H "Idempotency-Key: stl_8a1f2..." \
  -d '{
    "source_currency": "CAD",
    "target_currency": "INR",
    "amount": 250000.00,
    "rail": "askpay_express",
    "beneficiary_id": "ben_4421",
    "metadata": { "reference": "INV-0042" }
  }'

Lock an FX quote

curl -X POST https://api.askpay.ca/v1/quotes \
  -H "Authorization: Bearer $ASKPAY_KEY" \
  -d '{
    "source_currency": "USD",
    "target_currency": "MXN",
    "amount": 100000.00,
    "lock_seconds": 30
  }'

Endpoint overview

Method	Path	Purpose
POST	/v1/settlements	Initiate a multi-currency settlement on any supported corridor.
GET	/v1/settlements/:id	Fetch the lifecycle state and ledger entries for a settlement.
POST	/v1/quotes	Lock an FX quote for up to 30 seconds before committing the settlement.
POST	/v1/beneficiaries	Create and KYB-screen a payout counterparty before first settlement.
GET	/v1/balances	Read pooled and per-currency balances across your virtual accounts.
POST	/v1/webhooks	Subscribe to settlement, compliance, and treasury lifecycle events.

Spin up a sandbox key.

Build against the full settlement API with mocked corridor liquidity and synthetic compliance events.

Request a sandbox key