Introduction

Welcome to the automatedBD payment integration. Use our API to create invoices and process payments securely.

Base URL: https://payment.automatedbd.com/api

Authentication

Authenticate your requests by passing your API Key and Secret in the request headers.

x-api-key: YOUR_PUBLIC_KEY
x-api-secret: YOUR_SECRET_KEY

POST

Create Invoice

Create a new payment invoice and get the payment URL to redirect your customer.

/payment/create

Body Parameters

Field	Req	Description
amount	Yes	Payment amount (Numeric).
customer_name	Yes	Full name (Max 255 chars).
transaction_reference	Yes	Unique ID (Max 20 chars).
callback_url	Yes	Redirect URL after payment.

curl -X POST https://payment.automatedbd.com/api/payment/create \
  -H "x-api-key: YOUR_KEY" \
  -H "x-api-secret: YOUR_SECRET" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 100,
    "customer_name": "John Doe",
    "transaction_reference": "TRX123456",
    "callback_url": "https://yoursite.com/callback"
  }'

$client = new \GuzzleHttp\Client();
$response = $client->post('https://payment.automatedbd.com/api/payment/create', [
    'headers' => [
        'x-api-key' => 'YOUR_KEY',
        'x-api-secret' => 'YOUR_SECRET',
    ],
    'json' => [
        'amount' => 100,
        'customer_name' => 'John Doe',
        'transaction_reference' => 'TRX123456',
        'callback_url' => 'https://yoursite.com/callback'
    ]
]);

const axios = require('axios');

await axios.post('https://payment.automatedbd.com/api/payment/create', {
    amount: 100,
    customer_name: 'John Doe',
    transaction_reference: 'TRX123456',
    callback_url: 'https://yoursite.com/callback'
}, {
    headers: { 
        'x-api-key': 'YOUR_KEY',
        'x-api-secret': 'YOUR_SECRET'
    }
});

Success Response (200 OK)

{
  "status": "success",
  "invoice_id": "ATINV17038392001234",
  "payment_url": "https://automatedbd.com/methods/eyJpdiI6..."
}

GET

Check Payment Status

Verify the status of a transaction using the Invoice ID or Transaction Reference.

Endpoint Definition

GET
                        /payment/{id}

*{id} can be the invoice_number OR transaction_reference.

curl https://payment.automatedbd.com/api/payment/ATINV1703839200 \
  -H "x-api-key: YOUR_KEY" \
  -H "x-api-secret: YOUR_SECRET"

$client = new \GuzzleHttp\Client();
$response = $client->get('https://payment.automatedbd.com/api/payment/ATINV1703839200', [
    'headers' => [
        'x-api-key' => 'YOUR_KEY',
        'x-api-secret' => 'YOUR_SECRET',
    ]
]);
$data = json_decode($response->getBody(), true);

const axios = require('axios');

const response = await axios.get('https://payment.automatedbd.com/api/payment/ATINV1703839200', {
    headers: {
        'x-api-key': 'YOUR_KEY',
        'x-api-secret': 'YOUR_SECRET'
    }
});
console.log(response.data);

import requests

headers = {
    'x-api-key': 'YOUR_KEY',
    'x-api-secret': 'YOUR_SECRET'
}
response = requests.get('https://payment.automatedbd.com/api/payment/ATINV1703839200', headers=headers)
print(response.json())

Response

{
  "invoice_id": "ATINV17038392001234",
  "status": "paid",
  "amount_paid": 100,
  "paid_at": "2023-12-29T14:30:00Z"
}

POST

Batch Check Payment Status

Check the status of multiple transactions in a single request.

/payment/batch/status

Body Parameters

Field	Req	Description
ids	Yes	Array of invoice IDs or transaction refs.

curl -X POST https://payment.automatedbd.com/api/payment/batch/status \
  -H "x-api-key: YOUR_KEY" \
  -H "x-api-secret: YOUR_SECRET" \
  -H "Content-Type: application/json" \
  -d '{
    "ids": ["ATINV123", "TRX456"]
  }'

