Issuer Bank Account Registration
This endpoint allows registering a bank account associated with a previously registered issuer.
Request
ENDPOINT
/issuer_management/issuer/ISSUER-KEY/bank_accountMETHOD
POSTPath Params
| Field | Type | Description | Characters |
|---|---|---|---|
ISSUER-KEY | string | Unique issuer key (UUID v4). | 36 |
Request Body
Request Body
{
"account_number": "12345678",
"account_digit": "1",
"account_branch": "1234",
"financial_institution_code_number": "001",
"financial_institution_ispb": "00000000",
"account_type": "checking"
}
Request Body Params
| Field | Type | Description | Max Characters |
|---|---|---|---|
account_number * | string | Bank account number. Must contain only digits. | 20 |
account_digit * | string | Account verification digit. Must contain a single digit. | 1 |
account_branch * | string | Bank branch number. Must contain only digits. | 6 |
financial_institution_code_number* | string | Financial institution code (3 digits). | 3 |
financial_institution_ispb * | string | Financial institution ISPB code (8 digits). | 8 |
account_type * | string | Bank account type. | account_type Enumerators |
account_type Enumerators
| Enum | Description |
|---|---|
checking | Checking Account |
savings | Savings Account |
salary | Salary Account |
payment | Payment Account |
Response
STATUS
201Response Body
{
"bank_account_key": "123e4567-e89b-12d3-a456-426614174000",
"account_number": "12345678",
"account_digit": "1",
"account_branch": "1234",
"financial_institution_code_number": "001",
"financial_institution_ispb": "00000000",
"account_type": "checking"
}
Response Body Params
| Field | Type | Description | Max Characters |
|---|---|---|---|
bank_account_key | string | Unique identifier of the registered bank account (UUID v4). | 36 |
account_number | string | Bank account number. | 20 |
account_digit | string | Bank account verification digit. | 1 |
account_branch | string | Bank branch number. | 6 |
financial_institution_code_number | string | Financial institution code. | 3 |
financial_institution_ispb | string | Financial institution ISPB code. | 8 |
account_type | string | Bank account type. | account_type Enumerators |