2.2 - Electronic Payer Alteration
Electronic Payer Alteration
The AlterElectronicPayer method allows for the inclusion and exclusion of accounts linked to the payer client, as long as at least one remains active. The method must receive the SPB banks.
DDA accounts not mentioned in the modification request will not be replaced, meaning that excluded accounts must remain excluded, and active accounts must remain active.
It will not be possible to change the branch and account data of the payer. If necessary, the electronic payer must send a request to exclude the already registered branch and account and, subsequently, a request for inclusion. This action can be performed even within the same modification request, and does not necessarily need to be ordered.
{
"Method": "AlterElectronicPayer",
"BusinessUnitId": 123,
"PartnerId": 123,
"TaxNumber": "",
"Accounts": [
{
"Type": "",
"Bank": "",
"BankBranch": "",
"Account": "",
"AccountDigit": ""
}
]
}
{
"Success": "true",
"Message": "A solicitação para alteração do pagador eletrônico foi enviada"
}
Description
Parameter | Type | Description | Mandatory |
---|---|---|---|
Method | string | AlterElectronicPayer | Yes |
PartnerId | integer | FitBank provided ID | Yes |
BusinessUnitId | integer | FitBank provided ID | Yes |
TaxNumber | string | Electronic Payer's CPF/CNPJ | Yes |
Accounts | Object | Electronic Payer Account Information | Yes |
Type | integer | 0 → Inclusion of banking information 1 → Exclusion of banking information | Yes |
Bank | String | Electronic Payer's bank | Yes |
BankBranch | String | Electronic Payer's bank branch | Yes |
Account | String | Electronic Payer's account | Yes |
AccountDigit | String | Electronic Payer's account digit | Yes |
Failure Response - When the customer submits a non-SPB account.
{
"Success": "false",
"Message": "Não foi possível localizar a conta SPB na posição {0}0",
"Validation": []
}
Failure Response - Did the method confirm that the account provided corresponds to the entered TaxNumber?
{
"Success": "false",
"Message": "ISE0014 - Informações enviadas estão inválidas. Veja a propriedade Validation do json para mais detalhes.",
"Validation": [
{
"Key": "TaxNumber",
"Value": [
"ISE0141 - CPF/CNPJ do contribuinte deve ser informado."
]
}
]
}
Failure Response - When the user tries to register an already registered account
{
"Success": "false",
"Message": "A conta na posição {0} já cadastrada para pagador eletrônico",
"Validation": []
}
Failure Response - When the user has only one registered account
{
"Success": "false",
"Message": "O pagador eletrônico deve possuir pelo menos uma conta cadastrada",
"Validation": []
}
Failure Response - When user tries to delete an unregistered account
{
"Success": "false",
"Message": "Não foi possível localizar a conta SPB na posição {0}0",
"Validation": []
}
Failure Response - When a customer with only one registered account can send the deletion of that account and the inclusion of the same account
{
"Success": "false",
"Message": "Não é permitido enviar mais de uma alteração para uma mesma conta. Valide os dados da suas contas, e tente novamente",
"Validation": []
}
Updated 11 days ago