> ## Documentation Index
> Fetch the complete documentation index at: https://docs.rc.cleverhub.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Branch Codes

> You can get branch codes for a payout payment.
Currently we only support branch codes for payout method `vn_bank_vnd`. Branch code is required when:
  - Payout amount is greater than 300,000,000 VND
  - The bank is in the list of banks requiring branch code



## OpenAPI

````yaml /api/openapi/v2-reference.yaml get /v2/payouts/branch_codes
openapi: 3.0.2
info:
  title: Multi-currency Payment APIs
  description: >-
    ## Introduction

    The Multi-currency Payment API Solution provides developers with a unified
    API schema to support multiple currencies efficiently. These APIs enable
    seamless transactions for both payin and payout operations, ensuring a
    robust, reliable, and scalable payment infrastructure for businesses dealing
    with various currencies.

    ### Key Features

    - **Single API Schema**: A single schema supports all currencies in your
    account, simplifying integration and management.

    - **Payin and Payout Process**:
      - **Step 1**: Call the **Get payin method list** to retrieve the list of supported methods.
      - **Step 2**: Call the **Get payin required fields** to get specific required fields for each method.
      - **Step 3**: Create the payment using the method and required fields from the previous step.
      - **Step 4**: On the sandbox environment, you can call the **Simulate payin** to simulate the payment.

    <div class="gst-note-red">
      Please note: GST should only be set to <code>true</code> for AU Merchants for <b>AUD</b> currency only. For all other currencies, set GST to <code>false</code>.
    </div>

    This documentation provides detailed guidance for integrating these
    capabilities into your application.
  version: 2.0.0
  termsOfService: https://helloclever.co/terms
  contact:
    email: support@helloclever.co
servers:
  - url: https://api.cleverhub.co/api
    description: Sandbox Environment
  - url: https://api-merchant.helloclever.co/api
    description: Production Environment
security:
  - app-id: []
    secret-key: []
paths:
  /v2/payouts/branch_codes:
    get:
      tags:
        - Payout
      summary: Get Branch Codes
      description: >-
        You can get branch codes for a payout payment.

        Currently we only support branch codes for payout method `vn_bank_vnd`.
        Branch code is required when:
          - Payout amount is greater than 300,000,000 VND
          - The bank is in the list of banks requiring branch code
      parameters:
        - name: payout_method_name
          in: query
          schema:
            type: string
          description: Payout method name
          required: true
          example: vn_bank_vnd
        - name: swift_code
          in: query
          schema:
            type: string
          description: SWIFT code
          required: true
          example: SICOVNVX
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  branch_codes:
                    type: array
                    items:
                      type: object
                      properties:
                        branch_code:
                          type: string
                          description: Branch code
                          example: '79600001'
                        branch_name:
                          type: string
                          description: Branch name
                          example: >-
                            NH THE SIAM COMMERCIAL BANK PUBLIC-CN TP HO CHI MINH
                            (NH The Siam Commercial Bank Public)
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
              example:
                errors:
                  code: REQUIRE_LOGIN
                  message: Not Authorised
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: object
                    properties:
                      message:
                        type: string
              example:
                errors:
                  message: Error Lấy danh sách chi nhánh ngân hàng thất bại
components:
  securitySchemes:
    app-id:
      type: apiKey
      in: header
      name: app-id
      description: |
        A unique identifier assigned to each application.
    secret-key:
      type: apiKey
      in: header
      name: secret-key
      description: |
        A secure token associated with the `app-id`.

````

## Related topics

- [Multi-Currency Payout API Reference (v2)](/api/v2/payout.md)
- [Handle Multi-Currency Payins and Payouts](/developer-reference/api-use-cases/handle-multi-currency-payins-and-payouts.md)
- [Create a Payout](/api/payout/create-a-payout.md)
