Balance transactions

Requires read_payment access scope.

For more info , refer to:

[]

access permission

GET https://{handle}.myshopline.com/admin/openapi/v20250601/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
[]
Pagination parameter，Obtained in the link response header, used in page_info mode (querying non-first page data). Refer to the paging mechanism for details about pagination.
[]
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 required
[]
The value of this field is fixed to application/json; charset=utf-8
Authorization string required
[]
The access token for the API. Please refer to App authorization to obtain the access token, and then put the obtained access token into the API request header in Bearer Token.
Example:
[]
Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw

Response

[]

For more information about status codes, see Http status code.

Response Headers

link
[]
Pagination parameter, Refer to the paging mechanism for details about pagination.
traceId
[]
traceId

Response Body

transactionsobject[]
[]
Billing records
amount string
[]
Transaction amount , keep two decimal points
[]
Example: 1.00
currency string
[]
Trading currency , follow ISO4217 specifications
[]
Example: USD
exchange_rate string
[]
Exchange rate. Rounded to 10 decimal places. Example: 1.3000000000.
[]
Example: 1.3000000000
fee string
[]
Transaction fee , keep two decimal points
[]
Example: -0.76
id string
[]
Serial number of bill record
[]
Example: 202206161756376480011100000
net string
[]
Transaction net amount , keep two decimal points
[]
Example: 0.76
payout_id string
[]
Withdraw serial number
[]
Example: 202208031899561700999905280
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
processed_at string
[]
Processing time , follow ISO8601 specifications
[]
Example: 2022-02-25T18:00:42+08:00
settlement_amount string
[]
Settlement amount, rounded to 2 decimal places.
[]
Example: 1.00
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_order_id string
[]
This bill records the source order number
[]
Example: 8545173391
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
source_payment_id string
[]
Original payment order number for the transaction
[]
Example: 10010022516695213198582620160
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

API Explorer

Debugger

Base URL

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

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/v20250601/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