When there is a change in the bank details validation status, the API will send a notification with the following parameters: notification type, seller identification (MerchantId), and bank domicile data.
Example of bank domicile validation notification sent by the API:
{
"ChangeType": 21,
"MasterMerchantId": "96ffb8be-6693-4f9b-bf8e-925b555b3207",
"Data": {
"MerchantId": "4d76b525-e66d-402e-a318-5fd3ce1af7aa",
"MerchantType": "Subordinate",
"Status": 3,
"AccountNumber": "123",
"AccountDigit": "1",
"AgencyNumber": "3581",
"AgencyDigit": "x",
"CompeCode": "260",
"BankAccountType": 1,
"DocumentNumber": "45224563215",
"DocumentType": 2
}
}| Property | Type | Size | Description |
|---|---|---|---|
ChangeType | Number | Notification type identifier. For bank account validation notification, ChangeType equals "21". | |
MasterMerchantId | GUID | 36 | Master identification. |
Data.MerchantId | GUID | 36 | Seller identification. |
Data.MerchantType | Text | 14 | Merchant type. Valid types are “Subordinate” or “Master”. |
Data.BankAccountValidationStatus | Number | 1 | Bank domicile validation process status. Valid statuses are: InternalError = 0; Created = 1; Processing = 2; Success = 3; Error = 4. |
Data.CompeCode | Text | 3 | Bank clearing code. See list of clearing codes. |
Data.BankAccountType | Text | 1 | Bank account type. Valid types are: 1 - “CheckingAccount”; 2 - “SavingsAccount”. |
Data.AccountNumber | Text | 10 | Seller's account number. |
Data.AccountDigit | Text | 1 | Seller's account verifier digit. |
Data.AgencyNumber | Text | 15 | Seller's branch number. Warning: Zeroed values such as “0”, “00”, “000” are invalid. |
Data.AgencyDigit | Text | 1 | Seller's branch check digit. If the branch does not have a check digit, enter the value “x”. |
Data.DocumentNumber | Text | 14 | Seller's account document number. |
Data.DocumentType | Text | Document type. Valid types are “CPF” or “CNPJ”. |