Developer Documentation

Overview

General Overview

GG Pay BD is an online payment automation platform designed for websites, applications and digital businesses. Using our REST API, you can create payment requests and automatically receive payment status information.

Our API-based payment system allows your application to redirect customers to the payment page and receive the transaction result after the payment process is completed.

Setup Your Panel

API Credentials

Your application requires the following credentials to communicate securely with GG Pay BD.

• API Key — identifies your application.
• Secret Key — authenticates your API requests.
• Host Name — your registered website domain.

Payment Environment

GG Pay BD currently provides a live environment for processing real transactions.

REST API

Create Payment

Send a POST request to the GG Pay BD payment endpoint to create a new payment session.

Request Parameters

Request Headers

Payment Create Code

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => 'https://pay.ggtopup.shop/request/payment/create',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_FOLLOWLOCATION => false,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'POST',

    CURLOPT_POSTFIELDS => array(
        'cus_name' => 'Demo User',
        'cus_email' => 'demo@gmail.com',
        'amount' => '10',
        'success_url' => 'https://example.com/success.php',
        'cancel_url' => 'https://example.com/cancel.php'
    ),

    CURLOPT_HTTPHEADER => array(
        'app-key: YOUR_API_KEY',
        'secret-key: YOUR_SECRET_KEY',
        'host-name: example.com'
    ),
));

$response = curl_exec($curl);

curl_close($curl);

echo $response;

?>

<?php

use GuzzleHttp\Client;
use GuzzleHttp\Psr7\Request;

$client = new Client();

$headers = [
    'app-key' => 'YOUR_API_KEY',
    'secret-key' => 'YOUR_SECRET_KEY',
    'host-name' => 'example.com'
];

$options = [
    'multipart' => [

        [
            'name' => 'cus_name',
            'contents' => 'Demo User'
        ],

        [
            'name' => 'cus_email',
            'contents' => 'demo@gmail.com'
        ],

        [
            'name' => 'amount',
            'contents' => '10'
        ],

        [
            'name' => 'success_url',
            'contents' => 'https://example.com/success.php'
        ],

        [
            'name' => 'cancel_url',
            'contents' => 'https://example.com/cancel.php'
        ]

    ]
];

$request = new Request(
    'POST',
    'https://pay.ggtopup.shop/request/payment/create',
    $headers
);

$response = $client
    ->sendAsync($request, $options)
    ->wait();

echo $response->getBody();

?>

const axios = require('axios');
const FormData = require('form-data');

const data = new FormData();

data.append('cus_name', 'Demo User');
data.append('cus_email', 'demo@gmail.com');
data.append('amount', '10');

data.append(
    'success_url',
    'https://example.com/success.php'
);

data.append(
    'cancel_url',
    'https://example.com/cancel.php'
);

const config = {
    method: 'post',

    url: 'https://pay.ggtopup.shop/request/payment/create',

    headers: {
        'app-key': 'YOUR_API_KEY',
        'secret-key': 'YOUR_SECRET_KEY',
        'host-name': 'example.com',
        ...data.getHeaders()
    },

    data: data
};

axios.request(config)

.then((response) => {
    console.log(response.data);
})

.catch((error) => {
    console.error(error);
});

Payment Response

After the payment request is successfully created, the customer can be redirected to the payment page.

Successful Payment

Failed / Cancelled Payment

Returned Parameters

Verify Payment

Always verify the transaction from your server before marking an order as paid. Do not rely only on frontend redirect parameters.

Verify Endpoint

Verify Parameters

PHP Verification

<?php

$curl = curl_init();

curl_setopt_array($curl, array(

    CURLOPT_URL => 'https://pay.ggtopup.shop/request/payment/verify',

    CURLOPT_RETURNTRANSFER => true,

    CURLOPT_ENCODING => '',

    CURLOPT_MAXREDIRS => 10,

    CURLOPT_TIMEOUT => 30,

    CURLOPT_FOLLOWLOCATION => false,

    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,

    CURLOPT_CUSTOMREQUEST => 'POST',

    CURLOPT_POSTFIELDS => array(
        'transaction_id' => 'TRANSACTION_ID'
    ),

    CURLOPT_HTTPHEADER => array(
        'app-key: YOUR_API_KEY',
        'secret-key: YOUR_SECRET_KEY',
        'host-name: example.com'
    ),

));

$response = curl_exec($curl);

curl_close($curl);

echo $response;

?>

Verification Response

{
    "cus_name": "Demo User",
    "cus_email": "demo@gmail.com",
    "amount": "10",
    "transaction_id": "JJTG987652",
    "status": "1",
    "message": "success"
}

Response Status

Available Modules

Ready-to-use integrations can be provided for supported platforms.