Build faster with Delta Pay APIs

API Documentation: Payment Integration Guide

Getting Started

Welcome to DeltaPay's Collection API, a powerful tool designed to streamline your payment collection processes. Our API allows businesses to seamlessly integrate with various payment channels, enabling efficient and secure collection of funds from customers. Whether you're handling recurring billing, online sales, or any other type of payment collection, our Collection API ensures smooth and reliable transactions. With DeltaPay's Collection API, you can enhance your payment infrastructure , improve cash flow management, and provide a seamless payment experience for your customers.

To start integration, follow these steps:

Sign Up for DELTA PAY

To get started with DELTA PAY, visit our sign-up page. Enter your username or email and password to create an account. Make sure to agree to our cookie policy for the best user experience. Once registered, you'll have access to DELTA PAY's Sandbox services. For any issues with login or password retrieval.

Access Your API Key on DELTA PAY

Access Your API Key on DELTA PAY After registering on the DELTA PAY portal, log in to your account to access the API key. Navigate to the API section in your account settings to find your unique API key. This key is essential for integrating DELTA PAY services with your applications, enabling secure and efficient transactions. Ensure to keep your API key confidential to protect your account. For more details, visit the DELTA PAY portal.

Business Api's Key

Ensure these keys are securely stored to maintain the integrity and security of your application. For more details, visit the DELTA PAY portal.

Base URL

Hosted Method

Use this API to initiate a hosted payment. When this API is called, a payment request is sent to the user's mobile device for OTP confirmation. After the user confirms the payment, you will receive a callback on your provided IPN_URL. The API also returns a JSON response.

Endpoint

Required Headers

Body Parameters

Redirection Method

Required Headers

Body Parameters

Error (400 Bad Request)

An error response indicating that something went wrong with the request parameters.

QR Code Payment API Documentation

DeltaPay - AikPay QR Payment Integration Guide

1. Overview

This API is used to create a QR payment order. After a successful request, the system returns a qr_url and qr_text. Merchants can use either the ready-made redirection flow or build their own hosted QR payment page.

2. Create QR Payment

Endpoint

Headers

Request Parameters

Example cURL

curl --location 'https://api.deltapayofficial.com/api/qr/code/payment/initiate' \
--header 'ApiKey: YOUR_PUBLIC_API_KEY' \
--header 'SecretKey: YOUR_SECRET_KEY' \
--form 'amount="1"' \
--form 'ipn_url="https://your-domain.com/payment/ipn"' \
--form 'callback_url="https://your-domain.com/payment/callback"' \
--form 'order_id="1122332211122"' \
--form 'channel_id="4"' \
--form 'meta[customer_name]="John Doe"' \
--form 'meta[customer_email]="john@example.com"' \
--form 'meta[description]="Test Payment"'

Note: For meta fields, send data as meta[customer_name], meta[customer_email], and meta[description]. If customer_name or email are sent directly, they may not appear inside the meta response.

Success Response

{
  "status": "success",
  "message": "QR generated successfully",
  "data": {
    "id": "3be1ac08-6af8-485e-9ffd-1e9721218d4e",
    "amount": 1,
    "order_id": "1122332211122232",
    "wallet_order_id": "AIK645sd288066",
    "ipn_url": "https://your-domain.com/payment/ipn",
    "callback_url": "https://your-domain.com/payment/callback",
    "meta": {
      "customer_name": "John Doe",
      "customer_email": "john@example.com",
      "description": "Test Payment"
    },
    "qr_url": "https://api.deltapayofficial.com/qr/code/payment/3be1ac08-6af8-485e-9ffd-1e9721218d4e",
    "qr_text": "00020101021228760032808238..."
  }
}

3. Payment Flows

A. Redirection Flow

Use this flow if you want to redirect the customer to the ready-made QR payment page. After creating the payment, open the returned qr_url in the browser.

Example qr_url

The customer can scan the QR code using Easypaisa, JazzCash, or any supported banking app. When payment is completed, the page will automatically update and show success or failed status.

B. Hosted / Custom QR Flow

Use this flow if you want to show the QR code on your own website or mobile app. Use the qr_text value from the API response and generate a QR code on your own side.

Example qr_text

You can generate a QR image using any QR library or QR image API. Example:

Replace YOUR_QR_TEXT with the qr_text returned by the API.

4. Payment Status IPN

After the customer pays, the system will send payment status to the ipn_url provided in the create payment request.

IPN Payload

{
  "status": "Paid",
  "orderId": "1122332211122232",
  "amount": 1,
  "number": null,
  "transactionId": "9828814872096754"
}

Status Meaning

5. Error Response Example

{
  "status": "error",
  "error": [
    "The order id has already been taken."
  ]
}

6. Important Notes

Verify Payment (APIs)

To ensure the payment is completed, your application must verify the payment state. You will need to make a request with the following endpoint.

Endpoint

Body Parameters

1. order_id (string, required): The unique ID you received in the response.
   • Example: 453453434

Required Headers

Payment Statuses

1. Pending
2. Paid
3. Declined
4. Failed

