Endpoint Surface

Every retail API endpoint, grouped by domain, as a single lookup table.

The full public endpoint surface of the retail API, grouped by domain. Use it to find which guide
covers a path you have seen in a log or an SDK call.


DomainEndpoints
AuthorizationPOST /api/v1/token, POST /api/v1/user/authorize
ConfigurationGET /api/v1/config, GET /api/v1/config/tokens
ValidationGET /api/v1/validation/rules
OnboardingPOST /api/v1/user, POST /api/v2/user, POST /api/v1/user/retail, POST /api/v1/user/retail/validate
UserGET /api/v1/user, GET /api/v2/user, PUT /api/v2/user/kyc-data, POST /api/v1/user/documents, PUT /api/v1/user/phone-number, PUT /api/v1/user/phone-number/confirm, PUT /api/v1/user/freshdesk-id
KYCPOST /api/v1/user/verification-link, POST /api/v1/user/verification-token
ConfirmationPOST /api/v1/confirmation/signature/verify, POST /api/v1/confirmation/sms, POST /api/v1/confirmation/sms/verify
WalletsGET /api/v1/wallet, GET /api/v1/wallets, POST /api/v1/wallets/global
RatesGET /api/v1/rates
FXPOST /api/v1/fx/estimate, POST /api/v1/fx
CardsGET /api/v1/cards, GET /api/v1/cards/{cardId}
Card issuancePOST /api/v1/cards/{virtual|plastic|metal}, POST /api/v2/cards/{virtual|plastic|metal}, PUT /api/v1/cards/{cardId}/activate
Card feesGET /api/v1/cards/{type}/fees/{country}, POST /api/v1/cards/{type}/fees/{country}/payment, POST /api/v2/cards/{type}/fees/{country}/payment
Card deliveryGET /api/v1/cards/delivery/countries, GET /api/v1/cards/delivery/methods/{country}
Card managementPUT /api/v1/cards/{cardId}/{block|unblock|close|name|limit}
Card detailsPOST /api/v1/cards/{cardId}/{details|cvv|pin}
3DSGET /api/v1/cards/3ds/requests, POST /api/v1/cards/3ds/requests/{transactionId}/{approve|decline}
Card top-upPOST /api/v1/cards/topup/estimate, POST /api/v1/cards/topup/execute
Card transferPOST /api/v1/cards/transfer/estimate, POST /api/v1/cards/transfer
BankGET /api/v1/bank/accounts, POST /api/v1/bank/accounts, POST /api/v1/bank/accounts/init, POST /api/v1/bank/accounts/complete, POST /api/v1/bank/transfer, POST /api/v1/bank/transfer/estimate, POST /api/v2/bank/transfer/estimate
CorridorsPOST /api/v3/bank/{estimate|initiate|confirm}/{corridor}
RecipientsGET|POST /api/v1/recipients, POST /api/v2/recipients, GET|PUT|DELETE /api/v1/recipients/{recipientId}, PUT /api/v2/recipients/{recipientId}, GET /api/v1/recipients/filter/{catalog|currency|name|type}, POST /api/v1/recipients/{recipientId}/usage, POST|PUT|DELETE /api/v1/recipients/{recipientId}/payment_details[/{paymentDetailsId}]
ActivityGET /api/v1/activity/feed, GET /api/v2/activity/feed, GET /api/v2/activity/search, GET /api/v1/activity/single/{id}, GET /api/v2/activity/single/{id}, POST /api/v1/activity/statement/full, GET /api/v1/withdrawal/requests
XRPLPOST /api/v1/accounts, POST /api/v1/withdrawal/execute
ScreeningPOST /api/v1/transactions/risk-assessment

Endpoints tagged Obsolete in the API reference are omitted.


Did this page help you?