Reverse Transactions

This endpoint allows users to reverse a previously processed transaction. When making a request to this endpoint, provide the required body parameters which are the referenceNumberor instrumentNumber.

POST /api/postings/v1/reversetransaction

Headers

Name
Value

Content-Type*

application/json

Authorization*

Bearer <token>

Request-Reference

{unique-reference}

Body

Name
Data Type (length)
Required
Description

referenceNumber

string

The reference number for the transaction to be reversed

instrumentNumber

string

The instrument number associated with the transaction

Ensure that you provide either the referenceNumber or the instrumentNumber.

Here is an example request and response with a sample payload sent to the endpoint in Curl format.

Sample Request
curl --location -g '{{baseurl}}/api/postings/v1/reversetransaction' \
--header 'Authorization: bearer {token}' \
--header 'request-reference: {unique_reference}' \
--header 'Content-Type: application/json' \
--data '{
  "referenceNumber": "string",
  "instrumentNumber": "string"
}'
Respose: 200
{
  "status": true,
  "message": "string",
  "data": {
    "statusCode": "string",
    "referenceNumber": "string",
    "instrumentNumber": "string",
    "duration": "string"
  }
}

Last updated