Monicredit Api
  • 😊Hello
  • How to use this documentation
  • Demo vs Live Environment
  • Authentication
    • Login
  • OnBoarding
    • OnBoard New Merchant
  • Collection
    • Getting Started
    • Accept Payment (Inline)
    • Accept Payment (Standard)
    • Verify Payment
    • Virtual Accounts
    • Revenue Head
    • Settlement Bank
  • Transactions
    • Get Transactions
    • Get Initiated Transaction Info
    • Verify Transaction
    • Verify Payment
    • Transaction Virtual Account
    • Settlement Transactions
    • Initiate Transaction
  • Commercial
    • Calculate Commercials
  • Settlement Bank
    • Create Settlement Bank
    • List Settlement Banks
    • Update Settlement Bank
  • Revenue Heads
    • Create Revenue Head
    • Update Revenue Head
    • List Revenue Heads
    • Get Single Revenue Head
    • Search Revenue Head
    • Delete Revenue Head
  • Reports
    • Settlement Bank Report
    • Revenue Head Report
    • Merchant Report
  • Settlement
    • Get Settlements
    • Get Single Settlement
  • Wallets
    • Create Wallet
    • Update Wallet
    • Get Wallet Transactions
    • Get Single Customer Wallet
    • Get Account Wallets
    • Get All Wallets
    • Create Virtual Account
  • Customer Wallet
    • Create Customer Wallet
    • Get Customer Wallets
    • Create Customer Virtual Account
    • Update Customer Wallet
  • Beneficiary
    • Add Beneficiary
    • Update Beneficiary
    • Search Beneficiary
  • Disbursement
    • Single Fund Transfer
    • Transaction Settlement
    • Bank List
    • Name Enquiry
Powered by GitBook
On this page
  1. Reports

Settlement Bank Report

Introduction

The Settlement Bank Report provides a comprehensive overview of financial settlements, offering insights into transactions and ensuring transparency in your financial processes. This report is an essential tool for tracking settlements, facilitating reconciliation, and maintaining accurate financial records.

To access the Settlement Bank Report, use the following API endpoint:

Endpoint: GET - {{baseUrl}}/v1/reports/settlement-bank

Parameter
Required
Type

settlement_bank_id

no

string

search

no

string

Example Request

To retrieve data from the Settlement Bank Report, make a GET request using a tool like cURL. Replace "YOUR_BEARER_TOKEN" with the actual bearer token obtained through the authentication process

//A code snippet of how to consume the API

var myHeaders = new Headers();
myHeaders.append("Accept", "application/json");
myHeaders.append("Authorization", "Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczovL2RlbW8ubW9uaWNyZWRpdC5jb20vYXBpL3YxL2NvcmUvYXV0aC9sb2dpbiIsImlhdCI6MTY2ODk2NzQ0MywiZXhwIjoxNjY4OTcxMDQzLCJuYmYiOjE2Njg5Njc0NDMsImp0aSI6ImF0UE9GVHE4cU4yN2lBWlciLCJzdWIiOiJVU0FETUlOIiwicHJ2IjoiMjNiZDVjODk0OWY2MDBhZGIzOWU3MDFjNDAwODcyZGI3YTU5NzZmNyJ9.shrbQUV29vXRF30qMeBN3zxlc5JXd03QyMeD6ekzudU");

var raw = "";

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

fetch("https://demo.backend.monicredit.com/api/v1/reports/settlement-bank", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));
//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/reports/settlement-bank',
  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',
    'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczovL2RlbW8ubW9uaWNyZWRpdC5jb20vYXBpL3YxL2NvcmUvYXV0aC9sb2dpbiIsImlhdCI6MTY2ODk2NzQ0MywiZXhwIjoxNjY4OTcxMDQzLCJuYmYiOjE2Njg5Njc0NDMsImp0aSI6ImF0UE9GVHE4cU4yN2lBWlciLCJzdWIiOiJVU0FETUlOIiwicHJ2IjoiMjNiZDVjODk0OWY2MDBhZGIzOWU3MDFjNDAwODcyZGI3YTU5NzZmNyJ9.shrbQUV29vXRF30qMeBN3zxlc5JXd03QyMeD6ekzudU'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
//A code snippet of how to consume the API

curl -X GET \
  {{baseUrl}}/v1/reports/settlement-bank \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_BEARER_TOKEN"

Response

[
    {
        "id": "SB000000",
        "settle_bank_name": "MAIN-ACC",
        "settlement_bank_name": "Wema",
        "account_name": "Test Testing",
        "account_no": "7760000000",
        "merchant_id": "MC0000000",
        "business_name": "Test Testing",
        "total_transaction_count": 2,
        "settlement_count": 0,
        "transfer_count": 2,
        "card_count": 0,
        "transfer_total": 10000,
        "card_total": 0,
        "collection": 10000,
        "settlement": 0,
        "balance": 10000
    },
]
PreviousDelete Revenue HeadNextRevenue Head Report

Last updated 1 year ago