API ReferencePayments
Transactions List
Retrieve a list of transactions.
Authorization
oauth2 transactions:readAuthorizationBearer <token>
Generate an Access Token through Settings > API Access for single store access or use the Authorization Code flow with your partner App Client ID. Use required permission scopes for API endpoint access. Example Authorization: Bearer 123
In: header
Scope: transactions:read
Query Parameters
external_id?string
External ID
date_created_from?string
YYYY-MM-DD
Format
datedate_created_to?string
YYYY-MM-DD
Format
datetype?Type
Transaction Type
authorize- Authorizedebit- Debitrefund- Refundvoid- Void
Value in
- "authorize"
- "debit"
- "refund"
- "void"
card_type?array<>
Card Brand
visa- Visamastercard- Mastercardamerican_express- American Expressdiners_club- Diners Clubdiscover- Discoverjcb- JCBmaestro- Maestrodankort- Dankort
bankcard_first_six?string
Bankcard First Six
bankcard_last_four?string
Bankcard Last Four
gateway_id?integer
Gateway ID
payment_method?string
Payment Method
amount_min?number
Amount Min
amount_max?number
Amount Max
currency?string
core_transaction_code?string
Transaction Code
status?string
Status
succeeded- Succeededfailed- Failed
Value in
- "failed"
- "succeeded"
auth_code?string
Auth Code
network_transaction_id?string
Network Transaction ID
is_3ds?boolean
optimized_3ds?boolean
is_initial_retry?boolean
subscription_life_cycle?Subscription Lifecycle
recurring- Recurringnon-recurring- Non-Recurring
Value in
- "non-recurring"
- "recurring"
funnels?array<string|null>
Funnels
is_external?boolean
is_test?boolean
utm_source?string
UTM Source
utm_campaign?string
UTM Campaign
utm_content?string
UTM Content
utm_term?string
UTM Term
affiliate?string
Affiliate
subaffiliate1?string
Sub-Affiliate 1
subaffiliate2?string
Sub-Affiliate 2
subaffiliate3?string
Sub-Affiliate 3
subaffiliate4?string
Sub-Affiliate 4
subaffiliate5?string
Sub-Affiliate 5
cursor?string
The pagination cursor value.
Header Parameters
X-29next-API-Version*"2024-04-01"
Default
"2024-04-01"Value in
- "2024-04-01"
Response Body
application/json
curl -X GET "https://example.com/transactions/" \ -H "X-29next-API-Version: 2024-04-01"{ "next": "http://example.com", "previous": "http://example.com", "results": [ { "amount": "string", "amount_available_for_refund": "0.00", "attribution": { "affiliate": "string", "agent": { "email": "user@example.com", "first_name": "string", "id": 0, "last_name": "string" }, "funnel": "string", "gclid": "string", "metadata": null, "subaffiliate1": "string", "subaffiliate2": "string", "subaffiliate3": "string", "subaffiliate4": "string", "subaffiliate5": "string", "utm_campaign": "string", "utm_content": "string", "utm_medium": "string", "utm_source": "string", "utm_term": "string" }, "auth_code": "string", "currency": "string", "date_created": "2019-08-24T14:15:22Z", "external_id": "string", "id": 0, "initiator": { "email": "user@example.com", "first_name": "string", "id": 0, "last_name": "string" }, "is_disputed": true, "is_external": true, "network_transaction_id": "string", "order": "string", "parent_id": 0, "payment_details": { "bankcard_first_six": "string", "bankcard_last_four": "string", "card_token": "string", "gateway": { "id": 0, "is_next_payments": true, "name": "string", "type": "string" }, "is_3ds": true, "optimized_3ds": true, "paypal_vault_id": "string", "sca_flow": "string" }, "payment_method": "string", "response_code": 0, "status": "succeeded", "subscription": { "billing_cycle": 0, "id": 0 }, "type": "string", "user": { "accepts_marketing": true, "email": "user@example.com", "first_name": "string", "id": 0, "ip": "string", "language": "string", "last_name": "string", "phone_number": "string", "user_agent": "string" } } ]}