Transaction List

🔒

Requires read_order access scope. More access scope

Retrieve a list of order transactions, including details such as transaction status, payment channel, and other related information.

This API is especially useful for:

  1. Fetching payment transaction details for specific orders.
  2. Filtering order transactions based on their status.
  3. Querying transaction details by payment channel.

Note: The operation is scoped to a specific shop, identified by its unique domain prefix (shopdomain), ensuring all updates are applied to the correct store.

Request Parameters

Public Request Parameters

📘

Public Request Parameters

Path Parameters

ParameterTypeRequiredExampleDescription
idstringYes123456Unique identifier for the order.

Query Parameters

ParameterTypeRequiredDescriptionExample
statusstringNoTransaction status, e.g., success.success
payment_channelstringNoPayment channel, e.g., paypal.paypal

Response Explanation

Public Response Parameters

📘

Public Response Parameters

Successful Response

Field Type Example Description
transactionsarray[ ... ]List of transactions.
transactions
.id
string"2150768865"Unique identifier for the transaction.
transactions
.order_id
string"633130-00000007"Order ID associated with the transaction.
transactions
.payment_channel
string"bogus"Payment channel used for the transaction.

Examples:
- bogus - Test payment channel
- cod - Cash on delivery.
transactions
.message
string""Additional information about the transaction success or failure, provided by the payment provider.
transactions
.created_at
string"2024-04-19 09:54:03"Transaction creation time in UTC (0 timezone), formatted as ISO 8601.
transactions
.test
booleantrueIndicates whether the transaction is a test transaction.
transactions
.error_code
string""Error code returned in case of a failed transaction.
transactions
.amount
string"109.9000"Transaction amount.
transactions
.currency
string"CNY"Transaction currency.
transactions
.trade_id
string"test_633130-00000007"Unique trade ID provided by the payment provider.
transactions
.status
string"success"Transaction status. View more details of status.
transactions
.payment_details
objectobject of payment detailsDetailed payment information, including card details.
transactions
.payment_details
.card_number
string"420000******0000"Credit card number, showing only the first 6 and last 4 digits.
transactions
.payment_details
.card_month
string"01"Credit card expiration month.
transactions
.payment_details
.card_year
string"27"Credit card expiration year.
transactions
.payment_details
.card_first_name
string"ryan"Cardholder's first name.
transactions
.payment_details
.card_last_name
string"zhang"Cardholder's last name.
transactions
.payment_details
.card_first_six
string"420000"First 6 digits of the card number.
transactions
.payment_details
.card_last_four
string"0000"Last 4 digits of the card number.
transactions
.payment_details
.avs_result_code
string""Address Verification System response code.
transactions
.payment_details
.cvv_result_code
string""Response code indicating if the card's security code (CVV) was correctly entered and verified.
transactions
.payment_name
string""Payment name or additional identifier.
countinteger1Total number of transactions returned.
since_idstring"2150768865"ID of the most recent transaction in the list.

Error Response

Error responses in the API can be represented using two different fields: errors and error. Both fields provide details about issues encountered during request processing. Below is an explanation of the fields with their respective examples and descriptions.

FieldTypeExampleDescription
errorsArray["Context"]A list of errors encountered during the request processing.
FieldTypeExampleDescription
errorString "store is not active"Indicates an error encountered during the process

Error Detail

Status CodeMessagePossible ReasonExample Response
400Bad RequestInvalid input format or request structure (e.g., missing required fields or incorrect data types).Bad Request
UnauthorizedThe request is missing valid authentication credentials or the credentials provided are invalid.Unauthorized

API Structure Overview

Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!