Get Check

Request URL

GET /check/get/:checkId

Description

A request to this endpoint retrieves the details of a specified check. The cFiCheckId of the desired check should be passed as a path parameter.

Snippet Examples

javascript

const axios = require('axios');
const config = {
  method: 'GET',
  url: '${CONNECTFI_BASE_URL}/check/get/:checkId',
  headers: {
    'x-connectfi-token': "A long random string token received from /auth/get-token request"
  },
};

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/check/get/:checkId"  --header "x-connectfi-token: A long random string token received from /auth/get-token request" 

Successful Response Examples

200 CHECK/GET/:CHECKID SUCCESSFUL RESPONSE

HEADERS

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

PARAMETERS

Parameter	Description	Value
checkId	[required]	chk_10Yr0skuZ8NUX1wPG06MNA

REQUEST BODY

none

RESPONSE BODY

{
    "code": "0",
    "data": {
        "cFiCheckId": "chk_10Yr0skuZ8NUX1wPG06MNA",
        "reference": "extChkRef702",
        "serial": "90",
        "amount": 1.01,
        "currency": "USD",
        "cFiAggregatorId": "CLIENTID",
        "cFiCheckStatus": "Processing",
        "initVoid": false,
        "webhookUrl": "https://your_webhook_url/extChkRef702",
        "dtsCreatedAt": "2023-11-02T11:22:38.822Z"
    },
    "requestId": "283a5c10797211eeb5658f28ab5fe311"
}