BayadGate API Documentation
API reference for payment creation, payout settlement, status queries, signature generation, and asynchronous callbacks.
1.2 Endpoint Directories
Base Gateway URL: https://BayadGate.com/api
| Interface | Endpoint Path | Description |
|---|---|---|
| Create Payment | Initiates consumer payment redirects and transactions. | |
| Asynchronous Callback | Upstream network gateway receiver processing deposits. | |
| Create Payout | Handles withdrawal settlement orders. | |
| Single Status Query | Retrieves concrete data for specific orders. |
2.0 Security & Signature Generation
To prevent malicious request interception, every API interaction with the BayadGate engine must include an MD5 sign string generated using the following procedure:
2.1 Signature Generation Steps
Organize all request parameters alphabetically by their keys.
Standardize keys and values into a query string: k1=v1&k2=v2 (Omit empty fields).
Append your private secret key to the end: &key=your_secret_key.
Convert the combined string into a 32-character lowercase hex signature.
2.2 PHP Reference Code
// Prepare params array
$smm_params = [
'merchant_id' => 7005,
'order_id' => 'TXN2026',
'amount' => '500.00',
'status' => '5'
];
// Alphabetical ascending key sort
ksort($smm_params);
$signStr = "";
foreach ($smm_params as $k => $v) {
if ($v !== "") {
$signStr .= $k . '=' . $v . '&';
}
}
// Append key and generate MD5 hash
$sign = md5(rtrim($signStr, '&') . '&key=' . $merchant_secret);3.0 Create Payment Interface
Initiate consumer checkout paths and deposit redirects.
Request Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| merchant_id | String | Yes | Store ID assigned on BayadGate platform. |
| amount | Number | Yes | Payment value, standardized to 2 decimal places (e.g. 150.00). |
| order_id | String | Yes | Unique merchant transaction invoice tracking reference. |
| payment_method | String | Yes | GCASH, MAYA, or GOTYME. |
| redirect_url | String | Yes | Outbound destination URL for payout/deposit completion webhooks. |
| sign | String | Yes | The 32-character MD5 query verification signature. |
JSON Response Payload
{
"status": "SUCCESS",
"message": "Payment initialised successfully",
"order_id": "TXN2026",
"amount": "150.00",
"payment_url": "https://BayadGate.com/checkout.php?invoice=TXN2026"
}payment_url value from the JSON response and redirect the client's browser session immediately to complete verification.4.0 Withdrawal Payout Interface
Initiate settlements and outward transfers from your merchant wallet balance.
Request Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| merchant_id | String | Yes | Store identifier. |
| amount | Number | Yes | Requested withdrawal payout value (e.g. 500.00). |
| order_id | String | Yes | Withdrawal record tracking reference. |
| bank_code | String | Yes | Channel destination (GCASH, MAYA, or GOTYME). |
| account_name | String | Yes | The destination card holder name or recipient Gcash name. |
| account_no | String | Yes | Receiving mobile wallet phone number or card number. |
| sign | String | Yes | The calculated cryptographic MD5 signature. |
5.0 Asynchronous Notification Webhook (Callback)
BayadGate emits a secure, automated callback notification request to the merchant systems as soon as upstream transactions update to the success state.
SUCCESS to prevent automatic re-queue logic (up to 5 retry attempts).5.1 Outbound Payload Structure
BayadGate triggers the merchant notification endpoint via standard POST parameters:
| Parameter Name | Type | Information and Values |
|---|---|---|
| merchant_id | String | Store client ID string. |
| order_id | String | Original tracking invoice reference. |
| amount | String | Gross transaction value with standard decimals (e.g., 100.00). |
| status | String | Standard transaction outcome. Fixed to success value: 5. |
| sign | String | Cryptographic validation signature generated using your merchant BayadGate secret key. |
Callback endpoint
Gateway callback path: https://BayadGate.com/api/callback.php