Query store transaction records

Requires read_payment access scope.
For more info, refer to:
access permission.
GET https://{handle}.myshopline.com/admin/openapi/v20260301/payments/store/transactions.json
handle : The store's unique identifier, which is the prefix of the store's domain name. For example, if a store's domain name is open001.myshopline.com , the store handle is open001 .
Query a store's transaction records, including records of payments, refunds, and disputes.
Query Parameters
  • date_max string
    Specify the cut-off creation date and time for transactions to query, transactions created before this date and time are returned. The date_min and date_max parameters must be specified at the same time, and the maximum time interval between date_min and date_max cannot exceed 6 months. Format: ISO 8601.
    Example: 2024-12-10T00:00:00+08:00
  • date_min string
    Specify the start creation date and time for transactions to query, transactions created on or after this date and time are returned. The date_min and date_max parameters must be specified at the same time, and the maximum time interval between date_min and date_max cannot exceed 6 months. date_min can only be specified to query transactions created within 12 months. Format: ISO 8601.
    Example: 2024-12-10T00:00:00+08:00
  • limit string
    Maximum number of transaction records to be returned in the query. The maximum number cannot exceed 1000. Default value: 100.
  • page_info string
    The unique identifier for pagination queries, used to locate a specific page.
    This parameter value is obtained from the link value in the response header of this API after you have queried the pagination information.
    For example, if the link value you obtained is <https://{handle}.myshopline.com/admin/openapi/{version}/payments/store/transactions.json?limit=1&page_info=eyJzaW5jZUlkIjoiMTYwNTc1OTAxNTM4OTA4Mjk1MjExMTI3ODgiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjF9>; rel="next" , the value of page_info is eyJzaW5jZUlkIjoiMTYwNTc1OTAxNTM4OTA4Mjk1MjExMTI3ODgiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjF9 . For more information on how to use pagination, refer to Paging Mechanism.
  • since_id string
    The unique identifier for a payment, refund, or dispute. Filter transaction records that occurred before this order number for the since_id mode (query the first page of data). For more information on how to use pagination, refer to Paging Mechanism.
    Example: 10020122431667364394911580160
  • status string
    Transaction status.
    Whentransaction_type = PAYMENT, the valid values are:
    • CREATED: The transaction has been initiated.
    • CUSTOMER_ACTION: The transaction is pending customer action, such as confirmation or payment.
    • PROCESSING: The SHOPLINE Payments system is processing the transaction internally.
    • SUCCEEDED: The transaction was completed successfully.
    • FAILED: The transaction failed.
    • CANCELLED: The transaction has been cancelled.
    • EXPIRED: The transaction expired due to inactivity or time limits.
    When transaction_type = REFUND, the valid values are:
    • CREATED: The transaction has been initiated.
    • PROCESSING: The SHOPLINE Payments system is processing the transaction internally.
    • SUCCEEDED: The transaction was completed successfully.
    • FAILED: The transaction failed.
    When transaction_type = DISPUTE and dispute_type = CHARGEBACK, the valid values are:
    • CREATED: The dispute has been initiated.
    • EVIDENCE_RETURNED: Evidence submitted by the merchant was returned due to being incomplete or insufficient. The merchant needs to resubmit evidence.
    • EVIDENCE_REQUIRED: SHOPLINE Payments requests additional evidence from the merchant.
    • MERCHANT_SUBMITTED: The merchant has submitted evidence for review.
    • RESOLVED: The dispute is resolved but requires further action to determine the final outcome (either WON or LOST).
    • CANCELLED: The dispute was cancelled, likely leading to a WON outcome for the merchant.
    • EVIDENCE_UNDER_REVIEW: SHOPLINE Payments is reviewing the evidence submitted by the merchant.
    • LOST: The dispute was resolved in favor of the customer, with funds being returned to the customer.
    • WON: The dispute was resolved in favor of the merchant. Merchant retains funds.
    • EXPIRED: The dispute expired due to inactivity. This likely leads to a LOST outcome for the merchant.
    • SLP_EXPIRED: The merchant failed to provide evidence within the allotted time. This likely results in an EXPIRED dispute and potential loss for the merchant.
    • ACCEPTED: The merchant accepted the dispute. This leads to a LOST outcome for the merchant.
    • MERCHANT_ACCEPTED: The merchant agreed to resolve the dispute. This leads to an ACCEPTED outcome for the customer.
    When transaction_type = DISPUTE and dispute_type = PRE_CHARGEBACK, the valid values are:
    • PRE_CHARGEBACK_CREATED: A pre-chargeback has been initiated (a warning of a potential chargeback). The merchant needs to decide whether to accept or reject the refund request.
    • PRE_CHARGEBACK_IN_ACCEPT: The merchant accepted the pre-chargeback, leading to a PRE_CHARGEBACK_ACCEPTED outcome.
    • PRE_CHARGEBACK_IN_REJECT: The merchant rejected the pre-chargeback, leading to a PRE_CHARGEBACK_REJECTED outcome.
    • PRE_CHARGEBACK_IN_EXPIRE: A pre-chargeback expired due to merchant inactivity. The outcome could be either PRE_CHARGEBACK_ACCEPTED or PRE_CHARGEBACK_REJECTED.
    • PRE_CHARGEBACK_ACCEPTED: The merchant accepted the pre-chargeback and initiated a refund.
    • PRE_CHARGEBACK_REJECTED: The merchant rejected the pre-chargeback, potentially leading to further action, such as a chargeback.
    When transaction_type = DISPUTE and dispute_type = RETRIEVAL, the valid values are:
    • RETRIEVAL_CREATED: A retrieval request has been submitted.
    • RETRIEVAL_FINISHED: The retrieval was completed successfully.
    • RETRIEVAL_CANCELED: The retrieval request was cancelled.
    When transaction_type = DISPUTE and dispute_type = FRAUD_NOTIFICATION, the valid values are:
    • FRAUD_FINISHED: Notification of potential fraudulent activity. The merchant should contact the customer to verify the transaction and potentially issue a refund if necessary.
    Example: SUCCEEDED
  • trade_order_id string
    The unique identifier for a payment, refund, or dispute. Precisely search for information on the specified order number.
    Example: 10020122431667364394911580160
  • transaction_type string
    Transaction type. Valid values are:
    • PAYMENT: payment transaction
    • REFUND: refund transaction
    • DISPUTE: dispute transaction
