Skip to content

List Reminders

Request URL

POST /payment-link/payment/reminder/list

Description

This endpoint will allow you (the client/platform) to list all reminder notifications for the payment specified by the cFiTransactionId property.

Schema

Property table for payment-link/payment/reminder/list

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": "2GJU5xNOF2gH2t80n99amJ"
}

Snippet Examples

javascript

const axios = require('axios');
const data = {
    "cFiTransactionId": "2GJU5xNOF2gH2t80n99amJ"
};
const config = {
  method: 'POST',
  url: '${CONNECTFI_BASE_URL}/payment-link/payment/reminder/list',
  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/payment-link/payment/reminder/list" --data "{    \"cFiTransactionId\":\"2GJU5xNOF2gH2t80n99amJ\"}" --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": "2GJU5xNOF2gH2t80n99amJ"
}

RESPONSE BODY

{
    "code": "0",
    "data": [
        {
            "cFiReminderId": "4C61ApyCRDK5Q6z1d1LYTn",
            "cFiTransactionId": "2GJU5xNOF2gH2t80n99amJ",
            "remindDate": "2024-11-18T16:38:51.230Z",
            "notificationType": "sentLink",
            "createType": "manual",
            "status": "Completed",
            "notificationDeliveryTypes": [
                "SMS",
                "Email"
            ],
            "dtsSent": "2024-11-18T16:38:51.230Z",
            "dtsCreatedAt": "2024-11-18T16:38:51.244Z",
            "dtsUpdatedAt": "2024-11-18T16:38:51.244Z",
            "payment": [
                {
                    "cFiTransactionId": "2GJU5xNOF2gH2t80n99amJ",
                    "cFiAggregatorId": "CLIENTID",
                    "cFiMerchantId": "7tfd67RwOo6gjvRdV3JERQ",
                    "payerName": "Doe John",
                    "invoiceNumber": "11130",
                    "amount": 22.5,
                    "currency": "USD",
                    "dueDate": "2024-08-29T00:00:00.000Z",
                    "description": "test description",
                    "status": "Sent",
                    "fields": [
                        {
                            "index": 1,
                            "code": "firstName",
                            "label": "First Name",
                            "value": "John"
                        },
                        {
                            "index": 2,
                            "code": "lastName",
                            "label": "Last Name",
                            "value": "Doe"
                        },
                        {
                            "index": 3,
                            "code": "email",
                            "label": "Email",
                            "value": "customer_email@email.test"
                        }
                    ],
                    "availablePaymentType": [
                        "card",
                        "ach"
                    ],
                    "statusChangeHistory": [
                        {
                            "initiatorId": "7tfd67RwOo6gjvRdV3JERQ",
                            "initiatorType": "merchant",
                            "status": "Initiated",
                            "_id": "673b6d316817433ed7b90f1a",
                            "dtsCreatedAt": "2024-11-18T16:37:05.132Z",
                            "dtsUpdatedAt": "2024-11-18T16:37:05.132Z"
                        },
                        {
                            "initiatorId": "7tfd67RwOo6gjvRdV3JERQ",
                            "initiatorType": "merchant",
                            "status": "Sent",
                            "_id": "673b6d946817433ed7b90f45",
                            "dtsCreatedAt": "2024-11-18T16:38:44.884Z",
                            "dtsUpdatedAt": "2024-11-18T16:38:44.884Z"
                        }
                    ],
                    "dtsCreatedAt": "2024-11-18T16:37:05.132Z",
                    "dtsUpdatedAt": "2024-11-18T16:38:44.884Z",
                    "dtsExpiredAt": "2024-12-18T16:38:44.883Z",
                    "link": "5MHkgd25b4h7qkVdJkBSP64uWwwAjZeNqZmhCnujKBMt1tpw8fJz1uFuuFeMoTiPHL",
                    "url": "google.com/payment/5MHkgd25b4h7qkVdJkBSP64uWwwAjZeNqZmhCnujKBMt1tpw8fJz1uFuuFeMoTiPHL"
                }
            ]
        },
        {
            "cFiReminderId": "41wjp2dAhCZSAukBUYWvCN",
            "cFiTransactionId": "2GJU5xNOF2gH2t80n99amJ",
            "remindDate": "2024-11-25T00:00:00.000Z",
            "notificationType": "sentLink",
            "createType": "planned",
            "status": "Created",
            "notificationDeliveryTypes": [
                "SMS",
                "Email"
            ],
            "dtsCreatedAt": "2024-11-18T16:38:18.724Z",
            "dtsUpdatedAt": "2024-11-18T16:38:18.724Z",
            "payment": [
                {
                    "cFiTransactionId": "2GJU5xNOF2gH2t80n99amJ",
                    "cFiAggregatorId": "CLIENTID",
                    "cFiMerchantId": "7tfd67RwOo6gjvRdV3JERQ",
                    "payerName": "Doe John",
                    "invoiceNumber": "11130",
                    "amount": 22.5,
                    "currency": "USD",
                    "dueDate": "2024-08-29T00:00:00.000Z",
                    "description": "test description",
                    "status": "Sent",
                    "fields": [
                        {
                            "index": 1,
                            "code": "firstName",
                            "label": "First Name",
                            "value": "John"
                        },
                        {
                            "index": 2,
                            "code": "lastName",
                            "label": "Last Name",
                            "value": "Doe"
                        },
                        {
                            "index": 3,
                            "code": "email",
                            "label": "Email",
                            "value": "customer_email@email.test"
                        }
                    ],
                    "availablePaymentType": [
                        "card",
                        "ach"
                    ],
                    "statusChangeHistory": [
                        {
                            "initiatorId": "7tfd67RwOo6gjvRdV3JERQ",
                            "initiatorType": "merchant",
                            "status": "Initiated",
                            "_id": "673b6d316817433ed7b90f1a",
                            "dtsCreatedAt": "2024-11-18T16:37:05.132Z",
                            "dtsUpdatedAt": "2024-11-18T16:37:05.132Z"
                        },
                        {
                            "initiatorId": "7tfd67RwOo6gjvRdV3JERQ",
                            "initiatorType": "merchant",
                            "status": "Sent",
                            "_id": "673b6d946817433ed7b90f45",
                            "dtsCreatedAt": "2024-11-18T16:38:44.884Z",
                            "dtsUpdatedAt": "2024-11-18T16:38:44.884Z"
                        }
                    ],
                    "dtsCreatedAt": "2024-11-18T16:37:05.132Z",
                    "dtsUpdatedAt": "2024-11-18T16:38:44.884Z",
                    "dtsExpiredAt": "2024-12-18T16:38:44.883Z",
                    "link": "5MHkgd25b4h7qkVdJkBSP64uWwwAjZeNqZmhCnujKBMt1tpw8fJz1uFuuFeMoTiPHL",
                    "url": "google.com/payment/5MHkgd25b4h7qkVdJkBSP64uWwwAjZeNqZmhCnujKBMt1tpw8fJz1uFuuFeMoTiPHL"
                }
            ]
        },
        {
            "cFiReminderId": "41vcebwED3swY7ArZy5a7v",
            "cFiTransactionId": "2GJU5xNOF2gH2t80n99amJ",
            "remindDate": "2024-11-26T00:00:00.000Z",
            "notificationType": "sentLink",
            "createType": "planned",
            "status": "Created",
            "notificationDeliveryTypes": [
                "SMS",
                "Email"
            ],
            "dtsCreatedAt": "2024-11-18T16:38:18.708Z",
            "dtsUpdatedAt": "2024-11-18T16:38:18.708Z",
            "payment": [
                {
                    "cFiTransactionId": "2GJU5xNOF2gH2t80n99amJ",
                    "cFiAggregatorId": "CLIENTID",
                    "cFiMerchantId": "7tfd67RwOo6gjvRdV3JERQ",
                    "payerName": "Doe John",
                    "invoiceNumber": "11130",
                    "amount": 22.5,
                    "currency": "USD",
                    "dueDate": "2024-08-29T00:00:00.000Z",
                    "description": "test description",
                    "status": "Sent",
                    "fields": [
                        {
                            "index": 1,
                            "code": "firstName",
                            "label": "First Name",
                            "value": "John"
                        },
                        {
                            "index": 2,
                            "code": "lastName",
                            "label": "Last Name",
                            "value": "Doe"
                        },
                        {
                            "index": 3,
                            "code": "email",
                            "label": "Email",
                            "value": "customer_email@email.test"
                        }
                    ],
                    "availablePaymentType": [
                        "card",
                        "ach"
                    ],
                    "statusChangeHistory": [
                        {
                            "initiatorId": "7tfd67RwOo6gjvRdV3JERQ",
                            "initiatorType": "merchant",
                            "status": "Initiated",
                            "_id": "673b6d316817433ed7b90f1a",
                            "dtsCreatedAt": "2024-11-18T16:37:05.132Z",
                            "dtsUpdatedAt": "2024-11-18T16:37:05.132Z"
                        },
                        {
                            "initiatorId": "7tfd67RwOo6gjvRdV3JERQ",
                            "initiatorType": "merchant",
                            "status": "Sent",
                            "_id": "673b6d946817433ed7b90f45",
                            "dtsCreatedAt": "2024-11-18T16:38:44.884Z",
                            "dtsUpdatedAt": "2024-11-18T16:38:44.884Z"
                        }
                    ],
                    "dtsCreatedAt": "2024-11-18T16:37:05.132Z",
                    "dtsUpdatedAt": "2024-11-18T16:38:44.884Z",
                    "dtsExpiredAt": "2024-12-18T16:38:44.883Z",
                    "link": "5MHkgd25b4h7qkVdJkBSP64uWwwAjZeNqZmhCnujKBMt1tpw8fJz1uFuuFeMoTiPHL",
                    "url": "google.com/payment/5MHkgd25b4h7qkVdJkBSP64uWwwAjZeNqZmhCnujKBMt1tpw8fJz1uFuuFeMoTiPHL"
                }
            ]
        }
    ],
    "requestId": "a62f5a40a5cb11efa1c705d40488b012"
}

200 SUCCESSFUL RESPONSE - NO MATCHES FOUND

HEADERS

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

REQUEST BODY

{
    "cFiTransactionId": "UNKNOWN_TRANSACTION_ID"
}

RESPONSE BODY

{
    "code": "0",
    "data": [],
    "requestId": "15ff9ec0a5cc11efa1c705d40488b012"
}