Payout Bank Query API

Overview

The payout bank query API queries the merchant's available payout bank list, including bank ID, bank code, bank name and account type.

API Info

• Endpoint: GET /api/bank
• Method: GET
• Content-Type: application/json

Request Headers

All API requests require the following headers, see API Signature:

Header	Type	Required	Description
Content-Type	string	Y	application/json, fixed
MerchantId	string	Y	Merchant ID provided by Veloraya
Timestamp	string	Y	Current timestamp (ms), anti-replay
Nonce	string	Y	Random string, unique per request, anti-replay
Signature	string	Y	Request signature (RSA), Base64 encoded

Request Parameters

No request parameters; the merchant ID is passed via headers.

Response Format

Field	Type	Description
code	int	200 success, non-200 failure
msg	string	Response message
data	array	Response data, bank list on success

Response Parameters (data)

data is an array; each element contains:

Field	Type	Description
accountType	string	Account type
bankId	string	Bank ID
bankCode	string	Bank code
bankName	string	Bank name

Account type enum

Value	Description
BANK	Bank

Response Example

Success

{
  "code": 200,
  "msg": "SUCCESS",
  "data": [
    {
      "accountType": "BANK",
      "bankId": "355",
      "bankCode": "BAAC",
      "bankName": "BANK FOR AGRICULTURE AND AGRICULTURAL COOPERATIVES"
    }
  ]
}

Notes

• Headers: all required headers must be passed, see API Signature
• Signature: all requests must include a valid signature