Customers

The Customers API allows you to create and manage customers on your integration.

Create Customer - `POST`

Initialize a transaction from your backend

Headers

Name

Value

Content-Type

application/json

DPPRIVATEKEY

PRIVATE_KEY

Body Parameters

Name

Type

Description

first_name

string

First name of the customer

last_name

number

Last name of the customer

nin

string

NIN of the customer

bvn

string

BVN of the customer

phone

string

Phone number of the customer

email

string

Email address of the customer

reference

string

Wallet reference of the customer(To identitfy the customer.)

type

string

The type field can be either wallet or collection. When type is set to collection, the collection_wallet_code must be provided.

collection_wallet_code

string

collection_wallet_code for the customer.

Sample Request

curl --location 'https://api.backend.dotapay.ng/api/v1/customers/' \
--header 'DPPRIVATEKEY: PRIVATE_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
  "first_name": "Wale",
  "last_name": "Ajanlekoko",
  "nin": "12345678901",
  "dob": "1990-06-15",
  "bvn": "",
  "phone": "+2348012345678",
  "email": "[email protected]",
  "reference": "CUST2025-0017",
  "type": "wallet",
  "collection_wallet": "WALLET_DEMO_QRNTBVSE"
}
'

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.backend.dotapay.ng/api/v1/customers/',
  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 =>'{
  "first_name": "Wale",
  "last_name": "Ajanlekoko",
  "nin": "12345678901",
  "dob": "1990-06-15",
  "bvn": "",
  "phone": "+2348012345678",
  "email": "[email protected]",
  "reference": "CUST2025-0017",
  "type": "wallet",
  "collection_wallet": "WALLET_DEMO_QRNTBVSE"
}
',
  CURLOPT_HTTPHEADER => array(
    'DPPRIVATEKEY: PRIVATE_KEY',
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Update Customer - `PATCH`

Confirm the status of a transaction

Headers

Name

Value

Content-Type

application/json

DPPRIVATEKEY

PRIVATE_KEY

Body Parameters

Name

Type

Description

first_name

string

First name of the customer

last_name

number

Last name of the customer

nin

string

NIN of the customer

bvn

string

BVN of the customer

phone

string

Phone number of the customer

email

string

Email address of the customer

reference

string

Wallet reference of the customer(To identitfy the customer.)

type

string

The type field can be either wallet or collection. When type is set to collection, the collection_wallet_code must be provided.

collection_wallet_code

string

collection_wallet_code for the customer.

Sample Request

curl --location --globoff --request PATCH 'https://api.backend.dotapay.ng/api/v1/customers/{{identifier}}' \
--header 'DPPRIVATEKEY: PRIVATE_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
  "first_name": "Amina",
  "last_name": "Yusuf",
  "nin": "12345678901",
  "dob": "1995-08-24",
  "phone": "+2348012345678",
  "email": "[email protected]",
  "type": "wallet",
  "collection_wallet": null
}'

const axios = require('axios');
let data = JSON.stringify({
  "first_name": "Amina",
  "last_name": "Yusuf",
  "nin": "12345678901",
  "dob": "1995-08-24",
  "phone": "+2348012345678",
  "email": "[email protected]",
  "type": "wallet",
  "collection_wallet": null
});

