For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Status Dashboard

Guides API Reference Help Center

Guides API Reference Help Center

Authentication
- POSTRequest an Access Token
Collect
Exchange
Payouts

Request an Access Token
Get Available Payment Methods
Get Checkout Session
Create Checkout Session
Initiate Payment (Transaction)
Authorize a Payment (Transaction)
Adjust Authorized Amount
List Payments (Transactions)
Retrieve Payment Status (Transaction)
Create a Refund
Retrieve a Refund
Cancel a Session
Cancel a Transaction
Search Payments by Merchant Reference
Get Transaction Details
Get Processor Status
List Rules
Create a New Rule
Delete a Rule
Get a Rule
Update a Rule
Create Payer Profile
Get Payer Profile
List Stored Payment Methods
Add Stored Payment Method
Delete Stored Payment Method
Create Transactions Report (Job)
Fetch Transactions Report (By ID)
Create Reconciliation Report (Job)
Fetch Reconciliation Report (By ID)
Create Unmatched Settlements Report (Job)
Fetch Unmatched Settlements Report (By ID)
Fetch Settlements Report (By ID)
List Reports (Jobs)
Get current rate
Request a quote (RFQ)
Request comparative quotes (RFQ)
Get quote
Accept a quote
List orders
Get order
Cancel an order
Get balances
Get balance statement
Get deposit account details
List deposits
Get deposit
List beneficiaries
Create beneficiary
Get beneficiary
List withdrawals
Create withdrawal
Get withdrawal
Cancel a withdrawal
An order reached the `filled` status - the trade is complete and balances are updated.
An order reached the `cancelled` status - it was cancelled before trading and balances were reverted.
A withdrawal was created and is awaiting dispatch.
A withdrawal is being dispatched to the payment rail.
A withdrawal completed and the funds were sent.
A withdrawal failed before dispatch.
A withdrawal was cancelled while pending.
A withdrawal was returned by the receiving bank.
A deposit was detected and is awaiting crediting.
A deposit was credited and the funds are available.
A beneficiary was created and is awaiting activation.
A beneficiary reached the `active` status and can be used in withdrawals.
A beneficiary was rejected and cannot be used in withdrawals.
A beneficiary was disabled and can no longer be used in withdrawals.
Initiate Payout
Retrieve Payout
List Payouts
Search Payouts by Merchant Reference
Cancel Payout
Initiate Bulk Payout
List Payout Beneficiaries
Create Payout Beneficiary
Retrieve Payout Beneficiary
Signal Payout Beneficiary
List Banks for Country
Search Payouts by Merchant Reference
Get Payout History (Multiple)
Get Payout History (Single)
Get Payout by ID
Get Payouts by Batch ID
Verify a mobile number
Verify a bank account

Status Dashboard

Exchange Webhooks Deposits

A deposit was detected and is awaiting crediting.

Payload

1 {
2   "eventType": "deposit.credited",
3   "timestamp": "2026-06-09T08:15:30Z",
4   "payload": {
5     "depositId": "dep_550e8400-e29b-41d4-a716-446655440000",
6     "currency": "USD",
7     "amount": "10000.00",
8     "reference": "CC-ACME-USD-7Q3K",
9     "status": "pending",
10     "receivedAt": "2026-04-21T14:20:00.000Z"
11   }
12 }

Was this page helpful?

A deposit was credited and the funds are available.

Payload

The payload of this webhook request is an object.

eventTypestringRequired

The event type, e.g. deposit.credited.

timestampdatetimeRequired

When the event was generated.

payloadobjectRequired

Response

200

Return any 2xx status to acknowledge receipt.