API Explanation

Request Type

POST

Request URI

/api/v1/payment/local-card/reverse

Request

Parameter Type Required Sample data Description
paymentId String Yes 1694723326717300 Unique identifier for the payment transaction. This value represents the original payment transaction ID, essential for tracking and processing reversal requests.

Request Example:

{
  "paymentId": "1694723326717300"
}

Response

Parameter Type Sample data Description
reverseId String VOID1694723354144799 Reverse transaction ID. The unique identifier associated with the reversal transaction. Use this value for tracking and auditing purposes. Ensure that the reverseId is accurately captured and linked to the corresponding payment reversal.
paymentStatus String orderclosed Payment status. Indicates the current status of the payment transaction: init: Void Initiated; success : Void Success; failure: Void Failed

Response sample:

{
  "status": "SUCCESS",
  "result": {
    "reverseId": "VOID1694723354144799",
    "paymentStatus": "cancelled"
  }
}

API Response error code

code message description
10005 Invalid parameter Parameter format incorrect
10200 Gateway error OTT gateway’s error response.
20004 Database error Transaction data induced database error.
20008 Unsupported card The card type was not recognized, or The card was removed too quickly and the approval process was interrupted POS terminal was unable to encrypt the message and process the transaction
20019 Original payment not exist Original transaction/payment ID you provided cannot be found
20020 Original payment has been finished The Original payment has already been captured
20034 Other case Any other errors that not include in the list
50001 Failure Payment Failed
50002 Timeout Your request has been declined due to a timeout OR The authorization message is approved. The error occurs if: 1) the transaction was declined by the card afterwards, or 2) timeout on the terminal. As a result, the transaction is reversed.
50003 System error No response received for the sent request
90000 Unauthorized The entered access token is invalid