---
title: "Payout Bank"
method: GET
path: "/v3/metadata/payout/bank"
---

# Payout Bank

`GET /v3/metadata/payout/bank`

## Request

- Base URL: `https://service-sandbox.tazapay.com`
- URL: `https://service-sandbox.tazapay.com/v3/metadata/payout/bank`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/tazapay/apis/sandbox/docs/v3/metadata/payout/bank/get.ts> (a function with typed inputs; its response is checked against the schema)

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.

## Query parameters

- `country` string, required
- `currency` string

## Response `200`

200

- object
  - `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.
    - `payout_methods` object[]: List of payout methods available for the specified country and currency.
      - `beneficiary_type` string[]: Specifies the types of beneficiaries supported for this payout method (e.g., individual or business).
      - `country` string: Country code (ISO 3166-1 alpha-2) for which the payout method is available.
      - `currency` string: Currency supported for the payout method (ISO 4217 format).
      - `custom_remitter_support` boolean: Indicates whether the payout method supports custom remitters (different sender names).
      - `payout_type` string: Specifies the payout delivery channel or type (e.g., 'local', 'swift').
      - `required_bank_codes` string[]: List of bank codes required for this payout method (e.g., SWIFT, IFSC).
      - `required_bank_fields` string[]: List of required bank information fields that must be provided to initiate the payout.
      - `required_beneficiary_fields` string[]: List of required beneficiary information fields that must be provided to complete the payout, typically address-related fields.
      - `fund_transfer_networks` object[]: List of supported fund transfer networks for local payouts. Each object contains network details including name, preference support, and transfer limits.
        - `name` string: Name of the fund transfer network
        - `remitter_preference_support` boolean: Indicates if the network can be specified in the payout request
        - `additional_information` string: Any additional information stored against the network
        - `transfer_limit` object: Transfer limits specific to the network
          - `currency` string: Currency code
          - `maximum` number: Maximum transfer amount
          - `minimum` number: Minimum transfer amount
      - `recommended_fields` object: These are conditionally required fields. Recommend to add them to make your payouts compatible with all our PSPs and hence lower the failure rates.
        - `recommended_bank_codes` string[]: Recommended Bank codes
        - `recommended_bank_fields` string[]: Recommended Bank Fields
        - `recommended_beneficiary_fields` string[]: Recommended Beneficiary Fields
      - `supported_destinations` string[]: List of supported destination countries or payout corridors for this method, if applicable.
      - `transfer_limit` object: Defines the minimum and maximum payout limits for the given payout method.
        - `currency` string: Currency in which the transfer limits are defined.
        - `maximum` integer: Maximum allowable payout amount in the smallest currency unit (e.g., cents).
        - `minimum` integer: Minimum allowable payout amount in the smallest currency unit (e.g., cents).

## Other responses

- `400`: Bad Request

---

[API](https://skmtc.dev/tazapay/apis/sandbox.md) - [All operations](https://skmtc.dev/tazapay/apis/sandbox/llms.txt) - [OpenAPI document](https://skmtc.dev/tazapay/apis/sandbox/revisions/bf5f4b8f6f5d?raw)