post https://{subdomain}.myshoplaza.com/openapi/2022-01/payments_apps/complete_callbacks
Requires
write_payment_infoaccess scope.
Complete Payment API is uesd in jump payment and direct credit card payment with 3DS verification, after the customer completes the payment on the third-party page, the third-party payment provider must notify Shoplazza that the customer has completed the payment. Shoplazza will then return a redirect URL to direct the customer to the payment completion page.
At this stage, the final payment result does not need to be returned.
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
Public Request Parameters
| Key | Required | Type | Description | Example |
|---|---|---|---|---|
app_id | Yes | string | Payments app ID. | "db5fc9a6-2a64-11ec-8d3d-0242ac130003" |
payment_id | Yes | string | Payment ID. | "7eb3fefb-6b43-4400-b40a-a2a0531364ae" |
amount | Yes | number | Order amount. | 254.20 |
currency | Yes | string | Currency type. | "CAD" |
transaction_no | Yes | string | Third-party payment system order number. | "123456789" |
type | Yes | string | Payment type: - sale: Direct payment - authorization: Pre-authorization. | "sale" |
test | Yes | boolean | Indicates whether the request is in test mode. | false |
status | Yes | string | Payment status, fixed as paying. | "paying" |
extension | No | object | Custom extended fields. | { "foo": "bar" } |
timestamp | Yes | string | ISO 8601 format. | "2021-09-01T18:32:20Z" |
Response Explanation
Public Response Parameters
Successful Response
| Key | Type | Description | Example |
|---|---|---|---|
redirect_url | string | URL to redirect the customer to the payment completion page. | "https://developer.myshoplaza.com/checkout/12345" |