Route: POST /account
Description: When creating a new account, you can specify a webhook URL that will be used for account-related notifications.
Request Example:
{
"entity_uuid": "string",
"entity_type": "string",
"user_uuids": [
"string"
],
"transmitter": "string",
"name": "string",
"email": "string",
"tax_id": "string",
"mobile_phone": "string",
"account_type": "string",
"account_bank": {
"bank_code": "string",
"account_type": "string",
"account_number": "string",
"account_digit": "string",
"agency": "string"
},
"account_owner": {
"name": "string",
"tax_id": "string",
"birth_date": "string",
"mobile_phone": "string",
"mothers_name": "string"
},
"address": {
"street": "string",
"number": "string",
"district": "string",
"zip_code": "string",
"state": "string",
"city": "string"
},
"mcc": "string",
"hold_days": 2,
"split": {
"entity_uuid": "string",
"percentage": 0.2
},
"webhook_url": "https://webhook-test.com/3389079f102da2fa60b128e6aea86447"
}
Field webhook_url:
- Description: URL that will be called whenever there is a relevant update to the account.
- Format: String (valid URL)
- Required: Optional
Response Example:
{
"entity_uuid": "string",
"active": true
}
- entity_uuid:Unique identifier of the account.
- active: Indicates whether the account is active (true or false).