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))

}

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": "IN",
        "currency": "INR",
        "custom_remitter_support": true,
        "payout_type": "local",
        "delivery_time": null,
        "on_behalf_of_supported": null,
        "supported_modes": [],
        "restricted_purpose_codes": [],
        "cutoff_schedule": null,
        "fund_transfer_networks": [
          {
            "name": "imps",
            "additional_information": "IMPS is used for instant payouts eligible for real-time local clearing on a 24/7 basis.",
            "remitter_preference_support": true,
            "transfer_limit": {
              "currency": "INR",
              "maximum": 50000000,
              "minimum": 100
            },
            "delivery_time": "instant",
            "on_behalf_of_supported": true,
            "supported_modes": [
              "B2B",
              "B2C",
              "C2B",
              "C2C"
            ],
            "restricted_purpose_codes": [],
            "cutoff_schedule": null
          },
          {
            "name": "neft",
            "additional_information": "NEFT settles in batches during banking hours.",
            "remitter_preference_support": true,
            "transfer_limit": {
              "currency": "INR",
              "maximum": 50000000,
              "minimum": 100
            },
            "delivery_time": "next_day, t_plus_2, t_plus_3",
            "on_behalf_of_supported": false,
            "supported_modes": [
              "B2B",
              "B2C"
            ],
            "restricted_purpose_codes": [
              "P0102"
            ],
            "cutoff_schedule": {
              "timezone": "Asia/Kolkata",
              "days": {
                "1": {
                  "open": "09:00",
                  "close": "17:00"
                },
                "2": {
                  "open": "09:00",
                  "close": "17:00"
                },
                "3": {
                  "open": "09:00",
                  "close": "17:00"
                },
                "4": {
                  "open": "09:00",
                  "close": "17:00"
                },
                "5": {
                  "open": "09:00",
                  "close": "15:00"
                }
              }
            }
          }
        ],
        "recommended_fields": {
          "recommended_bank_codes": [],
          "recommended_bank_fields": [],
          "recommended_beneficiary_fields": []
        },
        "required_bank_codes": [
          "ifsc_code"
        ],
        "required_bank_fields": [
          "account_holder_name",
          "bank_name",
          "account_number"
        ],
        "required_beneficiary_fields": [
          "address.line1",
          "address.city",
          "address.state",
          "address.postal_code"
        ],
        "supported_destinations": [],
        "transfer_limit": {
          "currency": "INR",
          "maximum": 50000000,
          "minimum": 100
        }
      },
      {
        "beneficiary_type": [
          "individual",
          "business"
        ],
        "country": "IN",
        "currency": "OMR",
        "custom_remitter_support": true,
        "payout_type": "swift",
        "delivery_time": "next_day",
        "on_behalf_of_supported": false,
        "supported_modes": [
          "B2B",
          "B2C",
          "C2B",
          "C2C"
        ],
        "restricted_purpose_codes": [],
        "cutoff_schedule": {
          "timezone": "Asia/Singapore",
          "days": {
            "1": {
              "open": "08:30",
              "close": "18:30"
            },
            "2": {
              "open": "08:30",
              "close": "18:30"
            },
            "3": {
              "open": "08:30",
              "close": "18:30"
            },
            "4": {
              "open": "08:30",
              "close": "18:30"
            },
            "5": {
              "open": "08:30",
              "close": "18:30"
            }
          }
        },
        "fund_transfer_networks": [],
        "recommended_fields": {
          "recommended_bank_codes": [],
          "recommended_bank_fields": [],
          "recommended_beneficiary_fields": []
        },
        "required_bank_codes": [
          "swift_code"
        ],
        "required_bank_fields": [
          "account_holder_name",
          "bank_name",
          "account_number"
        ],
        "required_beneficiary_fields": [
          "address.line1",
          "address.city",
          "address.state",
          "address.postal_code"
        ],
        "supported_destinations": [],
        "transfer_limit": {
          "currency": "OMR",
          "maximum": 3500000000,
          "minimum": 500
        }
      }
    ]
  }
}

"{}"

Metadata

Payout Bank

Returns the payout methods available for a beneficiary country and currency, along with everything you need to build a valid payout request for each of them.

Each entry in payout_methods describes one corridor and covers two things:

What the payout request must contain — required_bank_codes, required_bank_fields, required_beneficiary_fields, recommended_fields, beneficiary_type and transfer_limit. Merchants must adhere to these requirements and keep their integration up to date.
What the corridor can do — delivery_time, on_behalf_of_supported, supported_modes, restricted_purpose_codes and cutoff_schedule. These are informational: they describe the shape of payouts the corridor carries and when they settle. A payout that falls inside what a corridor advertises will pass through.

Where to read the capability fields depends on payout_type. For payout_type: local they are populated on each fund_transfer_networks entry and returned empty (null / []) at the corridor top level, because capabilities such as operating hours and purpose-code restrictions are network-specific (IMPS vs NEFT in India, FPS vs CHATS in Hong Kong). For payout_type: swift they are populated at the corridor top level. Most swift corridors have fund_transfer_networks as an empty array, but certain corridors (such as those routed via a correspondent bank using cross_border_wire) return a fund_transfer_networks entry that carries the network-specific limits. Pass fund_transfer_network=cross_border_wire as a query parameter to retrieve only those corridors. The two levels are mutually exclusive for standard corridors — whichever one applies carries the values and the other is empty, so you never have to reconcile them.

