| Field | Type | Required | Description | Example |
|---|---|---|---|---|
cursor |
?string | ➖ | A pointer to the page of results to return. | ZXhhbXBsZTE |
limit |
?int | ➖ | The maximum number of items that are at returned. | 20 |
createdAtLte |
\DateTime | ➖ | 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 |
createdAtGte |
\DateTime | ➖ | 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 |
updatedAtLte |
\DateTime | ➖ | 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 |
updatedAtGte |
\DateTime | ➖ | 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 |
search |
?string | ➖ | N/A | transaction-12345 |
buyerExternalIdentifier |
?string | ➖ | N/A | buyer-12345 |
buyerId |
?string | ➖ | N/A | fe26475d-ec3e-4884-9553-f7356683f7f9 |
buyerEmailAddress |
?string | ➖ | N/A | john@example.com |
ipAddress |
?string | ➖ | N/A | 8.214.133.47 |
status |
array<string> | ➖ | Filters the results to only the transactions that have a status that matches with any of the provided status values. |
|
id |
?string | ➖ | N/A | 7099948d-7286-47e4-aad8-b68f7eb44591 |
paymentServiceTransactionId |
?string | ➖ | N/A | tx-12345 |
externalIdentifier |
?string | ➖ | N/A | transaction-12345 |
metadata |
array<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. |
[ { "first_key": "first_value", "second_key": "second_value" } ] |
amountEq |
?int | ➖ | Filters for transactions that have an amount that is equal to the provided amount_eq value. |
1299 |
amountLte |
?int | ➖ | Filters for transactions that have an amount that is less than or equal to the amount_lte value. |
1299 |
amountGte |
?int | ➖ | Filters for transactions that have an amount that is greater than or equal to the amount_gte value. |
1299 |
currency |
array<string> | ➖ | Filters for transactions that have matching currency values. The currency values provided must be formatted as 3-letter ISO currency code. |
[ "USD" ] |
country |
array<string> | ➖ | Filters for transactions that have matching country values. |
[ "US" ] |
paymentServiceId |
array<string> | ➖ | Filters for transactions that were processed by the provided payment_service_id values. |
[ "fffd152a-9532-4087-9a4f-de58754210f0" ] |
paymentMethodId |
?string | ➖ | N/A | ef9496d8-53a5-4aad-8ca2-00eb68334389 |
paymentMethodLabel |
?string | ➖ | N/A | 1234 |
paymentMethodScheme |
array<string> | ➖ | Filters for transactions where the payment_method_scheme matches one of the provided values. |
[ "visa" ] |
paymentMethodCountry |
?string | ➖ | Filters for transactions that have a payment method with a country that matches with the provided value. | |
paymentMethodFingerprint |
?string | ➖ | N/A | a50b85c200ee0795d6fd33a5c66f37a4564f554355c5b46a756aac485dd168a4 |
method |
array<string> | ➖ | Filters for transactions that have matching method values. |
|
errorCode |
array<string> | ➖ | Filters for transactions where the error_code matches one for the provided values. |
[ "insufficient_funds" ] |
hasRefunds |
?bool | ➖ | Filters for transactions with refunds. | true |
pendingReview |
?bool | ➖ | Filters for transactions with a pending manual anti-fraud review. | true |
checkoutSessionId |
?string | ➖ | Filters for transactions where the checkout_session_id matches the provided value. |
4137b1cf-39ac-42a8-bad6-1c680d5dab6b |
reconciliationId |
?string | ➖ | Filters for transactions where the reconciliation_id matches the provided value. |
7jZXl4gBUNl0CnaLEnfXbt |
hasGiftCardRedemptions |
?bool | ➖ | Filters for transactions with gift card redemptions. | true |
giftCardId |
?string | ➖ | Filters for transactions where a gift card used has an id that matches the provided value. |
356d56e5-fe16-42ae-97ee-8d55d846ae2e |
giftCardLast4 |
?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. | 7890 |
hasSettlements |
?bool | ➖ | Filters for transactions that have at least one associated settlement record. | true |
paymentMethodBin |
?string | ➖ | Filter for transactions that have a card with a BIN that matches exactly with the provided value. | 411111 |
paymentSource |
array<string> | ➖ | Filters the results to only the transactions that have a payment source that matches with any of the provided values. | |
isSubsequentPayment |
?bool | ➖ | Filters for transactions where the is_subsequent_payment matches the provided value. |
true |
merchantInitiated |
?bool | ➖ | Filters for transactions where the merchant_initiated matches the provided value. |
true |
used3ds |
?bool | ➖ | Filters for transactions that attempted 3DS authentication or not. | true |
disputed |
?bool | ➖ | Filters for transactions that have been disputed. | true |
buyerSearch |
array<string> | ➖ | Filters the results to only get the items for which some of the buyer data contains exactly the provided buyer_search values. |
[ "John", "London" ] |
merchantAccountId |
?string | ➖ | The ID of the merchant account to use for this request. | default |