Skip to content

Remove Invoice

Request URL

POST /public/merchant/invoice/remove/:cFiInvoiceId

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 removed a previously uploaded invoice file specified by the given cFiInvoiceId as a path parameter. 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/invoice/remove/:cFiInvoiceId

Property Description Required Schema
cFiInvoiceId The ID of the invoice in connectFi Yes {
  "type": "string",
  "pattern": "^[0-9a-zA-Z_]+$",
  "minLength": 1,
  "maxLength": 36,
  "$id": "common-id"
}

Snippet Examples

javascript

const axios = require('axios');
const config = {
  method: 'POST',
  url: '${CONNECTFI_BASE_URL}/public/merchant/invoice/remove/:cFiInvoiceId',
  headers: {
    'Content-Type': "application/json",
    'x-connectfi-jwtoken': "A long random string token received from /payment-link/merchant/get-token request"
  },
};

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/invoice/remove/:cFiInvoiceId"  --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

PARAMETERS

Parameter Description Value
cFiInvoiceId TcwgOjo16D0pNKQsqKjp7

REQUEST BODY

none

RESPONSE BODY

{
    "code": "0",
    "message": "Invoice removed",
    "requestId": "88a143804f2c11ef92543a54d404e711"
}