Retrieves the current payout balance
Endpoint:
POST https://api.key2payment.com/OmnipayInstaPay/QueryPayoutBalance
🧠 Request
Headers:
Content-Type: application/json
Body:
{
"merchantid": "merchantid",
"password": "merchant password"
}
✅ Successful Response
HTTP Status: 200 OK
{
"type": "valid",
"result": "Success",
"responsecode": "00",
"merchantid": "merchantid",
"token": null,
"error_code_tag": null,
"error_text": "Success",
"description": "Success",
"balanceAmt": "188.7000",
"currency": "PHP",
"maskedcard": "0015"
}
📘 Field Descriptions
| Field | Type | Description |
|---|---|---|
type | string | Indicates validation status (valid if credentials are correct). |
result | string | General API result message (Success / Failed). |
responsecode | string | Standard response code (00 for success). |
merchantid | string | Unique identifier of the merchant. |
token | string or null | Optional token field (may be null). |
error_code_tag | string or null | Error tag if any issue occurs. |
error_text | string | Error or success message text. |
description | string | Additional descriptive message. |
balanceAmt | string | Available payout balance. |
currency | string | Currency of the balance (e.g., PHP). |
maskedcard | string | Last 4 digits of the card number. |