Skip to content

Export Transactions

Request URL

POST /transfer-to/bills/export

Description

This endpoint will export a .csv file containing a list of the bill payment records that satisfy the specified criteria.

Schema

Property table for transfer-to/bills/export

Property Description Required Schema
cFiTransactionId The transaction ID in the connectFi system No {
  "type": "string",
  "pattern": "^[0-9a-zA-Z_]+$",
  "minLength": 1,
  "maxLength": 36,
  "nullable": true,
  "$id": "common-idNullable"
}
cFiTransactionIds Array of transaction IDs from the connectFi system obtained when each transaction was initialized No array of {
  "type": "string",
  "pattern": "^[0-9a-zA-Z_]+$",
  "minLength": 1,
  "maxLength": 36,
  "nullable": true,
  "$id": "common-idNullable"
}
reference An external alphanumeric reference ID for the entity in your system No {
  "type": "string",
  "pattern": "^[0-9a-zA-Z_]+$",
  "minLength": 1,
  "maxLength": 36,
  "nullable": true,
  "$id": "common-idNullable"
}
dateCreateFrom A beginning date in ISO Date format No {
  "type": "string",
  "format": "dateISO",
  "nullable": true
}
dateCreateTo An ending date in ISO Date format No {
  "type": "string",
  "format": "dateISO",
  "nullable": true
}
dateSettled The settlement date in ISO Date format No {
  "type": "string",
  "format": "dateISO",
  "pattern": "^\d{4}-\d{2}-\d{2}$",
  "$id": "common-dateOnly"
}
dateException The date an exception occurred in ISO Date format No {
  "type": "string",
  "format": "dateISO",
  "pattern": "^\d{4}-\d{2}-\d{2}$",
  "$id": "common-dateOnly"
}
status Status No {
  "type": "string",
  "nullable": true,
  "enum": [ "Initiated", "Processing", "Sent",
"Complete", "Settled", "Declined", "Unknown",
"DecryptError", "Cancelled" ]
}
billerId The biller ID in connectFi No {
  "type": "string",
  "pattern": "^[0-9a-zA-Z_]+$",
  "minLength": 1,
  "maxLength": 36,
  "$id": "common-id"
}
batchId The batch ID No {
  "type": "string",
  "pattern": "^[0-9a-zA-Z]+$",
  "minLength": 1,
  "maxLength": 32,
  "$id": "common-reference"
}
cFiTraceNumber The trace ID in connectFi No {
  "type": "string",
  "pattern": "^[0-9a-zA-Z_]+$",
  "minLength": 1,
  "maxLength": 36,
  "nullable": true,
  "$id": "common-idNullable"
}

Request Body

{
    "dateCreateFrom": "2024-06-28T18:27:33.684Z",
    "dateCreateTo": "2024-09-28T18:27:33.684Z",
    "cFiTransactionIds": [],
    "status": "Initiated",
    "billerId": "0003000666"
}

Snippet Examples

javascript

const axios = require('axios');
const data = {
    "dateCreateFrom": "2024-06-28T18:27:33.684Z",
    "dateCreateTo": "2024-09-28T18:27:33.684Z",
    "cFiTransactionIds": [],
    "status": "Initiated",
    "billerId": "0003000666"
};
const config = {
  method: 'POST',
  url: '${CONNECTFI_BASE_URL}/transfer-to/bills/export',
  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/bills/export" --data "{    \"dateCreateFrom\":\"2024-06-28T18:27:33.684Z\",\"dateCreateTo\":\"2024-09-28T18:27:33.684Z\",   \"cFiTransactionIds\":[],   \"status\":\"Initiated\",   \"billerId\":\"0003000666\"}" --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

{
    "dateCreateFrom": "2024-06-28T18:27:33.684Z",
    "dateCreateTo": "2024-09-28T18:27:33.684Z",
    "cFiTransactionIds": [],
    "status": "Initiated",
    "billerId": "0003000666"
}

RESPONSE BODY

Date,CFiAggregatorId,Date sent,CFiTransactionId,Reference,Currency,Status,Amount,MerchantId,Serial Number,CFiPackageId,BillerId,BillerName,AccountNumber,LegalName,FirstName,LastName,DeliveryTimeCode,IsReversal,Date Import,Import File Name,Date Processed,Package files,Processing date,Processing Response Code,Settled date,Settled amount,Settled Network Fee,Exception Date,Exception Amount,Exception NetworkFee,Exception Code,Exception Description
2024-07-30T15:48:59.361Z,evolve,,evolve_1Q5F9HjCpKdIEMELhrWC8a,extTrnBill325,USD,Initiated,1.01,10000001,000000000017117,,0003000666,Bechtel BMPC BPMI Benefits-1859,123456789,,Joe,Doe,N,,,,,,,,,,,,,,,

200 SUCCESSFUL RESPONSE - NO MATCHES

HEADERS

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

REQUEST BODY

{
    "dateCreateFrom": "2024-06-28T18:27:33.684Z",
    "dateCreateTo": "2024-09-28T18:27:33.684Z",
    "cFiTransactionIds": [],
    "status": "Initiated",
    "billerId": "0003000666"
}

RESPONSE BODY

Date,CFiAggregatorId,Date sent,CFiTransactionId,Reference,Currency,Status,Amount,MerchantId,Serial Number,CFiPackageId,BillerId,BillerName,AccountNumber,LegalName,FirstName,LastName,DeliveryTimeCode,IsReversal,Date Import,Import File Name,Date Processed,Package files,Processing date,Processing Response Code,Settled date,Settled amount,Settled Network Fee,Exception Date,Exception Amount,Exception NetworkFee,Exception Code,Exception Description