Reverse Transaction

Request URL

POST /transfer-to/card/reversal

Description

This endpoint can be used to reverse a specified pull transaction. Reversals are only supported for pull transactions at this time.

Schema

Property table for transfer-to/card/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,   "$id": "common-id" }

Request Body

{
  "cFiTransactionId": "CLIENTID_3aKevAR2l7zkOsF1HSstMu"
}

Snippet Examples

javascript

const axios = require('axios');
const data = {
  "cFiTransactionId": "CLIENTID_3aKevAR2l7zkOsF1HSstMu"
};
const config = {
  method: 'POST',
  url: '${CONNECTFI_BASE_URL}/transfer-to/card/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/transfer-to/card/reversal" --data "{  \"cFiTransactionId\":\"CLIENTID_3aKevAR2l7zkOsF1HSstMu\"}" --header "Content-Type: application/json" --header "x-connectfi-token: A long random string token received from /auth/get-token request" 

Successful Response Examples

200 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_3aKevAR2l7zkOsF1HSstMu"
}

RESPONSE BODY

{
    "code": "0",
    "data": {
        "reference": "ext2TnId25904",
        "cFiTransactionId": "CLIENTID_3aKevAR2l7zkOsF1HSstMu",
        "dtsCreated": "2023-11-02T11:17:28.263Z",
        "status": "Complete",
        "network": "Visa",
        "networkRC": "00",
        "reversalStatus": "Reversed",
        "reversal": {
            "networkRC": "00"
        }
    },
    "requestId": "71cd0130797111eeb5658f28ab5fe311"
}