$client = new \GuzzleHttp\Client();
$response = $client->post('https://payment.automatedbd.com/api/payment/batch/status', [
    'headers' => [
        'x-api-key' => 'YOUR_KEY',
        'x-api-secret' => 'YOUR_SECRET',
    ],
    'json' => [
        'ids' => ['ATINV123', 'TRX456']
    ]
]);
$data = json_decode($response->getBody(), true);

const axios = require('axios');

const response = await axios.post('https://payment.automatedbd.com/api/payment/batch/status', {
    ids: ['ATINV123', 'TRX456']
}, {
    headers: {
        'x-api-key': 'YOUR_KEY',
        'x-api-secret': 'YOUR_SECRET'
    }
});
console.log(response.data);

Response

{
  "status": "success",
  "total_requested": 2,
  "total_found": 2,
  "invoices": [
    {
      "invoice_id": "ATINV123",
      "transaction_reference": "REF1",
      "status": "paid",
      "amount": 100,
      "amount_paid": 100
    },
    {
      "invoice_id": "ATINV456",
      "transaction_reference": "REF2",
      "status": "pending",
      "amount": 500,
      "amount_paid": 0
    }
  ],
  "not_found_ids": []
}

Callback & Redirect URL

After the payment is completed or cancelled, users will be automatically redirected to your callback URL with query parameters containing the payment status and details.

Success Redirect


                            {callback_url}?status=success&invoice_id={invoice_id}&transaction_reference={transaction_ref}

User is redirected here when payment is successful.

Cancel Redirect


                            {callback_url}?status=cancel&invoice_id={invoice_id}&transaction_reference={transaction_ref}

User is redirected here when payment is cancelled.

Query Parameters

Parameter	Description	Example
status	Payment status (success or cancel)	success
invoice_id	Generated invoice number	ATINV1703856789123
transaction_reference	Your unique transaction reference	TXN123456

// Handle callback in your PHP application
// Route: https://yoursite.com/payment/callback

$status = $_GET['status']; // 'success' or 'cancel'
$invoiceId = $_GET['invoice_id'];
$transactionRef = $_GET['transaction_reference'];

if ($status === 'success') {
    // Verify payment status with API
    $client = new \GuzzleHttp\Client();
    $response = $client->get("https://payment.automatedbd.com/api/payment/{$invoiceId}", [
        'headers' => [
            'x-api-key' => 'YOUR_API_KEY',
            'x-api-secret' => 'YOUR_API_SECRET',
        ]
    ]);
    
    $paymentData = json_decode($response->getBody(), true);
    
    if ($paymentData['status'] === 'paid') {
        // Payment confirmed - update your database
        // Mark order as paid, send confirmation email, etc.
        echo "Payment successful!";
    }
} else {
    // Payment was cancelled
    echo "Payment cancelled by user.";
}

// Handle callback in your Node.js/Express application
// Route: GET /payment/callback

app.get('/payment/callback', async (req, res) => {
    const { status, invoice_id, transaction_reference } = req.query;
    
    if (status === 'success') {
        try {
            // Verify payment status with API
            const axios = require('axios');
            const response = await axios.get(
                `https://payment.automatedbd.com/api/payment/${invoice_id}`,
                {
                    headers: {
                        'x-api-key': 'YOUR_API_KEY',
                        'x-api-secret': 'YOUR_API_SECRET'
                    }
                }
            );
            
            if (response.data.status === 'paid') {
                // Payment confirmed - update your database
                // Mark order as paid, send confirmation email, etc.
                res.send('Payment successful!');
            }
        } catch (error) {
            console.error(error);
            res.status(500).send('Error verifying payment');
        }
    } else {
        // Payment was cancelled
        res.send('Payment cancelled by user.');
    }
});

# Handle callback in your Python/Flask application
# Route: /payment/callback

from flask import Flask, request
import requests