Integration Guide

Curl Integration Guide

PHP Integration Guide

                                                             
                
                                     $curl= curl_init();
                                    curl_setopt_array($curl, array(
                                        CURLOPT_URL => 'https://api.deltapayofficial./com/api/payment/init',
                                        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 => array('currency' => 'PKR','amount' => '100'),
                                        CURLOPT_HTTPHEADER => array(
                                            'ApiKey: 9a5cd8e5beb32c70400bfdfc5f575652bd09202d',
                                            'SecretKey: f2cc7f986a81b14525807a37a6a89ec99b8a82b6'
                                        ),
                                    );
                    
                                    $response = curl_exec($curl);
                    
                                    curl_close($curl);
                                   
                                   echo $response;
                          
                                
                             

RUBY Integration Guide

Nods Js Integration Guide

                            
                              

                                      var request = require('request');
                                      var options = {
                                        'method':'POST',
                                    'url' 'https://api.deltapayofficial./com/payment/initiate',
                                     'headers': {
                                          'ApiKey': '9a5cd8e5beb32c70400bfdcf5f576562bd09202d',
                                         'SecretKey': 'f2cc7f986a81b14525807a37a6a89ec99b8a82b6'
                                        },
                                        formData: {
                                            'currency':'PKR',
                                            'amount':'100',
                                            'ipn_url':'https://deltapayofficial.com/',
                                            'callback_url':'https://deltapayofficial.com/',
                                            'order_id':'256985412569',
                                            'customer_name':'John Doe',
                                            'email':'example@gmail.com',
                                            'description':''
                                        }
                                      };
                                  
                                     request (options, function (error, response) {
                                        if (error) throw newError (error);
                                     console.log(response.body);
                                      });
                                   
                       

Python Integration Guide

                              
                                        import requests

                                        url = "https://api.deltapayofficial./com/payment/initiate"                              
                                        payload={'currency': 'PKR',
                                    'amount' '100',
                                       'ipn_url':   'https://deltapayofficial.com/',
                                    'callback_url':   'https://deltapayofficial.com/',
                                       'order_id':  '256985412569',
                                      'customer_name':   'John Doe',
                                      'email':  'example@gmail.com',
                                      'description'  : ''
                                        files=[
                                        
                                        ]
                                        headers = {
                                             'ApiKey': '9a5cd8e5beb32c70400bfdcf5f576562bd09202d',
                                                'SecretKey': 'f2cc7f986a81b14525807a37a6a89ec99b8a82b6'    
                                        response = requests.request(  "POST", url, headers=headers, data=payload, files=files)
                                        print (response.text)
                                
                            

Delta Pay Disbursement Api's

Introduction

Welcome to DeltaPay Disbursement Api's, your premier solution for seamless payment disbursement through mobile wallets and IBFT (Interbank Fund Transfer). Designed with efficiency and security in mind, DeltaPay simplifies the complex process of distributing funds across multiple recipients. Whether you need to handle payroll, vendor payments, or any other form of financial disbursement, our software provides a robust, user-friendly platform to ensure transactions are executed quickly and accurately. With DeltaPay, managing payments through mobile wallets and IBFT has never been easier, empowering your business to operate smoothly and focus on what truly matters.has never been easier, empowering your business to operate smoothly and focus on what truly matters.

Disburse Funds to Registered Mobile Wallet & IBFT

API consumers will pass API body as encrypted and will also expect response in encrypted form. Encryption algorithm along with keys to be shared while integration onboarding.

AES -128 -CBC with HEX (BASE16) notation applied for encryption/decryption.. API keys to be shared separately.

https://www.devglan.com/online-tools/aes-encryption-decryption // You can use this reference for encryption and decryption.

Api Details

Below is the API signature.

Url

API Header

Following is the sample header APIs.

1. PublicKey : ae32030e4f15d2a2d4a425e3a8fc69af6285ec
2. SecretKey : 67c184cd2f9094ed4f84125b9d9a41941db74
3. AesKey : I7kEZ8gCFPHA7V
4. AesIv : AVXd9CylwhDhbh

API Request Body Specification

The unencrypted Body mobile wallet disbursement API is as below

                         

                                    import requests
                                    {
                                    "order_id":"533421343",     //Unique 
                                    "name":"john",
                                    "account_number":"0309*********",   // Mobile Wallet Number
                                    "amount":"1000",
                                    “ipn_url”:”https://abc.com/ipn/data”  // where user get callback response in payload 
                                    "type":"jazzcash"    //type will be easypaisa, jazzcash, bank
                                    “bank_code”:”12421”  //only mandatory when type is bank. Bank codes are given in last of Documentation.
                                    }
                                            
                               
                            

Below is the sample expected Form body for disbursement API which needs to be passed

The unencrypted Body mobile wallet disbursement API is as below

            

                    {
                        "data": "547F21830BA5B6DF781A90C963471C5D6822875488C8BBEBA5D912EE6EAD82D232CC7BAD84429E8E388ECA6456
                        29D3173B530B04602C2B00B79197BFBEBA9B0D1EBB387AAD8F95BDBFAE40E2C8E960EAA1F6248041154329CAD3A53B120DA
                        F4A607ABD659019DCC707836F32C841D0C2D70E58B34D094CA923C84BF9E6BC45F4"
                    }
                    

                      
                   

API Response

Below is the sample unencrypted response for disbursement API

Below is the encrypted response against mobile wallet API which consumer will get

               
                
                            { 
                            "encrypted_data": "1f59f5a483cf788775565e13d5030840017568e2665a32cdd090ca0270b61e5cf8ae957030948dffda
                            788217b2e0dcf79b66ecdadd14d7a72259889146ae0fc6751716b5bd1e319f8fa728253552e2fb40e8fe1c838940a5accf692
                            7b06cf2fd560b0814d047a5a7e508814414c3906495876da12e9d17f1626a24d2f26e443524084d01d5240e7b431bd49eaa59
                            f0ec340314c04fa73fbcb60fa618080400eb8f28581ae9e2c2f1b7d367c5c0cad455"
                            }

                  
               

Sample Snaps for Consumer

Status Inquiry API

API consumers will pass API body as encrypted and will also expect response in encrypted form. Encryption algorithm along with keys to be shared while integration onboarding.

AES -128 -CBC with HEX (BASE16) notation applied for encryption/decryption. API keys to be shared separately.

https://www.devglan.com/online-tools/aes-encryption-decryption // You can use this reference for encryption and decryption.

Api Details

Below is the API signature.

Url

API Header

Following is the sample header APIs..

1. PublicKey : ae32030e4f15d2a2d4a425e3a8fc69af6285ec
2. SecretKey : 67c184cd2f9094ed4f84125b9d9a41941db74
3. AesKey : I7kEZ8gCFPHA7V
4. AesIv : AVXd9CylwhDhbh

API Request Body Specification

Below is the sample expected Form body for disbursement API which needs to be passed

API Response

Below is the sample unencrypted response for disbursement API

Below is the encrypted response against mobile wallet API which consumer will get

Disbursement Status Codes

Every Disbursement/Payout API in this documentation — including the Status Inquiry API and the Mobile Wallet & IBFT disbursement API — reports transaction state using the order_status field. Regardless of which endpoint is called, this field can only ever return one of the three standardized values below. Integrators should design their systems to handle all three states.

Note: Pending is always the initial state of a disbursement. A payout only transitions to Paid or Declined once processing by the payout channel has completed; these two are terminal states and will not change further.

IPN / Callback Response

The callback response will be sent to the IPN URL provided by the merchant in the ipn_url parameter. For Collection/Payin APIs, the callback response will be received in JSON format. For Disbursement/Payout APIs, the callback response will be received in encrypted format, and the user must decrypt it using their own provided keys.

Decrypting the Disbursement IPN / Callback

Disbursement/Payout callbacks are encrypted using the same algorithm and keys issued during integration onboarding — AES-128-CBC with HEX (BASE16) notation. These are the identical AesKey and AesIv values used to encrypt requests for the Disbursement APIs (see Mobile Wallet & IBFT and Status Inquiry API).

1. Algorithm: AES-128-CBC
2. Encoding: HEX (BASE16)
3. Key: AesKey — shared during integration onboarding
4. IV: AesIv — shared during integration onboarding

Raw Callback Payload

The callback body posted to your ipn_url will look like this:

{
  "encrypted_data": "1f59f5a483cf788775565e13d5030840017568e2665a32cdd090ca0270b61e5cf8ae957030948dffda788217b2e0dcf79b66ecdadd14d7a72259889146ae0fc6751716b5bd1e319f8fa728253552e2fb40e8fe1c838940a5accf6927b06cf2fd560b0814d047a5a7e508814414c3906495876da12e9d17f1626a24d2f26e443524084d01d5240e7b431bd49eaa59f0ec340314c04fa73fbcb60fa618080400eb8f28581ae9e2c2f1b7d367c5c0cad455"
}

Decryption Steps

1. Read the encrypted_data value from the callback body.
2. HEX-decode the string into raw bytes.
3. Decrypt the bytes using AES-128-CBC with your AesKey as the key and AesIv as the initialization vector.
4. Remove PKCS7 padding from the decrypted output.
5. Parse the resulting plaintext as UTF-8 JSON.

You can validate your implementation using devglan's AES encryption/decryption tool — set the mode to CBC, the output type to HEX, and supply your AesKey and AesIv.

Decrypted Payload

Once decrypted, the callback resolves to a JSON object identical in shape to the Status Inquiry API response:

{
  "order_id": "5334321343",
  "amount": "100",
  "order_status": "Paid",
  "type": "jazzcash",
  "number": "03096698418",
  "response": ""
}

Note: The decrypted order_status will always be one of the three values described in Disbursement Status Codes — Pending, Paid, or Declined. Since Pending is a non-final state, most integrations only receive a callback once the status has settled to Paid or Declined.

Bank code list

Use this documentation to seamlessly integrate payment functionalities into your application, ensuring a smooth user experience for managing wallets and processing transactions.