Skip to content

List Reminders

Request URL

POST /public/merchant/reminder/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 list all reminder notifications for the payment specified by the cFiTransactionId property.

Schema

Property table for public/merchant/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": "7g5vgpiVqpEManU8FAxY4h"
}

Snippet Examples

javascript

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

{
    "cFiTransactionId": "7g5vgpiVqpEManU8FAxY4h"
}

RESPONSE BODY

{
    "code": "0",
    "data": [
        {
            "cFiReminderId": "1m2QgdICCgAsx03XeK0Q3D",
            "cFiTransactionId": "7g5vgpiVqpEManU8FAxY4h",
            "remindDate": "2024-10-25T17:32:56.953Z",
            "status": "Completed",
            "notificationType": "sentLink",
            "notificationDeliveryTypes": [
                "SMS",
                "Email"
            ],
            "dtsSent": "2024-10-25T17:32:56.953Z",
            "dtsCreatedAt": "2024-10-25T17:32:57.362Z",
            "dtsUpdatedAt": "2024-10-25T17:32:57.362Z"
        },
        {
            "cFiReminderId": "6iDrx6AmHYVOVH3EVo3dp7",
            "cFiTransactionId": "7g5vgpiVqpEManU8FAxY4h",
            "remindDate": "2024-10-26T00:00:00.000Z",
            "status": "Created",
            "notificationType": "sentLink",
            "notificationDeliveryTypes": [
                "SMS",
                "Email"
            ],
            "dtsCreatedAt": "2024-10-25T17:30:20.457Z",
            "dtsUpdatedAt": "2024-10-25T17:30:20.457Z"
        },
        {
            "cFiReminderId": "6iCKizExaSdJasQjdK0Sdj",
            "cFiTransactionId": "7g5vgpiVqpEManU8FAxY4h",
            "remindDate": "2024-10-27T00:00:00.000Z",
            "status": "Created",
            "notificationType": "sentLink",
            "notificationDeliveryTypes": [
                "SMS",
                "Email"
            ],
            "dtsCreatedAt": "2024-10-25T17:30:20.447Z",
            "dtsUpdatedAt": "2024-10-25T17:30:20.447Z"
        },
        {
            "cFiReminderId": "7BzkATAk1fx49MKCS2SW41",
            "cFiTransactionId": "7g5vgpiVqpEManU8FAxY4h",
            "remindDate": "2024-10-28T00:00:00.000Z",
            "status": "Created",
            "notificationType": "sentLink",
            "notificationDeliveryTypes": [
                "SMS",
                "Email"
            ],
            "dtsCreatedAt": "2024-10-25T17:24:22.919Z",
            "dtsUpdatedAt": "2024-10-25T17:24:22.919Z"
        }
    ],
    "requestId": "4068284092f711ef893705725acd1211"
}

200 SUCCESSFUL RESPONSE - NO MATCHES

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

{
    "cFiTransactionId": "UnknownId"
}

RESPONSE BODY

{
    "code": "0",
    "data": [],
    "requestId": "80f56d0092f711ef893705725acd1211"
}