POST
/
v1
/
beneficiaries
/
schema
curl --request POST \
  --url https://api.sandbox.hit-pay.com/v1/beneficiaries/schema \
  --header 'Content-Type: application/json' \
  --header 'X-BUSINESS-API-KEY: <x-business-api-key>' \
  --data '{
  "country": "sg",
  "transfer_method": "bank_transfer",
  "transfer_type": "local",
  "currency": "sgd",
  "holder_type": "company",
  "bank_swift_code": "AEIBSGSXXXX"
}'
[
  {
    "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
  }
]

Headers

​
X-BUSINESS-API-KEY
string
required
Example:

"b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d"

Body

application/json

Response

200
application/json

200

The response is of type any.