Lipisha REST APIs


Reverse Card


API Description

This API call for reverses an authorized credit card transaction.

This function unreserves funds previously authorized. It's called with the transaction_index and transaction_reference returned by the authorize_card_transaction function to reverse the authorization.

API Endpoint

The API service endpoint for making the Reverse Card Authorization API call is:

https://developer.lipisha.com/index.php/v2/api/reverse_card_authorization

API Request

The API request is made via HTTP POST and must be url encoded. Some of the parameters are required while others are optional. The parameters are:

Parameter Description Example
api_key Unique string specifying merchant's Lipisha API key.

This should match the api key that you have generated for your Lipisha account
3aa67677e8bf1d4c8fe886a38c03a860
api_signature Unique string specifying merchant's Lipisha API signature.

This should match the api signature that you have generated for your Lipisha account
SYetmwsNnb5bwaZRyeQ..........KhZNNkCoEx+5x=
api_version String specifying the version of the API in use 1.3.0
api_type String specifying the type of handshake or IPN call Callback
transaction_index The transaction index returned by a successful authorize_card_transaction call. 1234
transaction_reference The transaction reference returned by a successful authorize_card_transaction call. {123456789}

API Response

The API reponse will be returned as JSON. Each response will contain a status and content section. The parameters are:

Parameter Description Example
Status
status String specifying whether API Call executed successfully or failed SUCCESS
status_code Integers specifying status code of the API Call result 0000
status_description String containing description of the status Transaction reversed successfully
Content
transaction_reference A transaction reference for the successful reversal 1234
transaction_index A transaction index for the successful reversal. {123456789}

JSON Reponse
{
  "status": {
    "status_code": "0000",
    "status_description": "Transaction Reversed Successfully",
    "status": "SUCCESS"
  },
  "content": {
    "transaction_index": "{123456789}",
    "transaction_reference": "1234",
  }
}

Fork me on GitHub