let config = {
  method: 'patch',
  maxBodyLength: Infinity,
  url: 'https://api.backend.dotapay.ng/api/v1/customers/{{identifier}}',
  headers: { 
    'DPPRIVATEKEY': 'PRIVATE_KEY', 
    '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/customers/{{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 =>'{
  "first_name": "Amina",
  "last_name": "Yusuf",
  "nin": "12345678901",
  "dob": "1995-08-24",
  "phone": "+2348012345678",
  "email": "[email protected]",
  "type": "wallet",
  "collection_wallet": null
}',
  CURLOPT_HTTPHEADER => array(
    'DPPRIVATEKEY: PRIVATE_KEY',
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Fetch Single Customer - `GET`

Get single customer details using ID.

Headers

Name

Value

Content-Type

application/json

DPPRIVATEKEY

PRIVATE_KEY

Path Parameters

identifier String

The customer ID is used to fetch the customer's details

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

const axios = require('axios');

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

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

const axios = require('axios');

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

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

Fetch Balance - `GET`

Get single customer balance details using the ID.

Headers

Name

Value

Content-Type

application/json

DPPRIVATEKEY

PRIVATE_KEY

Path Parameters

identifier String

identifier used to create the customer.

curl --location --globoff 'https://api.backend.dotapay.ng/api/v1/customers/{{identifier}}/transactions' \
--header 'DPPRIVATEKEY: PRIVATE_KEY '

<?php

$curl = curl_init();

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

Fetch Customer Transactions - `GET`

Retrieve transactions for a customer using the customer ID.

Headers

Name

Value

Content-Type

application/json

DPPRIVATEKEY

PRIVATE_KEY

Path Parameters

identifier String

The customer ID is used to fetch the customer transactions.

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

const axios = require('axios');

let config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: 'https://api.backend.dotapay.ng/api/v1/customers/{{identifier}}/virtual-accounts-onetime',
  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/customers/{{identifier}}/virtual-accounts-onetime',
  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_HTTPHEADER => array(
    'Authorization: Bearer '
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Fetch Customer Virtual Accounts - `GET`

Get single customer virtual account(s) details using ID.

Headers

Name

Value

Content-Type

application/json

DPPRIVATEKEY

PRIVATE_KEY

Path Parameters

identifier String

The customer ID is used to fetch the customer's virtual accounts.

curl --location --globoff --request POST 'https://api.backend.dotapay.ng/api/v1/customers/{{identifier}}/virtual-accounts' \
--header 'DPPRIVATEKEY: PRIVATE_KEY ' \
--data ''

<?php

$curl = curl_init();

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

Create Customer Virtual Account - `POST`

Create new virtual account for a customer

Headers

Name

Value

Content-Type

application/json

DPPRIVATEKEY

PRIVATE_KEY

Path Parameters

identifier String

The customer ID is used to create the customer's virtual account.

curl --location --globoff --request POST 'https://api.backend.dotapay.ng/api/v1/customers/{{identifier}}/virtual-accounts' \
--header 'DPPRIVATEKEY: PRIVATE_KEY' \
--data ''

const axios = require('axios');
let data = '';

let config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: 'https://api.backend.dotapay.ng/api/v1/customers/{{identifier}}/virtual-accounts',
  headers: { 
    'DPPRIVATEKEY': 'PRIVATE_KEY'
  },
  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/customers/{{identifier}}/virtual-accounts',
  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_HTTPHEADER => array(
    'DPPRIVATEKEY: PRIVATE_KEY'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Create Customer One-Time Account - `POST`

Confirm the status of a transaction

Headers

Name

Value

Content-Type

application/json

DPPRIVATEKEY

PRIVATE_KEY

Path Parameters

identifier String

The customer ID is used to create a one-time account for the customer.

curl --location --globoff --request POST 'https://api.backend.dotapay.ng/api/v1/customers/{{identifier}}/virtual-accounts-onetime' \
--header 'DPPRIVATEKEY: PRIVATE_KEY'

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.backend.dotapay.ng/api/v1/customers/{{identifier}}/virtual-accounts-onetime',
  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_HTTPHEADER => array(
    'Authorization: Bearer '
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Customers List - `GET`

Get the list of all customers using the private key.

Headers

Name

Value

Content-Type

application/json

DPPRIVATEKEY

PRIVATE_KEY

Sample Request

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

const axios = require('axios');

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

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/customers/',
  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;

PreviousPayments NextSettlements Banks

Last updated 1 month ago

Good evening

hashtagCreate Customer - POST

hashtagUpdate Customer - PATCH

hashtagHeaders

hashtagFetch Single Customer - GET

hashtagHeaders

hashtagPath Parameters

hashtagFetch Balance - GET

hashtagHeaders

hashtagPath Parameters

hashtagFetch Customer Transactions - GET

hashtagHeaders

hashtagPath Parameters

hashtagFetch Customer Virtual Accounts - GET

hashtagHeaders

hashtagPath Parameters

hashtagCreate Customer Virtual Account - POST

hashtagHeaders

hashtagPath Parameters

hashtagCreate Customer One-Time Account - POST

hashtagHeaders

hashtagPath Parameters

hashtagCustomers List - GET

hashtagHeaders

Create Customer - `POST`

Update Customer - `PATCH`

Headers

Fetch Single Customer - `GET`

Headers

Path Parameters

Fetch Balance - `GET`

Headers

Path Parameters

Fetch Customer Transactions - `GET`

Headers

Path Parameters

Fetch Customer Virtual Accounts - `GET`

Headers

Path Parameters

Create Customer Virtual Account - `POST`

Headers

Path Parameters

Create Customer One-Time Account - `POST`

Headers

Path Parameters

Customers List - `GET`

Headers