Register beneficiary

Register a new beneficiary with Pismo.

A newly-registerd beneficiary is not initially enabled and must be activated before use in transactions.

Body Params

Register beneficiary request body

string
required
length ≤ 50

Beneficiary account code.

integer
required

Account ID

string
required
length ≤ 50

Beneficiary's first and last name.

string
required

ISO-3166 two letter country code. For example, BR=Brazil.

string
enum
required

Beneficiary schema validation:

BANKACCOUNT - account_code contains a Brazilian account number (used in junction with the bank_code and branch fields)

PIX - account_code contains a valid Pix key. For more information, see Pix instant payments

DOCUMENTNUMBER - account_code contains a valid Brazilian document number. This is government document number, such as Cadastro de Pessoas Físicas number - a Brazilian tax registry number, similar to a Social Security number in the US.

Allowed:
string
enum
length ≤ 4

Account type:
CACC - Checking/current account. Known as "conta corrente" in Portuguese, this is a bank account type designed for everyday financial transactions and is the most common type individuals and businesses use for day-to-day banking. SVGS - Savings account TRAN - Payment account. Payment institutions offer payment accounts to move funds and make payments, while banks offer checking accounts that include full financial services such as credit and investments. SLRY - Salary account. Employer deposits a fixed amount every month.

Allowed:
string
length ≤ 20

Beneficiary alias.

string
length ≤ 20

Beneficiary bank code.

string
length ≤ 50

Beneficiary branch.

string
length ≤ 20

A government document number, such as a Social Security number (US) or Cadastro de Pessoas Físicas number (Brazil).

Headers
string
required

Account token - Token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a 401 Unauthorized error.

Responses

Language
Credentials
Bearer
JWT
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json