Help Center
VCCHUB How-to
  1. Acquiring
  • Guides
    • Welcome
    • Interface
  • API Reference
    • Introduction
    • Endpoints
    • Data Types
    • Signing
    • 3-D Secure Verification
    • Subscription
    • Errors
    • Webhooks
    • Items Information
    • Changelog
    • Acquiring
      • Create a direct payment
        POST
      • Create a APM payment
        POST
      • Create a redirect (iFrame) payment
        POST
      • Query a transaction
        POST
      • Capture a transaction
        POST
      • Review a transaction
        POST
      • Cancel a transaction
        POST
      • Cancel a subscription
        POST
      • Refund a transaction
        POST
      • Search a refund transaction
        POST
      • Create a payout
        POST
      • Optimise payment methods
        POST
      • Batch Upload Logistics Information
        POST
      • Query a payout transaction
        POST
      • Query Merchant Payout Balance
        POST
      • Query Merchant Unsettled Amount
        POST
    • Issuing
      • Webhook Signature Verification
      • Cardholder
        • Create cardholder
        • Update Cardholder
        • Delete cardholder
        • Query cardholder
      • Group
        • Create group
        • Query group details
        • Delete group
        • Group Card Withdrawal
        • Update group status
        • Recharge group
        • Query rule
      • Card
        • Create a card
        • Query card details
        • Query card transaction
        • Cancel a card
        • Withdraw from a card
        • Update card status
        • Recharge card
        • Update shared card limit
        • Query for card operation
        • Query card BIN
      • Account
        • Query Account Balance
  • Appendix
    • Test Cards
    • Bank Code
    • Country Code
    • Currency Code
    • Payment Methods
  1. Acquiring

Query Merchant Payout Balance

Developing
POST
https://test-api.star-saas.comv1/payouts/balance
Returns the merchant's available Payout Balance that can be used for payout transactions.

Request

Body Params application/x-www-form-urlencodedRequired

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 'https://test-api.star-saas.comv1/payouts/balance' \
--data-urlencode 'merchant_id=1031201' \
--data-urlencode 'account_id=1031201038' \
--data-urlencode 'request_id=REQ_202602270002' \
--data-urlencode 'encryption_data=9683fb87ff9aac3468865a0e0fa9353e974dbe2d529e016df7770bcf58119e0a' \
--data-urlencode 'currency=EUR'

Responses

🟢200Success
application/json
Bodyapplication/json

Example
"account_id": "1031201038",
"data": {
    "available_balance": "8.60",
    "currency": "EUR",
    "frozen_balance": "3.00",
    "last_updated": "2026-02-28T03:08:44Z",
    "total_balance": "11.60"
},
"encryption_data": "0D7F2253B6775854FA19F982002D509A7D19447A2656ECAAA8B00739A2DF4A4E",
"return_message": "OK",
"return_status": "1",
"merchant_id": "1031201",
"request_id": "REQ_202602270002"
Previous
Query a payout transaction
Next
Query Merchant Unsettled Amount