get
https://{subdomain}.myshoplaza.com/openapi/2025-06/shoplazza-payment/payment-orders/
Retrieve details of a specific payment order using its unique identifier.
Requiresread_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.payment_order. |
string | 123456789 |
The unique ID of the payment order. |
data.payment_order. |
object | { ... } |
Contains details about transaction fees. |
data.payment_order. |
string | 10.00 |
The transaction fee amount. |
data.payment_order. |
string | USD |
The currency of the transaction fee. |
data.payment_order. |
string | 5.00 |
The foreign settlement fee. |
data.payment_order. |
string | 2024-04-28T06:00:00Z |
The creation timestamp of the payment order. |
data.payment_order. |
string | 2024-04-28T06:05:00Z |
The completion timestamp of the payment order. |
data.payment_order. |
string | succeeded |
The current payment status of the order. |
data.payment_order. |
string | credit_card |
The payment method used (e.g., credit card, PayPal). |
data.payment_order. |
string | Visa |
The brand of the credit card used. |
data.payment_order. |
string | USD |
The currency in which the payment was made. |
data.payment_order. |
string | 100.00 |
The payment amount in the specified currency. |
data.payment_order. |
string | 130.00 |
The converted amount in the store's base currency. |
data.payment_order. |
string | 50.00 |
The reserved amount, if applicable. |
data.payment_order. |
string | 987654321 |
The ID of the associated order. |
Error Response
| Field | Type | Example | Description |
|---|---|---|---|
code | string | InvalidParameter | Error http message |
message | string | `` | Error message |