Sign in

v1

latestOpenAPI 3.0.02026-07-2323080.8 KB
payment-history

get/payment

Query parameters

track_idinteger

Filter payments by a specific invoice ID.

type'invoice' | 'white_label' | 'static_address'

Filter payments by type.

status'Paying' | 'Paid'

Filter payments by status.

pay_currencystring

Filter payments by a specific crypto currency symbol in which the pay amount is specified.

currencystring

Filter payments by a specific currency symbol.

networkstring

Filter payments by the expected blockchain network for the specified crypto currency.

addressstring

Filter payments by the expected address. It’s better to filter static addresses.

from_dateinteger

The start of the date window to query for payments in UNIX format.

to_dateinteger

The end of the date window to query for payments in UNIX format.

from_amountnumber

Filter payments with amounts greater than or equal to the specified value.

to_amountnumber

Filter payments with amounts less than or equal to the specified value.

sort_by'create_date' | 'pay_date' | 'amount'

Sort the received list by a parameter.

sort_type'asc' | 'desc'

Display the list in ascending or descending order.

pageinteger

The page number of the results you want to retrieve.

sizeinteger

Number of records to display per page.

Headers

merchant_api_keystring required

Your Merchant API Key for authentication and authorization.

Content-Typestring required

Response

Successful operation

messagestring

A message containing additional information about the result of the request.

statusinteger

The status of the request response. Typically provided as a numeric code (e.g., 200 for success or other codes for errors).

versionstring

The version of the API being used.