v1

latestOpenAPI 3.0.02026-07-246335313.6 KB

Payout APIs

Create A Beneficiary

post/api/merchants/{key}/payout/createBeneficiary

Path parameters

keystring required

Headers

Content-Typestring

X-Portone-Client-Keystring

Authorizationstring

The Authorization header is used to include the JWT for authenticating API requests; learn how to generate the token <a href="/docs/jwt-authentication" target="_blank">in this guide</a>

Request body

emailstring

The email of the Beneficiary

namestring required

The name of the Beneficiary

phonestring

The phone number of the Beneficiary

addressstring

The address of the Beneficiary

bank_account_numberstring required

The bank account number of the Beneficiary

bank_account_namestring required

The first name of the Beneficiary registered with the bank

bank_account_middle_namestring

The middle name of the Beneficiary registered with the bank

bank_account_last_namestring

The last name of the Beneficiary registered with the bank

bank_namestring required

The bank name where the Beneficiary has their bank account

bank_nostring required

The bank number of the bank

bank_account_type'BANK' required

The bank account type of the approver Beneficiary

countrystring

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_hashstring required

The SignatureHash generated for the specific payload data

Example request

{
  "name": "Nguyen Van A",
  "email": "jatin@portone.io",
  "phone": "+919876543210",
  "address": "test",
  "bank_account_number": "288477738990000",
  "bank_account_name": "Nguyen Van A",
  "bank_name": "Bank of Ayudhya Public Company Limited",
  "bank_no": "025",
  "bank_account_type": "BANK",
  "payout_channel": "GBPRIMEPAY_PAYOUT",
  "environment": "sandbox",
  "signature_hash": "{{signature_hash}}"
}

Response

Successful response

uuidstring

The unique identifier for the beneficiary.

namestring

The name of the beneficiary.

emailstring

The email of the beneficiary.

phonestring

The phone of the beneficiary.

addressstring

The address of the beneficiary.