For a field-by-field breakdown of the response object see Payout Bank Metadata Fields, and for worked integration recipes see Using Payout Capability Fields.

GET

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))

}

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": "IN",
        "currency": "INR",
        "custom_remitter_support": true,
        "payout_type": "local",
        "delivery_time": null,
        "on_behalf_of_supported": null,
        "supported_modes": [],
        "restricted_purpose_codes": [],
        "cutoff_schedule": null,
        "fund_transfer_networks": [
          {
            "name": "imps",
            "additional_information": "IMPS is used for instant payouts eligible for real-time local clearing on a 24/7 basis.",
            "remitter_preference_support": true,
            "transfer_limit": {
              "currency": "INR",
              "maximum": 50000000,
              "minimum": 100
            },
            "delivery_time": "instant",
            "on_behalf_of_supported": true,
            "supported_modes": [
              "B2B",
              "B2C",
              "C2B",
              "C2C"
            ],
            "restricted_purpose_codes": [],
            "cutoff_schedule": null
          },
          {
            "name": "neft",
            "additional_information": "NEFT settles in batches during banking hours.",
            "remitter_preference_support": true,
            "transfer_limit": {
              "currency": "INR",
              "maximum": 50000000,
              "minimum": 100
            },
            "delivery_time": "next_day, t_plus_2, t_plus_3",
            "on_behalf_of_supported": false,
            "supported_modes": [
              "B2B",
              "B2C"
            ],
            "restricted_purpose_codes": [
              "P0102"
            ],
            "cutoff_schedule": {
              "timezone": "Asia/Kolkata",
              "days": {
                "1": {
                  "open": "09:00",
                  "close": "17:00"
                },
                "2": {
                  "open": "09:00",
                  "close": "17:00"
                },
                "3": {
                  "open": "09:00",
                  "close": "17:00"
                },
                "4": {
                  "open": "09:00",
                  "close": "17:00"
                },
                "5": {
                  "open": "09:00",
                  "close": "15:00"
                }
              }
            }
          }
        ],
        "recommended_fields": {
          "recommended_bank_codes": [],
          "recommended_bank_fields": [],
          "recommended_beneficiary_fields": []
        },
        "required_bank_codes": [
          "ifsc_code"
        ],
        "required_bank_fields": [
          "account_holder_name",
          "bank_name",
          "account_number"
        ],
        "required_beneficiary_fields": [
          "address.line1",
          "address.city",
          "address.state",
          "address.postal_code"
        ],
        "supported_destinations": [],
        "transfer_limit": {
          "currency": "INR",
          "maximum": 50000000,
          "minimum": 100
        }
      },
      {
        "beneficiary_type": [
          "individual",
          "business"
        ],
        "country": "IN",
        "currency": "OMR",
        "custom_remitter_support": true,
        "payout_type": "swift",
        "delivery_time": "next_day",
        "on_behalf_of_supported": false,
        "supported_modes": [
          "B2B",
          "B2C",
          "C2B",
          "C2C"
        ],
        "restricted_purpose_codes": [],
        "cutoff_schedule": {
          "timezone": "Asia/Singapore",
          "days": {
            "1": {
              "open": "08:30",
              "close": "18:30"
            },
            "2": {
              "open": "08:30",
              "close": "18:30"
            },
            "3": {
              "open": "08:30",
              "close": "18:30"
            },
            "4": {
              "open": "08:30",
              "close": "18:30"
            },
            "5": {
              "open": "08:30",
              "close": "18:30"
            }
          }
        },
        "fund_transfer_networks": [],
        "recommended_fields": {
          "recommended_bank_codes": [],
          "recommended_bank_fields": [],
          "recommended_beneficiary_fields": []
        },
        "required_bank_codes": [
          "swift_code"
        ],
        "required_bank_fields": [
          "account_holder_name",
          "bank_name",
          "account_number"
        ],
        "required_beneficiary_fields": [
          "address.line1",
          "address.city",
          "address.state",
          "address.postal_code"
        ],
        "supported_destinations": [],
        "transfer_limit": {
          "currency": "OMR",
          "maximum": 3500000000,
          "minimum": 500
        }
      }
    ]
  }
}

"{}"

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

payout_type

string

Filter results by payout type. Supported values: local, swift. When omitted, all payout types are returned.

fund_transfer_network

string

Filter results by fund transfer network. For payout_type=swift, pass cross_border_wire to retrieve only correspondent-bank (CRB) corridors. For payout_type=local, any network value is accepted. Ignored when payout_type is not specified.

Response

200

status

string

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

message

string

Additional message providing context or status information about the request.

data

object

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

Show child attributes

API Overview

Tazapay API

JavaScript SDK

Appendix

Payout Bank

Authorizations

Query Parameters

Response