API Reference
GET /v2/payments/rails/payment-methods: Get fiat payment methods.GET /v2/payments/rails/crypto: Get crypto rails.POST /v2/payments/transfers: Create a transfer quote.POST /v2/payments/transfers/{transferId}/execute: Execute a transfer quote.GET /v2/payments/transfers/{transferId}: Get a transfer by transferId.
Payment Rails
Payment rails are the source or the target of a transfer. We support the following payment rails:- Crypto rails: Onchain currency and networks to send and receive crypto (e.g. Currency: USDC, Network: Ethereum, Solana, Bitcoin, Polygon, Avalanche).
- Payment methods: Payment methods that are previously added in your account (e.g Debit Card).
Transfer
A Transfer is a money movement between two payment rails. we support the following transfer types:-
Fiat to Crypto transfer
- Source: a payment method (payment method that is already added in your account. e.g. Card)
- Target: onchain address to receive crypto
Create a Transfer
-
Use
/v2/payments/rails/payment-methodsand/v2/payments/rails/cryptoto get all available payment rails. -
Choose the payment rails to use as source and target, and the amount to transfer.
- Use
/v2/payments/transfersto create a transfer quote. - Optionally, you can set
executeto true to execute the transfer quote immediately.
- Use
-
Once you have a transfer quote, use
/v2/payments/transfers/{transferId}/executeto execute a transfer quote. -
Use
/v2/payments/transfers/{transferId}to get a transfer by transferId.