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

Parameter	Type	Description
PartnerId	integer	FitBank provided ID
ElectronicPayerTaxNumber	string	Electronic Payer CPF/CNPJ
InclusionDate	string	Date of joining the DDA service
CancelDate	string	Date of exclusion from electronic payer
Method	string	UpdateElectronicPayerWebhook
BusinessUnitId	string	FitBank provided ID

Webhook for Boleto Alerts

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

{
    "Beneficiary": {
        "TaxNumber": "",
        "TradingName": "", 
        "LegalName": "", 
        "FullName": "" 
    },
    "Payer": {
        "TaxNumber": "", 
        "TradingName": "", 
        "LegalName": "", 
        "FullName": "" 
    },
    "OurNumber": "", 
    "Barcode": "",
    "DigitableLine": "", 
    "DueDate": "", 
    "BoletoUpdSeqNumber": 2, 
    "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 
        }
    ],
    "OcurrenceDate": " ", 
    "Situation": "", 
    "Method":"UpdateBoletoAlert"
}

{
    "WriteOffs": [
        {
            "WriteOffIdentifier": "",
            "Barcode": "",
            "Type": 1,
            "PayerBankCode": "",
            "PayerBankBranch": "",
            "PaidValue": 1.0,
            "OccurrenceDate": " ",
            "Situation": "",
            "PaymentChannel": "",
            "PaymentMode": ""
        }
    ],
    "Method": "UpdateWriteOffAlert"
}

{
    "CancelWriteOffs": [
        {
            "WriteOffIdentifier": "",
            "PaidValue": 1.0,
            "OccurrenceDate": " ",
            "Situation": ""
        }
    ],
    "Method": "UpdateCancelWriteOffAlert"
}

Field Mapping Table

For Issued Boletos

Field	Type	Description
Method	string	Webhook method identifier: `UpdateBoletoAlert`
BoletoUpdSeqNumber	integer	Sequential number for boleto updates

Beneficiary Object

Field	Type	Description
TaxNumber	string	Beneficiary's CPF or CNPJ (tax identification number). Format: 11 digits for CPF or 14 digits for CNPJ
TradingName	string	Beneficiary's trade name (nome fantasia)
LegalName	string	Beneficiary's legal/corporate name (razão social)
FullName	string	Beneficiary's full name (same as legal name)

Payer Object

Field	Type	Description
TaxNumber	string	Payer's CPF or CNPJ (tax identification number). Format: 11 digits for CPF or 14 digits for CNPJ
TradingName	string	Payer's trade name (nome fantasia)
LegalName	string	Payer's legal/corporate name (razão social)
FullName	string	Payer's full name (same as legal name)

Payment Slip Fields

Field	Type	Description
OurNumber	string	Bank-assigned identifier for the payment slip (nosso número)
Barcode	string	Numeric barcode for payment processing (44 digits)
DigitableLine	string	Human-readable payment line with check digits (47 digits)
DueDate	string	Payment due date. Format: `YYYY-MM-DD`
PrincipalValue	decimal	Original face value of the payment slip
ExternalNumber	string	Document number assigned by beneficiary
CreationDate	string	Date when the payment slip was issued. Format: `YYYY-MM-DD`
ExpirationDate	string	Final date for payment acceptance. Format: `YYYY-MM-DD`
IsBlocked	boolean	Indicates if payment is currently blocked. `true` = blocked, `false` = available
RebateValue	decimal	Discount/rebate amount applied to the slip
OcurrenceDate	string	Date of the occurrence/movement. Format: `YYYY-MM-DD`
Situation	string	Current status/situation of the payment slip.

Interest Object

Field	Type	Description
Date	string	Date from which interest starts accruing. Format: `YYYY-MM-DD`
Type	integer	Interest calculation type code.
Value	decimal	Interest rate or amount (percentage or fixed value)

Fine Object

Field	Type	Description
Date	string	Date from which the fine becomes applicable. Format: `YYYY-MM-DD`
Type	integer	Fine calculation type code.
Value	decimal	Fine rate or amount (percentage or fixed value)

Discount Array

Field	Type	Description
Date	string	Date until which the discount is valid. Format: `YYYY-MM-DD`
Type	integer	Discount calculation type code.
Value	decimal	Discount rate or amount (percentage or fixed value)

For Settled Boletos (WriteOffs)

Field	Type	Description
Method	string	Webhook method identifier: `UpdateBoletoDDAWebhook`
WriteOffs	array	Array of write-off records for settled payments

WriteOff Object

Field	Type	Description
WriteOffIdentifier	string	Unique identifier for the write-off transaction
Barcode	string	Barcode of the payment slip that was written off (44 digits)
Type	integer	Type of write-off.
PayerBankCode	string	Bank code (COMPE) of the institution receiving the payment.
PayerBankBranch	string	Branch code where the payment was received
PaidValue	decimal	Total amount paid for the write-off
OcurrenceDate	string	Date and time when the write-off occurred. Format: `YYYY-MM-DD` or `YYYY-MM-DD HH:mm:ss`
Situation	string	Current status/situation of the payment slip.
PaymentChannel	string	Channel used for payment.
PaymentMode	string	Mode/method of payment.

For Write-Off Cancellation (CancelWriteOffs)

Field	Type	Description
Method	string	Webhook method identifier: `UpdateBoletoDDAWebhook`
CancelWriteOffs	array	Array of cancelled write-off records

CancelWriteOff Object

Field	Type	Description
WriteOffIdentifier	string	Unique identifier of the write-off being cancelled
PaidValue	decimal	Total amount that was paid (being reversed)
OcurrenceDate	string	Date and time when the cancellation occurred. Format: `YYYY-MM-DD` or `YYYY-MM-DD HH:mm:ss`
Situation	string	New status/situation after cancellation.

Open Payment Slips Webhook

Description

This webhook is triggered when there are open payment slips available for a payer. It provides a list of all active payment obligations that the payer needs to settle.

Method: UpdateNewPayerBoletoAlert

Payload Structure

{
    "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
                }
            ],
            "OcurrenceDate": "",
            "Situation": ""
        }
    ],
    "Method": "UpdateNewPayerBoletoAlert"
}