Settlements Banks

The Settlements API allows you to create and manage settlement banks on your integration.

Store Settlement Bank

Store a new settlement bank.

Headers

Name

Value

Content-Type

application/json

DPPRIVATEKEY

PRIVATE_KEY

Body Parameters

Name

Type

Description

name

string

Public key of the customer.

account_no

number

account number of the settlement bank.

account_name

string

account name of the settlement bank.

bank_code

string

bank code for the settlement bank.

bank_slug

string

Slug for the settlement bank

Sample Request

curl --location 'https://api.backend.dotapay.ng/api/v1/settlement-banks/' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data '{
  "name": "Jane Doe",
  "account_no": "1234567890",
  "account_name": "Jane Doe",
  "bank_code": "044",
  "bank_slug": "access-bank"
}
'

const axios = require('axios');
let data = JSON.stringify({
  "name": "Jane Doe",
  "account_no": "1234567890",
  "account_name": "Jane Doe",
  "bank_code": "044",
  "bank_slug": "access-bank"
});

let config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: 'https://api.backend.dotapay.ng/api/v1/settlement-banks/',
  headers: { 
    'Authorization': 'Bearer ', 
    'Content-Type': 'application/json'
  },
  data : data
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.backend.dotapay.ng/api/v1/settlement-banks/',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS =>'{
  "name": "Jane Doe",
  "account_no": "1234567890",
  "account_name": "Jane Doe",
  "bank_code": "044",
  "bank_slug": "access-bank"
}
',
  CURLOPT_HTTPHEADER => array(
    'DPPRIVATEKEY: PRIVATE_KEY ',
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Update Settlement Banks

Update details of a single settlement bank.

Headers

Name

Value

Content-Type

application/json

DPPRIVATEKEY

PRIVATE_KEY

Body Parameters

Name

Type

Description

name

string

Public key of the customer.

account_no

number

account number of the settlement bank.

account_name

string

account name of the settlement bank.

bank_code

string

bank code for the settlement bank.

bank_slug

string

Slug for the settlement bank

Path Parameters

identifier String

The settlement bank ID is used to update the settlement bank details.

curl --location --globoff --request PATCH 'https://api.backend.dotapay.ng/api/v1/settlement-banks/{{identifier}}' \
--header 'DPPRIVATEKEY: PRIVATE_KEY ' \
--header 'Content-Type: application/json' \
--data '{
  "name": "Jane Does",
  "account_no": "1234567890",
  "account_name": "Jane Doe",
  "bank_code": "044",
  "bank_slug": "access-bank"
}
'

const axios = require('axios');
let data = JSON.stringify({
  "name": "Jane Does",
  "account_no": "1234567890",
  "account_name": "Jane Doe",
  "bank_code": "044",
  "bank_slug": "access-bank"
});

let config = {
  method: 'patch',
  maxBodyLength: Infinity,
  url: 'https://api.backend.dotapay.ng/api/v1/settlement-banks/{{identifier}}',
  headers: { 
    'Authorization': 'Bearer ', 
    'Content-Type': 'application/json'
  },
  data : data
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.backend.dotapay.ng/api/v1/settlement-banks/{{identifier}}',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'PATCH',
  CURLOPT_POSTFIELDS =>'{
  "name": "Jane Does",
  "account_no": "1234567890",
  "account_name": "Jane Doe",
  "bank_code": "044",
  "bank_slug": "access-bank"
}
',
  CURLOPT_HTTPHEADER => array(
    'Authorization: Bearer ',
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Single Settlement Banks

Get single settlement bank.

Headers

Name

Value

Content-Type

application/json

DPPRIVATEKEY

PRIVATE_KEY

Path Parameters

identifier String

The settlement bank ID is used to fetch the settlement bank details.

curl --location --globoff 'https://api.backend.dotapay.ng/api/v1/payment/status/{{identifier}}' \
--header 'DPPRIVATEKEY: PDBDMOsdsldjsljdldjsljdsldjldjldsjljd'

const axios = require('axios');

let config = {
  method: 'get',
  maxBodyLength: Infinity,
  url: 'https://api.backend.dotapay.ng/api/v1/payment/status/{{identifier}}',
  headers: { 
    'DPPRIVATEKEY': 'PDBDMOsdsldjsljdldjsljdsldjldjldsjljd'
  }
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.backend.dotapay.ng/api/v1/payment/status/{{identifier}}',
  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(
    'DPPRIVATEKEY: PDBDMOsdsldjsljdldjsljdsldjldjldsjljd'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Settlement Banks List

Get the list of all settlement banks.

Headers

Name

Value

Content-Type

application/json

DPPRIVATEKEY

PRIVATE_KEY

Sample Request

curl --location 'https://api.backend.dotapay.ng/api/v1/settlement-banks/' \
--header 'DPPRIVATEKEY: PRIVATE_KEY '

const axios = require('axios');

let config = {
  method: 'get',
  maxBodyLength: Infinity,
  url: 'https://api.backend.dotapay.ng/api/v1/settlement-banks/',
  headers: { 
    'Authorization': 'Bearer '
  }
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.backend.dotapay.ng/api/v1/settlement-banks/',
  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(
    'Authorization: Bearer '
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

PreviousCustomers

Last updated 1 day ago

Good evening

Store Settlement Bank

Update Settlement Banks

Headers

Path Parameters

Single Settlement Banks

Headers

Path Parameters

Settlement Banks List

Headers

Sample Request