4 - Webhooks

Electronic Payer Webhook - UpdateElectronicPayerWebhook

The webhook will notify the client when the Electronic Payer is added, removed, or changed.

{
  "PartnerId": 630,
  "ElectronicPayerTaxNumber": "61756839352",
  "InclusionDate": "2023-12-19T10:38:43.74",
  "CancelDate": null,
  "Method": "UpdateElectronicPayerWebhook",
  "BusinessUnitId": 649
}
{
    "ElectronicPayerTaxNumber": "61756839352",
    "Accounts": [
        {
            "Type": "0", //CONTA INCLUIDA
            "Bank": "450",
            "BankBranch": "0001",
            "Account": "265262",
            "AccountDigit": "2"
        },
        {
            "Type": "1", //CONTA EXCLUIDA
            "Bank": "",
            "BankBranch": "0001",
            "Account": "65656",
            "AccountDigit": "7"
        }
    ],
    "Date": "2023-12-19T10:38:43.74",
    "PartnerId": 630,
    "Method": "UpdateElectronicPayerWebhook",
    "BusinessUnitId": 649
}
{  
  "PartnerId": 630,  
  "ElectronicPayerTaxNumber": "61756839352",  
  "InclusionDate": "2023-12-19T10:38:43.74",  
  "CancelDate": "2023-12-20T10:38:43.74",  
  "Method": "UpdateElectronicPayerWebhook",  
  "BusinessUnitId": 649  
}

Description

ParameterTypeDescription
PartnerIdintegerFitBank provided ID
ElectronicPayerTaxNumberstringElectronic Payer CPF/CNPJ
InclusionDatestringDate of joining the DDA service
CancelDatestringDate of exclusion from electronic payer
MethodstringUpdateElectronicPayerWebhook
BusinessUnitIdstringFitBank provided ID

🚧

Beta version

Webhook for Boleto Alerts

This webhook will notify when the electronic payer's boleto is issued, settled, and write-off canceled.

{
    "Boletos": [
        {
            "Beneficiary": {
                "TaxNumber": "",
                "TradingName": "",
                "LegalName": "",
                "FullName": ""
            },
            "Payer": {
                "TaxNumber": "",
                "TradingName": "",
                "LegalName": "",
                "FullName": ""
            },
            "OurNumber": "",
            "Barcode": "",
            "DigitableLine": "",
            "DueDate": "",
            "PrincipalValue": 1.0,
            "ExternalNumber": "",
            "CreationDate": "2023-10-27",
            "ExpirationDate": "2024-09-04",
            "IsBlocked": false,
            "RebateValue": 1.0,
            "Interest": {
                "Date": "",
                "Type": 0,
                "Value": 1.0
            },
            "Fine": {
                "Date": "",
                "Type": 0,
                "Value": 1.0
            },
            "Discount": [
                {
                    "Date": "",
                    "Type": 0,
                    "Value": 1.0
                }
            ],
            "OccurrenceDate": " ",
            "Situation": ""
        }
    ],
    "Method": "UpdateBoletoDDAWebhook"
}
{
    "WriteOffs": [
        {
            "WriteOffIdentifier": "",
            "Barcode": "",
            "Type": 1,
            "PayerBankCode": "",
            "PayerBankBranch": "",
            "PaidValue": 1.0,
            "OccurrenceDate": " ",
            "Situation": "",
            "PaymentChannel": "",
            "PaymentMode": ""
        }
    ],
    "Method": "UpdateWriteOffDDAWebhook"
}
{
    "CancelWriteOffs": [
        {
            "WriteOffIdentifier": "",
            "PaidValue": 1.0,
            "OccurrenceDate": " ",
            "Situation": ""
        }
    ],
    "Method": "UpdateCancelWriteOffDDAWebhook"
}