5 - Webhooks

Operations Status
According to the messages received from the Webhooks regarding the status of operations, this is a flow where we can see each step of the status and what each one of them are:

State Type:

Webhook - Payments
Status	Type	Description
3	Registered	The operation was successfully registered and is waiting for processing. This is not a final status of the transaction.
5	Paid	The operation was successfully completed and the payment was made. This is a final status.*
7	Cancel	The operation was cancelled and will not be processed. This is a final status.*
9	Error Balance	The operation is waiting for sufficient financial resources to attempt processing. Once the financial resources are available, the transaction will proceed normally through the workflow, according to the Business Unit's configuration. This is not a final status.

*Reversal:The operation initially reached the "Paid" status. However, due to some adverse event, the final recipient refused the payment and returned the financial resources. As a result, the status will be changed from "Paid" to "Cancelled" and the amount will be reversed to the account.

Payment HUB Webhook Boleto Out

{
    "InterestValue": 0.00,
    "FineValue": 0.00,
    "BankConcessionareFavored": "SEFAZ/CE",
    "Barcode": "85630000000034600098026012220262631403002800",
    "DueDate": "2026-01-22T00:00:00",
    "BeneficiaryTaxNumber": null,
    "BeneficiaryName": null,
    "GuarantorTaxNumber": null,
    "GuarantorName": null,
    "PayerTaxNumber": null,
    "PayerName": null,
    "ReceiptUrl": "https://receipt.fitbank.com.br/receiptapi/pdf?filename=2026-01-22/2130638431dpy5g.pdf",
    "PaymentAuthentication": "EE092B5A-F258-4D7E-9D2C-A53D09179F51",
    "PaymentProtocol": "d6361c7dksd0749939ae48dc790a51c48",
    "PaymentSubType": 13,
    "PaymentValue": 3.46,
    "SenderNameBank": "Bradesco",
    "SenderCodeBank": "237",
    "SenderBranch": "0504",
    "SenderAccount": "0432322",
    "SenderAccountDigit": "0",
    "ReturnCodes": [
        "BD"
    ],
    "ReturnErrorMessage": null,
    "ReturnErrorCode": null,
    "ReturnMessage": "Inclusão realizada com sucesso, pagamento registrado",
    "Tags": null,
    "PartnerId": 1755,
    "DocumentNumber": "280498241",
    "Identifier": "8b1b647e-4141-4dls-9932-77504d95abc3_2783426_system_08429cc7-bf8f-45cc-b8ca-362fafb5cb42",
    "EntryId": 12850980290,
    "Status": "Registered",
    "TotalValue": 3.46,
    "PaymentDate": null,
    "FineInterest": null,
    "DiscountValue": 0.00,
    "DiscountValue2": null,
    "DiscountValue3": null,
    "DiscountDate": null,
    "DiscountDate2": null,
    "DiscountDate3": null,
    "RebateValue": null,
    "IofValue": null,
    "PaidValue": 3.46,
    "OtherValues": 0.0,
    "CreditDate": null,
    "OccurrenceDate": null,
    "URL": null,
    "BankCode": "450",
    "BankBranch": "0001",
    "BankAccount": "40986277",
    "BankAccountDigit": "01",
    "ReturnCode": "BD",
    "Method": "BoletoOut",
    "BusinessUnitId": 1720
}{
    "InterestValue": 0.00,
    "FineValue": 0.00,
    "BankConcessionareFavored": "SEFAZ/CE",
    "Barcode": "856300000000987000620260122252344011403002800",
    "DueDate": "2026-01-22T00:00:00",
    "BeneficiaryTaxNumber": null,
    "BeneficiaryName": null,
    "GuarantorTaxNumber": null,
    "GuarantorName": null,
    "PayerTaxNumber": null,
    "PayerName": null,
    "ReceiptUrl": "https://receipt.fitbank.com.br/receiptapi/pdf?filename=2026-01-22/21306382331dpy5g.pdf",
    "PaymentAuthentication": "EE902B5A-F258-4D7E-9D2C-A43F51179F61",
    "PaymentProtocol": "d6361c7dd3b749939ke78dc790a51c48",
    "PaymentSubType": 13,
    "PaymentValue": 3.46,
    "SenderNameBank": "Bradesco",
    "SenderCodeBank": "237",
    "SenderBranch": "0504",
    "SenderAccount": "0403242",
    "SenderAccountDigit": "0",
    "ReturnCodes": [
        "BD"
    ],
    "ReturnErrorMessage": null,
    "ReturnErrorCode": null,
    "ReturnMessage": "Inclusão realizada com sucesso, pagamento registrado",
    "Tags": null,
    "PartnerId": 15,
    "DocumentNumber": "286613241",
    "Identifier": "8b1b647e-4141-47a0-9932-77504d95abc3_2783426_system_08429cc7-bf8f-45cc-b8ca-362fafb5cb42",
    "EntryId": 12853240290,
    "Status": "Registered",
    "TotalValue": 3.46,
    "PaymentDate": null,
    "FineInterest": null,
    "DiscountValue": 0.00,
    "DiscountValue2": null,
    "DiscountValue3": null,
    "DiscountDate": null,
    "DiscountDate2": null,
    "DiscountDate3": null,
    "RebateValue": null,
    "IofValue": null,
    "PaidValue": 3.46,
    "OtherValues": 0.0,
    "CreditDate": null,
    "OccurrenceDate": null,
    "URL": null,
    "BankCode": "450",
    "BankBranch": "0001",
    "BankAccount": "42434346277",
    "BankAccountDigit": "01",
    "ReturnCode": "BD",
    "Method": "BoletoOut",
    "BusinessUnitId": 10
}

