5 - Webhooks
5.1 UpdateCollectionOrderStatus
Collection Order webhooks will match the CollectionOrderType that was programmed in the GenerateCollectionOrder method: CollectionOrderType: PixQrCodeDinamicDueDate = 0, Boleto = 1, BoletoPixQrCode=2, PixQrCodeDinamic=3
As described below:
The CollectionOrderWebhook for Collection Orders generated with CollectionOrderType: PixQrCodeDinamicDueDate = 0 or PixQrCodeDinamic=3:
Collection Order webhook status Created
{
"CollectionOrder": {
"QRCode": {
"HashCode": null,
"Image": null
},
"DocumentNumber": "1459",
"Status": "0",
"StatusDescription": "Created",
"TaxNumber": "54694623079",
"ReceiptUrl": null,
"Identifier": "co-b5f90bc6-c7f4-4457-900b-526cd388edb0",
"Reason": null,
"InterestDate": null,
"FineDate": null,
},
"Method": "CollectionOrderStatus",
"BusinessUnitId": 1321
}
Collection order webhook status PreAuthorized
{
"CollectionOrder": {
"QRCode": {
"HashCode": "MDAwMjAxMDEwMjEyMjY4MDAwMTRici5nb3YuYmNiLnBpeDI1NThxcmNvZGUtaC5maXRiYW5rLmNvbS5ici9RUi9jb2J2LzIyREZDNUM5OEU5NUYzN0Q1REM0NzBBMzBENTIwNDAwMDA1MzAzOTg2NTgwMkJSNTkwN1NhYnJpbmE2MDA5c2FvIHBhdWxvNjEwODYzNDQ0NDQ0NjIwNzA1MDMqKio2MzA0MDJFMA",
"Image": "iVBORw0KGgoAAAANSUhEUgAAARQAAAEUAQAAAADCC/TUAAADgUlEQVR4nO2aUU7DQAxEfQPf/5a+gfG82aQFgfhzflpQqyYvaLP2zo4dov99VXyYD/M3ExGZnVVROe85h6rnfb7q1DqT81v+mLMZOlND5VyiY+vMDLl6jmr4NYOctyFm0KlTjzCDpGZuzumruMx8jokYQiNtBViBJreeYYTpY4KoMAotzWf2t7hvMeT876/v62KJ4ZVOeH2Q8JP5XT90Y4kprbk5I4Y7EK7FqEk9c7jJEEXGqh9WH2qgO6ncZ8JrsKSXxcxJo+ZO5gBLc5vRiegjlB1ehjN6XfIAo1OaPCWX5BONas0lurnOpEUB4eas0ky8tWKdYa9l6Sm0imnCQ133tcoQV+X3RFMHJeFJhCWe24z3tRYV6e9V5vL6G5uMll0R15QyFeN1WDXkfUYhlTeSBOgK5ZiiiZLmOqO1j0RprBq08gwDgI6vM4ql3vL4NQaLuY1bEzYZjVKjs5xrRk80q8m5bUY7vnIqnVH6iqdNX7zOSKQ0e9ppmTjug4vj0sxNhg2NTS09/LxSS5YpH2CsS4rgsdqwp1ZaZ+yFwuokHbB0SyTQrm3mckTZnjuLAeagbk1YZBp7xk5rT1uXJ3G1vc7gZ2WTTgkbyChl5L3nbjJ1TBoqkAgEXhvLlPuMxmxbFB6ncs36dOvGKhO2smfD5TyC9R7TPUZ+9th9KbczDgfpzsg2o0EzWfgiqkWHVDL1qqnXGCUYNqSPdfMCLG+ADzDssul5dI1W3nqln73O9FlwdW3AxDHdVat9Ju1i7dsSd601cA7nOlPUhzaStD703T67svaZvlwaTUaMCMIVF7jOBLWqjRIbP83qpo21zwRlkTqKSVQTa037I+4e0SKT7r1oD0lUyZ1YXEH1A4w7wH0M7KnY2vY29hk3ZK5CyGaW9dhue24z9KKLFhVVqzRLoumKMdeZ0+pwy5Xc96ZHWO/72mP8exyJO9RF2VavZwqbjJ9pRHnB3TWRPuMa8ybTlkaaRaS8rFrRyHrl/CITbLeWhHbZ6AcuHO595rQ/bAB4ABNseBp77DNsaDxPYPd3rltL3zz/HmNn73Zw2cpisvPY2m0m7zYI2dUUsS4c++WjFhk/0lDmn6fgQRuWaiSeYWiX0RFOdz2V7C5jH2Hi2DR3zVmGSYn0BNPu4rMUkYK+ejLRvc/4wa77r/5/ASoh7bn1/lx4i/nv9WE+zJ/MFybWL7tG2MRBAAAAAElFTkSuQmCC"
},
"DocumentNumber": "1459",
"Status": "1",
"StatusDescription": "PreAuthorized",
"TaxNumber": "54694623079",
"ReceiptUrl": null,
"Identifier": "co-b5f90bc6-c7f4-4457-900b-526cd388edb0",
"Reason": null,
"InterestDate": null,
"FineDate": null,
},
"Method": "CollectionOrderStatus",
"BusinessUnitId": 1321
}
Collection order webhook status Authorized
{
"CollectionOrder": {
"QRCode": {
"HashCode": "MDAwMjAxMDEwMjEyMjY4MDAwMTRici5nb3YuYmNiLnBpeDI1NThxcmNvZGUtaC5maXRiYW5rLmNvbS5ici9RUi9jb2J2LzIyREZDNUM5OEU5NUYzN0Q1REM0NzBBMzBENTIwNDAwMDA1MzAzOTg2NTgwMkJSNTkwN1NhYnJpbmE2MDA5c2FvIHBhdWxvNjEwODYzNDQ0NDQ0NjIwNzA1MDMqKio2MzA0MDJFMA",
"Image": "iVBORw0KGgoAAAANSUhEUgAAARQAAAEUAQAAAADCC/TUAAADgUlEQVR4nO2aUU7DQAxEfQPf/5a+gfG82aQFgfhzflpQqyYvaLP2zo4dov99VXyYD/M3ExGZnVVROe85h6rnfb7q1DqT81v+mLMZOlND5VyiY+vMDLl6jmr4NYOctyFm0KlTjzCDpGZuzumruMx8jokYQiNtBViBJreeYYTpY4KoMAotzWf2t7hvMeT876/v62KJ4ZVOeH2Q8JP5XT90Y4kprbk5I4Y7EK7FqEk9c7jJEEXGqh9WH2qgO6ncZ8JrsKSXxcxJo+ZO5gBLc5vRiegjlB1ehjN6XfIAo1OaPCWX5BONas0lurnOpEUB4eas0ky8tWKdYa9l6Sm0imnCQ133tcoQV+X3RFMHJeFJhCWe24z3tRYV6e9V5vL6G5uMll0R15QyFeN1WDXkfUYhlTeSBOgK5ZiiiZLmOqO1j0RprBq08gwDgI6vM4ql3vL4NQaLuY1bEzYZjVKjs5xrRk80q8m5bUY7vnIqnVH6iqdNX7zOSKQ0e9ppmTjug4vj0sxNhg2NTS09/LxSS5YpH2CsS4rgsdqwp1ZaZ+yFwuokHbB0SyTQrm3mckTZnjuLAeagbk1YZBp7xk5rT1uXJ3G1vc7gZ2WTTgkbyChl5L3nbjJ1TBoqkAgEXhvLlPuMxmxbFB6ncs36dOvGKhO2smfD5TyC9R7TPUZ+9th9KbczDgfpzsg2o0EzWfgiqkWHVDL1qqnXGCUYNqSPdfMCLG+ADzDssul5dI1W3nqln73O9FlwdW3AxDHdVat9Ju1i7dsSd601cA7nOlPUhzaStD703T67svaZvlwaTUaMCMIVF7jOBLWqjRIbP83qpo21zwRlkTqKSVQTa037I+4e0SKT7r1oD0lUyZ1YXEH1A4w7wH0M7KnY2vY29hk3ZK5CyGaW9dhue24z9KKLFhVVqzRLoumKMdeZ0+pwy5Xc96ZHWO/72mP8exyJO9RF2VavZwqbjJ9pRHnB3TWRPuMa8ybTlkaaRaS8rFrRyHrl/CITbLeWhHbZ6AcuHO595rQ/bAB4ABNseBp77DNsaDxPYPd3rltL3zz/HmNn73Zw2cpisvPY2m0m7zYI2dUUsS4c++WjFhk/0lDmn6fgQRuWaiSeYWiX0RFOdz2V7C5jH2Hi2DR3zVmGSYn0BNPu4rMUkYK+ejLRvc/4wa77r/5/ASoh7bn1/lx4i/nv9WE+zJ/MFybWL7tG2MRBAAAAAElFTkSuQmCC"
},
"DocumentNumber": "1459",
"Status": "3",
"StatusDescription": "Authorized",
"TaxNumber": "54694623079",
"ReceiptUrl": null,
"Identifier": "co-b5f90bc6-c7f4-4457-900b-526cd388edb0",
"Reason": null,
"InterestDate": null,
"FineDate": null,
},
"Method": "CollectionOrderStatus",
"BusinessUnitId": 1321
}
Collection order webhook status AwaitingPayment
{
"CollectionOrder": {
"QRCode": {
"HashCode": "MDAwMjAxMDEwMjEyMjY4MDAwMTRici5nb3YuYmNiLnBpeDI1NThxcmNvZGUtaC5maXRiYW5rLmNvbS5ici9RUi9jb2J2LzIyREZDNUM5OEU5NUYzN0Q1REM0NzBBMzBENTIwNDAwMDA1MzAzOTg2NTgwMkJSNTkwN1NhYnJpbmE2MDA5c2FvIHBhdWxvNjEwODYzNDQ0NDQ0NjIwNzA1MDMqKio2MzA0MDJFMA",
"Image": "iVBORw0KGgoAAAANSUhEUgAAARQAAAEUAQAAAADCC/TUAAADgUlEQVR4nO2aUU7DQAxEfQPf/5a+gfG82aQFgfhzflpQqyYvaLP2zo4dov99VXyYD/M3ExGZnVVROe85h6rnfb7q1DqT81v+mLMZOlND5VyiY+vMDLl6jmr4NYOctyFm0KlTjzCDpGZuzumruMx8jokYQiNtBViBJreeYYTpY4KoMAotzWf2t7hvMeT876/v62KJ4ZVOeH2Q8JP5XT90Y4kprbk5I4Y7EK7FqEk9c7jJEEXGqh9WH2qgO6ncZ8JrsKSXxcxJo+ZO5gBLc5vRiegjlB1ehjN6XfIAo1OaPCWX5BONas0lurnOpEUB4eas0ky8tWKdYa9l6Sm0imnCQ133tcoQV+X3RFMHJeFJhCWe24z3tRYV6e9V5vL6G5uMll0R15QyFeN1WDXkfUYhlTeSBOgK5ZiiiZLmOqO1j0RprBq08gwDgI6vM4ql3vL4NQaLuY1bEzYZjVKjs5xrRk80q8m5bUY7vnIqnVH6iqdNX7zOSKQ0e9ppmTjug4vj0sxNhg2NTS09/LxSS5YpH2CsS4rgsdqwp1ZaZ+yFwuokHbB0SyTQrm3mckTZnjuLAeagbk1YZBp7xk5rT1uXJ3G1vc7gZ2WTTgkbyChl5L3nbjJ1TBoqkAgEXhvLlPuMxmxbFB6ncs36dOvGKhO2smfD5TyC9R7TPUZ+9th9KbczDgfpzsg2o0EzWfgiqkWHVDL1qqnXGCUYNqSPdfMCLG+ADzDssul5dI1W3nqln73O9FlwdW3AxDHdVat9Ju1i7dsSd601cA7nOlPUhzaStD703T67svaZvlwaTUaMCMIVF7jOBLWqjRIbP83qpo21zwRlkTqKSVQTa037I+4e0SKT7r1oD0lUyZ1YXEH1A4w7wH0M7KnY2vY29hk3ZK5CyGaW9dhue24z9KKLFhVVqzRLoumKMdeZ0+pwy5Xc96ZHWO/72mP8exyJO9RF2VavZwqbjJ9pRHnB3TWRPuMa8ybTlkaaRaS8rFrRyHrl/CITbLeWhHbZ6AcuHO595rQ/bAB4ABNseBp77DNsaDxPYPd3rltL3zz/HmNn73Zw2cpisvPY2m0m7zYI2dUUsS4c++WjFhk/0lDmn6fgQRuWaiSeYWiX0RFOdz2V7C5jH2Hi2DR3zVmGSYn0BNPu4rMUkYK+ejLRvc/4wa77r/5/ASoh7bn1/lx4i/nv9WE+zJ/MFybWL7tG2MRBAAAAAElFTkSuQmCC"
},
"DocumentNumber": "1459",
"Status": "11",
"StatusDescription": "AwaitingPayment",
"TaxNumber": "54694623079",
"ReceiptUrl": null,
"Identifier": "co-b5f90bc6-c7f4-4457-900b-526cd388edb0",
"Reason": null,
"InterestDate": null,
"FineDate": null,,
},
"Method": "CollectionOrderStatus",
"BusinessUnitId": 1321
}
Collection order webhook status Settled
{
"CollectionOrder": {
"QRCode": {
"HashCode": null,
"Image": null,
"EndToEndPixIn": "E18236120202309281253s15e97018ab",
"EndToEndRefundPixIn": null
},
"DocumentNumber": "160183",
"Status": "9",
"StatusDescription": "Settled",
"TaxNumber": "03401834118",
"ReceiptUrl": null,
"Identifier": "co-87e4f465-536d-4355-8915-4b1eb2c1c13d",
"Reason": null,
"PaymentDate": "2023-09-28T09:54:18.05",
"PrincipalValue": "0.02",
"PaymentValue": "0.02",
"RefundDate": null,
"RefundValue": null,
"InterestDate": null,
"FineDate": null,
"Payer": {
"Name": "Nícolas Alves de Melo",
"AccountInfo": {
"TaxNumber": "03401834118",
"Bank": "260",
"BankBranch": "1",
"BankAccount": "52769618",
"BankAccountDigit": "5"
}
}
},
"Method": "CollectionOrderStatus",
"BusinessUnitId": 1259
}
Collection order webhook status Canceled
{
"CollectionOrder": {
"QRCode": {
"HashCode": "MDAwMjAxMDEwMjEyMjY4MDAwMTRici5nb3YuYmNiLnBpeDI1NThxcmNvZGUtaC5maXRiYW5rLmNvbS5ici9RUi9jb2J2LzIyREZDNUM5OEU5NUYzN0Q1REM0NzBBMzBENTIwNDAwMDA1MzAzOTg2NTgwMkJSNTkwN1NhYnJpbmE2MDA5c2FvIHBhdWxvNjEwODYzNDQ0NDQ0NjIwNzA1MDMqKio2MzA0MDJFMA",
"Image": "iVBORw0KGgoAAAANSUhEUgAAARQAAAEUAQAAAADCC/TUAAADgUlEQVR4nO2aUU7DQAxEfQPf/5a+gfG82aQFgfhzflpQqyYvaLP2zo4dov99VXyYD/M3ExGZnVVROe85h6rnfb7q1DqT81v+mLMZOlND5VyiY+vMDLl6jmr4NYOctyFm0KlTjzCDpGZuzumruMx8jokYQiNtBViBJreeYYTpY4KoMAotzWf2t7hvMeT876/v62KJ4ZVOeH2Q8JP5XT90Y4kprbk5I4Y7EK7FqEk9c7jJEEXGqh9WH2qgO6ncZ8JrsKSXxcxJo+ZO5gBLc5vRiegjlB1ehjN6XfIAo1OaPCWX5BONas0lurnOpEUB4eas0ky8tWKdYa9l6Sm0imnCQ133tcoQV+X3RFMHJeFJhCWe24z3tRYV6e9V5vL6G5uMll0R15QyFeN1WDXkfUYhlTeSBOgK5ZiiiZLmOqO1j0RprBq08gwDgI6vM4ql3vL4NQaLuY1bEzYZjVKjs5xrRk80q8m5bUY7vnIqnVH6iqdNX7zOSKQ0e9ppmTjug4vj0sxNhg2NTS09/LxSS5YpH2CsS4rgsdqwp1ZaZ+yFwuokHbB0SyTQrm3mckTZnjuLAeagbk1YZBp7xk5rT1uXJ3G1vc7gZ2WTTgkbyChl5L3nbjJ1TBoqkAgEXhvLlPuMxmxbFB6ncs36dOvGKhO2smfD5TyC9R7TPUZ+9th9KbczDgfpzsg2o0EzWfgiqkWHVDL1qqnXGCUYNqSPdfMCLG+ADzDssul5dI1W3nqln73O9FlwdW3AxDHdVat9Ju1i7dsSd601cA7nOlPUhzaStD703T67svaZvlwaTUaMCMIVF7jOBLWqjRIbP83qpo21zwRlkTqKSVQTa037I+4e0SKT7r1oD0lUyZ1YXEH1A4w7wH0M7KnY2vY29hk3ZK5CyGaW9dhue24z9KKLFhVVqzRLoumKMdeZ0+pwy5Xc96ZHWO/72mP8exyJO9RF2VavZwqbjJ9pRHnB3TWRPuMa8ybTlkaaRaS8rFrRyHrl/CITbLeWhHbZ6AcuHO595rQ/bAB4ABNseBp77DNsaDxPYPd3rltL3zz/HmNn73Zw2cpisvPY2m0m7zYI2dUUsS4c++WjFhk/0lDmn6fgQRuWaiSeYWiX0RFOdz2V7C5jH2Hi2DR3zVmGSYn0BNPu4rMUkYK+ejLRvc/4wa77r/5/ASoh7bn1/lx4i/nv9WE+zJ/MFybWL7tG2MRBAAAAAElFTkSuQmCC"
},
"DocumentNumber": "1459",
"Status": "8",
"StatusDescription": "Canceled",
"TaxNumber": "54694623079",
"ReceiptUrl": null,
"Identifier": "co-b5f90bc6-c7f4-4457-900b-526cd388edb0",
"Reason": "Payer failed during the KYC process",
"InterestDate": null,
"FineDate": null,
},
"Method": "CollectionOrderStatus",
"BusinessUnitId": 1321
}
Collection order webhook status Canceled-Refund
{
"CollectionOrder": {
"QRCode": {
"HashCode": null,
"Image": null,
"EndToEndPixIn": "b5f90bc6-c7f4-4457-900b-526cd388edb0",
"EndToEndRefundPixIn": "E3284600704190549966864763883940"
},
"DocumentNumber": "1459",
"Status": "15",
"StatusDescription": "Canceled-Refund",
"TaxNumber": "54694623079",
"ReceiptUrl": null,
"Identifier": "co-b5f90bc6-c7f4-4457-900b-526cd388edb0",
"Reason": "Amount refunded. Divergent data between Payer and Settlement",
"PrincipalValue": "74.00",
"PaymentDate": null,
"PaymentValue": null,
"RefundDate": "2023-09-28T09:54:18.05",
"RefundValue": "74.00",
"InterestDate": null,
"FineDate": null,
"Payer": {
"Name": "Alan Martins",
"AccountInfo": {
"TaxNumber": "84933904700",
"Bank": "237",
"BankBranch": "0011",
"BankAccount": "6066452",
"BankAccountDigit": "2"
}
}
},
"Method": "CollectionOrderStatus",
"BusinessUnitId": 1321
}
Collection order webhook status Error
{
"CollectionOrder": {
"QRCode": {
"HashCode": null,
"Image": null
},
"DocumentNumber": "1459",
"Status": "12",
"StatusDescription": "Error",
"TaxNumber": "54694623079",
"ReceiptUrl": null,
"Identifier": "co-b5f90bc6-c7f4-4457-900b-526cd388edb0",
"Reason": null,
"InterestDate": null,
"FineDate": null,
},
"Method": "CollectionOrderStatus",
"BusinessUnitId": 1321
}
Description:
Parameters | Description | Type | Comments |
---|---|---|---|
Method | API Method | STRING (TEXT) | None |
BusinessUnitId | Business Unit ID Provided by FitBank | STRING (TEXT) | None |
CollectionOrder | Object concerning CollectionOrder's info | OBJECT | None |
DocumentNumber | Collection order identification | STRING (TEXT) | None |
Status | Operation status | STRING (TEXT) | None |
StatusDescription | Status description | STRING (TEXT) | None |
Name | Payer's Name | STRING (TEXT) | None |
TaxNumber | CPF or CNPJ of the payer account | STRING (TEXT) | None |
Bank | Payer's Bank Code | STRING (TEXT) | None |
BankBanch | Payer's Bank Agency Code | STRING (TEXT) | None |
BankAccount | Payer's Bank Account | STRING (TEXT) | None |
BankAccountDigit | Payer's Bank Account Digit | STRING (TEXT) | None |
PaymentDate | Payment date | STRING (TEXT) | None |
PrincipalValue | Collection order's amount | STRING (TEXT) | None |
InterestDate | Date when interest starts accruing, or null if not applicable. | STRING (TEXT) | None |
FineDate | Date when fines start applying, or null if not applicable. | STRING (TEXT) | None |
PaymentValue | Collection Payment Value | STRING (TEXT) | None |
ReceiptUrl | Transaction voucher URL | STRING (TEXT) | None |
Identifier | External identifier | STRING (TEXT) | None |
Reason | Reason for canceling the collection order | STRING (TEXT) | None |
QrCode | Object concerning QRCode's info | OBJECT | None |
HashCode | Identification code (copy and paste) | STRING (TEXT) | Base64 format |
Image | QR Code image | STRING (TEXT) | Base64 format |
EndToEndPixIn | PIX credit identifier provided by the Central Bank | STRING (TEXT) | None |
EndToEndRefundPixIn | PIX refund identifier provided by the Central Bank | STRING (TEXT) | None |
Collection Order status:
Status | Status Description | Type | Description |
---|---|---|---|
0 | Created | STRING (TEXT) | The Collection Order was created |
1 | PreAuthorized | STRING (TEXT) | The Collection Order was pre-authorized and the collection was generated |
2 | Analysing | STRING (TEXT) | Payer under review in KYC process |
3 | Authorized | STRING (TEXT) | Payer Approved in KYC |
6 | Registered | STRING (TEXT) | The Collection was registered |
8 | Canceled | STRING (TEXT) | EXC0004 - Payer failed during the KYC process EXC0005 - Invalid billing email address EXC0006 - Collection has expired and payment has not been made EXC0007 - Divergent data between Payer and Settlement EXC0011 - Balance insufficient for fee collection EXC0012 - Payer failed in the validation process EXC0013 - Manual Cancellation INF0008 - Is a qualified person, you must send a Collection Order again, with the data { Name, Email, Phone, Country, Nationality, Occupation, ...} |
9 | Settled | STRING (TEXT) | Completed Billing Order (payment settled) |
11 | Awaiting Payment | STRING (TEXT) | Awaiting Payment |
12 | Error | STRING (TEXT) | EXC0008 - Internal Processing Error |
15 | Canceled-Refund | STRING (TEXT) | INF0010 - Amount refunded. Divergent data between Payer and Settlement INF0014 - Receiver Account Validation Failed INF0016 - Amount refunded. Payer is a qualified person. INF0017 - Amount refunded. Payer screening has failed during the KYC process |
The CollectionOrderWebhook for Collection Orders generated with CollectionOrderType: Boleto = 1:
Collection Order webhook status Created
{
"Method": "CollectionOrderStatus",
"BusinessUnitId": 205,
"CollectionOrder": {
"DocumentNumber": "800",
"Status": "0",
"StatusDescription": "Created",
"TaxNumber": "34596241082",
"ReceiptUrl": null,
"Identifier": "co-b5f90bc6-c7f4-4457-900b-526cd388edb0",
"Reason": null,
"InterestDate": null,
"FineDate": null,
"Boleto": {
"Barcode": null,
"Pdf": null
}
Collection order webhook status PreAuthorized
{
"Method": "CollectionOrderStatus",
"BusinessUnitId": 205,
"CollectionOrder": {
"DocumentNumber": "800",
"Status": "1",
"StatusDescription": "PreAuthorized",
"TaxNumber": "34596241082",
"ReceiptUrl": null,
"Identifier": "co-b5f90bc6-c7f4-4457-900b-526cd388edb0",
"Reason": null,
"InterestDate": null,
"FineDate": null,
"Boleto": {
"Barcode": null,
"Pdf": null
}
Collection order webhook status Authorized
{
"Method": "CollectionOrderStatus",
"BusinessUnitId": 205,
"CollectionOrder": {
"DocumentNumber": "800",
"Status": "3",
"StatusDescription": "Authorized",
"TaxNumber": "34596241082",
"ReceiptUrl": null,
"Identifier": "co-b5f90bc6-c7f4-4457-900b-526cd388edb0",
"Reason": null,
"InterestDate": null,
"FineDate": null,
"Boleto": {
"Barcode": null,
"Pdf": null
}
Collection order webhook status AwaitingPayment
{
"Method": "CollectionOrderStatus",
"BusinessUnitId": 205,
"CollectionOrder": {
"DocumentNumber": "800",
"Status": "11",
"StatusDescription": "AwaitingPayment",
"TaxNumber": "34596241082",
"ReceiptUrl": null,
"Identifier": "co-b5f90bc6-c7f4-4457-900b-526cd388edb0",
"Reason": null,
"InterestDate": null,
"FineDate": null,
"Boleto": {
"Barcode": null,
"Pdf": null
}
Collection order webhook status Settled
{
"Method": "CollectionOrderStatus",
"BusinessUnitId": 205,
"CollectionOrder": {
"DocumentNumber": "800",
"Status": "9",
"StatusDescription": "Settled",
"TaxNumber": "34596241082",
"ReceiptUrl": null,
"Identifier": "co-b5f90bc6-c7f4-4457-900b-526cd388edb0",
"Reason": null,
"InterestDate": null,
"FineDate": null,
"Boleto": {
"Barcode": null,
"Pdf": null
}
Collection order webhook status Canceled
{
"Method": "CollectionOrderStatus",
"BusinessUnitId": 205,
"CollectionOrder": {
"DocumentNumber": "800",
"Status": "8",
"StatusDescription": "Canceled",
"TaxNumber": "34596241082",
"ReceiptUrl": null,
"Identifier": "co-b5f90bc6-c7f4-4457-900b-526cd388edb0",
"Reason": "Payer failed during the KYC process",
"InterestDate": null,
"FineDate": null,
"Boleto": {
"Barcode": null,
"Pdf": null
}
Collection order webhook status Error
{
"Method": "CollectionOrderStatus",
"BusinessUnitId": 205,
"CollectionOrder": {
"DocumentNumber": "800",
"Status": "12",
"StatusDescription": "Error",
"TaxNumber": "34596241082",
"ReceiptUrl": null,
"Identifier": "co-b5f90bc6-c7f4-4457-900b-526cd388edb0",
"Reason": null,
"InterestDate": null,
"FineDate": null,
"Boleto": {
"Barcode": null,
"Pdf": null
}
Description:
Parameters | Description | Type | Comments |
---|---|---|---|
Method | API Method | STRING (TEXT) | None |
BusinessUnitId | Business Unit ID Provided by FitBank | STRING (TEXT) | None |
CollectionOrder | Object concerning CollectionOrder's info | OBJECT | None |
DocumentNumber | Collection order identification | STRING (TEXT) | None |
Status | Operation status | STRING (TEXT) | None |
StatusDescription | Status description | STRING (TEXT) | None |
TaxNumber | CPF or CNPJ of the payer account | STRING (TEXT) | None |
ReceiptUrl | Transaction voucher URL | STRING (TEXT) | None |
Identifier | External identifier | STRING (TEXT) | None |
Reason | Reason for canceling the collection order | STRING (TEXT) | None |
Boleto | Object concerning Boleto's info | OBJECT | None |
Barcode | Collection Boleto barcode | STRING (TEXT) | None |
Collection boleto image | STRING (TEXT) | Base64 format | |
InterestDate | Date when interest starts accruing, or null if not applicable. | STRING (TEXT) | None |
FineDate | Date when fines start applying, or null if not applicable. | STRING (TEXT) | None |
The CollectionOrderWebhook for Collection Orders generated with CollectionOrderType: BoletoPixQrCode=2:
Collection Order webhook status Created
}
"Method": "CollectionOrderStatus",
"BusinessUnitId": 205,
"CollectionOrder": {
"DocumentNumber": "800",
"Status": "0",
"StatusDescription": "Created",
"TaxNumber": "34596241082",
"ReceiptUrl": null,
"Identifier": "co-b5f90bc6-c7f4-4457-900b-526cd388edb0",
"Reason": null,
"InterestDate": null,
"FineDate": null,
"Boleto": {
"Barcode": null,
"Pdf": null,
"QrCode": {
"HashCode": null,
"Image": null
}
Collection order webhook status PreAuthorized
}
"Method": "CollectionOrderStatus",
"BusinessUnitId": 205,
"CollectionOrder": {
"DocumentNumber": "800",
"Status": "1",
"StatusDescription": "PreAuthorized",
"TaxNumber": "34596241082",
"ReceiptUrl": null,
"Identifier": "co-b5f90bc6-c7f4-4457-900b-526cd388edb0",
"Reason": null,
"InterestDate": null,
"FineDate": null,
"Boleto": {
"Barcode": null,
"Pdf": null,
"QrCode": {
"HashCode": null,
"Image": null
}
Collection order webhook status Authorized
}
"Method": "CollectionOrderStatus",
"BusinessUnitId": 205,
"CollectionOrder": {
"DocumentNumber": "800",
"Status": "3",
"StatusDescription": "Authorized",
"TaxNumber": "34596241082",
"ReceiptUrl": null,
"Identifier": "co-b5f90bc6-c7f4-4457-900b-526cd388edb0",
"Reason": null,
"InterestDate": null,
"FineDate": null,
"Boleto": {
"Barcode": null,
"Pdf": null,
"QrCode": {
"HashCode": null,
"Image": null
}
Collection order webhook status AwaitingPayment
}
"Method": "CollectionOrderStatus",
"BusinessUnitId": 205,
"CollectionOrder": {
"DocumentNumber": "800",
"Status": "11",
"StatusDescription": "AwaitingPayment",
"TaxNumber": "34596241082",
"ReceiptUrl": null,
"Identifier": "co-b5f90bc6-c7f4-4457-900b-526cd388edb0",
"Reason": null,
"InterestDate": null,
"FineDate": null,
"Boleto": {
"Barcode": null,
"Pdf": null,
"QrCode": {
"HashCode": null,
"Image": null
}
Collection order webhook status Settled
}
"Method": "CollectionOrderStatus",
"BusinessUnitId": 205,
"CollectionOrder": {
"DocumentNumber": "800",
"Status": "9",
"StatusDescription": "Settled",
"TaxNumber": "34596241082",
"ReceiptUrl": null,
"Identifier": "co-b5f90bc6-c7f4-4457-900b-526cd388edb0",
"Reason": null,
"InterestDate": null,
"FineDate": null,
"Boleto": {
"Barcode": null,
"Pdf": null,
"QrCode": {
"HashCode": null,
"Image": null
}
Collection order webhook status Canceled
}
"Method": "CollectionOrderStatus",
"BusinessUnitId": 205,
"CollectionOrder": {
"DocumentNumber": "800",
"Status": "8",
"StatusDescription": "Canceled",
"TaxNumber": "34596241082",
"ReceiptUrl": null,
"Identifier": "co-b5f90bc6-c7f4-4457-900b-526cd388edb0",
"Reason": "Payer failed during the KYC process",
"InterestDate": null,
"FineDate": null,
"Boleto": {
"Barcode": null,
"Pdf": null,
"QrCode": {
"HashCode": null,
"Image": null
}
Collection order webhook status Error
}
"Method": "CollectionOrderStatus",
"BusinessUnitId": 205,
"CollectionOrder": {
"DocumentNumber": "800",
"Status": "12",
"StatusDescription": "Error",
"TaxNumber": "34596241082",
"ReceiptUrl": null,
"Identifier": "co-b5f90bc6-c7f4-4457-900b-526cd388edb0",
"Reason": null,
"InterestDate": null,
"FineDate": null,
"Boleto": {
"Barcode": null,
"Pdf": null,
"QrCode": {
"HashCode": null,
"Image": null
}
Description:
Parameters | Description | Type | Comments |
---|---|---|---|
Method | API Method | STRING (TEXT) | None |
BusinessUnitId | Business Unit ID Provided by FitBank | STRING (TEXT) | None |
CollectionOrder | Object concerning CollectionOrder's info | OBJECT | None |
DocumentNumber | Collection order identification | STRING (TEXT) | None |
Status | Operation status | STRING (TEXT) | None |
StatusDescription | Status description | STRING (TEXT) | None |
TaxNumber | CPF or CNPJ of the payer account | STRING (TEXT) | None |
ReceiptUrl | Transaction voucher URL | STRING (TEXT) | None |
Identifier | External identifier | STRING (TEXT) | None |
Reason | Reason for canceling the collection order | STRING (TEXT) | None |
Boleto | Object concerning Boleto's info | OBJECT | None |
Barcode | Collection Boleto barcode | STRING (TEXT) | None |
Collection boleto image | STRING (TEXT) | Base64 format | |
QrCode | Object concerning QRCode's info | OBJECT | None |
HashCode | Identification code (copy and paste) | STRING (TEXT) | Base64 format |
Image | QR Code image | STRING (TEXT) | Base64 format |
InterestDate | Date when interest starts accruing, or null if not applicable. | STRING (TEXT) | None |
FineDate | Date when fines start applying, or null if not applicable. | STRING (TEXT) | None |
5.2 UpdateCollectionOrderPayerStatus
Collection order payer webhook status Created
{
"CollectionOrderPayer": {
"Name": "José Reinaldo Sales Soares",
"Status": "Created",
"TaxNumber": "20282702091",
"Phone": "88999999999",
"Mail": "[email protected]",
"Reason": null
},
"Method": "CollectionOrderPayerStatus",
"BusinessUnitId": 61859
}
Collection order payer webhook status Analysing
{
"CollectionOrderPayer": {
"Name": "José Reinaldo Sales Soares",
"Status": "Analysing",
"TaxNumber": "20282702091",
"Phone": "88999999999",
"Mail": "[email protected]",
"Reason": null
},
"Method": "CollectionOrderPayerStatus",
"BusinessUnitId": 61859
}
Collection order payer webhook status Approved
{
"CollectionOrderPayer": {
"Name": "José Reinaldo Sales Soares",
"Status": "Approved",
"TaxNumber": "20282702091",
"Phone": "88999999999",
"Mail": "[email protected]",
"Description": null,
"Reason": null
},
"Method": "CollectionOrderPayerStatus",
"BusinessUnitId": 61859
}
Collection order payer webhook status Denied
{
"CollectionOrderPayer": {
"Name": "José Reinaldo Sales Soares",
"Status": "Denied",
"TaxNumber": "20282702091",
"Phone": "88999999999",
"Mail": "[email protected]",
"Reason": [
"Identified that the Payer is at ONU with a percentage of 92, 00% with the following name ‘SILVA CHICO ALVES’ using evaluation ‘TokenSortRatio’;",
"Identified that the Payer is at ONU with a percentage of 92, 00% with the following name ‘SILVA CHICO ALVES’ using evaluation ‘TokenSetRatio’;"
]
},
"Method": "CollectionOrderPayerStatus",
"BusinessUnitId": 61859
}
Description:
Parameters | Description | Type | Comments |
---|---|---|---|
Name | Payer name | STRING (TEXT) | None |
Status | Payer status indication | STRING (TEXT) | Created = 0 Analysing = 1 Approved = 2 Denied = 3 |
TaxNumber | CPF or CNPJ of the payer | STRING (TEXT) | None |
Phone | Payer phone | STRING (TEXT) | None |
Payer mail | STRING (TEXT) | None | |
Reason | Reason for denying the payer | STRING (TEXT) | None |
Method | API method | STRING (TEXT) | None |
BusinessUnitId | Business Unit ID provided by FitBank | STRING (TEXT) | None |
Created = Created Payer
Analysing = Payer under review in KYC process
Approved = KYC approved payer
Denied = Reapproved KYC payer
Response webhook
To confirm receipt of the webhook, return us the following json:
{
"Success": true,
"Message": "Operation successfully completed."
}
Updated 20 days ago