Skip to content

Export Payments

Request URL

POST /public/merchant/payment/export-list

Description

After authenticating the merchant through your existing front-end merchant portal UI and requesting a merchant JSON Web Token through the `/payment-link/merchant/get-token` endpoint, you may make a call to this endpoint in order to allow the merchant corresponding to the provided 'x-connectfi-jwtoken' header to export a .csv file containing a list of their own payment link objects that match the specified properties. This action can also be facilitated through the Payment Link Iframe script when embedded into your existing front-end merchant portal UI.

Schema

Property table for public/merchant/payment/export-list

Property Description Required Schema
cFiTransactionId The transaction ID in the connectFi system No {
  "type": "string",
  "pattern": "^[0-9a-zA-Z_]+$",
  "minLength": 1,
  "maxLength": 36,
  "$id": "common-id"
}
cFiTransactionIds Array of transaction IDs from the connectFi system obtained when each transaction was initialized No array of {
  "type": "string"
}
status Status No {
  "type": "string",
  "nullable": true,
  "enum": [ "Initiated", "Sent", "Cancelled",
"Rejected", "Error", "Expired", "Processing",
"SentToPay", "Completed", "Settled",
"Returned", "Declined" ]
}
payerName Name of the payer No {
  "type": "string",
  "nullable": true
}
dateCreateFrom A beginning date in ISO Date format No {
  "type": "string",
  "nullable": true,
  "format": "dateISO"
}
dateCreateTo An ending date in ISO Date format No {
  "type": "string",
  "nullable": true,
  "format": "dateISO"
}
dueDateFrom A beginning date in ISO Date format No {
  "type": "string",
  "nullable": true,
  "format": "dateISO"
}
dueDateTo An ending date in ISO Date format No {
  "type": "string",
  "nullable": true,
  "format": "dateISO"
}
invoiceNumber The invoice number No {
  "type": "string",
  "pattern": "^((?![<>]).)*$",
  "minLength": 0,
  "maxLength": 50,
  "nullable": true,
  "$id": "common-commonStr50"
}
amountFrom A lower bound for amount No {
  "type": "number",
  "nullable": true
}
amountTo An upper bound for amount No {
  "type": "number",
  "nullable": true
}
paymentType The type of payment No {
  "type": "string",
  "nullable": true,
  "enum": [ "card", "ach" ]
}

Request Body

{
  "cFiTransactionId": "7l7TrL0ZukBQR4H4W2fsvT",
  "cFiTransactionIds": [],
  "status": "Sent",
  "dateCreateFrom": "2024-07-29T18:03:46.637Z",
  "dateCreateTo": "2024-07-30T18:03:46.637Z",
  "amountFrom": 0,
  "amountTo": 100,
  "payerName": "Doe John",
  "invoiceNumber": "11125"
}

Snippet Examples

javascript

const axios = require('axios');
const data = {
  "cFiTransactionId": "7l7TrL0ZukBQR4H4W2fsvT",
  "cFiTransactionIds": [],
  "status": "Sent",
  "dateCreateFrom": "2024-07-29T18:03:46.637Z",
  "dateCreateTo": "2024-07-30T18:03:46.637Z",
  "amountFrom": 0,
  "amountTo": 100,
  "payerName": "Doe John",
  "invoiceNumber": "11125"
};
const config = {
  method: 'POST',
  url: '${CONNECTFI_BASE_URL}/public/merchant/payment/export-list',
  headers: {
    'Content-Type': "application/json",
    'x-connectfi-jwtoken': "A long random string token received from /payment-link/merchant/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/public/merchant/payment/export-list" --data "{  \"cFiTransactionId\":\"7l7TrL0ZukBQR4H4W2fsvT\", \"cFiTransactionIds\":[], \"status\":\"Sent\", \"dateCreateFrom\":\"2024-07-29T18:03:46.637Z\", \"dateCreateTo\":\"2024-07-30T18:03:46.637Z\", \"amountFrom\":0, \"amountTo\":100, \"payerName\":\"Doe John\", \"invoiceNumber\":\"11125\"}" --header "Content-Type: application/json" --header "x-connectfi-jwtoken: A long random string token received from /payment-link/merchant/get-token request"

Successful Response Examples

200 SUCCESSFUL RESPONSE

HEADERS

Header Value
Content-Type application/json
x-connectfi-jwtoken A long random string token received from /payment-link/merchant/get-token request

REQUEST BODY

{
  "cFiTransactionIds": [],
  "dateCreateFrom": "2024-08-30T18:03:46.637Z",
  "dateCreateTo": "2024-10-30T18:03:46.637Z",
  "amountFrom": 0,
  "amountTo": 100,
  "payerName": "Doe John"
}

RESPONSE BODY

TRANSACTION ID,PLATFORM ID,INVOICE #,DATE CREATED (CST),DUE DATE,EXPIRATION DATE,FIRST NAME,LAST NAME,EMAIL,PHONE NUMBER,PAYMENT TYPE,AMOUNT,STATUS,MERCHANT #
m2GHCknYhGKZuF74jJPxu,CLIENTID,11128,2024-10-25T15:23:11.338Z,2024-10-29T00:00:00.000Z,,John,Doe,email.test+pltest1@test.email,,,1.5,Initiated,12
6gzPcs3M3VvfRD7jC2ETLm,CLIENTID,11129,2024-10-22T20:11:21.058Z,2024-10-29T00:00:00.000Z,,John,Doe,email.test+pltest1@test.email,,,1.5,Initiated,12
1mPKKOXGdRAjwSfwdHCVmg,CLIENTID,11127,2024-10-22T17:22:12.562Z,2024-10-29T00:00:00.000Z,,John,Doe,email.test+pltest1@test.email,,,1.5,Initiated,12