@app.route('/payment/callback')
def payment_callback():
    status = request.args.get('status')
    invoice_id = request.args.get('invoice_id')
    transaction_reference = request.args.get('transaction_reference')
    
    if status == 'success':
        # Verify payment status with API
        headers = {
            'x-api-key': 'YOUR_API_KEY',
            'x-api-secret': 'YOUR_API_SECRET'
        }
        
        response = requests.get(
            f'https://payment.automatedbd.com/api/payment/{invoice_id}',
            headers=headers
        )
        
        payment_data = response.json()
        
        if payment_data['status'] == 'paid':
            # Payment confirmed - update your database
            # Mark order as paid, send confirmation email, etc.
            return 'Payment successful!'
    else:
        # Payment was cancelled
        return 'Payment cancelled by user.'

Important: Always verify the payment status by calling the GET /payment/{id} endpoint after receiving the callback. Never trust the callback parameters alone for order fulfillment.

Payout API

Use the Payout API to send funds to your users/customers. Perfect for withdrawals, refunds, and disbursements.

Payout methods must be configured in your Store settings before using the API.

GET

Get Payout Methods

Retrieve the list of available payout methods configured for your store.

/payout/methods

curl https://payment.automatedbd.com/api/payout/methods \
  -H "x-api-key: YOUR_KEY" \
  -H "x-api-secret: YOUR_SECRET"

$client = new \GuzzleHttp\Client();
$response = $client->get('https://payment.automatedbd.com/api/payout/methods', [
    'headers' => [
        'x-api-key' => 'YOUR_KEY',
        'x-api-secret' => 'YOUR_SECRET',
    ]
]);
$methods = json_decode($response->getBody(), true);

const axios = require('axios');

const response = await axios.get('https://payment.automatedbd.com/api/payout/methods', {
    headers: {
        'x-api-key': 'YOUR_KEY',
        'x-api-secret': 'YOUR_SECRET'
    }
});
console.log(response.data);

Response

{
  "status": "success",
  "data": [
    {
      "id": 1,
      "name": "bKash",
      "type": "mobile_banking",
      "account_type": "Personal",
      "currency": "BDT",
      "min_amount": 100,
      "max_amount": 50000,
      "logo": "https://payment.automatedbd.com/storage/payout/bkash.png"
    }
  ]
}

POST

Create Payout Request

Initiate a payout to send funds to a recipient.

/payout/request

Body Parameters

Field	Req	Description
payout_method_id	Yes	Method ID from /payout/methods.
amount	Yes	Payout amount (Numeric).
recipient_name	Yes	Recipient's full name.
recipient_account	Yes	Account number / mobile number.
transaction_reference	Yes	Your unique reference (Max 50 chars).
description	No	Optional note.
callback_url	No	Webhook URL for status updates.

curl -X POST https://payment.automatedbd.com/api/payout/request \
  -H "x-api-key: YOUR_KEY" \
  -H "x-api-secret: YOUR_SECRET" \
  -H "Content-Type: application/json" \
  -d '{
    "payout_method_id": 1,
    "amount": 500,
    "recipient_name": "John Doe",
    "recipient_account": "01712345678",
    "transaction_reference": "WD123456"
  }'

$client = new \GuzzleHttp\Client();
$response = $client->post('https://payment.automatedbd.com/api/payout/request', [
    'headers' => [
        'x-api-key' => 'YOUR_KEY',
        'x-api-secret' => 'YOUR_SECRET',
    ],
    'json' => [
        'payout_method_id' => 1,
        'amount' => 500,
        'recipient_name' => 'John Doe',
        'recipient_account' => '01712345678',
        'transaction_reference' => 'WD123456'
    ]
]);

const axios = require('axios');

await axios.post('https://payment.automatedbd.com/api/payout/request', {
    payout_method_id: 1,
    amount: 500,
    recipient_name: 'John Doe',
    recipient_account: '01712345678',
    transaction_reference: 'WD123456'
}, {
    headers: { 
        'x-api-key': 'YOUR_KEY',
        'x-api-secret': 'YOUR_SECRET'
    }
});

Success Response (201 Created)

