Create A Beneficiary

post

https://api.portone.cloud/api/merchants/{key}/payout/createBeneficiary

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

key

string

required

Body Params

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

string

enum

required

The bank account type of the approver Beneficiary

Allowed:

country

string

The country code of the account of the Beneficiary

payout_channel

string

enum

required

The payout channel via which you want to use this Benificiary account

Allowed:

environment

string

enum

required

The environment of the transaction is either live OR sandbox

Allowed:

signature_hash

string

required

The SignatureHash generated for the specific payload data

Headers

Content-Type

string

X-Portone-Client-Key

string

Authorization

string

The Authorization header is used to include the JWT for authenticating API requests; learn how to generate the token in this guide

Responses

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful response

400Failure response

401Failure response