{
    "Method": "BoletoOut",
    "BusinessUnitId": 1,
    "InterestValue": 0.00,
    "FineValue": 0.00,
    "BankConcessionareFavored": "Banco Cooperativo Sicredi",
    "Barcode": "74797153400000045001126243915122060257992100",
    "DueDate": "2026-01-22T00:00:00",
    "BeneficiaryTaxNumber": "15675475700109",
    "BeneficiaryName": "SERVICOS OCUPACIONAIS",
    "GuarantorTaxNumber": null,
    "GuarantorName": null,
    "PayerTaxNumber": "44361000000233",
    "PayerName": "TRABALHO OCUPACIONAL LTDA",
    "ReceiptUrl": "https://receipt.fitbank.com.br/receiptapi/pdf?filename=2026-01-22/2130639319bsqry.pdf",
    "PaymentAuthentication": "14CDEA11-1088-431D-96DD-E391CF572EAC",
    "PaymentProtocol": "0a8961pfa49d42a6a91f07a01a4112de",
    "PaymentSubType": null,
    "PaymentValue": 45.00,
    "SenderNameBank": "Fitbank Pagamentos Eletronicos SA",
    "SenderCodeBank": "450",
    "SenderBranch": "0",
    "SenderAccount": "0",
    "SenderAccountDigit": "0",
    "ReturnCodes": [
        "00",
        "BD"
    ],
    "ReturnErrorMessage": null,
    "ReturnErrorCode": null,
    "ReturnMessage": "PAGAMENTO EFETUADO",
    "Tags": null,
    "PartnerId": 1,
    "DocumentNumber": "285518344",
    "Identifier": "387836_     9947744027_         1",
    "EntryId": 12855454314,
    "Status": "Paid",
    "TotalValue": 45.00,
    "PaymentDate": "2026-01-22T15:31:44.39",
    "FineInterest": null,
    "DiscountValue": 0.00,
    "DiscountValue2": null,
    "DiscountValue3": null,
    "DiscountDate": null,
    "DiscountDate2": null,
    "DiscountDate3": null,
    "RebateValue": null,
    "IofValue": null,
    "PaidValue": 45.00,
    "OtherValues": 0.0,
    "CreditDate": null,
    "OccurrenceDate": null,
    "URL": null,
    "BankCode": null,
    "BankBranch": null,
    "BankAccount": null,
    "BankAccountDigit": null,
    "ReturnCode": "00"
}

