> ## Documentation Index > Fetch the complete documentation index at: https://docs.hitpayapp.com/llms.txt > Use this file to discover all available pages before exploring further. # Get Beneficiary Schema > Get the required fields schema for creating beneficiaries by country ## OpenAPI ````yaml post /v1/beneficiaries/schema openapi: 3.1.1 info: title: HitPay API description: >- Accept PayNow, FPX, QRIS, GrabPay, cards, and 40+ payment methods with a single API. Production base URL: https://api.hit-pay.com, Sandbox: https://api.sandbox.hit-pay.com version: '1.0' servers: - url: https://api.hit-pay.com description: Production - url: https://api.sandbox.hit-pay.com description: Sandbox security: [] paths: /v1/beneficiaries/schema: post: summary: Get the API schema description: >- This API returns a dynamic schema that depends on the values of certain parameters. The schema contains the fields and validation rules for each payment scenario. A payment scenario is a combination of these parameters:country, transfer_method,transfer_type, currency, holder_type and bank_swift_code. To get the final schema, you need to submit the field values and re-render the form multiple times until all the fields are completed. For example, if you submit only the country parameter, the API will return a schema with the fields for country and transfer_method. If you submit the country and transfer_method parameters, the API will return a schema with the fields for country, transfer_method, currency, and so on. operationId: get-schema parameters: - name: X-BUSINESS-API-KEY in: header required: true style: simple explode: false schema: type: string example: b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d requestBody: content: application/json: schema: type: object properties: country: type: string pattern: ^([a-z]{2})$ minLength: 2 maxLength: 2 description: 2-letter ISO 3166-1 country code example: sg transfer_method: type: string description: >- The transfer method needs to be specified to ensure that accurate banking details are captured and validated for the specified transfer method. This is required for timely and accurate delivery of funds to the beneficiary account example: bank_transfer transfer_type: type: string description: >- The transfer type needs to be specified to ensure that accurate banking details are captured and validated for the specified transfer method. This is required for timely and accurate delivery of funds to the beneficiary account example: local currency: type: string description: It is beneficiary bank account currency example: sgd holder_type: type: string enum: - individual - company description: >- The type of the account holder. Individual is for personal accounts, and company is for business accounts. example: company bank_swift_code: type: string description: >- The bank swift code is a unique identifier for a specific bank. example: AEIBSGSXXXX responses: '200': description: '200' content: application/json: examples: Result: value: - key: country placeholder: null title: Country required: true type: select force_display: true options: - value: au label: Australia - value: bd label: Bangladesh - value: my label: Malaysia - value: ph label: Philippines - value: sg label: Singapore - value: vn label: Vietnam value: sg - key: transfer_method placeholder: null title: Transfer Method required: true type: select force_display: true options: - value: bank_transfer label: Bank Transfer value: bank_transfer - key: transfer_type placeholder: null title: Transfer Type required: false type: select force_display: false options: - value: local label: FAST value: local - key: currency placeholder: Select one title: Currency required: true type: select force_display: true options: - value: sgd label: Singapore Dollar ($) - value: usd label: US Dollar ($) value: sgd - key: holder_type placeholder: null title: Entity Type required: true type: select force_display: true options: - value: company label: Company - value: individual label: Individual value: company - key: holder_name placeholder: John Doe title: Account Holder Name required: true type: input - key: bank_swift_code placeholder: null type: select title: Bank Name required: true force_display: true options: - value: ABNASG2AXXX label: ABN AMRO BANK NV - value: AEIBSGSXXXX label: AMERICAN EXPRESS BANK LTD - value: ANZBSGSXXXX label: ANZ SINGAPORE - value: BKKBSGSGXXX label: BANGKOK BANK PUBLIC COMPANY - value: BOFASG2XXXX label: BANK OF AMERICA - value: BKCHSGSGXXX label: BANK OF CHINA - value: BKIDSGSGXXX label: BANK OF INDIA - value: BKNZSGSGXXX label: BANK OF NEW ZEALAND - value: BOTKSGSXXXX label: BANK OF TOKYO-MITSUBISHI - value: BNPASGSGXXX label: BNP PARIBAS - value: CRLYSGSGXXX label: CALYON - value: CTCBSGSGXXX label: CHINATRUST COMMERCIAL BANK CO., LTD - value: CIBBSGSGXXX label: CIMB BANK BERHAD - value: CITISGSGXXX label: CITIBANK NA - value: CITISGSLXXX label: CITIBANK SINGAPORE - value: KWHKSGSGXXX label: CITIC Bank International Ltd - value: COBASGSXXXX label: COMMERZBANK SG - value: DBSSSGSGXXX label: DBS Bank/POSB - value: DEUTSGSGXXX label: DEUTSCHE BANK - value: DNBASGSGXXX label: DnB NOR Bank ASA - value: FAEASGSGXXX label: FAR EASTERN BANK - value: FCBKSGSGXXX label: FIRST COMMERCIAL BANK - value: HABBSGSGXXX label: HABIB BANK LIMITED - value: HLBBSGSGXXX label: HL BANK - value: HSBCSGS2 label: HONGKONG & SHANGHAI BANKING CORPORATION (HSBC) - value: HSBCSGS2XXX label: HONGKONG & SHANGHAI BANKING CORPORATION (HSBC) - value: HSBCSGSGXXX label: HONGKONG & SHANGHAI BANKING CORPORATION (HSBC) - value: ICICSGSGXXX label: ICICI BANK - value: IDIBSGSGXXX label: INDIAN BANK - value: IOBASGSGXXX label: INDIAN OVERSEAS BANK - value: INGBSGSGXXX label: INTERNALTIONALE NEDERLANDEN BANK N.V. - value: BCITSGSGXXX label: INTESABCI S.P.A. - value: ICBKSGSGXXX label: Industrial & Commercial Bank of China - value: CHASSGSGXXX label: JP MORGAN CHASE BANK, N.A. - value: KOEXSGSGXXX label: KEB HANA BANK - value: MBBESGS2 label: MALAYAN BANKING BERHAD - value: MBBESGS2XXX label: MAYBANK SINGAPORE LIMITED - value: MHCBSGSGXXX label: MIZUHO CORPORATE BANK, LTD - value: NATASGSGXXX label: NATIONAL AUSTRALIA BANK LTD - value: NBOKSGSGXXX label: NATIONAL BANK OF KUWAIT, SAK - value: NDEASGSGXXX label: NORDEA BANK FINLAND PLC - value: OCBCSGSGXXX label: OVERSEA-CHINESE BANKING CORPORATION LTD - value: BNINSGSGXXX label: PT. BANK NEGARA INDONESIA - value: RHBBSGSGXXX label: RHB BANK BERHAD - value: BSGPSGSGXXX label: SINGAPORE ISLAND BANK - value: ESSESGSGXXX label: SKANDINAVISKA ENSKILDA BANKEN - value: SOGESGSGXXX label: SOCIETE GENERALE - value: SCBLSG22XXX label: STANDARD CHARTERED BANK - value: SCBLSGSGXXX label: STANDARD CHARTERED BANK - value: SBINSGSGXXX label: STATE BANK OF INDIA - value: SMBCSGSGXXX label: SUMITOMO MITSUI BANKING CORPORATION - value: HANDSGSGXXX label: SVENSKA HANDELSBANKEN AB (PUBL) - value: UBSWSGSGXXX label: SWISS BANK CORP - value: BEASSGSGXXX label: THE BANK OF EAST ASIA - value: NOSCSGSGXXX label: THE BANK OF NOVA SCOTIA - value: UCBASGSGXXX label: UCO BANK - value: UBAFSGSXXXX label: UNION DE BANQUES ARABES ET FRANCAISES - value: UOVBSGSGXXX label: UNITED OVERSEAS BANK LTD - value: TRWISGSGXXX label: Wise Asia-Pacific Pte Ltd value: AEIBSGSXXXX - key: account_number placeholder: '140989' type: input title: Account Number required: true validation: /^\d{4,32}$/ - key: nickname placeholder: John Doe title: Nickname required: false type: input - key: remark placeholder: 'Example: Test SGD transfer to US' title: Remark required: false type: input - key: email placeholder: null title: Email Address required: false type: input validation: email - key: is_favourite placeholder: null title: Mark this beneficiary as favourite required: false type: checkbox-boolean value: false '422': description: '422' content: application/json: examples: Result: value: message: >- The given data was invalid. The selected Country is invalid. errors: country: - The selected Country is invalid. transfer_method: - The selected Transfer Method is invalid. transfer_type: - The selected Transfer Type is invalid. currency: - The selected Currency is invalid. deprecated: false ````