Merchant Report

The Merchant Report enables you to retrieve detailed information about your transactions. By accessing this report through our API, you gain transparency into the various transactions associated with your financial activities.

To access the Merchant Report, make a GET request to the following endpoint:

Endpoint: GET - {{baseUrl}}/api/v1/public/reports/merchant-transactions

Parameter	Required	Type
private_key	yes	string

Request

Use the provided code snippet as a reference to make requests to the Merchant Report endpoint.

JavaScript

var myHeaders = new Headers();
myHeaders.append("Accept", "application/json");

var raw = "";

var requestOptions = {
  method: 'GET',
  headers: myHeaders,
  body: raw,
  redirect: 'follow'
};

fetch("https://demo.backend.monicredit.com/api/v1/public/reports/merchant-transactions", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

PHP

//A code snippet of how to consume the API

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://demo.backend.monicredit.com/api/v1/public/reports/merchant-transactions',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Accept: application/json',
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

CURL

//A code snippet of how to consume the API

curl --location '{{baseUrl}}/v1/public/reports/merchant-transactions' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer YOUR_BEARER_TOKEN' \
--data ''

Response

{
    "success": true,
    "message": "merchant report data fetched successfully",
    "data": [
        {
            "merchant_id": "MCxxxxxxx",
            "business_name": "xxxxx",
            "business_phone": "234xxxxxx",
            "business_email": "[e-mail]",
            "total_transaction_count": 0,
            "settlement_count": 0,
            "transfer_count": 0,
            "card_count": 0,
            "transfer_total": 0,
            "card_total": 0,
            "collection": 0,
            "settlement": 0,
            "balance": 0
        }
    ]
}