{
    "Method": "BoletoOut",
    "BusinessUnitId": 84,
    "InterestValue": 0.00,
    "FineValue": 0.00,
    "BankConcessionareFavored": "Claro",
    "Barcode": "84860000001241801622025090115358684405323122",
    "DueDate": "2025-09-01T00:00:00",
    "BeneficiaryTaxNumber": null,
    "BeneficiaryName": null,
    "GuarantorTaxNumber": null,
    "GuarantorName": null,
    "PayerTaxNumber": null,
    "PayerName": null,
    "ReceiptUrl": "https://receipt.fitbank.com.br/receiptapi/pdf?filename=2025-09-23/202572233262ufqp.pdf",
    "PaymentAuthentication": "44D329F7-54B9-4BF3-AF71-F93C0A7F73CE",
    "PaymentProtocol": "1ea020ba02323a141948612e",
    "PaymentSubType": 13,
    "PaymentValue": 62.27,
    "SenderNameBank": "Fitbank Pagamentos Eletronicos SA",
    "SenderCodeBank": "450",
    "SenderBranch": "0001",
    "SenderAccount": "00333",
    "SenderAccountDigit": "0",
    "ReturnCodes": [
        "CF"
    ],
    "ReturnErrorMessage": null,
    "ReturnErrorCode": null,
    "ReturnMessage": "O valor do pagamento é diferente do valor total",
    "Tags": null,
    "PartnerId": 1,
    "DocumentNumber": "268408557",
    "Identifier": "blt-2fd8-6204-a661-02dffbf6c2f9",
    "EntryId": 123760226,
    "Status": "Cancel",
    "TotalValue": 62.27,
    "PaymentDate": null,
    "FineInterest": null,
    "DiscountValue": 0.00,
    "DiscountValue2": null,
    "DiscountValue3": null,
    "DiscountDate": null,
    "DiscountDate2": null,
    "DiscountDate3": null,
    "RebateValue": null,
    "IofValue": null,
    "PaidValue": 62.27,
    "OtherValues": 0.0,
    "CreditDate": null,
    "OccurrenceDate": null,
    "URL": null,
    "BankCode": "1",
    "BankBranch": "8",
    "BankAccount": "631423323291",
    "BankAccountDigit": "0",
    "ReturnCode": "CF"
}

{
    "Method": "BoletoOut",
    "BusinessUnitId": 3,
    "InterestValue": 0.00,
    "FineValue": 0.00,
    "BankConcessionareFavored": "Banco Intermedium S.A.",
    "Barcode": "07794132600000323232011767805899631420844",
    "DueDate": "2026-01-14T00:00:00",
    "BeneficiaryTaxNumber": null,
    "BeneficiaryName": null,
    "GuarantorTaxNumber": null,
    "GuarantorName": null,
    "PayerTaxNumber": "16617693736",
    "PayerName": null,
    "ReceiptUrl": "https://receipt.fitbank.com.br/receiptapi/pdf?filename=2026-01-07/213232945479eyotu.pdf",
    "PaymentAuthentication": null,
    "PaymentProtocol": "1c4658e90f1b4daeb232375f6f47fc86",
    "PaymentSubType": null,
    "PaymentValue": 250.00,
    "SenderNameBank": "Fitbank Pagamentos Eletronicos SA",
    "SenderCodeBank": "450",
    "SenderBranch": "0",
    "SenderAccount": "0",
    "SenderAccountDigit": "0",
    "ReturnCodes": null,
    "ReturnErrorMessage": null,
    "ReturnErrorCode": null,
    "ReturnMessage": null,
    "Tags": [
        "233232"
    ],
    "PartnerId": 3,
    "DocumentNumber": "28323291314",
    "Identifier": "22419233232322593",
    "EntryId": null,
    "Status": "ErrorBalance",
    "TotalValue": 250.00,
    "PaymentDate": null,
    "FineInterest": null,
    "DiscountValue": 0.00,
    "DiscountValue2": null,
    "DiscountValue3": null,
    "DiscountDate": null,
    "DiscountDate2": null,
    "DiscountDate3": null,
    "RebateValue": null,
    "IofValue": null,
    "PaidValue": 250.00,
    "OtherValues": 0.0,
    "CreditDate": null,
    "OccurrenceDate": null,
    "URL": null,
    "BankCode": null,
    "BankBranch": null,
    "BankAccount": null,
    "BankAccountDigit": null,
    "ReturnCode": null
}

