Yuansfer DOCS
  • Introduction
  • GUIDE
    • Online Payment
    • Point of Sale
      • Scan QR Code
      • Create QR Code
    • Plugins
    • Payment Methods
    • Financial Report
    • Security
    • Incident Priorities
    • SDK
    • Tutorials & Examples
      • PHP SDK
      • JAVA SDK
      • C# SDK
      • JS SDK
  • API REFERENCE V3
    • Sandbox Environment
      • Apply Sandbox Credentials
    • Signing API Parameters
    • Customers
      • Register Customer
      • Retrieve Customer
      • Update Customer
    • Payments
      • Online Payment
        • Yuansfer Checkout
        • Yuansfer Integrated Payment
          • Braintree Payments
          • Prepay
        • Recurring Payments
          • Authorize
          • Apply Token
          • Pay
          • Revoke
      • Point of Sale Payment
        • Scan QR Code
          • Add
          • Prepay
        • Create QR Code
    • Transaction Revert
      • Refund
      • Cancel
    • Transaction Data Search
      • Transaction Query
    • Payouts
      • Create Payee
      • Retrieve Payee
      • Balance
      • Send Money
      • Search Payments
    • Notes
  • 中文
Powered by GitBook
On this page

Was this helpful?

  1. API REFERENCE V3
  2. Payouts

Balance

Use payout balance api to find out the available balance in your payor account.

Balance

POST https://mapi.yuansfer.com/v3/payouts/balance

Request Body

Name
Type
Description

timestamp

string

Current UTC time, Correct format should be: "yyyy-MM-ddTHH:mm:ssZ"

currency

string

The payout currency associate with payor account. It has to be three-letters currency code.

merchantNo

string

Merchant ID

storeNo

string

Store ID

verifySign

string

The parameter signature

{
    "balance": [
        {
            "amount": 499000.00,
            "currency": "USD"
        }
    ],
    "ret_msg": "success",
    "ret_code": "000100"
}

Response

Parameter

Type

Description

balance

array-object

The balance array-object.

ret_msg

string

The response return message.

ret_code

string

Result Array-Object

Parameter

Type

Description

amount

number

The transaction amount.

currency

string

The three-character currency code that identifies the currency.

PreviousRetrieve PayeeNextSend Money

Last updated 3 years ago

Was this helpful?

The response return code. For more details, see .

here