Notify Payment

POST 
/openapi/2022-01/payments_apps/notify_callbacks

Request

Header Parameters

Access-Token stringrequired

Oauth's Access Token

Shoplazza-Shop-Domain stringrequired

Shoplazza's store domain

Shoplazza-Hmac-Sha256 stringrequired

the hmac signature for this request

application/json

Body

Body

app_idstringrequired

Payment App's ID

payment_idstringrequired

Payment ID

amountfloatrequired

Order's total price

statusstringrequired

Payment status from Payment App

Possible values: [paid, failed]

currencystringrequired

Three-letter ISO 4217 currency code

transaction_nostringrequired

Payment App's transaction number for reference

typestringrequired

Either sale or authorization. If you support payment authorization, then this value is set based on the merchant's configuration. If you don't support separate authorization and capture, then the value is always sale. For sale transactions, you need to capture the funds instantly with this request. For authorization transactions, you must place a hold on the funds and capture them later when Shoplazza sends a capture request.

messagestring

fail reason describe here while payment fail

error_codestring

payment error code from Payment App

testbooleanrequired

Indicates whether the payment is in test or live mode. Refer to Test mode for more information.

extension object
Customize object from Payment App
object
timestampstringrequired

ISO-8601 format timestamp, eg: 2021-09-01T18:32:20Z

Example

{
  "app_id": "string",
  "payment_id": "string",
  "amount": 0,
  "status": "paid",
  "currency": "string",
  "transaction_no": "string",
  "type": "string",
  "message": "string",
  "error_code": "string",
  "test": true,
  "extension": {},
  "timestamp": "string"
}

Responses

200

200

application/json

No schema

400

400

application/json

No schema