Parameter	Description	Type
BusinessUnitId	Identifier of the business unit processing the payment	integer
InterestValue	Interest amount charged on the payment	double
FineValue	Fine amount charged on the payment	double
BankConcessionareFavored	Name of the beneficiary bank or concessionaire	string
Barcode	Boleto barcode number (digitable line)	string
DueDate	Original due date of the boleto	string
BeneficiaryTaxNumber	Tax ID (CPF/CNPJ) of the beneficiary	string
BeneficiaryName	Name of the beneficiary	string
GuarantorTaxNumber	Tax ID (CPF/CNPJ) of the guarantor (if applicable)	string
GuarantorName	Name of the guarantor (if applicable)	string
PayerTaxNumber	Tax ID (CPF/CNPJ) of the payer	string
PayerName	Name of the payer	string
ReceiptUrl	URL to download the payment receipt	string
PaymentAuthentication	Unique authentication code for the payment	string
PaymentProtocol	Protocol number for the payment transaction	string
PaymentSubType	Sub-type classification of the payment	string
PaymentValue	Original payment amount	double
SenderNameBank	Name of the bank sending the payment	string
SenderCodeBank	Bank code of the sender	string
SenderBranch	Branch number of the sender account	string
SenderAccount	Account number of the sender	string
SenderAccountDigit	Verification digit of the sender account	string
ReturnCodes	Array of return codes from the payment processing	array of strings
ReturnErrorMessage	Error message if the payment failed	string
ReturnErrorCode	Error code if the payment failed	string
ReturnMessage	Message describing the payment result	string
Tags	Custom tags associated with the payment	string
PartnerId	Identifier of the partner making the payment	integer
DocumentNumber	Document number associated with the payment	string
Identifier	Unique identifier for the payment request	string
EntryId	Internal entry ID for the payment	long
Status	Current status of the payment	string
TotalValue	Total amount including fees and interest	double
PaymentDate	Date and time when the payment was processed	string
FineInterest	Combined fine and interest amount	double
DiscountValue	First discount amount applied	double
DiscountValue2	Second discount amount applied (if applicable)	double
DiscountValue3	Third discount amount applied (if applicable)	double
DiscountDate	Date until which the first discount is valid	string
DiscountDate2	Date until which the second discount is valid	string
DiscountDate3	Date until which the third discount is valid	string
RebateValue	Rebate amount applied to the payment	double
IofValue	IOF (Tax on Financial Operations) amount	double
PaidValue	Actual amount paid	double
OtherValues	Other additional values/fees	double
CreditDate	Date when the amount will be credited	string
OccurrenceDate	Date of the payment occurrence	string
URL	Additional URL related to the payment	string
BankCode	Bank code for crediting	string
BankBranch	Branch number for crediting	string
BankAccount	Account number for crediting	string
BankAccountDigit	Verification digit for crediting account	string
ReturnCode	Primary return code from the payment processing	string

Payment HUB Webhook Boleto Darf

{
  "Method": "DarfOut",
  "PartnerId": 10358,
  "BusinessUnitId": 30733,
  "DocumentNumber": "00012500",
  "Identifier": "133283h19089ff1285dd83235655b",
  "EntryId": 4657153,
  "InterestValue": "1",
  "FineValue": 12,
  "TotalValue": 13.34,
  "CodeRevenue": "4321",
  "CalculationPeriod": "2020-12-28 00:00:00.000",
  "ContributorTaxNumber": "57990466000107",
  "ContributorName": "Maria Pix Conta",
  "ValueRecipeGrossAccumulated": "0.00",
  "DueDate": "2021-12-15T16:34:07.112Z",
  "ReferenceNumber": "477",
  "Status": "Paid",
  "PaymentDate": "2020-09-11 11:55:46.867",
  "SenderBranch": "string",
  "SenderAccount": 55433,
  "SenderAccountDigit": "9",
  "SenderCodeBank": "string",
  "SenderNameBank": "string",
  "FineInterest": 1,
  "DiscountValue": 2,
  "IofValue": 3,
  "PaidValue": 1000,
  "OtherValues": 0,
  "CreditDate": "11/01/2022",
  "OccurrenceDate": "11/01/2022",
  "PaymentAuthentication": "2CE6A7D9-C229-43E2-87FC-B105EA93A314",
  "PaymentProtocol": 860074288933337700,
  "BankCode": "450",
  "BankBranch": "0001",
  "BankAccount": "146492",
  "BankAccountDigit": "1",
  "ReturnCode": "00",
  "ReturnMessage": "Crédito ou Débito Efetivado",
  "ReturnCodes": "00",
  "ReceiptUrl": "http://www.pdfurl.com.br/2021-11-12/blnj3pof.pdf"
}

