Skip to main content
GET
Find payments

Authorizations

Authorization
string
header
required

Authentication header of the form api key, where api key is your organization api key.

Headers

X-API-Version
enum<string>
default:1.0.0
required

Specifies the version of the API to use

Available options:
1.0.0

Query Parameters

amount_from
integer

Minimum payment amount

amount_to
integer

Maximum payment amount

currency_code
enum<string>

ISO currency code (e.g., USD, EUR)

Available options:
AED,
AFN,
ALL,
AMD,
AOA,
ARS,
AUD,
AWG,
AZN,
BAM,
BBD,
BDT,
BGN,
BHD,
BIF,
BMD,
BND,
BOB,
BRL,
BSD,
BTN,
BWP,
BYN,
BZD,
CAD,
CDF,
CHF,
CLP,
CNY,
COP,
CRC,
CUC,
CUP,
CVE,
CZK,
DJF,
DKK,
DOP,
DZD,
EGP,
ERN,
ETB,
EUR,
FJD,
FKP,
GBP,
GEL,
GHS,
GIP,
GMD,
GNF,
GTQ,
GYD,
HKD,
HNL,
HTG,
HUF,
IDR,
ILS,
IMP,
INR,
IQD,
IRR,
ISK,
JEP,
JMD,
JOD,
JPY,
KES,
KGS,
KHR,
KMF,
KPW,
KRW,
KWD,
KYD,
KZT,
LAK,
LBP,
LKR,
LRD,
LSL,
LYD,
MAD,
MDL,
MGA,
MKD,
MMK,
MNT,
MOP,
MRU,
MUR,
MVR,
MWK,
MXN,
MYR,
MZN,
NAD,
NGN,
NIO,
NOK,
NPR,
NZD,
OMR,
PAB,
PEN,
PGK,
PHP,
PKR,
PLN,
PYG,
QAR,
RON,
RSD,
RUB,
RWF,
SAR,
SBD,
SCR,
SDG,
SEK,
SGD,
SHP,
SLE,
SOS,
SRD,
SSP,
STD,
STN,
SVC,
SYP,
SZL,
THB,
TJS,
TMT,
TND,
TOP,
TRY,
TTD,
TWD,
TZS,
BOV,
COU,
CHE,
CHW,
MXV,
UGX,
VES,
VND,
VUV,
XAF,
XCD,
XCG,
XOF,
XPF,
YER,
USD
from
string

Start datetime filter (ISO 8601 format)

limit
integer
default:100

Number of items per page

Required range: 1 <= x <= 1000
order
enum<string>
default:desc

Sort order

Available options:
asc,
desc
page
integer
default:1

Page number for paginated results

Required range: x >= 1
payment_status
enum<string>

Filter by payment status

Available options:
PENDING,
FAILED,
AUTHORIZED,
SETTLING,
SETTLED,
DECLINED,
BLOCKED,
CANCELLED
payment_status_in
enum<string>
Available options:
PENDING,
FAILED,
AUTHORIZED,
SETTLING,
SETTLED,
DECLINED,
BLOCKED,
CANCELLED
payment_status_not_in
enum<string>
Available options:
PENDING,
FAILED,
AUTHORIZED,
SETTLING,
SETTLED,
DECLINED,
BLOCKED,
CANCELLED
payment_status_set
string

Keyword to search across fields

snapshot_at
string

Timestamp of the data snapshot

sort
string
default:created_at

Field to sort by

statement_descriptor
string

Statement descriptor filter

to
string

End datetime filter (ISO 8601 format)

Response

OK

data
object[]
meta
object