Skip to main content
Version: Lastest

Payment method action callback

After creating the payment method and the client performing information validation, the AppotaPay system calls back the results of the requires action to the partner.

Note
  • Using the signature parameter to check the integrity of the received data, the partner creates a signature from the data received by AppotaPay and then compares it with the signature parameter sent by AppotaPay.

Redirect

AppotaPay will send the results via the API URL. The partner's URL has been sent to the API via the successReturnUrlfailureReturnUrl parameters. The partner's server checks the data integrity via the signature parameter and then updates the status of the payment method.

Request params

Method: GET

ParamTypeDescription
dataStringTransaction information is encode with base64encode & json_encode format
signatureStringSignature to check data

signature = HMAC_SHA256(data, secretKey)

timeStringResponse time

Decode

  1. Partners use the Base64Decode function to decode data in string form.
  2. Use the JSON_Decode function to decode the data a second time in json form.
ParamRequiredTypeDescription
actionRequiredObjectAction: AUTH
paymentMethodIdRequiredStringPayment Method ID
statusRequiredString

Status when performing requires action

- PENDING: processing action

- VERIFIED: requires action is performed successfully

- FAILED: requires action is performed unsuccessfully

errorCodeRequiredIntegerError code
errorMessageRequiredStringError message