get https://{subdomain}.myshoplaza.com/openapi/2024-07/shoplazza-payment/payment-orders/
Requires
financeaccess scope.
The List Payment Orders API returns a list of payment orders. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
This API is especially useful for:
- Retrieving a paginated list of payment orders.
- Filtering payment orders based on their creation date.
- Identifying payment statuses for order processing.
Request Parameters
Public Request Parameters
Path Parameters
| Field | Type | Required | Example | Description |
|---|---|---|---|---|
id | string | Yes | py_2oFAVxHstl9r | Unique identifier of the payment order. |
Response Explanation
Public Response Parameters
Successful Response
| Field | Type | Example | Description |
|---|---|---|---|
code | string | Success | Response status code. |
message | string | Success | Response message. |
data | object | - | Contains the payment order details. |
data.payment_order.id | string | py_2oFAVxHstl9r | Unique ID of the payment order. |
data.fee_details | object | - | Object containing fee details. |
fee_details.trans_fee_amount | string | "0.35" | Transaction fee amount. |
fee_details.fee_currency | string | usd | Currency for the transaction fee. |
fee_details.foreign_settlement_fee | string | "0.02" | Fee for foreign currency settlement. |
data.created_at | integer | 1739454978 | Timestamp when the order was created. |
data.finished_at | integer | 1739454982 | Timestamp when the order was completed. |
data.payment_status | string | succeeded | Status of the payment. |
data.payment_method | string | card | Payment method used for the transaction. |
data.card_brand | string | card:visa | Brand of the card used. |
data.pay_currency | string | usd | Currency used for the payment. |
data.pay_amount | string | 1.50 | Payment amount. |
data.converted_amount | string | 1.50 | Amount converted into the target currency. |
data.reserve_amount | string | "0.30" | Reserve amount for holding funds to cover potential adjustments or risks. |
data.order_id | string | 307899-00001207 | Related order ID associated with the payment. |
Error Response
Error responses in the API can be represented using two different fields: errors and error. Both fields provide details about issues encountered during request processing. Below is an explanation of the fields with their respective examples and descriptions.
| Field | Type | Description | Example |
|---|---|---|---|
code | string | The error code indicating the type of issue. | InvalidParameter |
message | string | A detailed message describing the error. | wrong cursor |
| Field | Type | Example | Description |
|---|---|---|---|
error | String | "store is not active" | Indicates an error encountered during the process |
Error Detail
| Status Code | Message | Possible Reason | Example Response |
|---|---|---|---|
| 400 | Bad Request | Invalid input format or request structure (e.g., missing required fields or incorrect data types). | Bad Request |
| Unauthorized | The request is missing valid authentication credentials or the credentials provided are invalid. | Unauthorized | |
| 500 | UnknownError | invalid or empty id input | "Unknown error, please contact shoplazza technical support to resolve the issue." |