get https://{subdomain}.myshoplaza.com/openapi/2024-07/shoplazza-payment/payment-orders/
Requires
read_financeaccess scope.
The Get Payment Order API retrieves detailed information about a specific payment order. This enables users to review payment details, including status, amount, associated customer, and transaction history.
This API is especially useful for:
1. Verifying payment order details for auditing or reporting.
2. Troubleshooting payment issues with specific orders.
3. Displaying order-specific payment data in custom applications or dashboards.
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 |
The status of the API response. |
message |
string | Success |
A descriptive message for the response status. |
data |
object | Contains the main response data. | |
data.has_more |
boolean | true |
Indicates whether there are more results to retrieve. |
data.cursor |
string | c3VwZXItY3Vyc29y |
The cursor for the next page of results. |
data.list |
array | A list of payment order objects. | |
data.list[]. |
string | 123456789 |
The unique ID of the payment order. |
data.list[]. |
object | { ... } |
Contains details about transaction fees. |
data.list[]. |
string | 10.00 |
The transaction fee amount. |
data.list[]. |
string | USD |
The currency of the transaction fee. |
data.list[]. |
string | 5.00 |
The foreign settlement fee. |
data.list[]. |
string | 2024-04-28T06:00:00Z |
The creation timestamp of the payment order. |
data.list[]. |
string | 2024-04-28T06:05:00Z |
The completion timestamp of the payment order. |
data.list[]. |
string | succeeded |
The current payment status of the order. |
data.list[]. |
string | credit_card |
The payment method used (e.g., credit card, PayPal). |
data.list[]. |
string | Visa |
The brand of the credit card used. |
data.list[]. |
string | USD |
The currency in which the payment was made. |
data.list[]. |
string | 100.00 |
The payment amount in the specified currency. |
data.list[]. |
string | 130.00 |
The converted amount in the store's base currency. |
data.list[]. |
string | 50.00 |
The reserved amount, if applicable. |
data.list[]. |
string | 987654321 |
The ID of the associated order. |
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." |