Langsung ke konten utama

API INQUIRY BALANCE

smilepayz teamsSekitar 2 menit

API inquiry saldo wilayah USDT (USDT).

Request

The Balance Inquiry API enables merchants to retrieve real-time account balance information for their Smilepayz accounts. This API provides detailed balance information for different account types including pay-in and pay-out accounts.

Request Path:

sandbox: https://sandbox-gateway.smilepayz.com/v2.0/inquiry-balance
production: https://gateway.smilepayz.com/v2.0/inquiry-balance

Header Parameters

FieldRequiredTypeDescription
Content-TypeMStringapplication/json request body.
X-TIMESTAMPMStringDatetime with zone offset, format yyyy-MM-ddTHH:mm:ss±HH:mm
X-SIGNATUREMStringSignature of JSON body (see product Signature doc).
X-PARTNER-IDMStringYour merchantID

Body Parameters

FieldRequiredTypeDescription
accountNoMString(128)Settlement accountNo if gateway returns it.
balanceTypesMList(String)Balance type specifications to retrieve Format: Array of predefined balance type codes Default: ["BALANCE"] Examples: BALANCE Used to specify which balance types to query

Important Notes

1. Sandbox Environment: accountNo uses randomly generated string values for testing purposes
2. Production Environment: accountNo can be retrieved from the merchant backend system.
See How to Get Production Account Number
3. Pay-In Account: Used for collecting funds from all incoming payment transactions
4. Pay-Out Account: Used for processing disbursement and withdrawal transactions
5. Account Transfers: Balances can be transferred between different account types.

Example Body – Balance Inquiry Request:

Content-type: application/json
X-TIMESTAMP: 2020-12-18T15:06:00+07:00
X-SIGNATURE: 85be817c55b2c135157c7e89f52499bf0c25ad6eeebe04a986e8c862561b19a5
X-PARTNER-ID: 20001

Response

HTTP Response

FieldRequiredTypeDescription
Content-TypeMStringapplication/json response or callback body.
X-TIMESTAMPMStringDatetime with zone offset, format yyyy-MM-ddTHH:mm:ss±HH:mm

Body Parameters

FieldRequiredTypeDescription
codeMString00 success, other values error.
messageMStringUTF-8 human-readable result line.
accountNoOStringSettlement accountNo if gateway returns it.
nameOStringBeneficiary full name (UTF-8).
balanceTypesOArrayRequested balance type specifications Format: Array of predefined balance type codes Examples: ["BALANCE"] Indicates which balance types were queried
accountInfosMObjectDetailed balance information container Contains comprehensive balance details for the specified account
    balanceTypeMStringType of balance being reported Format: Predefined balance type codes Examples: BALANCE Indicates the specific balance category
    amountMObjectAmount
        currencyMStringFixed to USDT.
        valueMStringBalance amount as string value Format: String representation of numeric value Example: "250000" represents USDT 250000 Used for precise balance representation
    availableBalanceMObjectAvailable balance for transactions Contains currency and value information May differ from total balance due to holds or restrictions See see Money model
        currencyMStringFixed to USDT.
        valueMStringAvailable balance amount as string value Format: String representation of numeric value Example: "250000" represents USDT 250000 Used for precise available balance representation
Content-type: application/json 
X-TIMESTAMP: 2020-12-17T10:55:00+07:00