API Explanation

Request Type

POST

Request URI

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

Request

ParameterTypeRequiredSample dataDescription
paymentIdStringYes1694723326717300Unique 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

ParameterTypeSample dataDescription
reverseIdStringVOID1694723354144799Reverse 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.
paymentStatusStringorderclosedPayment 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

codemessagedescription
10005Invalid parameterParameter format incorrect
10200Gateway errorOTT gateway’s error response.
20004Database errorTransaction data induced database error.
20008Unsupported cardThe 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
20019Original payment not existOriginal transaction/payment ID you provided cannot be found
20020Original payment has been finishedThe Original payment has already been captured
20034Other caseAny other errors that not include in the list
50001FailurePayment Failed
50002TimeoutYour 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.
50003System errorNo response received for the sent request
90000UnauthorizedThe entered access token is invalid