Balance transactions

Requires read_payment access scope.

For more info, refer to:

GET https://{handle}.myshopline.com/admin/openapi/v20260301/payments/store/balance_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 the bill records of SHOPLINE Payments account, support paging query. Does not support POS currently.

Query Parameters

limit string

Page size, default 1000 , no more than 10000

Example: 1000
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/balance_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.

Example: eyJwYXlvdXRTdGF0dXMiOiJjb21wbGV0ZWQiLCJzaW5jZUlkIjoiMjAyMjA3MjkxNDUxMjIzODIwMDExMTMwMDAwIiwicGFnZVR5cGUiOiJORVhUIn0%3D
payout_id string

Withdraw id , filter the bill record corresponding to this withdraw . Note : it does not support this parameter for CN stores

Example: 202208031899561700999905280
payout_status string

Withdraw status , available values : in progress ( in process ) ; accepted by bank ( bank accepted ) ; completed ( completed ) ; failed ( failed in payment ) ; retrying ( in re-sale ) ;

Example: in progress
since_id string

The serial number of bill record, filter the billing record that happened before the serial number, Used for since_id mode (query the first page of data). Refer to the paging mechanism for details about pagination.

Example: 202206161756376480011100000

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[]

Billing records
source_type string

Bill records source transaction types. Including payment transactions , refund transactions , problem transactions , etc.
Example: refund
transaction_time string

Transaction time , follow ISO8601 specifications
Example: 2022-02-25T18:00:42+08:00
type string

Bill type . Available value : payment ( payment success ) ; refund ( refund launch ) ; refund_failure ( refund failure ) ; chargeback ( chargeback launch ) ;Chargeback_won ; reserve_held ; reserve_released ; chargeback_won ;Accounting_adjustment ( the account is covered with the data of the account that can be paid ) ; transfer_in ; payout
Example: fee_reversed
fee string

Transaction fee , keep two decimal points
Example: -0.76
payout_id string

Withdraw serial number
Example: 202208031899561700999905280
processed_at string

Processing time , follow ISO8601 specifications
Example: 2022-02-25T18:00:42+08:00
source_order_transaction_id string

The bill records the transaction serial number of the source , including payment order number / refund order number , etc
Example: 30010022516695225053195427840
currency string

Trading currency , follow ISO4217 specifications
Example: USD
id string

Serial number of bill record
Example: 202206161756376480011100000
amount string

Transaction amount , keep two decimal points
Example: 1.00
payout_status string

Withdraw status . Available value : in progress ( in process ) ; accepted by bank ( bank accepted ) ; completed ( completed ) ; failed ( failed in payment ) ; retrying ( in re-sale ) .For stores where the main body belongs cn , the field is empty
Example: in progress
settlement_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
source_payment_id string

Original payment order number for the transaction
Example: 10010022516695213198582620160
exchange_rate string

Exchange rate. Rounded to 10 decimal places. Example: 1.3000000000.
Example: 1.3000000000
net string

Transaction net amount , keep two decimal points
Example: 0.76
settlement_amount string

Settlement amount, rounded to 2 decimal places.
Example: 1.00
source_order_id string

This bill records the source order number
Example: 8545173391

API Explorer

Debugger

Base URL

https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301

ParamOptions

Authorization — header required

limit — query

page_info — query

payout_id — query

payout_status — query

since_id — query

Language

curl --request GET \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301/payments/store/balance_transactions.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'

Was this article helpful to you?

SHOPLINE

Legal