API Documentation
  1. Merchant
API Documentation
  • API Documentation Change Log
  • API Reference Guide
    • Checkout Page
    • Payin - KRW (Server to Server)
    • Purpose Code
    • Payout Payload Example
    • List of Payin Methods
    • List of Bank for Payout Methods
  • API Documentation
    • Master Data
      • Get All Country & Currency Code
    • Payout Method
      • Get All Payout Method
    • Payin Method
      • Get All Payin Method
      • Get Required Fields by Payin method
    • Payin
      • Create Payin
      • Simulate Payin
      • Retrieve Payin
      • Create Virtual Account
    • Payout
      • Create Payout
      • Simulate Payout
      • Retrieve Payout
      • Get All Payout
    • Checkout
      • Create Payment Request
      • Get All Checkout
      • Get Detail Checkout
      • Create Virtual Account [KRW]
      • Get VA Bank Information [KRW]
      • Create New Checkout
    • Customer
      • Create Customer
      • Update Customer
      • Get All Customer
      • Get Detail Customer by Id
      • Check Is Customer Wallet Ready
      • Enable Customer
      • Disable Customer
      • Delete Customer
    • Webhook
      • Webhook PAYIN SUCCESS
      • Webhook PAYOUT SUCCESS
      • Webhook PAYOUT FAILED
      • VA Register Callback
      • Webhook PAYIN EXPIRED
    • Merchant
      • Get Balance Payout
        GET
    • Get List Payment Method by Currency
      GET
  • Features Documentation
    • Dashboard
    • Transaction
      • Payin
      • Payout
      • Rolling Reserve
      • Refund Request
    • Finance
      • Settlement Report APM
      • Settlement Report CARD
      • History Balance APM
      • History Balance CARD
    • Account
      • Profile Account
      • Manage Users
    • Setting
      • Integration Details
  1. Merchant

Get Balance Payout

GET
/api/v1/merchant/balance/{currency}
This API retrieves the available payout balance for a specific currency. To get the data, you must provide the currency code (e.g., USD, IDR, KRW) as an input. The response will return the current available balance for that currency, which is useful for validating whether sufficient funds are available before processing a payout.

Request

Path Params

Header Params

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.paycombat.com/api/v1/merchant/balance/AUD' \
--header 'X-token: snd_eyJpdiI6Inhxd2FacEtmY2hIdjhHbmMzY2lxNGc9PSIsInZhbHVlIjoiQVp0M3BIVC9LaXdiWGhtREVtcWJVRlJyOGl0ak55UUhDL1NJeGgvL1ZzOElnMUxqcWYybVJ5T0ZFTGpqd0xNZSIsIm1hYyI6IjE4ZGFkZjBhOTkwMTQ4NzNmMGU1YjI1YjkxMTZlODlhMGYzNTM2NjI5NjY5OGFhODQ5NGViZDEyYTNjMjljNzgiLCJ0YWciOiIifQ=='

Responses

🟢200Success
application/json
Body

Example
{
    "status": true,
    "message": "OK",
    "data": {
        "currency": "VND",
        "balance_available": 194970
    }
}
🟠400Bad Request
Modified at 2025-08-07 08:14:35
Previous
Webhook PAYIN EXPIRED
Next
Get List Payment Method by Currency