{
  "status": "success",
  "message": "Payout request created successfully",
  "payout_id": "ATPAY17038392001234",
  "transaction_reference": "WD123456",
  "amount": 500,
  "fee": 0,
  "total_amount": 500,
  "status": "pending"
}

GET

Check Payout Status

Check the status of a payout request using the Payout ID or Transaction Reference.

Endpoint Definition

GET /payout/{id}

*{id} can be the payout_id OR transaction_reference.

curl https://payment.automatedbd.com/api/payout/ATPAY17038392001234 \
  -H "x-api-key: YOUR_KEY" \
  -H "x-api-secret: YOUR_SECRET"

$client = new \GuzzleHttp\Client();
$response = $client->get('https://payment.automatedbd.com/api/payout/ATPAY17038392001234', [
    'headers' => [
        'x-api-key' => 'YOUR_KEY',
        'x-api-secret' => 'YOUR_SECRET',
    ]
]);
$data = json_decode($response->getBody(), true);

const axios = require('axios');

const response = await axios.get('https://payment.automatedbd.com/api/payout/ATPAY17038392001234', {
    headers: {
        'x-api-key': 'YOUR_KEY',
        'x-api-secret': 'YOUR_SECRET'
    }
});
console.log(response.data);

Response

{
  "payout_id": "ATPAY17038392001234",
  "transaction_reference": "WD123456",
  "status": "completed",
  "amount": 500,
  "fee": 0,
  "total_amount": 500,
  "recipient_name": "John Doe",
  "recipient_account": "01712345678",
  "processed_at": "2023-12-29T14:30:00Z",
  "created_at": "2023-12-29T14:00:00Z"
}

Payout Statuses

Status	Description
pending	Payout is awaiting processing.
processing	Payout is being processed.
completed	Payout was successful.
rejected	Payout was rejected by admin.
cancelled	Payout was cancelled.

POST

Batch Check Payout Status

Check the status of multiple payout requests in a single request.

/payout/batch/status

Body Parameters

Field	Req	Description
ids	Yes	Array of payout IDs or transaction refs.

curl -X POST https://payment.automatedbd.com/api/payout/batch/status \
  -H "x-api-key: YOUR_KEY" \
  -H "x-api-secret: YOUR_SECRET" \
  -H "Content-Type: application/json" \
  -d '{
    "ids": ["ATPAY123", "WD456"]
  }'

$client = new \GuzzleHttp\Client();
$response = $client->post('https://payment.automatedbd.com/api/payout/batch/status', [
    'headers' => [
        'x-api-key' => 'YOUR_KEY',
        'x-api-secret' => 'YOUR_SECRET',
    ],
    'json' => [
        'ids' => ['ATPAY123', 'WD456']
    ]
]);
$data = json_decode($response->getBody(), true);

const axios = require('axios');

const response = await axios.post('https://payment.automatedbd.com/api/payout/batch/status', {
    ids: ['ATPAY123', 'WD456']
}, {
    headers: {
        'x-api-key': 'YOUR_KEY',
        'x-api-secret': 'YOUR_SECRET'
    }
});
console.log(response.data);

Response

{
  "status": "success",
  "total_requested": 2,
  "total_found": 2,
  "payouts": [
    {
      "payout_id": "ATPAY123",
      "transaction_reference": "WD123",
      "status": "completed",
      "amount": 500
    },
    {
      "payout_id": "ATPAY456",
      "transaction_reference": "WD456",
      "status": "pending",
      "amount": 1000
    }
  ],
  "not_found_ids": []
}

Introduction

Authentication

Create Invoice

Body Parameters

Check Payment Status

Endpoint Definition

Batch Check Payment Status

Body Parameters

Callback & Redirect URL

Success Redirect

Cancel Redirect

Query Parameters

Available SDKs

PHP Laravel

Node.js

Python

Payout API

Get Payout Methods

Create Payout Request

Body Parameters

Check Payout Status

Endpoint Definition

Payout Statuses

Batch Check Payout Status

Body Parameters