5 - Webhooks
Webhook TED OUT
Webhook responsible for notifying transfer status, sensitized after requesting the moneytransfer method.
Status:
Status 0: Created
Status 1: CanBeRegister (It sensitizes)
Status 2: Registering (It creates the xml)
Status 3: Registered (It sends to the Control Center)
Status 5: Paid (The Control Center sends to BACEN)
Status 7: Cancel
Status 9: ErrorBalance
{
"MoneyTransferDocumentNumber": null,
"BankName": "NU PAGAMENTOS S.A (NUBANK)",
"TaxNumber": "07018105307",
"ReceiptUrl": "https://sandboxreceipt.fitbank.com.br/receipt/2022-06-06/r1i0lbbh.pdf",
"Name": "Ariel Nepomuceno Cursino de Sena",
"SenderName": "Ariel Nepomuceno Cursino de Sena",
"SenderTaxNumber": "07018105307",
"SenderNameBank": "Itaú Unibanco",
"SenderCodeBank": "341",
"SenderBranch": "0845",
"SenderAccount": "12306",
"SenderAccountDigit": "6",
"ReturnCodes": [
"02"
],
"PaymentAuthentication": null,
"PaymentProtocol": "682170729578008118",
"OccurrenceMotive": null,
"ReturnErrorCode": null,
"ReturnErrorMessage": null,
"OurNumber": null,
"AccountRateValue": 0,
"BuRateValue": 3.99,
"FromBankCode": null,
"FromBankBranch": null,
"FromBankAccount": null,
"FromBankAccountDigit": null,
"PartnerId": null,
"DocumentNumber": "38992",
"Identifier": "5471",
"EntryId": 125509252,
"Status": "Registered",
"TotalValue": 50,
"PaymentDate": null,
"FineInterest": null,
"DiscountValue": null,
"IofValue": null,
"PaidValue": 50,
"OtherValues": 0,
"CreditDate": "2022-06-06T16:16:53.18",
"OccurrenceDate": null,
"URL": null,
"BankCode": "260",
"BankBranch": "0001",
"BankAccount": "4947285",
"BankAccountDigit": "9",
"ReturnCode": "02",
"ReturnMessage": null,
"Method": "MoneyTransfer",
"BusinessUnitId": 1099
}
Paramenters | Response | Type |
---|---|---|
MoneyTransferDocumentNumber | Identifier number | String |
BankName | Name of the receiving bank | String |
TaxNumber | CPF/CNPJ of the recipient | String |
ReceiptUrl | URL to receive webhooks | String |
Name | Recipient name | String |
SenderName | Sender's name | String |
SenderTaxNumber | Sender's CPF/CNPJ | String |
SenderNameBank | Name of the sending bank | String |
SenderCodeBank | Bank number, of the sending bank | String |
SenderBranch | Sender's agency | String |
SenderAccount | Sender account | String |
SenderAccountDigit | Verifying digit of the sender account | String |
ReturnCodes | Return code | String |
PaymentAuthentication | Authentication code | String |
PaymentProtocol | Protocol code | String |
OccurrenceMotive | Reason for occurrence | String |
ReturnErrorCode | Error code | String |
ReturnErrorMessage | Error Return Message | String |
OurNumber | Fitbank Identifier | String |
AccountRateValue | Account Rate Parameter | Decimal |
BuRateValue | business unit rate parameter | Decimal |
FromBankCode | Data relating to the source account | String |
FromBankBranch | Data relating to the source account | String |
FromBankAccount | Data relating to the source account | String |
FromBankAccountDigit | Data relating to the source account | String |
PartnerId | PartnerID da business unit | String |
DocumentNumber | Identifier number | String |
Identifier | Identifier | String |
EntryId | Posting Number | Long |
Status | Transaction Status | String |
TotalValue | Total transaction value | Decimal |
PaymentDate | Date of payment | String |
FineInterest | Interest fine | Decimal |
DiscountValue | Discount Amount | Decimal |
IofValue | IOF | Decimal |
PaidValue | Final transfer value | Decimal |
OtherValues | OtherValues | Decimal |
CreditDate | Credit date | String |
OccurrenceDate | Date of occurrence | String |
URL | Link to the voucher | String |
BankCode | Bank code of the recipient | String |
BankBranch | Recipient's agency | String |
BankAccount | Recipient account | String |
BankAccountDigit | Recipient's account digit | String |
ReturnCode | Return code | String |
ReturnMessage | Return message | String |
Method | Method of operation | String |
BusinessUnitId | business unit ID | Long |
Webhook TEDIN
Webhook responsible for notifying receipt of value
{
"MoneyTransferInDocumentNumber": "104245",
"Name": "Teste.Emanuele. ",
"TaxNumber": "18236120000158",
"Mail": "[email protected]",
"Phone": "85999487360",
"RateValue": 0.00,
"CreditedValue": 2000.00,
"TransferDate": "2022-05-10T09:23:36",
"FromName": null,
"FromTaxNumber": null,
"FromBankCode": null,
"FromBankBranch": null,
"FromBankAccount": null,
"FromBankAccountDigit": null,
"PartnerId": null,
"DocumentNumber": "1090005",
"Identifier": null,
"EntryId": 1234567890,
"Status": "Paid",
"TotalValue": 2000.00,
"PaymentDate": null,
"FineInterest": null,
"DiscountValue": null,
"IofValue": null,
"PaidValue": null,
"OtherValues": null,
"CreditDate": "2022-05-10T10:56:29.6",
"OccurrenceDate": null,
"URL": null,
"BankCode": "450",
"BankBranch": "0001",
"BankAccount": "187310303",
"BankAccountDigit": "9",
"ReturnCode": null,
"ReturnMessage": null,
"PaymentProtocol": null,
"Method": "MoneyTransferIn",
"BusinessUnitId": 673
}
Paramenters | Response | Type |
---|---|---|
MoneyTransferInDocumentNumber | Identifier number | String |
Name | Recipient's name | String |
TaxNumber | CPF/CNPJ of the recipient | String |
Recipient E-mail | String | |
Phone | Recipient's phone number | String |
RateValue | Rate Value | Decimal |
CreditedValue | Credit value | Decimal |
TransferDate | Transfer date | String |
FromName | Sender's name | String |
FromTaxNumber | Sender's CPF/CNPJ | String |
FromBankCode | Origin Bank Code | String |
FromBankBranch | Origin Agency Number | String |
FromBankAccount | Transfer source account | String |
FromBankAccountDigit | Data relating to the source account | String |
PartnerId | Business united PartnerID | String |
DocumentNumber | Identifier number | String |
Identifier | Identifier | String |
EntryId | Posting Number | Long |
Status | Transaction Status | String |
TotalValue | Total transaction value | Decimal |
PaymentDate | Payment date | String |
FineInterest | Interest fine | Decimal |
DiscountValue | Discount value | Decimal |
IofValue | IOF | Decimal |
PaidValue | Final value of the transfer | Decimal |
OtherValues | OtherValues | Decimal |
CreditDate | Credit date | String |
OccurrenceDate | Occurrence date | String |
URL | Voucher Link | String |
BankCode | Bank code of recipient | String |
BankBranch | Recipient Agency | String |
BankAccount | Recipient account | String |
BankAccountDigit | Recipient account digit | String |
ReturnCode | Return code | String |
ReturnMessage | Return message | String |
PaymentProtocol | Protocol code | String |
Method | Operation Method | String |
BusinessUnitId | business unit ID | Long |
Updated over 1 year ago