YfpayYfpay
  • Introduction
  • Signing API requests
  • Receive money
  • Get a transaction for receive money
  • Webhook for receive money
  • Send money
  • Get a transaction for send money
  • Webhook for send money
  • Account Balance
  • All Channels
  • Responses
  • Brazil
  • China
  • India
  • Indonesia
  • Mexico
  • Nigeria
  • Philippines
  • South Africa
  • Thailand
  • Ukraine
  • Vietnam
  • Usdt
  • English
  • 简体中文
  • Introduction
  • Signing API requests
  • Receive money
  • Get a transaction for receive money
  • Webhook for receive money
  • Send money
  • Get a transaction for send money
  • Webhook for send money
  • Account Balance
  • All Channels
  • Responses
  • Brazil
  • China
  • India
  • Indonesia
  • Mexico
  • Nigeria
  • Philippines
  • South Africa
  • Thailand
  • Ukraine
  • Vietnam
  • Usdt
  • English
  • 简体中文
  • Guide

    • Introduction
    • Signing API requests
    • Receive money
    • Get a transaction for receive money
    • Webhook for receive money
    • Send money
    • Get a transaction for send money
    • Webhook for send money
    • Account Balance
    • All Channels
    • Responses

Account Balance

GET /api/v1/user/balances

HTTP headers Header

KeyValue
Acceptapplication/json

Query parameters Query

KeyTypeRequiredSignDescription
client_keystringYesYesThe API access key.
signaturestringYesNoSigned value.

Request example

curl -X GET \
  https://example.com/api/v1/user/balances?client_key=01h6tn69wfcpy5q5x3vpb3x9me&signature=ba5df26991273c746960ce5238c6479e8ca6116381ac46cea96ffd30fafed082 \
  -H "Accept: application/json"

Response parameters

KeyTypeDescription
client_keystringThe API access key.
available_fundsstringAvailable funds of your account.
locked_fundsstringLocked funds of your account.
currencystringThe currency code.

Response example

{
  "client_key": "01h6tn69wfcpy5q5x3vpb3x9me",
  "available_funds": "16055.90",
  "locked_funds": "0.00",
  "currency": "BRL"
}
Prev
Webhook for send money
Next
All Channels