Skip to main content
GET
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_instrument_type
enum<string>[]

Filter payments by their payment instrument type.

The type of payment instrument used to make a payment.

Available options:
PAYMENT_CARD,
PAYPAL_ORDER,
PAYPAL_BILLING_AGREEMENT,
APPLE_PAY,
APPLE_PAY_ENCRYPTED_TOKEN,
GOOGLE_PAY,
KLARNA_AUTHORIZATION_TOKEN,
KLARNA_CUSTOMER_TOKEN,
PAY_NL_IDEAL,
APAYA,
OFF_SESSION_PAYMENT,
CARD_OFF_SESSION_PAYMENT,
AUTOMATED_CLEARING_HOUSE
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.

authorization_type
enum<string>

Filter payments by their authorization type. Type of authorization for the payment.

Available options:
ESTIMATED,
FINAL

Response

Successful Response

data
PaymentSummaryAPISchema · object[]
required
nextCursor
string
prevCursor
string