Payments

The Payments API allows you to create and manage payments on your integration.

Initialize Transaction - `POST`

Initialize a transaction from your backend

Headers

Name

Value

Content-Type

application/json

DPPRIVATEKEY

PRIVATE_KEY

Body Parameters

Name

Type

Description

public_key

string

Public key of the customer.

customer_email

number

email of the customer

customer_name

string

Name of the customer

order_id

string

order_Id of the transaction

items

array

aray of items and split group payments (see example)

fee_bearer

string

bearer of the transaction charges.

curl --location 'https://api.backend.dotapay.ng/api/v1/payment/request' \
--header 'DPPRIVATEKEY: PDBDMOsdsldjsljdldjsljdsldjldjldsjljd' \
--header 'Content-Type: application/json' \
--data-raw '{
    "public_key": "PUB_DP_DEMOQTD9839ZV0DAP27VKEGUHZJDE3A1JZNWCQIH",
    "items": [
        {
            "unit_cost": 500,
            "quantity": 2,
            "split_group_id": "SG_DEMO_8OFOA9O4"
        },
        {
            "unit_cost": 1000,
            "quantity": 1,
            "split_group_id": null
        }
    ],
    "customer_email": "[email protected]",
    "customer_name": "Alice Johnson",
    "order_id": "ORD202250d9s2s3X3s3113",
    "fee_bearer": "merchant"
}
'

const axios = require('axios');
let data = JSON.stringify({
  "public_key": "PUB_DP_DEMOQTD9839ZV0DAP27VKEGUHZJDE3A1JZNWCQIH",
  "items": [
    {
      "unit_cost": 500,
      "quantity": 2,
      "split_group_id": "SG_DEMO_8OFOA9O4"
    },
    {
      "unit_cost": 1000,
      "quantity": 1,
      "split_group_id": null
    }
  ],
  "customer_email": "[email protected]",
  "customer_name": "Alice Johnson",
  "order_id": "ORD202250d9s2s3X3s3113",
  "fee_bearer": "merchant"
});

let config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: 'https://api.backend.dotapay.ng/api/v1/payment/request',
  headers: { 
    'DPPRIVATEKEY': 'PDBDMOsdsldjsljdldjsljdsldjldjldsjljd', 
    '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/payment/request',
  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 =>'{
    "public_key": "PUB_DP_DEMOQTD9839ZV0DAP27VKEGUHZJDE3A1JZNWCQIH",
    "items": [
        {
            "unit_cost": 500,
            "quantity": 2,
            "split_group_id": "SG_DEMO_8OFOA9O4"
        },
        {
            "unit_cost": 1000,
            "quantity": 1,
            "split_group_id": null
        }
    ],
    "customer_email": "[email protected]",
    "customer_name": "Alice Johnson",
    "order_id": "ORD202250d9s2s3X3s3113",
    "fee_bearer": "merchant"
}
',
  CURLOPT_HTTPHEADER => array(
    'DPPRIVATEKEY: PDBDMOsdsldjsljdldjsljdsldjldjldsjljd',
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Initialize Customer Transaction - `POST`

Initialize a transaction for a customer from your backend.

Headers

Name

Value

Content-Type

application/json

DPPRIVATEKEY

PRIVATE_KEY

Body Parameters

Name

Type

Description

public_key

string

Public key of the customer.

customer_email

number

email of the customer

customer_name

string

Name of the customer

order_id

string

order_Id of the transaction

items

array

aray of items and split group payments (see example)

fee_bearer

string

bearer of the transaction charges.

curl --location 'https://api.backend.dotapay.ng/api/v1/payment/verify-customer' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data '{
    "identifier": "PAY_DEMO_WNH1IJTZY6JI"
}'

const axios = require('axios');
let data = JSON.stringify({
  "identifier": "PAY_DEMO_WNH1IJTZY6JI"
});

let config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: 'https://api.backend.dotapay.ng/api/v1/payment/verify-customer',
  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/payment/verify-customer',
  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 =>'{
    "identifier": "PAY_DEMO_WNH1IJTZY6JI"
}',
  CURLOPT_HTTPHEADER => array(
    'Authorization: Bearer ',
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Verify Customer Transaction - `POST`

Verify customer transaction using the identifier.

Headers

Name

Value

Content-Type

application/json

DPPRIVATEKEY

PRIVATE_KEY

Body Parameters

Name

Type

Description

identifier

string

Identifier for the transaction.

Sample Request

curl --location 'https://api.backend.dotapay.ng/api/v1/payment/verify-customer' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data '{
    "identifier": "PAY_DEMO_WNH1IJTZY6JI"
}'

const axios = require('axios');
let data = JSON.stringify({
  "identifier": "PAY_DEMO_WNH1IJTZY6JI"
});

let config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: 'https://api.backend.dotapay.ng/api/v1/payment/verify-customer',
  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/payment/verify-customer',
  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 =>'{
    "identifier": "PAY_DEMO_WNH1IJTZY6JI"
}',
  CURLOPT_HTTPHEADER => array(
    'Authorization: Bearer ',
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Verify Transaction - `GET`

Confirm the status of a transaction

Headers

Name

Value

Content-Type

application/json

DPPRIVATEKEY

PRIVATE_KEY

Body Parameters

Name

Type

Description

identifier

string

Reference of the transaction

Sample Request

curl --location 'https://api.backend.dotapay.ng/api/v1/payment/verify' \
--header 'DPPRIVATEKEY: PRIVATE_KEY' \
--header 'Content-Type: application/json' \
--data '{
    "identifier": "payment_ref"
}'

const axios = require('axios');
let data = JSON.stringify({
  "identifier": ""
});

let config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: 'https://api.backend.dotapay.ng/api/v1/payment/verify',
  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/payment/verify',
  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 =>'{
    "identifier": ""
}',
  CURLOPT_HTTPHEADER => array(
    'DPPRIVATEKEY: PRIVATE_KEY',
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Transaction Status - `GET`

Confirm the status of a transaction

Headers

Name

Value

Content-Type

application/json

DPPRIVATEKEY

PRIVATE_KEY

Path Parameters

identifier String

The identifier is used to check the transaction status.

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;

Transactions List - `GET`

Get the list of all transactions using the private key.

Headers

Name

Value

Content-Type

application/json

DPPRIVATEKEY

PRIVATE_KEY

curl --location 'https://api.backend.dotapay.ng/api/v1/payment/list' \
--header 'DPPRIVATEKEY: PDBDMOsdsldjsljdldjsljdsldjldjldsjljd'

const axios = require('axios');

let config = {
  method: 'get',
  maxBodyLength: Infinity,
  url: 'https://api.backend.dotapay.ng/api/v1/payment/list',
  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/list',
  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;

PreviousErrors NextCustomers

Last updated 1 month ago

Good evening

hashtagInitialize Transaction - POST

hashtagInitialize Customer Transaction - POST

hashtagVerify Customer Transaction - POST

hashtagVerify Transaction - GET

hashtagHeaders

hashtagTransaction Status - GET

hashtagHeaders

hashtagPath Parameters

hashtagTransactions List - GET

hashtagHeaders

Initialize Transaction - `POST`

Initialize Customer Transaction - `POST`

Verify Customer Transaction - `POST`

Verify Transaction - `GET`

Headers

Transaction Status - `GET`

Headers

Path Parameters

Transactions List - `GET`

Headers