Skip to content

Remove Reminders

Request URL

POST /public/merchant/reminder/remove

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 remove (cancel) one or more scheduled reminder notifications for the payment specified by the cFiTransactionId property. The reminder(s) to be cancelled must have the following properties.

  • Must have a "Created" status

  • Must pertain to a payment belonging to the Merchant

Schema

Property table for public/merchant/reminder/remove

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"
}
cFiReminderIds cFiReminderIds Yes array of {
  "type": "string",
  "pattern": "^[0-9a-zA-Z_]+$",
  "minLength": 1,
  "maxLength": 36,
  "$id": "common-id"
}

Request Body

{
    "cFiReminderIds": ["7BzkATAk1fx49MKCS2SW41"],
    "cFiTransactionId": "7g5vgpiVqpEManU8FAxY4h"
}

Snippet Examples

javascript

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

{
    "cFiReminderIds": ["7BzkATAk1fx49MKCS2SW41"],
    "cFiTransactionId": "7g5vgpiVqpEManU8FAxY4h"
}

RESPONSE BODY

{
    "code": "0",
    "data": {
        "cFiReminderIds": [
            "7BzkATAk1fx49MKCS2SW41"
        ],
        "removedCount": 1
    },
    "requestId": "1b46955092f811ef893705725acd1211"
}