Skip to main content
GET
Get payments

Authorizations

x-service-key
string
header
required

Service key for API authentication

Query Parameters

type
enum<string>

Filter by payment type

Available options:
OFFRAMP,
ONRAMP,
SWAP,
WALLET
status
enum<string>

Filter by payment status

Available options:
AWAITING_DEPOSIT,
PROCESSING,
COMPLETED,
FAILED

Filter by reference or keyword

Maximum string length: 200
start_date
string<date-time>

Filter by start date e.g 2026-01-01

end_date
string<date-time>

Filter by end date e.g 2026-01-01

page
integer
default:1

Results page number. Default 1.

Required range: x >= 1
limit
integer
default:10

Results per page. Default 10, maximum 100.

Required range: 1 <= x <= 100

Response

Payment history retrieved successfully

success
boolean
required
message
string
required
timestamp
string<date-time>
required
data
object
required