v1

latestOpenAPI 3.0.02026-07-14664396.8 KB
ONRAMP

List Onramp Transactions

Lists onramp transactions using date range, pagination, customer, email, country, order and status filters.

get/onramp

Query parameters

startDatestring required
Example:2023-01-01

Start date to filter transactions

endDatestring required
Example:2023-12-31

End date to filter transactions

limitnumber required
Example:10

Number of items per page

pagenumber required
Example:1

Page number for pagination

customerIdstring
Example:123e4567-e89b-12d3-a456-426614174000

Customer ID to filter transactions

emailstring
Example:customer@example.com

Customer email to filter transactions

countrystring
Example:Spain

Customer country to filter transactions

order'ASC' | 'DESC'
Example:ASC

Order of the results

status'FIAT_DEPOSIT_RECEIVED' | 'TRADE_COMPLETED' | 'ON_CHAIN_INITIATED' | 'ON_CHAIN_COMPLETED' | 'FAILED' | 'FIAT_TRANSFER_INITIATED' | 'FIAT_TRANSFER_COMPLETED' | 'CREATED'
Example:ON_CHAIN_COMPLETED

Status of the onramps

Headers

api-keystring
Example:alfredpay.T+QdhCoMofy8.gGKO5KdB7M+B/9jLFef

API Key for service authentication (alternative to JWT Bearer token). Optional.

api-secretstring
Example:PwF+cDGZd37eHYZ.CVvF1/zbHCBosSo1

API Secret for service authentication (alternative to JWT Bearer token). Optional.