Skip to main content

Create destination account for escrow

This endpoint allows creating a destination account for an escrow account

Request

Request Endpoint

ENDPOINT
/account/ACCOUNT_KEY/destination
METHOD
POST

Request Path Params

FieldTypeDescriptionCharacters
account_key *uuid4Unique account identification key.36
Request Body: adding destination account
{
"name": "Minha conta destino",
"ted_account_type": "checking_account",
"document_number": "51297635200133",
"account_branch": "3422",
"account_digit": "8",
"account_number": "08042",
"financial_institutions_code_number": "329"
}

Body Params

FieldTypeDescription
name *stringRecipient name
ted_account_type *enumDestination account type.
account_branch *stringDestination account branch.
account_digit *stringDestination account digit.
account_number *stringDestination account number.
financial_institutions_code_number *stringDestination account bank code.

Response

Success Response

STATUS
201
Response Body:
{}

Error Response

STATUS
4XX
Response Body
{
"title": "Título",
"description": "Description in english",
"translation": "Descrição em português",
"code": "Código"
}
HTTP CodeQI CodeTitleDescription (eng)Description (pt-br)
404ACC000006Not foundAccount not found for the given key ACCOUNT_KEYAccount not found for the given key ACCOUNT_KEY
403ACC000219Requester not allowed to perform this actionRequester not allowed to create destinationRequester not allowed to create destination