Get Payment Order list

get

https://{subdomain}.myshoplaza.com/openapi/2025-06/shoplazza-payment/payment-orders

Retrieve a list of all payment orders with pagination.

Query Params

cursor

string

Cursor for pagination, use the cursor from the response to retrieve the next page.

page_size

int32

A limit on the number of objects to be returned. Ranges from 1 to 100. Default is 10.

created_at_min

string

Filters payment orders created after a specified timestamp (Unix format).

created_at_max

string

Filters payment orders created before a specified timestamp (Unix format).

status

string

Filter payment orders by status. Valid values are:

succeeded: The payment has been completed successfully, and the funds are confirmed.
failed: The payment has failed, and the funds were not successfully processed.
requires_action: Additional action is required to complete the payment, such as user verification (e.g., 3D authentication).
init: The payment order has been created but not yet processed.
canceled: The payment order has been canceled, and no funds were processed or have been returned.
processing: The payment is currently in process, with the final result pending confirmation.

Response

200OK