Parameter	Description	Type
Method	API method identifier.	string
PartnerId	Partner identifier	integer
BusinessUnitId	Business unit identifier provided by FitBank	integer
DocumentNumber	Document number associated with the payment	string
Identifier	Unique identifier for the payment request	string
EntryId	Internal entry ID for the payment	long
InterestValue	Interest amount charged on the payment	double
FineValue	Fine amount charged on the payment	double
TotalValue	Total DARF amount including fees and interest	double
CodeRevenue	Revenue code for the DARF payment	string
CalculationPeriod	Period used for tax calculation	string
ContributorTaxNumber	Tax ID (CPF/CNPJ) of the contributor	string
ContributorName	Name of the contributor	string
ValueRecipeGrossAccumulated	Accumulated gross revenue value	double
DueDate	DARF expiration/due date (	string
ReferenceNumber	DARF reference number	string
Status	Current status of the payment	string
PaymentDate	Date and time when payment was processed	string
SenderBranch	Beneficiary branch/agency number	string
SenderAccount	Beneficiary account number	string
SenderAccountDigit	Beneficiary account verification digit	string
SenderCodeBank	Beneficiary bank code	string
SenderNameBank	Beneficiary bank name	string
FineInterest	Combined fine and interest amount	double
DiscountValue	Discount amount applied	double
IofValue	IOF (Tax on Financial Operations) amount	double
PaidValue	Actual amount paid	double
OtherValues	Other additional values/fees	double
CreditDate	Date when amount will be credited	string
OccurrenceDate	Date of payment occurrence	string
PaymentAuthentication	Unique payment authentication code	string
PaymentProtocol	Payment protocol number	string
BankCode	Bank code for crediting	string
BankBranch	Branch/agency number for crediting	string
BankAccount	Account number for crediting	string
BankAccountDigit	Account verification digit for crediting	string
ReturnCode	Primary return code from payment processing	string
ReturnMessage	Message describing the payment result	string
ReturnCodes	Array of return codes from payment processing	array of strings
ReceiptUrl	URL to download the payment receipt	string

Payment HUB Webhook Boleto Darj

{
  "Method": "Darj",
  "PartnerId": 10358,
  "BusinessUnitId": 30733,
  "DocumentNumber": "00012500",
  "Identifier": "133283h19089ff1285dd83235655b",
  "EntryId": 4657153,
  "InterestValue": "1",
  "FineValue": 12,
  "MonetaryValue": 22,
  "TotalValue": 13.34,
  "CodeRevenue": "4321",
  "ContributorTaxNumber": "57990466000107",
  "ContributorName": "Maria Pix Conta",
  "OriginDocument": "2",
  "StateRegistration": "67890",
  "ReferenceNumber": "477",
  "DueDate": "2021-12-15T16:34:07.112Z",
  "Status": "Paid",
  "PaymentDate": "2020-09-11 11:55:46.867",
  "SenderBranch": "string",
  "SenderAccount": 55433,
  "SenderAccountDigit": "9",
  "SenderCodeBank": "string",
  "SenderNameBank": "string",
  "FineInterest": 1,
  "DiscountValue": 2,
  "IofValue": 3,
  "PaidValue": 1000,
  "OtherValues": 0,
  "CreditDate": "11/01/2022",
  "OccurrenceDate": "11/01/2022",
  "PaymentAuthentication": "2CE6A7D9-C229-43E2-87FC-B105EA93A314",
  "PaymentProtocol": 860074288933337700,
  "BankCode": "450",
  "BankBranch": "0001",
  "BankAccount": "146492",
  "BankAccountDigit": "1",
  "ReturnCode": "00",
  "ReturnMessage": "Crédito ou Débito Efetivado",
  "ReturnCodes": "00",
  "ReceiptUrl": "http://www.pdfurl.com.br/2021-11-12/blnj3pof.pdf"
}

Parameter	Description	Type
Method	API method identifier.	string
PartnerId	Partner identifier	integer
BusinessUnitId	Business unit identifier provided by FitBank	integer
DocumentNumber	Document number associated with the payment	string
Identifier	Unique identifier for the payment request	string
EntryId	Internal entry ID for the payment	long
InterestValue	Interest amount charged on the payment	double
FineValue	Fine amount charged on the payment	double
MonetaryValue	Monetary value	double
TotalValue	Total DARJ amount including fees and interest	double
CodeRevenue	Revenue code for the DARJ payment	string
ContributorTaxNumber	Tax ID (CPF/CNPJ) of the contributor	string
ContributorName	Name of the contributor	string
OriginDocument	Origin document	string
StateRegistration	State registration number	string
ReferenceNumber	DARJ reference number	string
DueDate	DARJ expiration/due date	string
Status	Current status of the payment	string
PaymentDate	Date and time when payment was processed	string
SenderBranch	Beneficiary branch/agency number	string
SenderAccount	Beneficiary account number	string
SenderAccountDigit	Beneficiary account verification digit	string
SenderCodeBank	Beneficiary bank code	string
SenderNameBank	Beneficiary bank name	string
FineInterest	Combined fine and interest amount	double
DiscountValue	Discount amount applied	double
IofValue	IOF (Tax on Financial Operations) amount	double
PaidValue	Actual amount paid	double
OtherValues	Other additional values/fees	double
CreditDate	Date when amount will be credited	string
OccurrenceDate	Date of payment occurrence	string
PaymentAuthentication	Unique payment authentication code	string
PaymentProtocol	Payment protocol number	string
BankCode	Bank code for crediting	string
BankBranch	Branch/agency number for crediting	string
BankAccount	Account number for crediting	string
BankAccountDigit	Account verification digit for crediting	string
ReturnCode	Primary return code from payment processing	string
ReturnMessage	Message describing the payment result	string
ReturnCodes	Array of return codes from payment processing	array of strings
ReceiptUrl	URL to download the payment receipt	string

Payment HUB Webhook Boleto FGTS

{
  "Method": "Boleto",
  "PartnerId": 10358,
  "BusinessUnitId": 30733,
  "DocumentNumber": "00012500",
  "Identifier": "133283h19089ff1285dd83235655b",
  "EntryId": 4657153,
  "TotalValue": 13.34,
  "CodeRevenue": "4321",
  "ContributorTaxNumber": "57990466000107",
  "ContributorName": "Maria Pix Conta",
  "Barcode": "81640000000568802962018110831018100030355704",
  "FgtsIdentifier": "44",
  "SocialConnectivityCode": 48,
  "SocialConnectivityDigit": 4,
  "DueDate": "2021-12-15T16:34:07.112Z",
  "Status": "Paid",
  "PaymentDate": "2020-09-11 11:55:46.867",
  "SenderBranch": "string",
  "SenderAccount": 55433,
  "SenderAccountDigit": "9",
  "SenderCodeBank": "string",
  "SenderNameBank": "string",
  "FineInterest": 1,
  "DiscountValue": 2,
  "IofValue": 3,
  "PaidValue": 1000,
  "OtherValues": 0,
  "CreditDate": "11/01/2022",
  "OccurrenceDate": "11/01/2022",
  "PaymentAuthentication": "2CE6A7D9-C229-43E2-87FC-B105EA93A314",
  "PaymentProtocol": 860074288933337700,
  "BankCode": "450",
  "BankBranch": "0001",
  "BankAccount": "146492",
  "BankAccountDigit": "1",
  "ReturnCode": "00",
  "ReturnMessage": "Crédito ou Débito Efetivado",
  "ReceiptUrl": "http://www.pdfurl.com.br/2021-11-12/blnj3pof.pdf"
}

Parameter	Description	Type
Method	API method identifier.	string
PartnerId	Partner identifier	integer
BusinessUnitId	Business unit identifier provided by FitBank	integer
DocumentNumber	Document number associated with the payment	string
Identifier	Unique identifier for the payment request	string
EntryId	Internal entry ID for the payment	long
TotalValue	Total FGTS amount including fees and interest	double
CodeRevenue	Revenue code for the FGTS payment	string
ContributorTaxNumber	Tax ID (CPF/CNPJ) of the contributor	string
ContributorName	Name of the contributor	string
Barcode	FGTS barcode number	string
FgtsIdentifier	FGTS unique identifier	string
SocialConnectivityCode	Social connectivity code	string
SocialConnectivityDigit	Social connectivity verification digit	string
DueDate	FGTS expiration/due date	string
Status	Current status of the payment	string
PaymentDate	Date and time when payment was processed	string
SenderBranch	Beneficiary branch/agency number	string
SenderAccount	Beneficiary account number	string
SenderAccountDigit	Beneficiary account verification digit	string
SenderCodeBank	Beneficiary bank code	string
SenderNameBank	Beneficiary bank name	string
FineInterest	Combined fine and interest amount	double
DiscountValue	Discount amount applied	double
IofValue	IOF (Tax on Financial Operations) amount	double
PaidValue	Actual amount paid	double
OtherValues	Other additional values/fees	double
CreditDate	Date when amount will be credited	string
OccurrenceDate	Date of payment occurrence	string
PaymentAuthentication	Unique payment authentication code	string
PaymentProtocol	Payment protocol number	string
BankCode	Bank code for crediting	string
BankBranch	Branch/agency number for crediting	string
BankAccount	Account number for crediting	string
BankAccountDigit	Account verification digit for crediting	string
ReturnCode	Primary return code from payment processing	string
ReturnMessage	Message describing the payment result	string
ReceiptUrl	URL to download the payment receipt	string

Payment HUB Webhook Boleto Gare

{
  "Method": "Boleto",
  "PartnerId": 10358,
  "BusinessUnitId": 30733,
  "DocumentNumber": "00012500",
  "Identifier": "133283h19089ff1285dd83235655b",
  "EntryId": 4657153,
  "InterestValue": "1",
  "FineValue": 12,
  "TotalValue": 13.34,
  "CodeRevenue": "4321",
  "ContributorTaxNumber": "57990466000107",
  "ContributorName": "Maria Pix Conta",
  "ActiveDebit": "1",
  "ReferenceNumber": "477",
  "DueDate": "2021-12-15T16:34:07.112Z",
  "Status": "Paid",
  "PaymentDate": "2020-09-11 11:55:46.867",
  "SenderBranch": "string",
  "SenderAccount": 55433,
  "SenderAccountDigit": "9",
  "SenderCodeBank": "string",
  "SenderNameBank": "string",
  "FineInterest": 1,
  "DiscountValue": 2,
  "IofValue": 3,
  "PaidValue": 1000,
  "OtherValues": 0,
  "CreditDate": "11/01/2022",
  "OccurrenceDate": "11/01/2022",
  "PaymentAuthentication": "2CE6A7D9-C229-43E2-87FC-B105EA93A314",
  "PaymentProtocol": 860074288933337700,
  "BankCode": "450",
  "BankBranch": "0001",
  "BankAccount": "146492",
  "BankAccountDigit": "1",
  "ReturnCode": "00",
  "ReturnMessage": "Crédito ou Débito Efetivado",
  "ReturnCodes": "00",
  "ReceiptUrl": "http://www.pdfurl.com.br/2021-11-12/blnj3pof.pdf"
}

Parameter	Description	Type
Method	API method identifier.	string
PartnerId	Partner identifier	integer
BusinessUnitId	Business unit identifier provided by FitBank	integer
DocumentNumber	Document number associated with the payment	string
Identifier	Unique identifier for the payment request	string
EntryId	Internal entry ID for the payment	long
InterestValue	Interest amount charged on the payment	double
FineValue	Fine amount charged on the payment	double
TotalValue	Total GARE amount including fees and interest	double
CodeRevenue	Revenue code for the GARE payment	string
ContributorTaxNumber	Tax ID (CPF/CNPJ) of the contributor	string
ContributorName	Name of the contributor	string
ActiveDebit	Active debit indicator	string
ReferenceNumber	GARE reference number	string
DueDate	GARE expiration/due date	string
Status	Current status of the payment	string
PaymentDate	Date and time when payment was processed (	string
SenderBranch	Beneficiary branch/agency number	string
SenderAccount	Beneficiary account number	string
SenderAccountDigit	Beneficiary account verification digit	string
SenderCodeBank	Beneficiary bank code	string
SenderNameBank	Beneficiary bank name	string
FineInterest	Combined fine and interest amount	double
DiscountValue	Discount amount applied	double
IofValue	IOF (Tax on Financial Operations) amount	double
PaidValue	Actual amount paid	double
OtherValues	Other additional values/fees	double
CreditDate	Date when amount will be credited	string
OccurrenceDate	Date of payment occurrence	string
PaymentAuthentication	Unique payment authentication code	string
PaymentProtocol	Payment protocol number	string
BankCode	Bank code for crediting	string
BankBranch	Branch/agency number for crediting	string
BankAccount	Account number for crediting	string
BankAccountDigit	Account verification digit for crediting	string
ReturnCode	Primary return code from payment processing	string
ReturnMessage	Message describing the payment result	string
ReturnCodes	Array of return codes from payment processing	array of strings
ReceiptUrl	URL to download the payment receipt	string

Payment HUB Webhook Boleto GPS

{
  "Method": "Boleto",
  "PartnerId": 10358,
  "BusinessUnitId": 30733,
  "DocumentNumber": "00012500",
  "Identifier": "133283h19089ff1285dd83235655b",
  "EntryId": 4657153,
  "TotalValue": 13.34,
  "ContributorTaxNumber": "57990466000107",
  "ContributorName": "Maria Pix Conta",
  "FineInterestValue": "1.00",
  "OtherValue": 0,
  "JurisdictionDate": "102017",
  "PaymentCode": 15,
  "DueDate": "2021-12-15T16:34:07.112Z",
  "Status": "Paid",
  "PaymentDate": "2020-09-11 11:55:46.867",
  "SenderBranch": "string",
  "SenderAccount": 55433,
  "SenderAccountDigit": "9",
  "SenderCodeBank": "string",
  "SenderNameBank": "string",
  "FineInterest": 1,
  "DiscountValue": 2,
  "IofValue": 3,
  "PaidValue": 1000,
  "OtherValues": 0,
  "CreditDate": "11/01/2022",
  "OccurrenceDate": "11/01/2022",
  "PaymentAuthentication": "2CE6A7D9-C229-43E2-87FC-B105EA93A314",
  "PaymentProtocol": 860074288933337700,
  "BankCode": "450",
  "BankBranch": "0001",
  "BankAccount": "146492",
  "BankAccountDigit": "1",
  "ReturnCode": "00",
  "ReturnMessage": "Crédito ou Débito Efetivado",
  "Returns": {
    "Message": "string",
    "Code": "string"
  },
  "ReceiptUrl": "http://www.pdfurl.com.br/2021-11-12/blnj3pof.pdf"
}

Parameter	Description	Type
Method	API method identifier.	string
PartnerId	Partner identifier	integer
BusinessUnitId	Business unit identifier provided by FitBank	integer
DocumentNumber	Document number associated with the payment	string
Identifier	Unique identifier for the payment request	string
EntryId	Internal entry ID for the payment	long
InterestValue	Interest amount charged on the payment	double
FineValue	Fine amount charged on the payment	double
MonetaryValue	Monetary value	double
TotalValue	Total DARJ amount including fees and interest	double
CodeRevenue	Revenue code for the DARJ payment	string
ContributorTaxNumber	Tax ID (CPF/CNPJ) of the contributor	string
ContributorName	Name of the contributor	string
OriginDocument	Origin document	string
StateRegistration	State registration number	string
ReferenceNumber	DARJ reference number	string
DueDate	DARJ expiration/due date	string
Status	Current status of the payment	string
PaymentDate	Date and time when payment was processed	string
SenderBranch	Beneficiary branch/agency number	string
SenderAccount	Beneficiary account number	string
SenderAccountDigit	Beneficiary account verification digit	string
SenderCodeBank	Beneficiary bank code	string
SenderNameBank	Beneficiary bank name	string
FineInterest	Combined fine and interest amount	double
DiscountValue	Discount amount applied	double
IofValue	IOF (Tax on Financial Operations) amount	double
PaidValue	Actual amount paid	double
OtherValues	Other additional values/fees	double
CreditDate	Date when amount will be credited	string
OccurrenceDate	Date of payment occurrence	string
PaymentAuthentication	Unique payment authentication code	string
PaymentProtocol	Payment protocol number	string
BankCode	Bank code for crediting	string
BankBranch	Branch/agency number for crediting	string
BankAccount	Account number for crediting	string
BankAccountDigit	Account verification digit for crediting	string
ReturnCode	Primary return code from payment processing	string
ReturnMessage	Message describing the payment result	string
ReturnCodes	Array of return codes from payment processing	array of strings
ReceiptUrl	URL to download the payment receipt	string