GET
/
transactions

This endpoint requires the transactions.read scope.

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

buyer_external_identifier
string

Filters the results to only the items for which the buyer has an external_identifier that matches this value.

buyer_id
string

Filters the results to only the items for which the buyer has an id that matches this value.

cursor
string

A cursor that identifies the page of results to return. This is used to paginate the results of this API.

For the first page of results, this parameter can be left out. For additional pages, use the value returned by the API in the next_cursor field. Similarly the previous_cursor can be used to reverse backwards in the list.

limit
integer
default: 20

Defines the maximum number of items to return for this request.

Required range: 1 < x < 500
amount_eq
integer

Filters for transactions that have an amount that is equal to the provided amount_eq value.

amount_gte
integer

Filters for transactions that have an amount that is greater than or equal to the amount_gte value.

amount_lte
integer

Filters for transactions that have an amount that is less than or equal to the amount_lte value.

checkout_session_id
string

Filters for transactions that are linked to the unique ID for a Checkout Session.

created_at_gte
string

Filters the results to only transactions created after this ISO date-time string. The time zone must be included.

Ensure that the date-time string is URL encoded, e.g. 2022-01-01T12:00:00+08:00 must be encoded as 2022-01-01T12%3A00%3A00%2B08%3A00.

created_at_lte
string

Filters the results to only transactions created before this ISO date-time string. The time zone must be included.

Ensure that the date-time string is URL encoded, e.g. 2022-01-01T12:00:00+08:00 must be encoded as 2022-01-01T12%3A00%3A00%2B08%3A00.

currency
string[]

Filters for transactions that have matching currency values. The currency values provided must be formatted as 3-letter ISO currency code.

external_identifier
string

Filters the results to only the items for which the external_identifier matches this value.

gift_card_id
string

Filters for transactions that have at least one gift card redemption with a matching gift_card_id value.

gift_card_last4
string

Filters for transactions that have at least one gift card redemption where the last 4 digits of its gift card number matches exactly with the provided value.

Required string length: 4
has_gift_card_redemptions
boolean

When set to true, filters for transactions that have at least one gift card redemption associated with it. When set to false, filter for transactions that have no gift card redemptions.

has_refunds
boolean

When set to true, filter for transactions that have at least one completed refund (including gift card refunds) associated with it. When set to false, filter for transactions that have no completed refunds.

has_settlements
boolean

When set to true, filter for transactions that have at least one settlement. When set to false, filter for transactions that have no settlements.

id
string

Filters for the transaction that has a matching id value.

metadata
string[]

Filters for transactions where their metadata values contain all of the provided metadata keys. The value sent for metadata must be formatted as a JSON string, and all keys and values must be strings. This value should also be URL encoded.

Duplicate keys are not supported. If a key is duplicated, only the last appearing value will be used.

method
enum<string>[]

Filters the results to only the items for which the method has been set to this value.

Available options:
afterpay,
alipay,
alipayhk,
applepay,
bacs,
bancontact,
banked,
becs,
bitpay,
boleto,
boost,
card,
cashapp,
chaseorbital,
checkout-session,
clearpay,
click-to-pay,
dana,
dcb,
dlocal,
ebanx,
eps,
everydaypay,
gcash,
giropay,
givingblock,
gocardless,
googlepay,
googlepay_pan_only,
gopay,
grabpay,
id,
ideal,
kakaopay,
kcp,
klarna,
laybuy,
linepay,
linkaja,
maybankqrpay,
multibanco,
multipago,
network-token,
oney_3x,
oney_4x,
oney_6x,
oney_10x,
oney_12x,
ovo,
oxxo,
payid,
paymaya,
paypal,
paypalpaylater,
payto,
venmo,
pix,
rabbitlinepay,
razorpay,
scalapay,
sepa,
shopeepay,
singteldash,
smartpay,
sofort,
spei,
stripedd,
thaiqr,
touchngo,
truemoney,
trustly,
trustlyeurope,
vipps,
waave,
wechat,
zippay
payment_method_id
string

Filters for transactions that have a payment method with an ID that matches exactly with the provided value.

payment_method_label
string

Filters for transactions that have a payment method with a label that matches exactly with the provided value.

payment_service_id
string[]

Filters for transactions that were processed by the provided payment_service_id values.

payment_service_transaction_id
string

Filters for transactions that have a matching payment_service_transaction_id value. The payment_service_transaction_id is the identifier of the transaction given by the payment service.

pending_review
boolean

When set to true, filter for transactions that have a manual review pending. When set to false, filter for transactions that don't have a manual review pending.

reconciliation_id
string

Filters for transactions based on their transaction reconciliation identifier.

search
string
deprecated

Filters for transactions that have one of the following fields match exactly with the provided search value.

  • buyer_external_identifier
  • buyer_id
  • external_identifier
  • id
  • payment_service_transaction_id

The search will apply against all fields at the same time. Please do not use this query parameter in a production application, as this API call is very inefficient and may negatively impact transaction performance.

status
enum<string>[]

Filters the results to only the transactions that have a status that matches with any of the provided status values.

Available options:
processing,
buyer_approval_pending,
authorization_succeeded,
authorization_failed,
authorization_declined,
capture_pending,
capture_succeeded,
authorization_void_pending,
authorization_voided
updated_at_gte
string

Filters the results to only transactions last updated after this ISO date-time string. The time zone must be included.

Ensure that the date-time string is URL encoded, e.g. 2022-01-01T12:00:00+08:00 must be encoded as 2022-01-01T12%3A00%3A00%2B08%3A00.

updated_at_lte
string

Filters the results to only transactions last updated before this ISO date-time string. The time zone must be included.

Ensure that the date-time string is URL encoded, e.g. 2022-01-01T12:00:00+08:00 must be encoded as 2022-01-01T12%3A00%3A00%2B08%3A00.

Response

200 - application/json

A list of transactions.

items
object[]

A list of transactions.

limit
integer
default: 20

The limit applied to request. This represents the number of items that are at maximum returned by this request.

Required range: 1 < x < 500
next_cursor
string | null

The cursor that represents the next page of results. Use the cursor query parameter to fetch this page of items.

Required string length: 1 - 1000
previous_cursor
string | null

The cursor that represents the next page of results. Use the cursor query parameter to fetch this page of items.

Required string length: 1 - 1000

Was this page helpful?

New transaction