3 - 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 registered
5	Paid	The operation was paid
7	Canceled	The operation was canceled
9	Error Balance	The operation was awaiting balance

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 ",}

Parameter	Type	Model
Method	API Method	String (Text)
PartnerId	Identificador do Parceiro	Long (Number)
BusinessUnitId	Business Unit Identifier provided by Fitbank	Long (Number)
DocumentNumber	Document number	String (Text)
Identifier	Unique Identifier	String (Text)
EntryId	EntryId	Long (Number)
InterestValue	InterestValue	String (Text)
FineValue	FineValue	Long (Number)
TotalValue	Boleto Total Amount	Long (Number)
BankConcessionareFavored	Favored Concessionaire	String (Text)
Barcode	Boleto Bar Code	String (Text)
DueDate	Due Date	String (Text)
BeneficiaryTaxNumber	CPF of the Receiver	Long (Number)
BeneficiaryName	Name of the Receiver	String (Text)
GuarantorTaxNumber	CNPJ of the Receiver	Long (Number)
GuarantorName	Name of the CNPJ holder	String (Text)
PayerTaxNumber	Cnpj of the Payer	Long (Number)
PayerName	Name of the Payer	String (Text)
PaymentSubType	Payment subtype	Long (Number)
Status	Boleto's Status	String (Text)
PaymentDate	Payment's date	String (Text)
PaymentValue	Payment's value	Long (Number)
BankCode	Bank Code	String (Text)
BankBranch	Agency Number	String (Text)
BankAccount	Account Number	String (Text)
BankAccountDigit	Account Digit Number	String (Text)
SenderBranch	Number of the Beneficiary Agency	String (Text)
SenderAccount	Number of the Beneficiary Account	Long (Number)
SenderAccountDigit	Beneficiary Account Digit	String (Text)
SenderCodeBank	Beneficiary Bank Code	String (Text)
SenderNameBank	Beneficiary Bank Name	String (Text)
FineInterest	FineInterest	Long (Number)
DiscountValue	Discount Amount	Long (Number)
IofValue	Iof Value	Long (Number)
PaidValue	Amount paid	Long (Number)
OtherValues	Other values	Long (Number)
CreditDate	CreditDate	String (Text)
OccurrenceDate	Date of occurrence	String (Text)
PaymentAuthentication	Payment Authenticator	String (Text)
PaymentProtocol	Payment Protocol Number	Long (Number)
ReturnCode	Return Code	String (Text)
ReturnMessage	Return message	String (Text)
ReturnErrorCode	ReturnErrorCode	String (Text)
ReturnErrorMessage	ReturnErrorMessage	String (Text)
ReturnCodes	ReturnCodes	String (Text)
ReceiptUrl	ReceiptUrl	String (Text)
Tags	Tag List	String (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"
}

Parameter	Type	Model
Method	API Method	String (Text)
PartnerId	Partner Identifier	Long (Number)
BusinessUnitId	Business Unit Identifier provided by Fitbank	Long (Number)
DocumentNumber	Document number	String (Text)
Identifier	Unique Identifier	String (Text)
EntryId	EntryId	Long (Number)
InterestValue	InterestValue	String (Text)
FineValue	FineValue	Long (Number)
TotalValue	Boleto Total Amount	Long (Number)
CodeRevenue	CodeRevenue	String (Text)
CalculationPeriod	CalculationPeriod	String (Text)
ContributorTaxNumber	ContributorTaxNumber	String (Text)
ContributorName	ContributorName	String (Text)
ValueRecipeGrossAccumulated	ValueRecipeGrossAccumulated	String (Text)
Data de vencimento	Expiration Date	String (Text)
ReferenceNumber	ReferenceNumber	String (Text)
Status	Boleto status	String (Text)
PaymentDate	Payment date	String (Text)
SenderBranch	Beneficiary Agency Number	String (Text)
SenderAccount	Beneficiary Account Number	Long (Number)
SenderAccountDigit	Beneficiary Account Digit	String (Text)
SenderCodeBank	Beneficiary Bank Code	String (Text)
SenderNameBank	Beneficiary Bank Name	String (Text)
FineInterest	FineInterest	Long (Number)
DiscountValue	Discount Amount	Long (Number)
IofValue	IOF value	Long (Number)
PaidValue	Paid Amount	Long (Number)
OtherValues	Other values	Long (Number)
CreditDate	CreditDate	String (Text)
OccurrenceDate	Occurrence date	String (Text)
PaymentAuthentication	Payment Authenticator	String (Text)
PaymentProtocol	Payment Protocol Number	Long (Number)
BankCode	Bank code	String (Text)
BankBranch	Agency Number	String (Text)
BankAccount	Account number	String (Text)
BankAccountDigit	Account Digit Number	String (Text)
ReturnCode	Return Code	String (Text)
ReturnMessage	ReturnMessage	String (Text)
ReturnCodes	ReturnCodes	String (Text)
ReceiptUrl	ReceiptUrl	String (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"
}

