Create Beneficiaries



Ensure that your user account has Creator role, otherwise request will be rejected.

Use this API to create a new beneficiary information for quick access on the Payout page in Midtrans Dashboard.

  "name": "John Doe",
  "account": "33452784",
  "bank": "bca",
  "alias_name": "johnbca",
  "email": "[email protected]"
  "status": "created"

HTTP Request

POST BASE_URL/api/v1/beneficiaries

Request Parameters

namestring Name of the Beneficiary
accountnumber Bank account number of the Beneficiary (for payout to bank account) or phone number beginning with 62 or 08 (for payout to e-wallet)
Length should be within 6 to 20 characters
bankstring Bank name used by the Beneficiary for payout to bank, or gopay and ovo for payout to e-wallet.
alias_namestring Alias name used by the Beneficiary
Length should be less than or equal to 20 characters
Only alphanumeric characters are allowed
emailoptional string Valid Email address for Beneficiary