Payout Bank
curl --request GET \
--url https://service-sandbox.tazapay.com/v3/metadata/payout/bank \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://service-sandbox.tazapay.com/v3/metadata/payout/bank"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://service-sandbox.tazapay.com/v3/metadata/payout/bank', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://service-sandbox.tazapay.com/v3/metadata/payout/bank",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://service-sandbox.tazapay.com/v3/metadata/payout/bank"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Basic <encoded-value>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://service-sandbox.tazapay.com/v3/metadata/payout/bank")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://service-sandbox.tazapay.com/v3/metadata/payout/bank")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
response = http.request(request)
puts response.read_body{
"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": [
{
"additional_information": "CHATS is used for high-value or time-critical payouts requiring real-time gross settlement.",
"name": "chats",
"remitter_preference_support": false,
"transfer_limit": {
"currency": "HKD",
"maximum": 78000000000,
"minimum": 1
}
},
{
"additional_information": "FPS is used for instant payouts eligible for real-time local clearing on a 24/7 basis.",
"name": "fps",
"remitter_preference_support": false,
"transfer_limit": {
"currency": "HKD",
"maximum": 78000000000,
"minimum": 1
}
}
],
"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
}
}
]
}
}"{}"Metadata
Payout Bank
This allows you to check the requirements with respect to bank fields for a given beneficiary country. These requirements will be made live on 30th April 2025, merchants must adhere to these requirements and update the integration on or before the deadline.
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>'import requests
url = "https://service-sandbox.tazapay.com/v3/metadata/payout/bank"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://service-sandbox.tazapay.com/v3/metadata/payout/bank', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://service-sandbox.tazapay.com/v3/metadata/payout/bank",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://service-sandbox.tazapay.com/v3/metadata/payout/bank"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Basic <encoded-value>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://service-sandbox.tazapay.com/v3/metadata/payout/bank")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://service-sandbox.tazapay.com/v3/metadata/payout/bank")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
response = http.request(request)
puts response.read_body{
"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": [
{
"additional_information": "CHATS is used for high-value or time-critical payouts requiring real-time gross settlement.",
"name": "chats",
"remitter_preference_support": false,
"transfer_limit": {
"currency": "HKD",
"maximum": 78000000000,
"minimum": 1
}
},
{
"additional_information": "FPS is used for instant payouts eligible for real-time local clearing on a 24/7 basis.",
"name": "fps",
"remitter_preference_support": false,
"transfer_limit": {
"currency": "HKD",
"maximum": 78000000000,
"minimum": 1
}
}
],
"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
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Query Parameters
2-letter ISO country code. For e.g. US for United States
3-letter currency code. For e.g. USD
Response
200
Was this page helpful?
⌘I