---
title: "Create A Beneficiary"
method: POST
path: "/api/merchants/{key}/payout/createBeneficiary"
tags: ["Payout APIs"]
---

# Create A Beneficiary

`POST /api/merchants/{key}/payout/createBeneficiary`

## Path parameters

- `key` string, required

## Headers

- `Content-Type` string
- `X-Portone-Client-Key` string
- `Authorization` string

## Request body

- object
  - `email` string — The email of the Beneficiary
  - `name` string, required — The name of the Beneficiary
  - `phone` string — The phone number of the Beneficiary
  - `address` string — The address of the Beneficiary
  - `bank_account_number` string, required — The bank account number of the Beneficiary
  - `bank_account_name` string, required — The first name of the Beneficiary registered with the bank
  - `bank_account_middle_name` string — The middle name of the Beneficiary registered with the bank
  - `bank_account_last_name` string — The last name of the Beneficiary registered with the bank
  - `bank_name` string, required — The bank name where the Beneficiary has their bank account
  - `bank_no` string, required — The bank number of the bank
  - `bank_account_type` 'BANK', required — The bank account type of the approver Beneficiary
  - `country` string — The country code of the account of the Beneficiary
  - `payout_channel` 'GBPRIMEPAY_PAYOUT' | 'PAYNAMICS_PAYOUT' | 'APPOTAPAY_PAYOUT', required — The payout channel via which you want to use this Benificiary account
  - `environment` 'live' | 'sandbox', required — The environment of the transaction is either live OR sandbox
  - `signature_hash` string, required — The SignatureHash generated for the specific payload data

## Response `200`

Successful response

- object
  - `uuid` string — The unique identifier for the beneficiary.
  - `name` string — The name of the beneficiary.
  - `email` string — The email of the beneficiary.
  - `phone` string — The phone of the beneficiary.
  - `address` string — The address of the beneficiary.

## Other responses

- `400` — Failure response
- `401` — Failure response

---

[API](https://skmtc.net/portone/apis/payment-apis.md) · [All operations](https://skmtc.net/portone/apis/payment-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/portone/payment-apis/revisions/f3ccea652555/schema)