Query Payout Balance API

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

FieldTypeDescription
typestringIndicates validation status (valid if credentials are correct).
resultstringGeneral API result message (Success / Failed).
responsecodestringStandard response code (00 for success).
merchantidstringUnique identifier of the merchant.
tokenstring or nullOptional token field (may be null).
error_code_tagstring or nullError tag if any issue occurs.
error_textstringError or success message text.
descriptionstringAdditional descriptive message.
balanceAmtstringAvailable payout balance.
currencystringCurrency of the balance (e.g., PHP).
maskedcardstringLast 4 digits of the card number.