Remove Logo

Request URL

POST /payment-link/merchant/remove/logo

Description

This endpoint will allow you (the client/platform) to remove a previously uploaded logo image associated with the specified merchant.

Schema

Property table for payment-link/merchant/remove/logo

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

Request Body

{
    "logoId": "1XqJDbXs94tsLwvhSoLf28",
    "cFiMerchantId": "4CLMxknljmKO2aPJwvwCNe"
}

Snippet Examples

javascript

const axios = require('axios');
const data = {
    "logoId": "1XqJDbXs94tsLwvhSoLf28",
    "cFiMerchantId": "4CLMxknljmKO2aPJwvwCNe"
};
const config = {
  method: 'POST',
  url: '${CONNECTFI_BASE_URL}/payment-link/merchant/remove/logo',
  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/merchant/remove/logo" --data "{    \"logoId\":\"1XqJDbXs94tsLwvhSoLf28\",   \"cFiMerchantId\":\"4CLMxknljmKO2aPJwvwCNe\"}" --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

{
    "logoId": "7fzkoyqPI3LIyNxNQuqopi",
    "cFiMerchantId": "7MYoRiCN2XuAxJxWr82n6I"
}

RESPONSE BODY

{
    "code": "0",
    "data": {
        "cFiMerchantId": "7MYoRiCN2XuAxJxWr82n6I",
        "logoId": "7fzkoyqPI3LIyNxNQuqopi",
        "type": "light1"
    },
    "requestId": "0c15bc7092e211efb50456da8a8633f0"
}