Create a beneficiary

post

https://{base_url}/v2/beneficiaries

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Create an ACH beneficiary

country

string

enum

required

Beneficiary ISO 2 Country Code

address

object

Address of the beneficiary, Residential for Individual or Registered Legal address for Business.

kind

string

enum

required

Kind of Beneficiary

Allowed:

name

string

required

length ≤ 128

Account holder name

friendly_name

string

length ≤ 128

Optional name for easier identification

currency

string

enum

required

Currency of the account

Allowed:

string

Email address of the beneficiary

is_own_account

boolean

Defaults to false

Is this an account owned by the Institution

client_reference

string

length ≤ 128

Custom reference for this beneficiary (optional)

method

object

required

Response

Language

Credentials

Header

URL

Loading…

Response

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

application/json

201Created beneficiary