Get payouts

Requires read_payment access scope.

For more info, refer to:

GET https://{handle}.myshopline.com/admin/openapi/v20260301/payments/store/payouts.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 .

Get the payout records of the store. A payout refers to the transfer of funds from the SHOPLINE Payments account to the store's bank account.

Query Parameters

payout_transaction_no string

Payout transaction number, used to search for the payout transaction record by matching the exact number.
since_id string

Payout transaction number, used to filter the payout records processed before this payout transaction number.
start_time string required

The start creation time of the payout records to be queried. Payout records created on and after this time will be returned. start_time and end_time parameters must be specified at the same time. The time interval between start_time and end_time cannot exceed 3 months. Format: ISO 8601.

Example: 2025-04-30T00:00:00+08:00
status string
Payout status. Valid values are:
- CREATED: created
- PROCESSING: processing
- SUCCESS: payout completed
- FAILED: payout failed
Example: CREATED
end_time string required

The end creation time of payout records to be queried. Payout records created on and before this time will be returned. start_time and end_time parameters must be specified at the same time. The time interval between start_time and end_time cannot exceed 3 months. Format: ISO 8601.

Example: 2025-04-30T00:00:00+08:00
limit string required

Maximum number of records to be returned in the query. The maximum number cannot exceed 100.

Default value: 50
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/payouts.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.

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

payoutsobject[]

A list of payout records for the SHOPLINE Payments account.
amount string

The payout amount. The value is rounded to two decimal places.
Example: 12.34
currency string

The payout currency. The value of this field is a three-digit currency code that follows the ISO 4217 international standard, such as USD.
payout_transaction_no string

The payout transaction number.
status string

Payout status. Valid values are:

CREATED: created

PROCESSING: processing

SUCCESS: payout completed

FAILED: payout failed

Example: CREATED
time string

Payout date and time. Format: ISO 8601.
Example: 2025-04-30T00:00:00+08:00

API Explorer

Debugger

Examples

Base URL

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

ParamOptions

start_time — query required

end_time — query required

limit — query required

Authorization — header required

payout_transaction_no — query

since_id — query

status — query

page_info — query

Language

curl --request GET \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301/payments/store/payouts.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