---
title: "Create a new beneficiary"
method: POST
path: "/v1/beneficiaries"
---

# Create a new beneficiary

`POST /v1/beneficiaries`

A beneficiary is a person or business receiving the funds. HitPay currently supports local beneficiaries, enabling payouts within the same country and region.

## Headers

- `X-BUSINESS-API-KEY` string, required

## Request body

- union
  - BeneficiarySqdFast
    - `country` 'sg', required — Beneficiary bank country/region
    - `transfer_method` 'bank_transfer', required — 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
    - `transfer_type` 'local', required
    - `currency` 'sgd', required — It is beneficiary bank account currency.
    - `holder_type` 'individual', required — The Holder Type
    - `holder_name` string, required — The Holder Name
    - `bank_swift_code` string — It's bank swift code. To obtain a list of supported SWIFT codes, call `Get the API schema` API with the following parameters: `country: sg`, currency: `sgd`,transfer_method: `bank_transfer`, transfer_type: `local` and holder_type: `individual`.
    - `account_number` string, required — The account number
    - `nickname` string — Nickname
    - `remark` string — Remark
    - `is_favourite` boolean
    - `email` string, email — Email address
  - BeneficiaryBdLocal
    - `country` 'bd', required — Beneficiary bank country/region
    - `transfer_method` 'bank_transfer', required — 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
    - `transfer_type` 'local', required
    - `currency` 'bdt', required — It is beneficiary bank account currency.
    - `holder_type` 'individual', required — The Holder Type
    - `holder_name` string, required — The Holder Name
    - `bank_id` string, required — It's bank id. To obtain a list of supported values for `bank_id`, call `Get the API schema` API with the following parameters: `country: bd`, currency: `bdt`,transfer_method: `bank_transfer`, transfer_type: `local` and holder_type: `individual` to get the the correct supported bank id.
    - `bank_routing_number` string, required — Bank Rounting Number
    - `account_number` string, required — The account number
    - `nickname` string — Nickname
    - `remark` string — Remark
    - `is_favourite` boolean — Remark
    - `email` string, email — Email address
  - BeneficiaryBdUpay
    - `country` 'bd', required — Beneficiary bank country/region
    - `transfer_method` 'upay', required — 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
    - `currency` 'bdt', required — It is beneficiary bank account currency.
    - `holder_type` 'individual', required — The Holder Type
    - `holder_name` string, required — The Holder Name
    - `district` string, required — District
    - `account_number` string, required — The account number
    - `nickname` string — Nickname
    - `remark` string — Remark
    - `is_favourite` boolean — Remark
    - `email` string, email — Email address
  - BeneficiaryBdBkash
    - `country` 'bd', required — Beneficiary bank country/region
    - `transfer_method` 'bkash', required — 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
    - `currency` string, required — It is beneficiary bank account currency.
    - `holder_type` 'individual', required — The Holder Type
    - `holder_name` string, required — The Holder Name
    - `district` string, required — District
    - `account_number` string, required — The account number
    - `nickname` string — Nickname
    - `remark` string — Remark
    - `is_favourite` boolean — Remark
    - `email` string, email — Email address
  - BeneficiaryBdTap
    - `country` 'bd', required — Beneficiary bank country/region
    - `transfer_method` 'tap', required — 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
    - `currency` string, required — It is beneficiary bank account currency.
    - `holder_type` 'individual', required — The Holder Type
    - `holder_name` string, required — The Holder Name
    - `district` string, required — District
    - `account_number` string, required — The account number
    - `nickname` string — Nickname
    - `remark` string — Remark
    - `is_favourite` boolean — Remark
    - `email` string, email — Email address
  - BeneficiaryPhpLocal
    - `country` 'ph', required — Beneficiary bank country/region
    - `transfer_method` 'bank_transfer', required — 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
    - `transfer_type` 'local'
    - `currency` 'php', required — It is beneficiary bank account currency.
    - `holder_type` 'individual', required — The Holder Type
    - `holder_name` string, required — The Holder Name
    - `bank_id` string, required — It's bank id. To obtain a list of supported values for `bank_id`, call `Get the API schema` API with the following parameters: `country: ph`, currency: `php`,transfer_method: `bank_transfer`, transfer_type: `local` and holder_type: `individual` to get the the correct supported bank id.
    - `account_number` string, required — The account number
    - `address` object, required
      - `street` string, required
      - `postcode` string, required
      - `city` string, required
    - `nickname` string — Nickname
    - `remark` string — Remark
    - `is_favourite` boolean
    - `email` string, email — Email address

## Response `201`

201

## Other responses

- `422` — 201

---

[API](https://skmtc.net/hitpayapp/apis/hitpay-api.md) · [All operations](https://skmtc.net/hitpayapp/apis/hitpay-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hitpayapp/hitpay-api/revisions/6aae1a736990/schema)