> ## 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 Payout Required Fields

> Certain payout methods may require information to be collected from consumers. This API will provide all the parameters potentially needed for a specific payout method. The returned parameters could be either optional or mandatory.



## OpenAPI

````yaml /api/openapi/v2-reference.yaml get /v2/payouts/payout_method/params
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/payout_method/params:
    get:
      tags:
        - Payout Methods
      summary: Get Payout Required Fields
      description: >-
        Certain payout methods may require information to be collected from
        consumers. This API will provide all the parameters potentially needed
        for a specific payout method. The returned parameters could be either
        optional or mandatory.
      parameters:
        - name: payout_method_name
          in: query
          schema:
            type: string
          description: Payout method name
          required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  record:
                    type: object
                    required:
                      - currency
                      - payout_method_name
                      - description
                      - payment_type
                      - payout_method_params
                      - banks
                      - min_amount
                      - max_amount
                    properties:
                      currency:
                        type: string
                        description: Currency Code (ISO 4217, 3-char alphabetic code).
                      symbol:
                        type: string
                        description: Currency symbol.
                      logo:
                        type: string
                        description: Bank or ewallet logo.
                      payout_method_name:
                        type: string
                        description: Payout method name
                      description:
                        type: string
                        description: Description payin method.
                      payment_type:
                        type: string
                        description: Type of payment, incoming or outgoing.
                      payout_method_params:
                        type: object
                        description: >-
                          Params need using payout method.Each payment method
                          may have different parameters, which can be either
                          mandatory or optional.
                      banks:
                        type: array
                        description: List of supported banks for the payout method.
                        items:
                          type: object
                          required:
                            - code
                            - name
                          properties:
                            code:
                              type: string
                              description: Identification of the bank
                            name:
                              type: string
                              description: Bank name
                            short_name:
                              type: string
                              description: Bank short name
                      min_amount:
                        type: number
                        description: The minimum allowable amount.
                      max_amount:
                        type: number
                        description: The maximum allowable amount.
              examples:
                PHP Bank Maya:
                  summary: PHP Bank Maya
                  value:
                    record:
                      currency: PHP
                      symbol: ₱
                      logo: ''
                      payout_method_name: ph_bank_maya_php
                      description: MAYA
                      payout_method_params:
                        account_number: string:Mandatory Bank Account Number
                        account_name: string:Mandatory Account Holder Name
                        bank_code: string:Mandatory Bank Code
                      banks:
                        - code: '600'
                          name: GCASH
                          short_name: null
                      payment_type: pay_out
                      is_refundable: false
                      is_cancellable: false
                      require_contact: false
                      require_kyc: false
                      min_amount: 200
                      max_amount: 50000
                PHP GCash eWallet:
                  summary: PHP GCash eWallet
                  value:
                    record:
                      currency: PHP
                      symbol: ₱
                      logo: ''
                      payout_method_name: ph_ewallet_gcash_php
                      description: GCASH
                      payout_method_params:
                        account_number: string:Mandatory Bank Account Number
                        account_name: string:Mandatory Account Holder Name
                        bank_code: string:Mandatory Bank Code
                      banks:
                        - code: '600'
                          name: GCASH
                          short_name: null
                      payment_type: pay_out
                      is_refundable: false
                      is_cancellable: false
                      min_amount: 200
                      max_amount: 50000
                PHP Bank Transfer:
                  summary: PHP Bank Transfer
                  value:
                    record:
                      currency: PHP
                      symbol: ₱
                      logo: ''
                      payout_method_name: ph_bank_php
                      description: Bank Transfer
                      payout_method_params:
                        account_number: string:Mandatory Bank Account Number
                        bank_code: >-
                          string:Mandatory Bank Code, please check the list of
                          banks:
                          https://helloclever.azureedge.net/hellocleverweb-staging/clever/section/php/php_banks.json
                      payment_type: pay_out
                      is_refundable: false
                      is_cancellable: false
                      require_contact: true
                      require_kyc: false
                      min_amount: 100
                      max_amount: 50000
                PHP QR Ph:
                  summary: PHP QR Ph
                  value:
                    record:
                      currency: PHP
                      symbol: ₱
                      logo: ''
                      payout_method_name: ph_qrph_php
                      description: QR Ph
                      payout_method_params:
                        account_number: string:Mandatory Bank Account Number
                        account_name: string:Mandatory Account Holder Name
                        bank_code: string:Mandatory Bank Code
                      payment_type: pay_out
                      is_refundable: false
                      is_cancellable: false
                      min_amount: 100
                      max_amount: 50000
                IDR Bank QRIS:
                  summary: IDR Bank QRIS
                  value:
                    record:
                      currency: IDR
                      symbol: Rp
                      logo: ''
                      payout_method_name: id_bank_qris_idr
                      description: Quick Response Code Indonesian Standard
                      payout_method_params:
                        account_number: string:Mandatory Bank Account Number
                        account_name: string:Mandatory Account Holder Name
                        bank_code: string:Mandatory Bank Code
                      banks:
                        - code: '600'
                          name: GCASH
                          short_name: null
                      payment_type: pay_out
                      is_refundable: false
                      is_cancellable: false
                      require_contact: false
                      require_kyc: false
                      min_amount: 100000
                      max_amount: 10000000
                IDR Bank Transfer:
                  summary: IDR Bank Transfer
                  value:
                    record:
                      currency: IDR
                      symbol: Rp
                      logo: ''
                      payout_method_name: id_bank_idr
                      description: Bank Transfer
                      payout_method_params:
                        bank_code: string:Mandatory recipient's bank code
                        account_name: string:Mandatory recipient's bank account name
                        account_number: string:Mandatory recipient's bank account number
                        description: string:Mandatory description for the transfer
                      banks:
                        - code: BMRIIDJA
                          name: BANK MANDIRI
                          short_name: null
                      payment_type: pay_out
                      is_refundable: false
                      is_cancellable: false
                      require_contact: false
                      require_kyc: false
                      min_amount: 100000
                      max_amount: 10000000
                VND Viet QR:
                  summary: VND Viet QR
                  value:
                    record:
                      currency: VND
                      symbol: ₫
                      logo: ''
                      payout_method_name: vn_other_vietqr_vnd
                      description: VietQR
                      payout_method_params:
                        account_number: string:Mandatory Bank Account Number
                        account_name: string:Mandatory Account Holder Name
                        bank_code: string:Mandatory Bank Code
                      banks:
                        - code: '600'
                          name: GCASH
                          short_name: null
                      payment_type: pay_out
                      is_refundable: false
                      is_cancellable: false
                      require_contact: false
                      require_kyc: false
                      min_amount: 100000
                      max_amount: 5000000000
                VND Momo eWallet:
                  summary: VND Momo eWallet
                  value:
                    record:
                      currency: VND
                      symbol: ₫
                      logo: ''
                      payout_method_name: vn_ewallet_momo_vnd
                      description: MOMO
                      payout_method_params:
                        account_number: string:Mandatory Bank Account Number
                        account_name: string:Mandatory Account Holder Name
                        bank_code: string:Mandatory Bank Code
                      banks:
                        - code: '600'
                          name: GCASH
                          short_name: null
                      payment_type: pay_out
                      is_refundable: false
                      is_cancellable: false
                      require_contact: false
                      require_kyc: false
                      min_amount: 100000
                      max_amount: 50000000
                VND Bank Transfer:
                  summary: VND Bank Transfer
                  value:
                    record:
                      currency: VND
                      symbol: ₫
                      logo: ''
                      payout_method_name: vn_bank_vnd
                      description: Bank Transfer
                      payout_method_params:
                        description: string:Mandatory Content for the bank transfer
                        account_number: string:Mandatory Bank Account Number
                        account_name: string:Mandatory Account Holder Name
                        swift_code: string:Mandatory SWIFT code
                        type: string:Mandatory Enum(WITHDRAW, PAYMENT, SALARY)
                        branch_code: >-
                          string:Optional required if amount greater than
                          300,000,000 or bank in list required
                      payment_type: pay_out
                      is_refundable: false
                      is_cancellable: false
                      require_contact: false
                      require_kyc: false
                      min_amount: 10000
                      max_amount: 300000000
                MYR Bank Duitnow:
                  summary: MYR Bank Duitnow
                  value:
                    record:
                      currency: MYR
                      symbol: RM
                      logo: ''
                      payout_method_name: my_bank_duitnow_myr
                      description: >-
                        Simple and convenient way of transferring money using
                        easy-to-remember DuitNow IDs such as mobile number and
                        NRIC number.
                      payout_method_params:
                        account_number: string:Mandatory Bank Account Number
                        account_name: string:Mandatory Account Holder Name
                        bank_code: string:Mandatory Bank Code
                      banks:
                        - code: '600'
                          name: GCASH
                          short_name: null
                      payment_type: pay_out
                      is_refundable: false
                      is_cancellable: false
                      require_contact: false
                      require_kyc: false
                      min_amount: 500
                      max_amount: 50000
                MYR Bank Transfer:
                  summary: MYR Bank Transfer
                  value:
                    record:
                      currency: MYR
                      symbol: RM
                      logo: ''
                      payout_method_name: my_bank_myr
                      description: Bank Transfer.
                      payout_method_params:
                        bank_name: string:Optional recipient's bank name
                        bank_code: string:Mandatory recipient's bank code
                        account_number: string:Mandatory recipient's bank account number
                        account_name: string:Mandatory recipient's bank account name
                        business_reg_no: >-
                          string:Mandatory merchant's business registration
                          number
                      banks: []
                      payment_type: pay_out
                      is_refundable: false
                      is_cancellable: false
                      require_contact: false
                      require_kyc: false
                      min_amount: 10
                      max_amount: 100000000
                MYR eWallet Transfer:
                  summary: MYR eWallet Transfer
                  value:
                    record:
                      currency: MYR
                      symbol: RM
                      logo: ''
                      payout_method_name: my_ewallet_*_myr
                      description: Bank Transfer.
                      payout_method_params:
                        bank_code: string:Mandatory recipient's bank code
                        account_number: >-
                          string:Mandatory recipient's mobile number include the
                          country code '60' (Malaysia's country code)
                        account_name: string:Mandatory recipient's account name
                        business_reg_no: >-
                          string:Mandatory merchant's business registration
                          number
                      banks: []
                      payment_type: pay_out
                      is_refundable: false
                      is_cancellable: false
                      require_contact: false
                      require_kyc: false
                      min_amount: 10
                      max_amount: 100000000
                JPY Bank Transfer:
                  summary: JPY Bank Transfer
                  value:
                    record:
                      currency: JPY
                      symbol: ¥
                      logo: ''
                      payout_method_name: jp_bank_jpy
                      description: Bank Transfer
                      payout_method_params:
                        user_id: string:Mandatory the unique ID of the customer
                        ip_address: string:Mandatory customer device IP
                        phone: string:Mandatory
                        bank_name: string:Mandatory recipient's bank name
                        bank_code: string:Mandatory recipient's bank code
                        branch_name: string:Mandatory recipient's bank branch name
                        branch_code: string:Mandatory recipient's bank branch code
                        account_number: string:Mandatory recipient's bank account number
                        account_name: >-
                          string:Mandatory bank account owner's name (in
                          Katakana)
                        native_account_name: string:Mandatory bank account owner's name (in Kanji)
                        account_type: >-
                          string:Mandatory Enum(ordinary, savings, current,
                          other)
                    payment_type: pay_out
                    is_refundable: false
                    is_cancellable: false
                    require_contact: false
                    require_kyc: false
                    min_amount: 1
                    max_amount: 17000000
                USDC Bank:
                  summary: USDC Bank
                  value:
                    record:
                      currency: USDC
                      symbol: USDC
                      logo: ''
                      payout_method_name: usdc_bank
                      description: Bank Transfer
                      payout_method_params:
                        original_currency: >-
                          string:Mandatory Enum(USD, GBP, EUR) - input specific
                          original currency and combine with original amount
                        original_amount: >-
                          number:Mandatory - input specific original amount, the
                          system uses this field to payin
                        callback_url: string:Mandatory
                      payment_type: pay_out
                      is_refundable: false
                      is_cancellable: false
                      require_contact: false
                      require_kyc: false
                      min_amount: 1
                      max_amount: 9999999
                Interac CAD:
                  summary: Interac CAD
                  value:
                    record:
                      currency: CAD
                      symbol: CAD
                      logo: ''
                      payout_method_name: ca_interac_cad
                      description: Interac e-Transfer
                      payout_method_params:
                        email: string:Mandatory
                        purpose_code: >-
                          string:Optional Enum(expense_or_medical_reimbursement,
                          fee_payments, payroll_processing,
                          transaction_between_banks,
                          services_related_to_financial_trade_travel_or_accounting,
                          transportation_costs, software_export_or_development,
                          personal, other)
                        beneficiary_email: string:Mandatory email of the beneficiary
                        security_question: string:Mandatory security question
                        security_answer: string:Mandatory security answer
                      payment_type: pay_out
                      is_refundable: false
                      is_cancellable: false
                      require_contact: true
                      require_kyc: true
                      min_amount: 34
                      max_amount: 50000
                NGN Bank Transfer:
                  summary: NGN Bank Transfer
                  value:
                    record:
                      currency: NGN
                      symbol: ₦
                      logo: ''
                      payout_method_name: ng_bank_ngn
                      description: Bank Transfer
                      payment_type: pay_out
                      payout_method_params:
                        bank_code: string:Mandatory
                        account_number: string:Mandatory Bank Account Number
                      banks: []
                      min_amount: 100
                      max_amount: 10000000
                      require_contact: false
                      require_kyc: false
                KES Bank Transfer:
                  summary: KES Bank Transfer
                  value:
                    record:
                      currency: KES
                      symbol: KSh
                      logo: ''
                      payout_method_name: ke_bank_kes
                      description: Bank Transfer
                      payment_type: pay_out
                      payout_method_params:
                        bank_code: string:Mandatory
                        account_number: string:Mandatory Bank Account Number
                      banks: []
                      min_amount: 10
                      max_amount: 85000
                      require_contact: false
                      require_kyc: false
                KES Mobile Money:
                  summary: KES Mobile Money
                  value:
                    record:
                      currency: KES
                      symbol: KSh
                      logo: ''
                      payout_method_name: ke_mobile_money_kes
                      description: Mobile Money
                      payment_type: pay_out
                      payout_method_params:
                        account_number: string:Mandatory mobile money account number
                        mobile_money_operator: string:Mandatory mobile money operator
                      banks: []
                      min_amount: 10
                      max_amount: 85000
                      require_contact: false
                      require_kyc: false
                GHS Mobile Money:
                  summary: GHS Mobile Money
                  value:
                    record:
                      currency: GHS
                      symbol: GH₵
                      logo: ''
                      payout_method_name: gh_mobile_money_ghs
                      description: Mobile Money
                      payment_type: pay_out
                      payout_method_params:
                        account_number: string:Mandatory mobile money account number
                        mobile_money_operator: string:Mandatory mobile money operator
                      banks: []
                      min_amount: 10
                      max_amount: 10000
                      require_contact: false
                      require_kyc: false
                ZAR Bank Transfer:
                  summary: ZAR Bank Transfer
                  value:
                    record:
                      currency: ZAR
                      symbol: R
                      logo: ''
                      payout_method_name: sa_bank_zar
                      description: Bank Transfer
                      payment_type: pay_out
                      payout_method_params:
                        bank_code: string:Mandatory
                        account_number: string:Mandatory Bank Account Number
                        account_name: string:Mandatory Bank Account Name
                      banks: []
                      min_amount: 2
                      max_amount: 500000
                      require_contact: false
                      require_kyc: false
                XAF Mobile Money:
                  summary: XAF Mobile Money
                  value:
                    record:
                      currency: XAF
                      symbol: FCFA
                      logo: ''
                      payout_method_name: cm_mobile_money_xaf
                      description: Mobile Money
                      payment_type: pay_out
                      payout_method_params:
                        account_number: string:Mandatory mobile money account number
                        mobile_money_operator: string:Mandatory mobile money operator
                      banks: []
                      min_amount: 500
                      max_amount: 500000
                      require_contact: false
                      require_kyc: false
                XOF Mobile Money:
                  summary: XOF Mobile Money
                  value:
                    record:
                      currency: XOF
                      symbol: CFA
                      logo: ''
                      payout_method_name: ci_mobile_money_xof
                      description: Mobile Money
                      payment_type: pay_out
                      payout_method_params:
                        account_number: string:Mandatory mobile money account number
                        mobile_money_operator: string:Mandatory mobile money operator
                      banks: []
                      min_amount: 500
                      max_amount: 500000
                      require_contact: false
                      require_kyc: false
                BRL PIX:
                  summary: BRL PIX
                  value:
                    record:
                      currency: BRL
                      symbol: R$
                      logo: ''
                      payout_method_name: br_pix_brl
                      description: PIX
                      payment_type: pay_out
                      payout_method_params:
                        purpose_code: >-
                          string:Optional Enum(expense_or_medical_reimbursement,
                          fee_payments, payroll_processing,
                          transaction_between_banks,
                          services_related_to_financial_trade_travel_or_accounting,
                          transportation_costs, software_export_or_development,
                          personal, other)
                        document_type: string:Mandatory Enum(CPF, CNPJ)
                        document_number: string:Mandatory Regex:/^\d{11,14}$/
                        account_name: string:Mandatory Payer's name
                        pixkey_type: string:Mandatory Enum(CPF, EMAIL, PHONE)
                        pix_key: string:Mandatory
                        beneficiary_type: string:Mandatory Enum(individual, company)
                      banks: []
                      min_amount: 1
                      max_amount: 10000000
                      require_contact: true,
                      require_kyc: false
                BRL Bank Transfer:
                  summary: BRL Bank Transfer
                  value:
                    record:
                      currency: BRL
                      symbol: R$
                      logo: ''
                      payout_method_name: br_bank_brl
                      description: Bank Transfer
                      payment_type: pay_out
                      payout_method_params:
                        purpose_code: >-
                          string:Optional Enum(expense_or_medical_reimbursement,
                          fee_payments, payroll_processing,
                          transaction_between_banks,
                          services_related_to_financial_trade_travel_or_accounting,
                          transportation_costs, software_export_or_development,
                          personal, other)
                        document_type: string:Mandatory Enum(CPF, CNPJ)
                        document_number: string:Mandatory Regex:/^\d{11,14}$/
                        account_number: string:Mandatory
                        bank_code: string:Mandatory
                        branch_code: string:Mandatory
                        account_type: string:Mandatory Enum(checking, savings)
                      banks: []
                      min_amount: 30
                      max_amount: 10000
                      require_contact: true,
                      require_kyc: false
                THB Bank Transfer:
                  summary: THB Bank Transfer
                  value:
                    record:
                      currency: THB
                      symbol: ฿
                      logo: ''
                      payout_method_name: th_bank_thb
                      description: Bank Transfer
                      payment_type: pay_out
                      payout_method_params:
                        description: string:Mandatory Content for the bank transfer
                        account_number: string:Mandatory Bank Account Number
                        account_name: string:Mandatory Account Holder Name
                        swift_code: string:Mandatory SWIFT code
                        type: string:Mandatory Enum(WITHDRAW, PAYMENT, SALARY)
                      banks: []
                      min_amount: 300
                      max_amount: 2000000
                      require_contact: false
                      require_kyc: false
                KRW Bank Transfer:
                  summary: KRW Bank Transfer
                  value:
                    record:
                      currency: KRW
                      symbol: ₩
                      logo: ''
                      payout_method_name: kr_bank_krw
                      description: Bank Transfer
                      payment_type: pay_out
                      payout_method_params:
                        bank_code: string:Mandatory recipient's bank code
                        account_number: string:Mandatory recipient's bank account number
                        account_name: string:Mandatory recipient's bank account name
                        payment_reason: >-
                          string:Optional Enum(E_COMMERCE, SALES_OF_GOODS,
                          SALES_OF_SERVICES, TUITION_PAYMENT, TRAVEL_EXPENSES,
                          UTILITY_PAYMENT, RENT_OR_MORTGAGE_PAYMENT,
                          MEDICAL_PAYMENT, MEDICAL_INSURANCE_PAYMENT,
                          ENTERTAINMENT_PAYMENT, REFUND, PREFUNDING) Purpose of
                          the payment, default is E_COMMERCE
                      banks: []
                      min_amount: 1
                      max_amount: 1000000000
                      require_contact: false
                      require_kyc: false
                INR Bank Transfer:
                  summary: INR Bank Transfer
                  value:
                    record:
                      currency: INR
                      symbol: ₹
                      logo: ''
                      payout_method_name: in_bank_inr
                      description: Bank Transfer
                      payment_type: pay_out
                      payout_method_params:
                        account_name: string:Mandatory the nick name of the payee
                        account_number: string:Mandatory bank account number of the payee
                        bank_name: string:Mandatory the name of the bank of the payee
                        state: string:Mandatory the name of the state of the payee
                        postal_code: string:Mandatory Postal code of the payee
                        ifsc: string:Mandatory IFSC Code
                        city: string:Mandatory the name of the city of the payee
                        address: string:Mandatory the address of the payee
                        email: string:Mandatory Email
                        phone: string:Mandatory Phone Number
                        payment_mode: >-
                          string:Mandatory Payment Mode, Accepted values:
                          "IMPS", "NEFT", "RTGS"
                      banks: []
                      min_amount: 10
                      max_amount: 1000000
                      require_contact: false
                      require_kyc: false
                ARS Bank Transfer:
                  summary: ARS Bank Transfer
                  value:
                    record:
                      currency: ARS
                      symbol: AR$
                      logo: ''
                      payout_method_name: ar_bank_ars
                      description: Bank Transfer
                      payment_type: pay_out
                      payout_method_params:
                        user_id: string:Mandatory
                        ip_address: string:Mandatory
                        phone: string:Mandatory
                        account_type: >-
                          string:Mandatory Enum(CACC, SVGS) # CACC: Current,
                          SVGS: Savings
                        account_number: >-
                          string:Optional recipient's bank account number
                          (required if alias is not provided)
                        alias: >-
                          string:Optional letter code used in the Argentine
                          banking system to identify an account instead of an
                          account number (required if account number is not
                          provided)
                      banks: []
                      min_amount: 5000
                      max_amount: 1000000
                      require_contact: false
                      require_kyc: false
                ARS CVU:
                  summary: ARS CVU
                  value:
                    record:
                      currency: ARS
                      symbol: AR$
                      logo: ''
                      payout_method_name: ar_cvu_ars
                      description: CVU
                      payment_type: pay_out
                      payout_method_params:
                        account_number: >-
                          string:Mandatory The 22-digit CVU of the beneficiary
                          minLength:22, maxLength:22
                        document_number: >-
                          string:Mandatory CUIL number of the beneficiary
                          Regex:/^(20|23|24|25|26|27|30|33|34)(-?\d{8}-?\d|\d{8}\d)$/
                        description: string:Mandatory Brief description for the transaction
                      banks: []
                      min_amount: 1500
                      max_amount: 13000000
                      require_contact: false
                      require_kyc: false
                BWP Bank Transfer:
                  summary: BWP Bank Transfer
                  value:
                    record:
                      currency: BWP
                      symbol: P
                      logo: ''
                      payout_method_name: bw_bank_bwp
                      description: Bank Transfer
                      payment_type: pay_out
                      payout_method_params:
                        user_type: >-
                          string:Mandatory ENUM(individual, organization)
                          Specifies recipient validation type: organization
                          requires business_name and business_reg_no; individual
                          requires all other personal fields
                        address: string:Optional required if user_type is individual
                        dob: >-
                          string:Optional format MM/DD/YYYY required if
                          user_type is individual
                        document_number: string:Optional required if user_type is individual
                        document_type: string:Optional required if user_type is individual
                        phone: string:Optional required if user_type is individual
                        country: string:Optional required if user_type is individual
                        business_reg_no: string:Optional required if user_type is organization
                        business_name: string:Optional required if user_type is organization
                        account_number: string:Mandatory
                        account_name: string:Mandatory
                        user_id: string:Mandatory Unique identifier for the user
                        payment_reason: >-
                          string:Mandatory ENUM(other, bills, groceries, travel,
                          health, entertainment, housing, school-fees)
                        bank_name: string:Mandatory
                      banks: []
                      min_amount: 0
                      max_amount: null
                      require_contact: false
                      require_kyc: false
                BWP Mobile Money:
                  summary: BWP Mobile Money
                  value:
                    record:
                      currency: BWP
                      symbol: P
                      logo: ''
                      payout_method_name: bw_mobile_money_bwp
                      description: Mobile Money
                      payment_type: pay_out
                      payout_method_params:
                        user_type: >-
                          string:Mandatory ENUM(individual, organization)
                          Specifies recipient validation type: organization
                          requires business_name and business_reg_no; individual
                          requires all other personal fields
                        address: string:Optional required if user_type is individual
                        dob: >-
                          string:Optional format MM/DD/YYYY required if
                          user_type is individual
                        document_number: string:Optional required if user_type is individual
                        document_type: string:Optional required if user_type is individual
                        phone: string:Optional required if user_type is individual
                        country: string:Optional required if user_type is individual
                        business_reg_no: string:Optional required if user_type is organization
                        business_name: string:Optional required if user_type is organization
                        account_number: >-
                          string:Mandatory is the mobile number within E.164
                          format associated with the mobile money account
                        account_name: string:Mandatory
                        user_id: string:Mandatory Unique identifier for the user
                        payment_reason: >-
                          string:Mandatory ENUM(other, bills, groceries, travel,
                          health, entertainment, housing, school-fees)
                      banks: []
                      min_amount: 0
                      max_amount: null
                      require_contact: false
                      require_kyc: false
                MWK Mobile Money:
                  summary: MWK Mobile Money
                  value:
                    record:
                      currency: MWK
                      symbol: MW
                      logo: ''
                      payout_method_name: mw_mobile_money_mwk
                      description: Mobile Money
                      payment_type: pay_out
                      payout_method_params:
                        user_type: >-
                          string:Mandatory ENUM(individual, organization)
                          Specifies recipient validation type: organization
                          requires business_name and business_reg_no; individual
                          requires all other personal fields
                        address: string:Optional required if user_type is individual
                        dob: >-
                          string:Optional format MM/DD/YYYY required if
                          user_type is individual
                        document_number: string:Optional required if user_type is individual
                        document_type: string:Optional required if user_type is individual
                        phone: string:Optional required if user_type is individual
                        country: string:Optional required if user_type is individual
                        business_reg_no: string:Optional required if user_type is organization
                        business_name: string:Optional required if user_type is organization
                        account_number: >-
                          string:Mandatory is the mobile number within E.164
                          format associated with the mobile money account
                        account_name: string:Mandatory
                        user_id: string:Mandatory Unique identifier for the user
                        payment_reason: >-
                          string:Mandatory ENUM(other, bills, groceries, travel,
                          health, entertainment, housing, school-fees)
                        network_code: >-
                          string:Mandatory ENUM(tnm, airtel) specifies the
                          mobile money network
                      banks: []
                      min_amount: 0
                      max_amount: null
                      require_contact: false
                      require_kyc: false
                MWK Bank Transfer:
                  summary: MWK Bank Transfer
                  value:
                    record:
                      currency: MWK
                      symbol: MW
                      logo: ''
                      payout_method_name: mw_bank_mwk
                      description: Bank Transfer
                      payment_type: pay_out
                      payout_method_params:
                        user_type: >-
                          string:Mandatory ENUM(individual, organization)
                          Specifies recipient validation type: organization
                          requires business_name and business_reg_no; individual
                          requires all other personal fields
                        address: string:Optional required if user_type is individual
                        dob: >-
                          string:Optional format MM/DD/YYYY required if
                          user_type is individual
                        document_number: string:Optional required if user_type is individual
                        document_type: string:Optional required if user_type is individual
                        phone: string:Optional required if user_type is individual
                        country: string:Optional required if user_type is individual
                        business_reg_no: string:Optional required if user_type is organization
                        business_name: string:Optional required if user_type is organization
                        account_number: string:Mandatory
                        account_name: string:Mandatory
                        user_id: string:Mandatory Unique identifier for the user
                        payment_reason: >-
                          string:Mandatory ENUM(other, bills, groceries, travel,
                          health, entertainment, housing, school-fees)
                        bank_code: string:Mandatory Bank Code
                      banks: []
                      min_amount: 0
                      max_amount: null
                      require_contact: false
                      require_kyc: false
                TZS Bank Transfer:
                  summary: TZS Bank Transfer
                  value:
                    record:
                      currency: TZS
                      symbol: TSh
                      logo: ''
                      payout_method_name: tz_bank_tzs
                      description: Bank Transfer
                      payment_type: pay_out
                      payout_method_params:
                        user_type: >-
                          string:Mandatory ENUM(individual, organization)
                          Specifies recipient validation type: organization
                          requires business_name and business_reg_no; individual
                          requires all other personal fields
                        address: string:Optional required if user_type is individual
                        dob: >-
                          string:Optional format MM/DD/YYYY required if
                          user_type is individual
                        document_number: string:Optional required if user_type is individual
                        document_type: string:Optional required if user_type is individual
                        phone: string:Optional required if user_type is individual
                        country: string:Optional required if user_type is individual
                        business_reg_no: string:Optional required if user_type is organization
                        business_name: string:Optional required if user_type is organization
                        account_number: string:Mandatory
                        account_name: string:Mandatory
                        user_id: string:Mandatory Unique identifier for the user
                        payment_reason: >-
                          string:Mandatory ENUM(other, bills, groceries, travel,
                          health, entertainment, housing, school-fees)
                        bank_code: string:Mandatory
                      banks:
                        - code: NMIBTZTZ
                          name: NMB Bank PLC
                          short_name: null
                      min_amount: 0
                      max_amount: null
                      require_contact: false
                      require_kyc: false
                USD KHQR:
                  summary: USD KHQR
                  value:
                    record:
                      currency: USD
                      symbol: $
                      logo: ''
                      payout_method_name: kh_pay_usd
                      description: KHQR
                      payment_type: pay_out
                      payout_method_params:
                        account_number: >-
                          string:Mandatory account number, or wallet phone
                          number if using PiPay Wallet (e.g. "099222114" or
                          "85599222114"). For bank transfer, use bank account
                          number.
                        bank_code: >-
                          string:Mandatory bank code. Use "PIPAKHPPXXX" for
                          PiPay Wallet, "BAKONG" for Bakong, or the destination
                          bank code for bank transfer (e.g. "ABAAKHPPXXX").
                        description: string:Mandatory description for the payout
                      banks:
                        - code: CSBCKHPPXXX
                          name: Cathay United Bank (Cambodia)
                          short_name: null
                        - code: VBLCKHPPXXX
                          name: Vattanac
                          short_name: null
                        - code: DARAKHPPXXX
                          name: Dara Sakor Pay PLC
                          short_name: null
                        - code: CABCKHP2XXX
                          name: Cambodia Asia Bank Ltd
                          short_name: null
                        - code: HLBBKHPPXXX
                          name: Hong Leong Bank (Cambodia) Plc
                          short_name: null
                        - code: CADIKHPPXXX
                          name: Canadia Bank Plc
                          short_name: null
                        - code: PIPAKHPPXXX
                          name: PIPAY PLC
                          short_name: null
                        - code: BAKONG
                          name: MK Microfinance Institution Plc
                          short_name: null
                        - code: AMRTKHPPXXX
                          name: Amret MFI
                          short_name: null
                        - code: AMKBKHPPXXX
                          name: AMK MFI
                          short_name: null
                        - code: ASWLKHPPXXX
                          name: Asia Wei Luy
                          short_name: null
                        - code: CIBBKHPPXXX
                          name: CIMB Bank Plc.
                          short_name: null
                        - code: BIOBKHPPXXX
                          name: BIC Bank
                          short_name: null
                        - code: OSKIKHPPXXX
                          name: RHB Bank (Camboia) Plc.
                          short_name: null
                        - code: UCBPKHPPXXX
                          name: Union Commercial Bank Plc.
                          short_name: null
                        - code: HKLBKHPPXXX
                          name: Hatha Kaksekar Limited
                          short_name: null
                        - code: ACLBKHPPXXX
                          name: Acleda Bank Plc.
                          short_name: null
                        - code: TRMCKHPPXXX
                          name: TrueMoney Cambodia
                          short_name: null
                        - code: PPCBKHPPXXX
                          name: Phnom Penh Commercial Bank
                          short_name: null
                        - code: MBBEKHPPXXX
                          name: Maybank Cambodia PLC
                          short_name: null
                        - code: CMCBKHPPXXX
                          name: Chip Mong Commercial Bank Plc.
                          short_name: null
                        - code: MOHAKHPPXXX
                          name: MOHANOKOR MFI Plc.
                          short_name: null
                        - code: TCABKHPPXXX
                          name: J Trust Royal Bank Plc.
                          short_name: null
                        - code: ADEOKHPPXXX
                          name: APD Bank
                          short_name: null
                        - code: WINGKHPPXXX
                          name: Wing Specialized Bank
                          short_name: null
                        - code: SHBKKHPPXXX
                          name: Shinhan Bank Cambodia Plc
                          short_name: null
                        - code: AEONKHPPXXX
                          name: AEON Bank
                          short_name: null
                        - code: ABAAKHPPXXX
                          name: ABA Bank
                          short_name: null
                        - code: BAXX002
                          name: BAXX002
                          short_name: null
                        - code: HDSBKHPPXXX
                          name: Phillip Bank Plc
                          short_name: null
                      min_amount: 0
                      max_amount: null
                      require_contact: false
                      require_kyc: false
        '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:
                      payout_method_name:
                        type: string
              example:
                errors:
                  payout_method_name: invalid
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)
