List transactions
Lists all transactions for an account. Sorted by last updated at.
This endpoint requires the transactions.read
scope.
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
Filters the results to only the items for which the buyer
has an
external_identifier
that matches this value.
Filters the results to only the items for which the buyer
has an
id
that matches this value.
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.
Defines the maximum number of items to return for this request.
Filters for transactions that have an amount
that is
equal to the provided amount_eq
value.
Filters for transactions that have an amount
that is
greater than or equal to the amount_gte
value.
Filters for transactions that have an amount
that is
less than or equal to the amount_lte
value.
Filters for transactions that are linked to the unique ID for a Checkout Session.
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
.
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
.
Filters for transactions that have matching currency
values.
The currency
values provided must be formatted as 3-letter ISO
currency code.
Filters the results to only the items for which the external_identifier
matches this value.
Filters for transactions that have at least one gift card
redemption with a matching gift_card_id
value.
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.
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.
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.
When set to true
, filter for transactions that have at least one settlement.
When set to false
, filter for transactions that have no settlements.
Filters for the transaction that has a matching id
value.
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.
Filters the results to only the items for which the method
has been set to
this value.
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
Filters for transactions that have a payment method with an ID that matches exactly with the provided value.
Filters for transactions that have a payment method with a label that matches exactly with the provided value.
Filters for transactions that were processed by the provided
payment_service_id
values.
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.
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.
Filters for transactions based on their transaction reconciliation identifier.
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.
Filters the results to only the transactions that have a status
that matches with any of the provided status values.
processing
, buyer_approval_pending
, authorization_succeeded
, authorization_failed
, authorization_declined
, capture_pending
, capture_succeeded
, authorization_void_pending
, authorization_voided
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
.
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
A list of transactions.
A list of transactions.
The limit applied to request. This represents the number of items that are at maximum returned by this request.
The cursor that represents the next page of results. Use the cursor
query
parameter to fetch this page of items.
The cursor that represents the next page of results. Use the cursor
query
parameter to fetch this page of items.
Was this page helpful?