get
https://{shopdomain}.myshoplaza.com/openapi/2022-01/application_charges/
The Get Application Charge Detail API retrieves detailed information about a specific application charge using its unique charge_id.
This API is especially useful for:
- Verifying the status of a specific application charge.
- Reviewing details such as charge name, price, and return URL.
- Debugging or auditing application charges.
Request Parameters
Public Request Parameters
Path Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
charge_id | string | Yes | The unique ID of the application charge. | 372212374292312759 |
Response Explanation
Public Response Parameters
Success Response
| Field | Type | Example | Description |
|---|---|---|---|
application_charge. |
string | The unique ID of the application charge. | 372212374292312759 |
application_charge. |
string | The name of recurring application charge. | test |
application_charge. |
string | The price of the application charge. | 10.0 |
application_charge. |
string | The confirmation URL for the application charge. | https://test-shoplazza.stg.myshoplaza.com |
application_charge. |
string | The redirect URL after payment. | https://shoplazza.com |
application_charge. |
string | The current status of the application charge. | active |
application_charge. |
boolean | Whether this is a test charge. | false |
application_charge. |
string | The creation timestamp of the application charge. | 2024-04-23T02:39:05Z |
application_charge. |
string | The last updated timestamp of the application charge. | 2024-04-23T02:39:19Z |
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 | Example | Description |
|---|---|---|---|
errors | Array | [ "file number error"] | A list of errors encountered during the request processing. |
| Field | Type | Example | Description |
|---|---|---|---|
error | String | "page not found" | 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 | |
| 404 | Not Found | empty charge id | "Record not found" |