Requireswrite_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 |
|---|---|---|---|---|
| Yes | string | Payments app ID. |
|
| Yes | string | Payment ID. |
|
| Yes | number | Order amount. |
|
| Yes | string | Currency type. |
|
| Yes | string | Third-party payment system order number. |
|
| Yes | string | Payment type: |
|
| Yes | boolean | Indicates whether the request is in test mode. |
|
| Yes | string | Payment status, fixed as |
|
| No | object | Custom extended fields. |
|
| Yes | string | ISO 8601 format. |
|
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" |