Parameter	Type	Model
Method	API Method	String (Text)
PartnerId	Partner Identifier	Long (Number)
BusinessUnitId	Business Unit Identifier provided by Fitbank	Long (Number)
DocumentNumber	Document number	String (Text)
Identifier	Unique Identifier	String (Text)
EntryId	EntryId	Long (Number)
InterestValue	InterestValue	String (Text)
FineValue	FineValue	Long (Number)
MonetaryValue	MonetaryValue	Long (Number)
TotalValue	Boleto Total Amount	Long (Number)
CodeRevenue	CodeRevenue	String (Text)
ContributorTaxNumber	ContributorTaxNumber	String (Text)
ContributorName	ContributorName	String (Text)
OriginDocument	OriginDocument	String (Text)
StateRegistration	StateRegistration	String (Text)
ReferenceNumber	ReferenceNumber	String (Text)
DueDate	Expiration Date	String (Text)
Status	Boleto status	String (Text)
PaymentDate	Payment date	String (Text)
SenderBranch	Beneficiary Agency Number	String (Text)
SenderAccount	Beneficiary Account Number	Long (Number)
SenderAccountDigit	Beneficiary Account Digit	String (Text)
SenderCodeBank	Beneficiary Bank Code	String (Text)
SenderNameBank	Beneficiary Bank Name	String (Text)
FineInterest	FineInterest	Long (Number)
DiscountValue	Discount Amount	Long (Number)
IofValue	IOF value	Long (Number)
PaidValue	Paid Amount	Long (Number)
OtherValues	Other values	Long (Number)
CreditDate	CreditDate	String (Text)
OccurrenceDate	Occurrence date	String (Text)
PaymentAuthentication	Payment Authenticator	String (Text)
PaymentProtocol	Payment Protocol Number	Long (Number)
BankCode	Bank code	String (Text)
BankBranch	Agency Number	String (Text)
BankAccount	Account number	String (Text)
BankAccountDigit	Account Digit Number	String (Text)
ReturnCode	Return Code	String (Text)
ReturnMessage	ReturnMessage	String (Text)
ReturnCodes	ReturnCodes	String (Text)
ReceiptUrl	ReceiptUrl	String (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"
}

Parameter	Type	Model
Method	API Method	String (Text)
PartnerId	Partner Identifier	Long (Number)
BusinessUnitId	Business Unit Identifier provided by Fitbank	Long (Number)
DocumentNumber	Document number	String (Text)
Identifier	Unique Identifier	String (Text)
EntryId	EntryId	Long (Number)
TotalValue	Boleto Total Amount	Long (Number)
CodeRevenue	CodeRevenue	String (Text)
ContributorTaxNumber	ContributorTaxNumber	String (Text)
ContributorName	ContributorName	String (Text)
Barcode	Boleto Bar Code	String (Text)
FgtsIdentifier	Identificador Fgts	String (Text)
SocialConnectivityCode	SocialConnectivityCode	Long (Number)
SocialConnectivityDigit	SocialConnectivityDigit	Long (Number)
DueDate	Expiration Date	String (Text)
Status	Boleto status	String (Text)
PaymentDate	Payment Date	String (Text)
SenderBranch	Beneficiary Agency Number	String (Text)
SenderAccount	Beneficiary Account Number	Long (Number)
SenderAccountDigit	Beneficiary Account Digit	String (Text)
SenderCodeBank	Beneficiary Bank Code	String (Text)
SenderNameBank	Beneficiary Bank Name	String (Text)
DiscountValue	FineInterest	Long (Number)
Valor do desconto	Discount Amount	Long (Number)
IofValue	IOF value	Long (Number)
PaidValue	Paid Amount	Long (Number)
OtherValues	Other values	Long (Number)
CreditDate	CreditDate	String (Text)
OccurrenceDate	Occurrence date	String (Text)
PaymentAuthentication	Payment Authenticator	String (Text)
PaymentProtocol	Payment Protocol Number	Long (Number)
BankCode	Bank code	String (Text)
BankBranch	Agency Number	String (Text)
BankAccount	Account number	String (Text)
BankAccountDigit	Account Digit Number	String (Text)
ReturnCode	Return Code	String (Text)
ReturnMessage	ReturnMessage	String (Text)
ReceiptUrl	ReceiptUrl	String (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"
}

