Verify Payment API Guideline

Through this API, a payment's status can be identified. After calling the Create Charge API, an invoice_id will generate and UddoktaPay will send that invoice_id with redirect_url in API V2. Using this invoice_id, the Verify Payment API can be called at anytime.

Request URL: {base_URL}/api/verify-payment
**base_URL is UddoktaPay installation location (eg: pay.your-domain.com)

Request Headers

Header Name	Value
Content-Type	"application/json"
Accept	"application/json"
RT-UDDOKTAPAY-API-KEY	Collect API KEY From Dashboard

Request Parameters

Property	Presence	Type	Description
invoice_id	Mandatory	string	UddoktaPay generated invoice_id for this payment creation request.

Success Response Parameters

Property	Type	Description
full_name	string	Full Name value which was passed along with the payment request.
email	string	Email value which was passed along with the payment request.
amount	string	Amount value which was passed along with the payment request.
fee	string	Fee of the payment transaction.
charged_amount	string	Amount of the payment transaction.
invoice_id	string	UddoktaPay generated invoice_id for this payment creation request.
metadata	json object	Any related json object which was passed along with the payment request.
payment_method	string	Payment Method of the payment transaction. (bKash/Rocket/Nagad/Upay or Bank)
sender_number	string	Sender Number of the payment transaction.
transaction_id	string	Transaction ID of the payment transaction.
date	string	Date of the payment transaction.
status	string	COMPLETED or PENDING or ERROR Status of the payment.

Error Response Parameters

Property	Type	Description
status	string	ERROR
message	string	Message associated with the status, explaining the status.

Sample Request

<?php

$baseURL = 'https://sandbox.uddoktapay.com/';
$apiKEY = '982d381360a69d419689740d9f2e26ce36fb7a50';

$fields = [
    'invoice_id'     => 'Erm9wzjM0FBwjSYT0QVb'
];


$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => $baseURL . "api/verify-payment",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode($fields),
  CURLOPT_HTTPHEADER => [
    "RT-UDDOKTAPAY-API-KEY: " . $apiKEY,
    "accept: application/json",
    "content-type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

curl --request POST \
     --url https://sandbox.uddoktapay.com/api/verify-payment \
     --header 'RT-UDDOKTAPAY-API-KEY: 982d381360a69d419689740d9f2e26ce36fb7a50' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
     "invoice_id": "Erm9wzjM0FBwjSYT0QVb"
}
'

const axios = require('axios');

const options = {
  method: 'POST',
  url: 'https://sandbox.uddoktapay.com/api/verify-payment',
  headers: {
    accept: 'application/json',
    'RT-UDDOKTAPAY-API-KEY': '982d381360a69d419689740d9f2e26ce36fb7a50',
    'content-type': 'application/json'
  },
  data: {invoice_id: 'Erm9wzjM0FBwjSYT0QVb'}
};

axios
  .request(options)
  .then(function (response) {
    console.log(response.data);
  })
  .catch(function (error) {
    console.error(error);
  });

import requests

url = "https://sandbox.uddoktapay.com/api/verify-payment"

payload = {"invoice_id": "Erm9wzjM0FBwjSYT0QVb"}
headers = {
    "accept": "application/json",
    "RT-UDDOKTAPAY-API-KEY": "982d381360a69d419689740d9f2e26ce36fb7a50",
    "content-type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

Sample Response

{
  "full_name": "John Doe",
  "email": "[email protected]",
  "amount": "100.00",
  "fee": "0.00",
  "charged_amount": "100.00",
  "invoice_id": "Erm9wzjM0FBwjSYT0QVb",
  "metadata": {
    "user_id": "10",
    "order_id": "50"
  },
  "payment_method": "bkash",
  "sender_number": "01311111111",
  "transaction_id": "TESTTRANS1",
  "date": "2023-01-07 14:00:50",
  "status": "COMPLETED"
}