Request Headers
  • Content-Type string required
    The field must be set to the fixed value application/json; charset=utf-8.
  • Authorization string required
    The access token for the API resource. Refer to App authorization to obtain the access token, and then pass the obtained token in the Bearer format.
    Example:
    Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw
Status Codes
For the complete list of codes and messages, see Http status code.
Response Headers
  • link
    The URL link that provides the pagination data. You can obtain page_info from this parameter for subsequent pagination requests.
    This parameter is returned when the requested page has a previous or next page.
    For more information on how to use pagination, refer to Paging Mechanism.
  • traceId
    A globally unique identifier for the request. It is used to track the request flow throughout the system, allowing for easy location and debugging when issues arise.
Response Body
  • transactionsobject[]
    Transaction list.
  • sub_payment_method string
    Payment sub-methods are detailed classifications of payment_method, and only some payment methods have sub-methods. For example, the payment method Alipay includes the sub-methods AlipayQrCode and AlipayWap.
  • additional_dataobject
    Additional Information.
  • dispute_evidence_update_deadline string
    Deadline for merchant to submit evidence. Format: ISO 8601.
  • is_settled boolean
    Whether the transaction has been settled.
    • true: settled
    • false: to be settled
    Example: true
  • reserve_held string
    Reserved funds. SHOPLINE Payments may charge a certain reserve for payment orders and will transfer it into the merchant's account balance after the holding period ends. Rounded to 2 decimal places.
    Example: 1.23
  • reserve_release_time string
    Release time of reserved funds, the time when SHOPLINE Payments transfers the reserved funds into the merchant's account balance. Format: ISO 8601.
    Example: 2024-12-10T00:00:00+08:00
  • settle_time string
    Settlement time. Format: ISO 8601.
    Example: 2024-12-09T00:00:00+08:00
  • statement_time string
    Consolidated statement generation time. Format: ISO 8601.
  • reason string
    The reason of refund or dispute. When transaction_type = DISPUTE and dispute_type = CHARGEBACK, the valid values are:
    • fraudulent: The transaction was fraudulent.
    • unrecognized: The transaction is suspicious.
    • duplicate: The customer was charged twice for the same item or service.
    • subscription_canceled: The customer canceled a subscription but was still billed.
    • product_not_received: The customer did not receive the purchased product.
    • product_unacceptable: The customer received the product but was dissatisfied with it.
    • credit_not_processed: The customer was promised a refund but never received it.
    • general: Other reasons.
    When transaction_type = DISPUTE and dispute_type = PRE_CHARGEBACK / RETRIEVAL / FRAUD_NOTIFICATION, this field value can be any string.
    When transaction_type = REFUND, this field value can be any string.
    When transaction_type = PAYMENT, the reason field is empty.
  • trade_order_id string
    The unique identifier for a payment, refund, or dispute.
    Example: 10010062529029006852253184000
  • transaction_type string
    Transaction type. Valid values are:
    • PAYMENT: payment transaction
    • REFUND: refund transaction
    • DISPUTE: dispute transaction
  • paid_amount string
    Actual payment amount, rounded to 2 decimal places.
    Example: 10.10
  • payment_method string
    Payment method.
    Example: ApplePay
  • channel_deal_id string
    The serial number for the payment channel used by SHOPLINE Payments to process transactions.
    Example: Z237HWV6LT7QCWX3
  • credit_cardobject
    Credit card information. This field is returned when the value of payment_method is CreditCard, Applepay, or Googlepay.
  • auth_code string
    Authorization code. The authorization code is a unique code generated by the issuing bank to indicate that the transaction has been approved.
    Example: 123456
  • bin string
    Card BIN.
    Example: 48068133
  • brand string
    Card brand.
    Example: Visa
  • issuer_country string
    Card issuing country.
    Example: US
  • last4 string
    Last four digits of card number.
    Example: 1234
  • type string
    Card type.
    Example: CREDIT
  • currency string
    Transaction currency. The value of this parameter is a three-letter currency code that follows the ISO 4217 standard. Example: USD.
    Example: USD
  • dispute_type string
    This field is returned when transaction_type is DISPUTE. Valid values are:
    • CHARGEBACK: A customer disputed the transaction with their bank, resulting in a reversal of funds.
    • PRE_CHARGEBACK: This signifies a preliminary stage before a full chargeback. The issuing bank is investigating the dispute.
    • RETRIEVAL: The acquirer requests additional information from the merchant regarding the transaction.
    • FRAUD_NOTIFICATION: This indicates a notification of potential fraudulent activity related to the transaction.
    Example: CHARGEBACK
  • sub_status string
    Transaction sub-statuses are detailed classifications of the status, and only some transaction statuses have sub-statuses.
    When status = FAILED, the valid values are:
    • CONFIRM_FAILED: An exception occurred during the CONFIRM phase of the transaction.
    • CAPTURE_FAILED: An exception occurred during the CAPTURE phase of the transaction.
    • PAYMENT_FAILED: An exception occurred during the PAYMENT phase of the transaction.
    • RISK_REJECTED: The transaction was rejected due to risk control reasons.
  • amount string
    Transaction amount. Rounded to 2 decimal places.
    Example: 10.10
  • exchangeobject
    Foreign exchange information.
  • amount string
    The amount of foreign exchange based on the actual payment amount, rounded to 2 decimal places.
    Example: 10.10
  • currency string
    Exchange currency. The value of this parameter is a three-letter currency code that follows the ISO 4217 standard. Example: USD.
    Example: USD
  • rate string
    Exchange rate, in the format of Transaction currency/Exchange currency @Exchange rate. The value is precise to 10 decimal places. Example: USD/USD @1.0000000000.
    Example: USD/USD @1.0000000000
  • merchant_id string
    Merchant’s ID in SHOPLINE Payments.
    Example: 2143350491097202688
  • payment_msgobject
    Payment failure information. When transaction_type is PAYMENT or REFUND, and the status is FAILED, this field is returned.
  • code string
    Error code.
    Example: The payment has been declined for unspecificed reasons.
  • msg string
    Error description.
    Example: 4600
  • update_time string
    Transaction detail update time. Format: ISO 8601. Updates include changes to transaction status and settlement information.
    Example: 2024-12-09T01:00:00+08:00
  • create_time string
    Transaction order creation time. Format: ISO 8601.
    Example: 2024-12-09T00:00:00+08:00
  • customerobject
    Customer information.
  • personal_infoobject
    Customer identity information.
  • first_name string
    Customer's first name.
    Example: demo
  • last_name string
    Customer's last name.
    Example: payment
  • fee string
    Transaction fees. If SHOPLINE Payments charges a fee to the merchant, this field is displayed as a negative amount. If SHOPLINE Payments refunds a fee to the merchant, this field is displayed as a positive amount.
    Example: -0.22
  • fee_type string
    Fee type. Valid values are:
    • domestic: Local transaction fee, the fee for accepting domestic bank card transactions.
    • international: Cross-border transaction fee, the fee for accepting foreign bank card transactions.
    Example: international
  • payment_method_optionobject
    Optional information for payment method.
  • installmentobject
    Installment information of payment method.
  • count string
    Number of installments.
    Example: 12
  • seller_order_id string
    Business order number.
    Example: 123456
  • status string
    Transaction status. For specific values of this field, refer to the description of the status field in the query parameters.
    Example: SUCCEEDED
API Explorer
https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301

ParamOptions

— header required
— query
— query
— query
— query
— query
— query
— query
— query

Language

curl --request GET \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301/payments/store/transactions.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'
Examples
Query of parameter validation failure
Response
{
  "errors": "Required param: date_min"
}
Was this article helpful to you?
SHOPLINE
SHOPLINE
SHOPLINE Enterprise
Legal
Privacy
Terms
Developer Agreement
LinkedInEmail
LinkedInEmail
© Copyright 2013-2025 SHOPLINE Limited.