Skip to main content
GET
/
v3
/
metadata
/
payout
/
bank
Payout Bank
curl --request GET \
  --url https://service-sandbox.tazapay.com/v3/metadata/payout/bank \
  --header 'Authorization: Basic <encoded-value>'
{
  "status": "success",
  "message": "",
  "data": {
    "payout_methods": [
      {
        "beneficiary_type": [
          "individual",
          "business"
        ],
        "country": "HK",
        "currency": "HKD",
        "custom_remitter_support": true,
        "payout_type": "swift",
        "required_bank_codes": [
          "swift_code"
        ],
        "required_bank_fields": [
          "account_holder_name",
          "bank_name",
          "account_number"
        ],
        "fund_transfer_networks": [],
        "recommended_fields": {
          "recommended_bank_codes": [],
          "recommended_bank_fields": [],
          "recommended_beneficiary_fields": []
        },
        "required_beneficiary_fields": [],
        "supported_destinations": [],
        "transfer_limit": {
          "currency": "HKD",
          "maximum": 78000000000,
          "minimum": 100
        }
      },
      {
        "beneficiary_type": [
          "individual",
          "business"
        ],
        "country": "HK",
        "currency": "HKD",
        "custom_remitter_support": false,
        "payout_type": "local",
        "required_bank_codes": [
          "swift_code"
        ],
        "required_bank_fields": [
          "account_holder_name",
          "bank_name",
          "account_number"
        ],
        "fund_transfer_networks": [
          "chats",
          "fps"
        ],
        "recommended_fields": {
          "bank_branch": "optional",
          "account_type": "recommended"
        },
        "required_beneficiary_fields": [
          "address.line1",
          "address.city"
        ],
        "supported_destinations": [],
        "transfer_limit": {
          "currency": "HKD",
          "maximum": 78000000000,
          "minimum": 1
        }
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Query Parameters

​
country
string
required

2-letter ISO country code. For e.g. US for United States

​
currency
string

3-letter currency code. For e.g. USD

Response

200

​
status
string

Indicates whether the request to retrieve available payout methods was successful.

Example:

"success"

​
message
string

Additional message providing context or status information about the request.

Example:

""

​
data
object

Contains the list of available payout methods and their associated details.