Skip to main content

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_account
METHOD
POST

Path Params

FieldTypeDescriptionCharacters
ISSUER-KEYstringUnique 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

FieldTypeDescriptionMax Characters
account_number *stringBank account number. Must contain only digits.20
account_digit *stringAccount verification digit. Must contain a single digit.1
account_branch *stringBank branch number. Must contain only digits.6
financial_institution_code_number*stringFinancial institution code (3 digits).3
financial_institution_ispb *stringFinancial institution ISPB code (8 digits).8
account_type *stringBank account type.account_type Enumerators

account_type Enumerators

EnumDescription
checkingChecking Account
savingsSavings Account
salarySalary Account
paymentPayment Account

Response

STATUS
201
Response 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

FieldTypeDescriptionMax Characters
bank_account_keystringUnique identifier of the registered bank account (UUID v4).36
account_numberstringBank account number.20
account_digitstringBank account verification digit.1
account_branchstringBank branch number.6
financial_institution_code_numberstringFinancial institution code.3
financial_institution_ispbstringFinancial institution ISPB code.8
account_typestringBank account type.account_type Enumerators