Skip to content

Reverse Transaction

Request URL

POST /acquiring/reversal

Description

This endpoint can be used to reverse a specified transaction.

Schema

Property table for acquiring/reversal

Property Description Required Schema
cFiTransactionId The transaction ID in the connectFi system Yes {
  "type": "string",
  "pattern": "^[0-9a-zA-Z_]+$",
  "minLength": 1,
  "maxLength": 36,
  "description": "common-id"
}

Request Body

{
  "cFiTransactionId": "CLIENTID_7DaTiGX2UPeEJ0cEZmJFcK"
}

Snippet Examples

javascript

const axios = require('axios');
const data = {
  "cFiTransactionId": "CLIENTID_7DaTiGX2UPeEJ0cEZmJFcK"
};
const config = {
  method: 'POST',
  url: '${CONNECTFI_BASE_URL}/acquiring/reversal',
  headers: {
    'Content-Type': "application/json",
    'x-connectfi-token': "A long random string token received from /auth/get-token request"
  },
  data
};

let result;
try {
  result = await axios.request(config);
  if (result.status === 200) {
    console.log(JSON.stringify(result.data));
  }
} catch (err) {
  console.log({
    errCode: err.code,
    responseStatus: err.response && err.response.status,
    data: err.response && JSON.stringify(err.response.data)
  });
}

cURL

curl --location "CONNECTFI_BASE_URL/acquiring/reversal" --data "{  \"cFiTransactionId\":\"CLIENTID_7DaTiGX2UPeEJ0cEZmJFcK\"}" --header "Content-Type: application/json" --header "x-connectfi-token: A long random string token received from /auth/get-token request" 

Successful Response Examples

200 ACQUIRING/REVERSAL SUCCESSFUL RESPONSE

HEADERS

Header Value
Content-Type application/json
x-connectfi-token A long random string token received from /auth/get-token request

REQUEST BODY

{
  "cFiTransactionId": "CLIENTID_7DaTiGX2UPeEJ0cEZmJFcK"
}

RESPONSE BODY

{
    "code": "0",
    "data": {
        "reference": "exrnl2TnId2602",
        "cFiTransactionId": "CLIENTID_7DaTiGX2UPeEJ0cEZmJFcK",
        "dtsCreated": "2023-11-02T10:52:56.052Z",
        "status": "Complete",
        "network": "Visa",
        "networkRC": "00",
        "reversalStatus": "Reversed",
        "reversal": {
            "networkRC": "00"
        }
    },
    "requestId": "05f9bb40796e11eeb5658f28ab5fe311"
}