List transactions
List all transactions for a specific merchant account sorted by most recently created.
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Headers
The ID of the merchant account to use for this request.
"default"
Query Parameters
A pointer to the page of results to return.
"ZXhhbXBsZTE"
The maximum number of items that are at returned.
1 <= x <= 100
20
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
.
"2022-01-01T12:00:00+08:00"
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
.
"2022-01-01T12:00:00+08:00"
Filters the results to only transactions 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
.
"2022-01-01T12:00:00+08:00"
Filters the results to only transactions 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
.
"2022-01-01T12:00:00+08:00"
Filters for transactions that have one of the following fields match exactly with the provided search
value.
"transaction-12345"
Filters the results to only the items for which the buyer
has an external_identifier
that exactly matches this value.
"buyer-12345"
Filters the results to only the items for which the buyer
has an id
that matches this value.
"fe26475d-ec3e-4884-9553-f7356683f7f9"
Filters the results to only the items for which the buyer
has an email_address
that matches this value.
"john@example.com"
Filters the results to only the transactions that have a status
that matches with any of the provided status values.
processing
, authorization_succeeded
, authorization_declined
, authorization_failed
, authorization_voided
, authorization_void_pending
, capture_succeeded
, capture_pending
, buyer_approval_pending
"authorization_succeeded"
Filters for the transaction that has a matching id
value.
"7099948d-7286-47e4-aad8-b68f7eb44591"
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.
"tx-12345"
Filters the results to only the items for which the external_identifier
matches this value.
"transaction-12345"
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.
[
{
"first_key": "first_value",
"second_key": "second_value"
}
]
Filters for transactions that have an amount
that is equal to the provided amount_eq
value.
x >= 0
1299
Filters for transactions that have an amount
that is less than or equal to the amount_lte
value.
x >= 0
1299
Filters for transactions that have an amount
that is greater than or equal to the amount_gte
value.
x >= 0
1299
Filters for transactions that have matching currency
values. The currency
values provided must be formatted as 3-letter ISO currency code.
["USD"]
Filters for transactions that were processed by the provided payment_service_id
values.
["fffd152a-9532-4087-9a4f-de58754210f0"]
Filters for transactions that have a payment method with an ID that matches exactly with the provided value.
"ef9496d8-53a5-4aad-8ca2-00eb68334389"
Filters for transactions that have a payment method with a label that matches exactly with the provided value.
"1234"
Filters for transactions that have a payment method with a fingerprint that matches exactly with the provided value
"a50b85c200ee0795d6fd33a5c66f37a4564f554355c5b46a756aac485dd168a4"
Filters for transactions that have matching method
values.
abitab
, affirm
, afterpay
, alipay
, alipayhk
, applepay
, arcuspaynetwork
, bacs
, bancontact
, banked
, bcp
, becs
, bitpay
, boleto
, boost
, card
, cashapp
, chaseorbital
, clearpay
, click-to-pay
, dana
, dcb
, dlocal
, ebanx
, efecty
, eps
, everydaypay
, gcash
, gem
, gemds
, gift-card
, giropay
, givingblock
, gocardless
, googlepay
, googlepay_pan_only
, gopay
, grabpay
, ideal
, kakaopay
, kcp
, khipu
, klarna
, latitude
, latitudeds
, laybuy
, linepay
, linkaja
, maybankqrpay
, mercadopago
, multibanco
, multipago
, nequi
, netbanking
, network-token
, nupay
, oney_10x
, oney_12x
, oney_3x
, oney_4x
, oney_6x
, ovo
, oxxo
, pagoefectivo
, payid
, paymaya
, paypal
, paypalpaylater
, payto
, payvalida
, picpay
, pix
, pse
, rabbitlinepay
, razorpay
, rapipago
, redpagos
, scalapay
, sepa
, servipag
, shopeepay
, singteldash
, smartpay
, sofort
, spei
, stitch
, stripedd
, thaiqr
, touchngo
, truemoney
, trustly
, trustlyeurope
, upi
, venmo
, vipps
, waave
, webpay
, wechat
, yape
, zippay
"card"
Filters for transactions where the error_code
matches one for the provided values.
["insufficient_funds"]
Filters for transactions with refunds.
true
Filters for transactions with a pending manual anti-fraud review.
true
Filters for transactions where the checkout_session_id
matches the provided value.
"4137b1cf-39ac-42a8-bad6-1c680d5dab6b"
Filters for transactions where the reconciliation_id
matches the provided value.
"7jZXl4gBUNl0CnaLEnfXbt"
Filters for transactions with gift card redemptions.
true
Filters for transactions where a gift card used has an id
that matches the provided value.
"356d56e5-fe16-42ae-97ee-8d55d846ae2e"
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.
4
"7890"
Filters for transactions that have at least one associated settlement record.
true
Filter for transactions that have a card with a BIN that matches exactly with the provided value.
"411111"
Filters the results to only the transactions that have a payment source that matches with any of the provided values.
The way payment method information made it to this transaction.
ecommerce
, moto
, recurring
, installment
, card_on_file
"recurring"
Filters for transactions where the is_subsequent_payment
matches the provided value.
true
Filters for transactions where the merchant_initiated
matches the provided value.
true
Response
The response is of type object
.