> ## Documentation Index
> Fetch the complete documentation index at: https://developer.tazapay.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 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.



## OpenAPI

````yaml get /v3/metadata/payout/bank
openapi: 3.1.0
info:
  title: sandbox
  version: '3'
servers:
  - url: https://service-sandbox.tazapay.com
security:
  - sec0: []
paths:
  /v3/metadata/payout/bank:
    get:
      summary: Payout Bank
      description: >-
        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.
      operationId: payout-bank
      parameters:
        - name: country
          in: query
          description: 2-letter ISO country code. For e.g. US for United States
          required: true
          schema:
            type: string
        - name: currency
          in: query
          description: 3-letter currency code. For e.g. USD
          schema:
            type: string
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  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:
                            - 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
              schema:
                type: object
                properties:
                  status:
                    type: string
                    description: >-
                      Indicates whether the request to retrieve available payout
                      methods was successful.
                  message:
                    type: string
                    description: >-
                      Additional message providing context or status information
                      about the request.
                  data:
                    type: object
                    description: >-
                      Contains the list of available payout methods and their
                      associated details.
                    properties:
                      payout_methods:
                        type: array
                        description: >-
                          List of payout methods available for the specified
                          country and currency.
                        items:
                          type: object
                          properties:
                            beneficiary_type:
                              type: array
                              description: >-
                                Specifies the types of beneficiaries supported
                                for this payout method (e.g., individual or
                                business).
                              items:
                                type: string
                            country:
                              type: string
                              description: >-
                                Country code (ISO 3166-1 alpha-2) for which the
                                payout method is available.
                            currency:
                              type: string
                              description: >-
                                Currency supported for the payout method (ISO
                                4217 format).
                            custom_remitter_support:
                              type: boolean
                              description: >-
                                Indicates whether the payout method supports
                                custom remitters (different sender names).
                            payout_type:
                              type: string
                              description: >-
                                Specifies the payout delivery channel or type
                                (e.g., 'local', 'swift').
                            required_bank_codes:
                              type: array
                              description: >-
                                List of bank codes required for this payout
                                method (e.g., SWIFT, IFSC).
                              items:
                                type: string
                            required_bank_fields:
                              type: array
                              description: >-
                                List of required bank information fields that
                                must be provided to initiate the payout.
                              items:
                                type: string
                            required_beneficiary_fields:
                              type: array
                              description: >-
                                List of required beneficiary information fields
                                that must be provided to complete the payout,
                                typically address-related fields.
                              items:
                                type: string
                            fund_transfer_networks:
                              type: array
                              description: >-
                                List of supported fund transfer networks for
                                local payouts. Each object contains network
                                details including name, preference support, and
                                transfer limits.
                              items:
                                type: object
                                properties:
                                  name:
                                    type: string
                                    description: Name of the fund transfer network
                                  remitter_preference_support:
                                    type: boolean
                                    description: >-
                                      Indicates if the network can be specified
                                      in the payout request
                                  additional_information:
                                    type: string
                                    description: >-
                                      Any additional information stored against
                                      the network
                                  transfer_limit:
                                    type: object
                                    description: Transfer limits specific to the network
                                    properties:
                                      currency:
                                        type: string
                                        description: Currency code
                                      maximum:
                                        type: number
                                        description: Maximum transfer amount
                                      minimum:
                                        type: number
                                        description: Minimum transfer amount
                            recommended_fields:
                              type: object
                              description: >-
                                These are conditionally required fields.
                                Recommend to add them to make your payouts
                                compatible with all our PSPs and hence lower the
                                failure rates.
                              properties:
                                recommended_bank_codes:
                                  type: array
                                  description: Recommended Bank codes
                                  items:
                                    type: string
                                recommended_bank_fields:
                                  type: array
                                  description: Recommended Bank Fields
                                  items:
                                    type: string
                                recommended_beneficiary_fields:
                                  type: array
                                  description: Recommended Beneficiary Fields
                                  items:
                                    type: string
                            supported_destinations:
                              type: array
                              description: >-
                                List of supported destination countries or
                                payout corridors for this method, if applicable.
                              items:
                                type: string
                            transfer_limit:
                              type: object
                              description: >-
                                Defines the minimum and maximum payout limits
                                for the given payout method.
                              properties:
                                currency:
                                  type: string
                                  description: >-
                                    Currency in which the transfer limits are
                                    defined.
                                maximum:
                                  type: integer
                                  description: >-
                                    Maximum allowable payout amount in the
                                    smallest currency unit (e.g., cents).
                                minimum:
                                  type: integer
                                  description: >-
                                    Minimum allowable payout amount in the
                                    smallest currency unit (e.g., cents).
        '400':
          description: Bad Request
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      deprecated: false
components:
  schemas:
    ErrorResponse:
      type: object
      description: Standard error response structure
      properties:
        status:
          type: string
          enum:
            - error
          description: Always 'error' for error responses
        message:
          type: string
          description: High-level error message
        errors:
          type: array
          description: Array of detailed error objects
          items:
            type: object
            properties:
              code:
                type: integer
                description: Specific error code
              message:
                type: string
                description: Detailed error message
              remarks:
                type: string
                description: Additional context or suggestions for resolution
  securitySchemes:
    sec0:
      type: http
      scheme: basic

````