Requireswrite_payment_infoaccess scope.
This API allows third-party payment providers to asynchronously notify Shoplazza of the final result for both payments and refunds.
If Shoplazza does not receive a successful response (200 OK), the request should be retried.
- For payments, notify the final payment result.
- For refunds, notify the final refund result.
Both notifications share the same endpoint and request format, with differences only in the type and status values.
Request Headers
| Header | Description |
|---|---|
Access-Token | OAuth authorization token returned upon authentication. |
Shoplazza-Shop-Domain | System domain name assigned by Shoplazza. |
Shoplazza-Hmac-Sha256 | The encrypted signature calculated using the signature method. |
Content-Type | Fixed as application/json. |
Request Parameters
Key | Required | Type | Description | Example |
|---|---|---|---|---|
| Y | string | Payments app ID. |
|
| Y | string | Payment ID. |
|
| Y | number | Order amount. |
|
| Y | string | Currency type. |
|
| Y | string | Status of the transaction: - For payments:
|
|
| Y | string | Third-party payment system order number. |
|
| Y | string | Type of notification:
|
|
| N | string | Payment failure message, required if payment fails. |
|
| Y | string | Error code (required when |
|
| Y | boolean | Indicates whether the request is in test mode. |
|
| N | object | Custom extended fields. |
|
| Y | string | ISO 8601 formatted timestamp. |
|
Response Explanation
Public Response Parameters
Successful Response
| Key | Type | Description | Example |
|---|---|---|---|
| HTTP Status Code | number | Shoplazza returns 200 after receiving the request. | 200 |