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
StatusTypeDescription
3RegisteredThe operation was successfully registered and is waiting for processing.
This is not a final status of the transaction.
5PaidThe operation was successfully completed and the payment was made.
This is a final status.*
7CanceledThe operation was cancelled and will not be processed.
This is a final status.*
9Error BalanceThe 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

{"Method":"BoletoOut",
"BusinessUnitId":000,
"InterestValue":0.00,
"FineValue":0.00,
"BankConcessionareFavored":"Teste",
"Barcode":"87770000000509500860010074714400103202420003",
"DueDate":"2020-03-26T00:00:00",
"BeneficiaryTaxNumber":null,
"BeneficiaryName":null,
"GuarantorTaxNumber":null,
"GuarantorName":null,
"PayerTaxNumber":null,
"PayerName":null,
"ReceiptUrl":"https://receipt.fitbank.com.br/receiptapi/pdf?filename=2024-03-15/78991391f3dw.pdf",
"PaymentAuthentication":"05DCXXXAB6E61A3F4E29C8E6DA2C2E647C0E379C9647CF74DDF2E3DF1A329E8A",
"PaymentProtocol":"000092",
"PaymentSubType":13,
"PaymentValue":0.95,
"SenderNameBank":"XXXX",
"SenderCodeBank":"000",
"SenderBranch":"0000",
"SenderAccount":"00000",
"SenderAccountDigit":"0",
"ReturnCodes":["00","BD"],
"ReturnErrorMessage":null,
"ReturnErrorCode":null,
"ReturnMessage":"PAGAMENTO EFETUADO",
"Tags":null,
"PartnerId":000,
"DocumentNumber":"000840000",
"Identifier":"5667732a-bnmc-45b4-af10-9403a8449cc5",
"EntryId":0000000000,
"Status":"Paid",
"TotalValue":50.95,
"PaymentDate":"2020-03-15T00:00:00",
"FineInterest":null,
"DiscountValue":null,
"DiscountValue2":null,
"DiscountValue3":null,
"DiscountDate":null,
"DiscountDate2":null,
"DiscountDate3":null,
"RebateValue":null,
"IofValue":null,
"PaidValue":0.95,
"OtherValues":0.0,
"CreditDate":null,
"OccurrenceDate":null,
"URL":null,
"BankCode":null,
"BankBranch":null,
"BankAccount":null,
"BankAccountDigit":null,
"ReturnCode":"00 ",}
ParameterTypeModel
MethodAPI MethodString (Text)
PartnerIdIdentificador do ParceiroLong (Number)
BusinessUnitIdBusiness Unit Identifier provided by FitbankLong (Number)
DocumentNumberDocument numberString (Text)
IdentifierUnique IdentifierString (Text)
EntryIdEntryIdLong (Number)
InterestValueInterestValueString (Text)
FineValueFineValueLong (Number)
TotalValueBoleto Total AmountLong (Number)
BankConcessionareFavoredFavored ConcessionaireString (Text)
BarcodeBoleto Bar CodeString (Text)
DueDateDue DateString (Text)
BeneficiaryTaxNumberCPF of the ReceiverLong (Number)
BeneficiaryNameName of the ReceiverString (Text)
GuarantorTaxNumberCNPJ of the ReceiverLong (Number)
GuarantorNameName of the CNPJ holderString (Text)
PayerTaxNumberCnpj of the PayerLong (Number)
PayerNameName of the PayerString (Text)
PaymentSubTypePayment subtypeLong (Number)
StatusBoleto's StatusString (Text)
PaymentDatePayment's dateString (Text)
PaymentValuePayment's valueLong (Number)
BankCodeBank CodeString (Text)
BankBranchAgency NumberString (Text)
BankAccountAccount NumberString (Text)
BankAccountDigitAccount Digit NumberString (Text)
SenderBranchNumber of the Beneficiary AgencyString (Text)
SenderAccountNumber of the Beneficiary AccountLong (Number)
SenderAccountDigitBeneficiary Account DigitString (Text)
SenderCodeBankBeneficiary Bank CodeString (Text)
SenderNameBankBeneficiary Bank NameString (Text)
FineInterestFineInterestLong (Number)
DiscountValueDiscount AmountLong (Number)
IofValueIof ValueLong (Number)
PaidValueAmount paidLong (Number)
OtherValuesOther valuesLong (Number)
CreditDateCreditDateString (Text)
OccurrenceDateDate of occurrenceString (Text)
PaymentAuthenticationPayment AuthenticatorString (Text)
PaymentProtocolPayment Protocol NumberLong (Number)
ReturnCodeReturn CodeString (Text)
ReturnMessageReturn messageString (Text)
ReturnErrorCodeReturnErrorCodeString (Text)
ReturnErrorMessageReturnErrorMessageString (Text)
ReturnCodesReturnCodesString (Text)
ReceiptUrlReceiptUrlString (Text)
TagsTag ListString (Text)

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"
}
ParameterTypeModel
MethodAPI MethodString (Text)
PartnerIdPartner IdentifierLong (Number)
BusinessUnitIdBusiness Unit Identifier provided by FitbankLong (Number)
DocumentNumberDocument numberString (Text)
IdentifierUnique IdentifierString (Text)
EntryIdEntryIdLong (Number)
InterestValueInterestValueString (Text)
FineValueFineValueLong (Number)
TotalValueBoleto Total AmountLong (Number)
CodeRevenueCodeRevenueString (Text)
CalculationPeriodCalculationPeriodString (Text)
ContributorTaxNumberContributorTaxNumberString (Text)
ContributorNameContributorNameString (Text)
ValueRecipeGrossAccumulatedValueRecipeGrossAccumulatedString (Text)
Data de vencimentoExpiration DateString (Text)
ReferenceNumberReferenceNumberString (Text)
StatusBoleto statusString (Text)
PaymentDatePayment dateString (Text)
SenderBranchBeneficiary Agency NumberString (Text)
SenderAccountBeneficiary Account NumberLong (Number)
SenderAccountDigitBeneficiary Account DigitString (Text)
SenderCodeBankBeneficiary Bank CodeString (Text)
SenderNameBankBeneficiary Bank NameString (Text)
FineInterestFineInterestLong (Number)
DiscountValueDiscount AmountLong (Number)
IofValueIOF valueLong (Number)
PaidValuePaid AmountLong (Number)
OtherValuesOther valuesLong (Number)
CreditDateCreditDateString (Text)
OccurrenceDateOccurrence dateString (Text)
PaymentAuthenticationPayment AuthenticatorString (Text)
PaymentProtocolPayment Protocol NumberLong (Number)
BankCodeBank codeString (Text)
BankBranchAgency NumberString (Text)
BankAccountAccount numberString (Text)
BankAccountDigitAccount Digit NumberString (Text)
ReturnCodeReturn CodeString (Text)
ReturnMessageReturnMessageString (Text)
ReturnCodesReturnCodesString (Text)
ReceiptUrlReceiptUrlString (Text)

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"
}
ParameterTypeModel
MethodAPI MethodString (Text)
PartnerIdPartner IdentifierLong (Number)
BusinessUnitIdBusiness Unit Identifier provided by FitbankLong (Number)
DocumentNumberDocument numberString (Text)
IdentifierUnique IdentifierString (Text)
EntryIdEntryIdLong (Number)
InterestValueInterestValueString (Text)
FineValueFineValueLong (Number)
MonetaryValueMonetaryValueLong (Number)
TotalValueBoleto Total AmountLong (Number)
CodeRevenueCodeRevenueString (Text)
ContributorTaxNumberContributorTaxNumberString (Text)
ContributorNameContributorNameString (Text)
OriginDocumentOriginDocumentString (Text)
StateRegistrationStateRegistrationString (Text)
ReferenceNumberReferenceNumberString (Text)
DueDateExpiration DateString (Text)
StatusBoleto statusString (Text)
PaymentDatePayment dateString (Text)
SenderBranchBeneficiary Agency NumberString (Text)
SenderAccountBeneficiary Account NumberLong (Number)
SenderAccountDigitBeneficiary Account DigitString (Text)
SenderCodeBankBeneficiary Bank CodeString (Text)
SenderNameBankBeneficiary Bank NameString (Text)
FineInterestFineInterestLong (Number)
DiscountValueDiscount AmountLong (Number)
IofValueIOF valueLong (Number)
PaidValuePaid AmountLong (Number)
OtherValuesOther valuesLong (Number)
CreditDateCreditDateString (Text)
OccurrenceDateOccurrence dateString (Text)
PaymentAuthenticationPayment AuthenticatorString (Text)
PaymentProtocolPayment Protocol NumberLong (Number)
BankCodeBank codeString (Text)
BankBranchAgency NumberString (Text)
BankAccountAccount numberString (Text)
BankAccountDigitAccount Digit NumberString (Text)
ReturnCodeReturn CodeString (Text)
ReturnMessageReturnMessageString (Text)
ReturnCodesReturnCodesString (Text)
ReceiptUrlReceiptUrlString (Text)

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"
}
ParameterTypeModel
MethodAPI MethodString (Text)
PartnerIdPartner IdentifierLong (Number)
BusinessUnitIdBusiness Unit Identifier provided by FitbankLong (Number)
DocumentNumberDocument numberString (Text)
IdentifierUnique IdentifierString (Text)
EntryIdEntryIdLong (Number)
TotalValueBoleto Total AmountLong (Number)
CodeRevenueCodeRevenueString (Text)
ContributorTaxNumberContributorTaxNumberString (Text)
ContributorNameContributorNameString (Text)
BarcodeBoleto Bar CodeString (Text)
FgtsIdentifierIdentificador FgtsString (Text)
SocialConnectivityCodeSocialConnectivityCodeLong (Number)
SocialConnectivityDigitSocialConnectivityDigitLong (Number)
DueDateExpiration DateString (Text)
StatusBoleto statusString (Text)
PaymentDatePayment DateString (Text)
SenderBranchBeneficiary Agency NumberString (Text)
SenderAccountBeneficiary Account NumberLong (Number)
SenderAccountDigitBeneficiary Account DigitString (Text)
SenderCodeBankBeneficiary Bank CodeString (Text)
SenderNameBankBeneficiary Bank NameString (Text)
DiscountValueFineInterestLong (Number)
Valor do descontoDiscount AmountLong (Number)
IofValueIOF valueLong (Number)
PaidValuePaid AmountLong (Number)
OtherValuesOther valuesLong (Number)
CreditDateCreditDateString (Text)
OccurrenceDateOccurrence dateString (Text)
PaymentAuthenticationPayment AuthenticatorString (Text)
PaymentProtocolPayment Protocol NumberLong (Number)
BankCodeBank codeString (Text)
BankBranchAgency NumberString (Text)
BankAccountAccount numberString (Text)
BankAccountDigitAccount Digit NumberString (Text)
ReturnCodeReturn CodeString (Text)
ReturnMessageReturnMessageString (Text)
ReceiptUrlReceiptUrlString (Text)

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"
}
ParameterTypeModel
MethodAPI MethodString (Text)
PartnerIdPartner IdentifierLong (Number)
BusinessUnitIdBusiness Unit Identifier provided by FitbankLong (Number)
DocumentNumberDocument numberString (Text)
IdentifierUnique IdentifierString (Text)
EntryIdEntryIdLong (Number)
InterestValueInterestValueString (Text)
FineValueFineValueLong (Number)
TotalValueBoleto Total AmountLong (Number)
CodeRevenueCodeRevenueString (Text)
ContributorTaxNumberContributorTaxNumberString (Text)
ContributorNameContributorNameLong (Number)
ActiveDebitActiveDebitString (Text)
ReferenceNumberReferenceNumberString (Text)
DueDateExpiration DateString (Text)
StatusBoleto statusString (Text)
PaymentDatePayment DateString (Text)
SenderBranchBeneficiary Agency NumberString (Text)
SenderAccountBeneficiary Account NumberLong (Number)
SenderAccountDigitBeneficiary Account DigitString (Text)
SenderCodeBankBeneficiary Bank CodeString (Text)
SenderNameBankBeneficiary Bank NameString (Text)
FineInterestFineInterestLong (Number)
DiscountValueDiscount AmountLong (Number)
IofValueIOF valueLong (Number)
PaidValuePaid AmountLong (Number)
OtherValuesOther valuesLong (Number)
CreditDateCreditDateString (Text)
OccurrenceDateOccurrence dateString (Text)
PaymentAuthenticationPayment AuthenticatorString (Text)
PaymentProtocolPayment Protocol NumberLong (Number)
BankCodeBank codeString (Text)
BankBranchAgency NumberString (Text)
BankAccountAccount numberString (Text)
BankAccountDigitAccount Digit NumberString (Text)
ReturnCodeReturn CodeString (Text)
ReturnMessageReturnMessageString (Text)
ReturnCodesReturnCodesString (Text)
ReceiptUrlReceiptUrlString (Text)

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"
}
ParameterTypeModel
MethodAPI MethodString (Text)
PartnerIdPartner IdentifierInteiro (número)
Identificador da Unidade de negócioBusiness Unit Identifier provided by FitbankInteiro (número)
DocumentNumberDocument numberString (Text)
IdentifierUnique IdentifierString (Text)
EntryIdEntryIdInteiro (número)
TotalValueBoleto Total AmountLong (Number)
ContributorTaxNumberContributorTaxNumberString (Text)
ContributorNameContributorNameString (Text)
FineInterestValueFineInterestValueString (Text)
OtherValueAnother valueLong (Number)
JurisdictionDateJurisdictionDateString (Text)
PaymentCodePaymentCodeLong (Number)
DueDateExpiration DateString (Text)
StatusBoleto statusString (Text)
PaymentDatePayment DateString (Text)
SenderBranchBeneficiary Agency NumberString (Text)
SenderAccountBeneficiary Account NumberLong (Number)
SenderAccountDigitBeneficiary Account DigitString (Text)
SenderCodeBankBeneficiary Bank CodeString (Text)
SenderNameBankBeneficiary Bank NameString (Text)
FineInterestFineInterestLong (Number)
DiscountValueDiscount AmountLong (Number)
IofValueIOF valueLong (Number)
PaidValuePaid AmountLong (Number)
OtherValuesOther valuesLong (Number)
CreditDateCreditDateString (Text)
OccurrenceDateOccurrence dateString (Text)
PaymentAuthenticationPayment AuthenticatorString (Text)
PaymentProtocolPayment Protocol NumberLong (Number)
BankCodeBank codeString (Text)
BankBranchAgency NumberString (Text)
BankAccountAccount numberString (Text)
BankAccountDigitAccount Digit NumberString (Text)
ReturnCodeReturn CodeString (Text)
ReturnMessageReturnMessageString (Text)
ReturnCodesReturnCodesString (Text)
ReceiptUrlReceiptUrlString (Text)