Search & list payments

Authorizations

X-API-KEY

string

header

required

Headers

X-API-VERSION

string

required

Specifies the version of the API to use. This must be set to 2.4.

Example:

"2.4"

Query Parameters

status

enum<string>[]

Filter payments by their status.

An enumeration.

Available options:

PENDING,

FAILED,

AUTHORIZED,

SETTLING,

PARTIALLY_SETTLED,

SETTLED,

DECLINED,

CANCELLED

payment_method_type

enum<string>[]

Filter payments by their payment method type.

Payment method type, where OFF_SESSION_PAYMENT is used for APM (Alternative Payment Method) payments and PAYMENT_CARD for traditional debit or credit cards. Please note that this list is different from one indicated on available payment methods page and values of this field will be changed in the future versions of the API.

Available options:

PAYMENT_CARD,

GOOGLE_PAY,

APPLE_PAY,

PAYPAL,

BANK_ACCOUNT,

KLARNA,

APAYA,

OPENNODE,

HOOLAH,

ATOME,

COINBASE,

NETS,

TWOC2P,

CLEARPAY,

SHOPEEPAY,

TRIPLE_A,

AFTERPAY,

NOL_PAY,

PAY_NL_IDEAL,

PAY_NL_BANCONTACT,

PAY_NL_DIRECT_DEBIT,

PAY_NL_SOFORT_BANKING,

PAY_NL_PAYPAL,

PAY_NL_PAYCONIQ,

PAY_NL_GIROPAY,

PAY_NL_P24,

PAY_NL_EPS,

PAY_NL_KAARTDIRECT,

ADYEN_SOFORT,

ADYEN_TWINT,

ADYEN_GIROPAY,

ADYEN_TRUSTLY,

ADYEN_ALIPAY,

ADYEN_MOBILEPAY,

ADYEN_MULTIBANCO,

ADYEN_VIPPS,

ADYEN_DOTPAY,

ADYEN_IDEAL,

ADYEN_BLIK,

ADYEN_PAYTRAIL,

ADYEN_INTERAC,

ADYEN_PAYSHOP,

ADYEN_MBWAY,

ADYEN_AFFIRM,

ADYEN_KLARNA,

ADYEN_BANCONTACT_PAYCONIQ,

ADYEN_EPS,

ADYEN_BANCONTACT_CARD,

ADYEN_SWISH,

MOLLIE_IDEAL,

MOLLIE_BANCONTACT,

MOLLIE_P24,

MOLLIE_GIROPAY,

MOLLIE_EPS,

MOLLIE_GIFTCARD,

MOLLIE_SOFORT,

NETAXEPT_PAYTRAIL,

BUCKAROO_IDEAL,

BUCKAROO_BANCONTACT,

BUCKAROO_SOFORT,

BUCKAROO_GIROPAY,

BUCKAROO_EPS,

RAPYD_GCASH,

RAPYD_PROMPTPAY,

RAPYD_GRABPAY,

RAPYD_POLI,

RAPYD_FAST,

XFERS_PAYNOW,

STRIPE_GIROPAY,

STRIPE_IDEAL,

ALIPAY_CN,

CHAI_KAKAOPAY,

CHAI_NAVER,

CHAI_TOSS,

XENDIT_DANA,

XENDIT_OVO,

XENDIT_SHOPEEPAY,

XENDIT_RETAIL_OUTLETS,

OMISE_PROMPTPAY,

OMISE_TRUEMONEY,

EBANX_PAGOFACIL,

PACYPAY_WECHAT,

PACYPAY_ALIPAY,

PACYPAY_ALIPAY_PLUS,

WORLDPAY_IDEAL,

IPAY88_CARD,

INGENICO_PAYPAL,

VOLT_PIX,

VOLT_BANK_TRANSFER,

BRAINTREE_VENMO,

THUNES_SPIRIT_OF_CADEAU,

THUNES_ILLICADO,

THUNES_CARTE_CADEAU_CONFORAMA,

THUNES_CHEQUE_FIDELITE_CONFORAMA,

SIPS_CPAY,

SIPS_CPAYCONFORAMA,

MONEXT_CETELEM,

MONEXT_CPAY

processor

string[]

Filter payments by their payment processor.

currency_code

string[]

Filter payments by their payment currency. e.g. use USD for US dollars.

Filter payments by their payment currency.

Use the 3-letter currency code in ISO 4217 format. e.g. use USD for US dollars."

from_date

string<date-time>

Return only payments from this date (inclusive).

to_date

string<date-time>

Return only payments up to this date (inclusive).

order_id

string

Return payments related to this order ID.

min_amount

integer<int64>

Return payments of this amount minimum (inclusive).

max_amount

integer<int64>

Return payments of this amount max (inclusive).

customer_id

string[]

ID of the customer that has made the payment.

merchant_id

string[]

ID of the merchant involved in the payment.

customer_email_address

string[]

Email of the customer that has made the payment.

last_4_digits

string[]

Last 4 digits of the card used for the payment.

paypal_email

string[]

Paypal email address associated with the payment.

klarna_email

string[]

Klarna email address associated with the payment.

limit

integer<int64>

default:100

Maximum number of payments to return per page.

Required range: 1 <= x <= 100

cursor

string

If results are paginated, pass the nextCursor to access next page.

Response

Successful Response

data

PaymentSummaryAPISchema · object[]

Show child attributes

data.id

string

required

The unique payment ID.

You can use this ID to retrieve the payment details, or perform downstream operations.

data.date

string<date-time>

required

The date and time at which the payment was created in UTC format.

data.dateUpdated

string<date-time>

required

The date and time of the last payment update in UTC format.

data.status

enum<string>

required

See the payment status table for more information.

Available options:

PENDING,

FAILED,

AUTHORIZED,

SETTLING,

PARTIALLY_SETTLED,

SETTLED,

DECLINED,

CANCELLED

data.orderId

string

required

Your reference for the payment.

data.currencyCode

string

required

The 3-letter currency code in ISO 4217 format. e.g. use USD for US dollars.

data.amount

integer<int64>

required

The payment amount, in minor units. e.g. $7 would show as 700.

data.processor

Processor · object

The payment processor used for this payment.

Show child attributes

data.processor.name

string

required

The payment processor used for this payment.

data.processor.processorMerchantId

string

The merchant ID registered at the payment processor used for this payment.

data.metadata

Payment Metadata · object

Additional data to be used throughout the payment lifecycle.

A dictionary of key-value pairs where the values can only be strings or integers.

e.g. {"productId": 1001, "merchantId": "a13bsd62s"}

nextCursor

string

prevCursor

string

API reference

Authorizations

Headers

Query Parameters

Response