Parameter	Type	Model
Method	API Method	String (Text)
PartnerId	Partner Identifier	Long (Number)
BusinessUnitId	Business Unit Identifier provided by Fitbank	Long (Number)
DocumentNumber	Document number	String (Text)
Identifier	Unique Identifier	String (Text)
EntryId	EntryId	Long (Number)
InterestValue	InterestValue	String (Text)
FineValue	FineValue	Long (Number)
TotalValue	Boleto Total Amount	Long (Number)
CodeRevenue	CodeRevenue	String (Text)
ContributorTaxNumber	ContributorTaxNumber	String (Text)
ContributorName	ContributorName	Long (Number)
ActiveDebit	ActiveDebit	String (Text)
ReferenceNumber	ReferenceNumber	String (Text)
DueDate	Expiration Date	String (Text)
Status	Boleto status	String (Text)
PaymentDate	Payment Date	String (Text)
SenderBranch	Beneficiary Agency Number	String (Text)
SenderAccount	Beneficiary Account Number	Long (Number)
SenderAccountDigit	Beneficiary Account Digit	String (Text)
SenderCodeBank	Beneficiary Bank Code	String (Text)
SenderNameBank	Beneficiary Bank Name	String (Text)
FineInterest	FineInterest	Long (Number)
DiscountValue	Discount Amount	Long (Number)
IofValue	IOF value	Long (Number)
PaidValue	Paid Amount	Long (Number)
OtherValues	Other values	Long (Number)
CreditDate	CreditDate	String (Text)
OccurrenceDate	Occurrence date	String (Text)
PaymentAuthentication	Payment Authenticator	String (Text)
PaymentProtocol	Payment Protocol Number	Long (Number)
BankCode	Bank code	String (Text)
BankBranch	Agency Number	String (Text)
BankAccount	Account number	String (Text)
BankAccountDigit	Account Digit Number	String (Text)
ReturnCode	Return Code	String (Text)
ReturnMessage	ReturnMessage	String (Text)
ReturnCodes	ReturnCodes	String (Text)
ReceiptUrl	ReceiptUrl	String (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"
}

Parameter	Type	Model
Method	API Method	String (Text)
PartnerId	Partner Identifier	Inteiro (número)
Identificador da Unidade de negócio	Business Unit Identifier provided by Fitbank	Inteiro (número)
DocumentNumber	Document number	String (Text)
Identifier	Unique Identifier	String (Text)
EntryId	EntryId	Inteiro (número)
TotalValue	Boleto Total Amount	Long (Number)
ContributorTaxNumber	ContributorTaxNumber	String (Text)
ContributorName	ContributorName	String (Text)
FineInterestValue	FineInterestValue	String (Text)
OtherValue	Another value	Long (Number)
JurisdictionDate	JurisdictionDate	String (Text)
PaymentCode	PaymentCode	Long (Number)
DueDate	Expiration Date	String (Text)
Status	Boleto status	String (Text)
PaymentDate	Payment Date	String (Text)
SenderBranch	Beneficiary Agency Number	String (Text)
SenderAccount	Beneficiary Account Number	Long (Number)
SenderAccountDigit	Beneficiary Account Digit	String (Text)
SenderCodeBank	Beneficiary Bank Code	String (Text)
SenderNameBank	Beneficiary Bank Name	String (Text)
FineInterest	FineInterest	Long (Number)
DiscountValue	Discount Amount	Long (Number)
IofValue	IOF value	Long (Number)
PaidValue	Paid Amount	Long (Number)
OtherValues	Other values	Long (Number)
CreditDate	CreditDate	String (Text)
OccurrenceDate	Occurrence date	String (Text)
PaymentAuthentication	Payment Authenticator	String (Text)
PaymentProtocol	Payment Protocol Number	Long (Number)
BankCode	Bank code	String (Text)
BankBranch	Agency Number	String (Text)
BankAccount	Account number	String (Text)
BankAccountDigit	Account Digit Number	String (Text)
ReturnCode	Return Code	String (Text)
ReturnMessage	ReturnMessage	String (Text)
ReturnCodes	ReturnCodes	String (Text)
ReceiptUrl	ReceiptUrl	String (Text)