5 - Webhooks
Keys
Pix Key Action Webhook
This webhook notifies the customer of the actions performed on a PIX key, according to the request made, e.g. key creation, cancellation, change of bank details, claim or portability.
{
"ActionStatus": "Processed",
"Action": "CreatePixKey",
"DocumentNumber": 178746,
"PixKeyValue": "string",
"PixkeyClaim": {
"PixKeyClaimOrigin": null,
"Type": null,
"Status": null,
"BankCode": null,
"ExpirationDate": null,
"ExpirationCycle": null,
"CancelReason": null
},
"PixKeyChange": {
"Status": null,
"FromBankCode": null,
"FromBankBranch": null,
"FromBankAccount": null,
"FromBankAccountDigit": null,
"ToBankCode": null,
"ToBankBranch": null,
"ToBankAccount": null,
"ToBankAccountDigit": null
},
"Method": "CreatePixKey",
"BusinessUnitId": 458
}
Description:
Parameter | Description | Type | Comments |
---|---|---|---|
ActionStatus | Current status of the action the PIX key went through | STRING | - |
Action | Type of action the key went through | STRING | - |
DocumentNumber | Internal PIX key ID after registration request | NUMBER | - |
PixKeyValue | Value of the PIX key | STRING | - |
PixKeyClaim | Object concerning PIX key claim and portability actions | OBJECT | - |
PixKeyClaimOrigin | PIX key claim or portability origin | STRING | Internal = FitBank account receiving the request External = FitBank account sending the request |
Type | Action type | STRING | Ownership or Portability |
Status | PIX key status | STRING | - |
BankCode | PIX key's Bank Code | STRING | - |
ExpirationDate | 7-day expiration date of the claim or portability request | NUMBER | - |
ExpirationCycle | Claim request cycle or portability | INT | Determines how many times the key in question has been through a claim or portability request. For example: First cycle = 0 Second cycle = 1 |
CancelReason | Reason for cancellation of claim request or portability | STRING | CustomerRequest = 0 AccountClosure = 1 Fraud = 2 DefaultResponse = 3 Reconciliation = 4 |
PixKeyChange | Object concerning actions for changing the PIX key's bank details | OBJECT | - |
Status | Status of the claim or portability request | STRING | - |
FromBankCode | PIX key's source Bank Code | STRING | - |
FromBankBranch | PIX key's source Bank Agency Code | STRING | - |
FromBankAccount | PIX key's source Bank Account | STRING | - |
FromBankAccountDigit | PIX key's source Bank Account Digit | STRING | - |
ToBankCode | PIX key's destination Bank Code | STRING | - |
ToBankBranch | PIX key's destination Bank Branch | STRING | - |
ToBankAccount | PIX key's destination Bank Account | STRING | - |
ToBankAccountDigit | PIX key's destination Bank Account Digit | STRING | - |
Method | Message pointing to the action performed in the operation | STRING | - |
BusinessUnitId | Business unit ID provided by FitBank | INT | - |
PIX key status and its status codes sent in the webhooks:
- 0 - Created: Key registration request has been received by FitBank
- 1 - Registering: The key registration request is in the process of being registered in DICT
- 2 - Registered: The key was registered in DICT and is ready for use
- 3 - Disabled: The key was disabled
- 4 - Canceled: The key was canceled
- 5 - Error: Error in processing the key register in DICT
- 6 - Claiming: The key is in portability and claiming process (within 7 days valid)
- 7 - ErrorOwnership: After attempting to create, it was validated that the key is registered with a different owner
- 8 - ErrorPortability: It was validated that the key is registered with another institution
PIX key Actions sent in the webhooks:
- 0 - CreatePixKey
- 1 - ChangePixKey
- 2 - CancelPixKey
- 3 - ClaimPixKey
- 4 - CancelInternalClaimPixKey
- 5 - CancelExternalClaimPixKey
- 6 - ConfirmExternalClaimPixKey
- 7 - CheckExternalPixKeyClaim
Action status sent in the webhooks:
- 0 - Created
- 1 - Processed
- 2 - Error
- 3 - Canceled
- 4 - Registering
- 5 - CanBeCancel
- 6 - Registered
- 7 - CanBeCompleted
- 8 - CanBeProcessed
- 9 - Expected
Important: While in the PIX Key Action Webhook the Status of the key is received, in the PIX Key Status Webhook the Status and the StatusCode are received, in separate parameters.
When there is no action for the PIX key regarding bank data change or claim and portability, the PixKeyClaim and PixKeyChange objects will return their parameters as null.
However, when there is an action regarding claim or portability, the object PixKeyClaim will be filled in, indicating the origin of the request, i.e. whether internal or external (PixKeyClaimOrigin field), the type of the request, whether claim or portability (Type field), and other information.
When there are actions regarding changing bank details linked to the PIX key in question, the PixKeyChange object will return its filled parameters, signaling the source and destination account of the key being changed, as well as the request status.
When requesting the registration of a random key, when its processing has been successfully completed by Banco Central, it is possible to retrieve it via webhook. In this path, at the end of the flow the customer will receive:
- A Pix Key Action Webhook, signaling that the key registration request has been successfully processed ("ActionStatus": "Processed"), and containing the key value ("PixKeyValue": "string");
- A Pix Key Status Webhook notifying that the key is under Registered status, that is, properly registered and fit for use in FitBank's base, and also containing the value of the key in question ("PixKey": "string").
Pix Key Status Webhook
This webhook notifies you of the statuses the PIX key may be in, or through, according to the actions performed on it, e.g. key creation, cancellation, change of bank details, claim or portability.
{
"PixKey": "[email protected]",
"Status": "Registered",
"Type": "RandomKeyCode",
"StatusCode": 0,
"Bank": "450",
"BankBranch": "0001",
"BankAccount": "741099532",
"BankAccountDigit": "5",
"Method": "UpdatePixKeyStatus",
"BusinessUnitId": 494
}
Description:
Parameter | Description | Type | Comments |
---|---|---|---|
PixKey | PIX key | STRING | - |
Status | PIX key status | STRING | - |
Type | PIX key type | STRING | SocialSecurity = 0 TaxNumber = 1 E-mail = 2 PhoneNumber = 3 RandomKeyCode = 4 |
StatusCode | PIX key's status code | NUMBER | - |
Bank | PIX key's Bank Code | STRING | - |
BankBranch | PIX key's Bank Agency Code | STRING | - |
BankAccount | PIX key's Bank Account | STRING | - |
BankAccountDigit | PIX key's Bank Account Digit | STRING | - |
Method | Message pointing to the action performed in the operation | STRING | - |
BusinessUnitId | Business unit ID provided by FitBank | INT | - |
Payment
Pix Out Webhook
This webhook is responsible for notifying when a PIX payment goes through certain actions, executed either by customer request or by FitBank's system.
Through it, it is possible to identify what status the payment is in and other information, such as bank details of who pays and who receives, reason for cancelling the payment if any, payment date, and other information.
{
"FromName": "Fagner Ferreira",
"FromTaxNumber": "41801125333",
"FromBankCode": "450",
"FromBankBranch": "0001",
"FromBankAccount": "1000006021",
"FromBankAccountDigit": "3",
"FromISPB": "13203354",
"ToName": "Fagner Gomes Ferreira",
"ToTaxNumber": "41801125317",
"ToBankCode": "323",
"ToBankBranch": "1",
"ToBankAccount": "25999966234",
"ToBankAccountDigit": "9",
"RateValue": 0,
"ToISPB": "10573521",
"RefundDate": "0001-01-01T00:00:00",
"ReceiptUrl": "https://receipt.fitbank.com.br/receiptapi/pdf?filename=2024-09-26/tm2323eddsq30.pdf",
"EndToEndId": "E1320335420240966669963350EB475DB",
"Tags": null,
"ErrorDescription": null,
"ErrorCode": null,
"InitiationEndToEndId": null,
"InitiationDocumentNumber": null,
"RefundCode": null,
"PartnerId": 678,
"DocumentNumber": "293880493",
"Identifier": "e2442e4b-6dee-88187c5f021a",
"EntryId": 8863961213,
"Status": "Paid",
"TotalValue": 0.1,
"PaymentDate": "2024-09-26T10:26:55.86",
"Method": "PixOut",
"BusinessUnitId": 494
}
Description:
Parameter | Description | Type | Comments |
---|---|---|---|
FromName | Payer's name | STRING | - |
FromTaxNumber | Payer's CPF/CNPJ | STRING | - |
FromBankCode | Payer's Bank Code | STRING | - |
FromISPB | Payer's Bank ISPB code | STRING | - |
FromBankBranch | Payer's Bank Agency Code | STRING | - |
FromBankAccount | Payer's Bank Account | STRING | - |
FromBankAccountDigit | Payer's Bank Account Digit | STRING | - |
ToTaxNumber | Receiver's CPF/CNPJ | STRING | - |
ToName | Receiver's name | STRING | - |
ToBankCode | Receiver's Bank Code | STRING | - |
ToISPB | Receiver's Bank ISPB Code | STRING | - |
ToBankBranch | Receiver's Bank Agency Code | STRING | - |
ToBankAccount | Receiver's Bank Account | STRING | - |
ToBankAccountDigit | Receiver's Bank Account Digit | STRING | - |
RateValue | Rate value | NUMBER | - |
ReceiptUrl | Receipt's URL | STRING | - |
EndToEndId | Unique external operation identifier | STRING | - |
Tags | List of tags | STRING | E.g.: Transfer, API Test |
ErrorDescription | Operation description | STRING | When the transaction is cancelled or settled, the reason and description will be sent in this field |
ErrorCode | Operation error code | STRING | When the transaction is cancelled, the reason code will be sent. If the transaction is settled, the parameter is sent as null |
PartnerId | Partner ID provided by FitBank | INT | - |
DocumentNumber | FitBank's internal operation ID | STRING | - |
Identifier | Payment identifier assigned by the payer | STRING | - |
EntryId | Internal identifier used to distinguish and track the operation within FitBank | NUMBER | FitBank internal data, can be disregarded |
Status | Payment status | STRING | - |
TotalValue | Payment value | NUMBER | - |
PaymentDate | Payment date | STRING | - |
Method | Message pointing to the action performed in the operation | STRING | - |
BusinessUnitId | Business unit ID provided by FitBank | INT | - |
PIX Out status sent in the webhooks:
- Paid: Settled transaction
- Cancel: Canceled transaction
Note: It is important to note that, while status Paid is returned through webhooks, it will be returned as Settled through APIs (methods GetPixOutById or GetPixOutByDate). Their function and meaning is the same, since they both indicate that the PIX payment was settled.
On an other note, status Cancel will be returned in webhooks, and status Canceled will be returned through APIs. The meaning is the same in both situations, since they both refer to a canceled PIX payment.
ErrorCodes and ErrorDescriptions sent in the webhooks:
ErrorCode | ErrorDescription |
---|---|
OCR0001 | Insufficient balance for payment of transaction and/or fees |
OCR0002 | Transaction canceled by Institution |
OCR0003 | Transaction cancelled at user's requestAn error occurred while processing the PIX transaction |
SPI0001 | An error occurred while processing the PIX transaction |
SPI0002 | Transaction settlement interrupted due to SPI timeout |
SPI0003 | Transaction interrupted due to error in recipient user's participant |
SPI0004 | PIX transaction sender timeout |
SPI0005 | Invalid/inexistent branch and/or account number of recipient user |
SPI0006 | Recipient's account blocked |
SPI0007 | Recipient user account is closed |
SPI0008 | Incorrect type for the receiving user's transaction account |
SPI0009 | The transaction type is not supported/authorized in the recipient user's account |
SPI0010 | Transaction with this Processing Type is not allowed |
SPI0011 | No refund of an instant payment |
SPI0012 | The direct participant is not settling the paying user |
SPI0013 | PIX transaction with zero value is not allowed |
SPI0014 | Payment/return order exceeds the limit allowed for the account type |
SPI0015 | Insufficient balance in PI account of paying user |
SPI0016 | Return exceeds original PIX transaction amount |
SPI0017 | Divergence between the sum of the block values |
SPI0018 | Invalid transaction quantity |
SPI0019 | CPF/CNPJ of the recipient does not diverge from the data of the Account holder |
SPI0020 | Unauthorized PIX transaction initiator |
SPI0021 | QR Code rejected by the receiving user's participant |
SPI0022 | CPF/CNPJ of the incorrect recipient user |
SPI0023 | Incorrect or incompatible message content |
SPI0024 | Transaction rejected by the receiving user's participant |
SPI0025 | Participant who signed the message is not authorized |
SPI0026 | Transaction rejected due to timeout between messages |
SPI0027 | The participant is not registered or has not yet started operating in SPI |
SPI0028 | Date and time of sending the invalid message |
SPI0029 | The transaction exceeds the maximum time limit for returning a PIX transaction |
SPI0030 | Inconsistency between the transaction purpose and the message |
SPI0031 | Poorly formatted operation identifier |
SPI0032 | ISPB of the facilitating participant of the non-existing Pix Withdrawal or Pix Change service |
SPI0033 | Invalid or non-existent ISPB of the paying participant |
SPI0034 | Invalid or non-existent ISPB of the paying participant |
SPI0035 | Transaction rejected as paying user is sanctioned |
SPI0036 | The original transaction is not related to PIX Withdrawal or PIX Change |
Refund Pix In Webhook
This webhook notifies when a PIX return has been made by an account in FitBank, after using the GenerateRefundPixIn method, and in what status it is, as well as general data of source and destination account, voucher, date and amount of the transaction, among others.
{
"FromName": "Teste prod",
"FromTaxNumber": "41801125317",
"FromBankCode": "450",
"FromBankBranch": "0001",
"FromBankAccount": "101006513",
"FromBankAccountDigit": "0",
"FromISPB": "13203354",
"ToName": "Fagner Gomes Ferreira",
"ToTaxNumber": "41801125317",
"ToBankCode": "260",
"ToBankBranch": "1",
"ToBankAccount": "1611804",
"ToBankAccountDigit": "2",
"RateValue": 0,
"ToISPB": "18236120",
"RefundDate": "2024-03-14T13:56:31.747",
"ReceiptUrl": "https://receipt.fitbank.com.br/receiptapi/pdf?filename=https://receipt.fitbank.com.br/receiptapi/pdf?filename=2024-03-14/gml55dfeb00000d2.pdf",
"EndToEndId": "D1320335420240314165635435918350",
"Tags": [
"picpay",
"FagnerGomes",
"41801125317",
"249127438"
],
"ErrorDescription": null,
"ErrorCode": null,
"InitiationEndToEndId": "E18236120202403141431s0950699519",
"InitiationDocumentNumber": "249127438",
"RefundCode": "MD06",
"PartnerId": 678,
"DocumentNumber": "1507655",
"Identifier": "Te.6sxsss",
"EntryId": 5971045869,
"Status": "Paid",
"TotalValue": 0.12,
"PaymentDate": null,
"Method": "RefundPixIn",
"BusinessUnitId": 494
}
Description:
Parameter | Description | Type | Comments |
---|---|---|---|
FromName | Payer's name | STRING | - |
FromTaxNumber | Payer's tax number | STRING | - |
FromBankCode | Payer's Bank Code | STRING | - |
FromISPB | Payer's Bank ISPB Code | STRING | - |
FromBankBranch | Payer's Bank Agency Code | STRING | - |
FromBankAccount | Payer's Bank Account | STRING | - |
FromBankAccountDigit | Payer's Bank Account Digit | STRING | - |
ToName | Receiver's name | STRING | - |
ToTaxNumber | Receiver's CPF/CNPJ | STRING | - |
ToBankCode | Receiver's Bank Code | STRING | - |
ToISPB | Receiver's Bank ISPB Code | STRING | - |
ToBankBranch | Receiver's Agency Code | STRING | - |
ToBankAccount | Receiver's Bank Account | STRING | - |
ToBankAccountDigit | Receiver's Bank Account Digit | STRING | - |
RefundDate | Operation date | STRING | - |
ReceiptUrl | Receiving receipt URL | STRING | - |
EndToEndId | Unique external operation identifier | STRING | - |
Tags | List of Tags | ARRAY OF STRINGS | E.g.: ‘Transfer’, ‘Teste API’ |
ErrorDescription | Error Description | STRING | Data concerning other operation types. It is part of the standard webhooks body structure and can be disregarded in the RefundPixIn operation |
ErrorCode | Error Code | STRING | Data concerning other operation types. It is part of the standard webhooks body structure and can be disregarded in the RefundPixIn operation |
InitiationEndToEndId | Original transaction identifier | STRING | - |
InitiationDocumentNumber | FitBank's internal original operation ID | STRING | - |
RefundCode | Reason for Return | STRING | MD06: Return payment requested by the receiving user. BE08: Return of instant payment requested by the Paying PSP due to operational failure FR01: Return of instant payment requested by the receiving user under a special return mechanism |
PartnerId | Partner ID provided by FitBank | INT | - |
DocumentNumber | FitBank's internal operation ID | STRING | - |
Identifier | Operation ID assigned in its generation | STRING | - |
EntryId | Internal identifier used to distinguish and track the operation within FitBank | NUMBER | FitBank internal data, can be disregarded |
Status | Operation status | STRING | - |
TotalValue | Operation value | NUMBER | - |
PaymentDate | Payment date | STRING | Data concerning other operation types. It is part of the standard webhooks body structure and can be disregarded in the RefundPixIn operation |
Method | Message pointing to the action performed in the operation | STRING | - |
BusinessUnitId | Business unit ID provided by FitBank | INT | - |
Refund PIX In status sent in the webhooks:
- Cancel: Canceled transaction
- Paid: Settled transaction
Refund Pix Out Webhook
This webhook notifies when an account within FitBank has received a return of a payment made earlier.
{
"FromName": "Amarillys Félix",
"FromTaxNumber": "86775031000130",
"FromBankCode": "450",
"FromBankBranch": "0001",
"FromBankAccount": "188573858",
"FromBankAccountDigit": "5",
"FromISPB": "13203354",
"ToName": "Amarillys RF Silva",
"ToTaxNumber": "16985164013",
"ToBankCode": "450",
"ToBankBranch": "0001",
"ToBankAccount": "184780718",
"ToBankAccountDigit": "8",
"ToISPB": "13203354",
"InitiationEndToEndId": "E2101818909290219019210109302018",
"InitiationDocumentNumber": "764",
"RefundDate": "2022-10-25T16:19:42.347",
"ReceiptUrl": "http://www.pdfurl.com.br/",
"EndToEndId": null,
"Tags": null,
"PixOutIdentifier": "Amarillys payment",
"PartnerId": 755,
"DocumentNumber": "5593541",
"Identifier": "3921731e-089f-4278-9913-69801f827411",
"EntryId": null,
"Status": "Paid",
"TotalValue": 1,
"PaymentDate": null,
"FineInterest": null,
"DiscountValue": null,
"IofValue": null,
"PaidValue": null,
"OtherValues": null,
"CreditDate": null,
"OccurrenceDate": null,
"URL": null,
"BankCode": null,
"BankBranch": null,
"BankAccount": null,
"BankAccountDigit": null,
"ReturnCode": null,
"ReturnMessage": null,
"PaymentProtocol": null,
"Method": "RefundPixOut",
"BusinessUnitId": 672
}
Description:
Parameter | Description | Type | Comments |
---|---|---|---|
FromName | Payer's name | STRING | - |
FromTaxNumber | Payer's CPF/CNPJ | STRING | - |
FromBankCode | Payer's Bank Code | STRING | - |
FromBankBranch | Payer's Bank Agency Code | STRING | - |
FromBankAccount | Payer's Bank Account | STRING | - |
FromBankAccountDigit | Payer's Bank Account Digit | STRING | - |
FromISPB | Payer's Bank ISPB Code | STRING | - |
ToName | Receiver's name | STRING | - |
ToTaxNumber | Receiver's CPF/CNPJ | STRING | - |
ToBankCode | Receiver's Bank Code | STRING | - |
ToBankBranch | Receiver's Bank Agency Code | STRING | - |
ToBankAccount | Receiver's Bank Account | STRING | - |
ToBankAccountDigit | Receiver's Bank Account Digit | STRING | - |
ReceiptUrl | Receipt URL | STRING | - |
ToISPB | Receiver's Bank ISPB Code | STRING | - |
InitiationEndToEndId | Original transaction identifier | STRING | - |
InitiationDocumentNumber | FitBank's internal original operation ID | STRING | - |
RefundDate | Operation date | STRING | - |
EndToEndId | Unique external operation identifier | STRING | - |
Tags | List of Tags | ARRAY OF STRINGS | E.g.: ‘Transfer’, ‘Teste API’ |
PartnerId | Partner ID provided by FitBank | INT | - |
DocumentNumber | FitBank's internal operation ID | STRING | - |
Identifier | Internal ID generated by FitBank | STRING | - |
EntryId | Internal identifier used to distinguish and track the operation within FitBank | NUMBER | FitBank internal data, can be disregarded |
Status | Operation status | STRING | - |
TotalValue | Payment value | NUMBER | - |
PaymentDate | Payment date | STRING | - |
FineInterest | Fine value | STRING | Data concerning other operation types. It is part of the standard webhooks body structure and can be disregarded in the RefundPixOut operation |
DiscountValue | Discount value | STRING | Data concerning other operation types. It is part of the standard webhooks body structure and can be disregarded in the RefundPixOut operation |
IofValue | Brazilian transaction tax on a financial transaction | STRING | Data concerning other operation types. It is part of the standard webhooks body structure and can be disregarded in the RefundPixOut operation |
PaidValue | Paid operation value | STRING | Data concerning other operation types. It is part of the standard webhooks body structure and can be disregarded in the RefundPixOut operation |
OtherValues | Other values regarding the operation | STRING | Data concerning other operation types. It is part of the standard webhooks body structure and can be disregarded in the RefundPixOut operation |
CreditDate | Credit date | STRING | Data concerning other operation types. It is part of the standard webhooks body structure and can be disregarded in the RefundPixOut operation |
OccurrenceDate | Occurrence date | STRING | Data concerning other operation types. It is part of the standard webhooks body structure and can be disregarded in the RefundPixOut operation |
URL | Operation URL | STRING | Data concerning other operation types. It is part of the standard webhooks body structure and can be disregarded in the RefundPixOut operation |
BankCode | Bank Code | STRING | Data concerning other operation types. It is part of the standard webhooks body structure and can be disregarded in the RefundPixOut operation |
BankBranch | Bank Agency Code | STRING | Data concerning other operation types. It is part of the standard webhooks body structure and can be disregarded in the RefundPixOut operation |
BankAccount | Bank Account | STRING | Data concerning other operation types. It is part of the standard webhooks body structure and can be disregarded in the RefundPixOut operation |
BankAccountDigit | Bank Account Digit | STRING | Data concerning other operation types. It is part of the standard webhooks body structure and can be disregarded in the RefundPixOut operation |
ReturnCode | Return code | STRING | Data concerning other operation types. It is part of the standard webhooks body structure and can be disregarded in the RefundPixOut operation |
ReturnMessage | Return message | STRING | Data concerning other operation types. It is part of the standard webhooks body structure and can be disregarded in the RefundPixOut operation |
PaymentProtocol | Payment protocol | STRING | Data concerning other operation types. It is part of the standard webhooks body structure and can be disregarded in the RefundPixOut operation |
Method | Message pointing to the action performed in the operation | STRING | - |
BusinessUnitId | Business unit ID provided by FitBank | INT | - |
Refund PIX Out status sent in the webhooks:
- Paid: The return Receipt was processed and settled
Receipt and collection
Pix In Webhook
This webhook is responsible for notifying a common pix receipt, that is, when an account in FitBank receives the amount of a payment.
It is accompanied by its possible status and other information, such as the origin and destination account, day of receipt, End To End code, transaction amount, among others.
{
"FromName": "Fagner Gomes Ferreira",
"FromTaxNumber": "41801125317",
"FromBankNumber": "380",
"FromBankBranch": "1",
"FromBankAccount": "776232",
"FromBankAccountDigit": "1",
"FromISPB": "22896431",
"ToName": "Teste prod",
"ToTaxNumber": "41801125317",
"ToBankNumber": "450",
"ToBankBranch": "0001",
"ToBankAccount": "76577713",
"ToBankAccountDigit": "8",
"ToISPB": "13203354",
"CustomerMessage": null,
"Value": 0.01,
"TransferDate": "2024-03-07T12:43:02.517",
"ReceiptUrl": "https: //receipt.fitbank.com.br/receiptapi/pdf?filename=2024-03-07/f056o3k2m.pdf" ,
"EndToEndId": "E22896431202403071542Mor2f7ed716",
"ReceiverPixKey": null,
"QRCodeInfos": null,
"InitiationType": "Manual",
"Tags": null,
"FromSPB": "22896431",
"ToSPB": "13203354",
"DocumentNumber": "238576956",
"EntryId": 5876280980,
"Status": "Paid",
"PartnerId": 678,
"BusinessUnitId": 494,
"Method": "PixIn"
}
{
"FromName": "Fagner Gomes Ferreira",
"FromTaxNumber": "41801125317",
"FromBankNumber": "380",
"FromBankBranch": "1",
"FromBankAccount": "66526",
"FromBankAccountDigit": "1",
"FromISPB": "22896431",
"ToName": "Fagner Ferreira",
"ToTaxNumber": "41801125317",
"ToBankNumber": "450",
"ToBankBranch": "0001",
"ToBankAccount": "1095822021",
"ToBankAccountDigit": "3",
"ToISPB": "13203354",
"CustomerMessage": null,
"Value": 0.3,
"TransferDate": "2024-03-07T13:06:01.927",
"ReceiptUrl": "https://receipt.fitbank.com.br/receiptapi/pdf?filename=2024-03-07/gfgf366zi.pdf",
"EndToEndId": "E22896431202403071605SPYY2MvTLuK",
"ReceiverPixKey": "31cc948e-2665-322662b5-56ec7012b17c",
"QRCodeInfos": {
"DocumentNumber": "295440995",
"Type": "Dynamic",
"ConciliationId": "3097427B422D70C1633A1F6C8F6F51096EA",
"Identifier": "testecshSange",
"Payer": {
"Name": "fagnerg gomes",
"TaxNumber": null
},
"Value": {
"PrincipalValue": 0.3,
"DiscountValue": null,
"RebateValue": null,
"FineValue": null,
"InterestValue": null
}
},
"InitiationType": "DynamicQRCode",
"Tags": null,
"FromSPB": "22896431",
"ToSPB": "13203354",
"DocumentNumber": "238647063",
"EntryId": 5876806776,
"Status": "Paid",
"PartnerId": 678,
"BusinessUnitId": 494,
"Method": "PixIn"
}
{
"FromName": "Fagner Gomes Ferreira",
"FromTaxNumber": "41801125317",
"FromBankNumber": "380",
"FromBankBranch": "1",
"FromBankAccount": "341612656358",
"FromBankAccountDigit": "1",
"FromISPB": "22896431",
"ToName": "Fagner Ferreira",
"ToTaxNumber": "41801125317",
"ToBankNumber": "450",
"ToBankBranch": "0001",
"ToBankAccount": "10962965632021",
"ToBankAccountDigit": "3",
"ToISPB": "13203354",
"CustomerMessage": null,
"Value": 0.02,
"TransferDate": "2024-03-07T12:48:27.033",
"ReceiptUrl": "https://receipt.fitbank.com.br/receiptapi/pdf?filename=2024-03-07/5v2yo215dfg0q.pdf",
"EndToEndId": "E2289643120240307154813640297479",
"ReceiverPixKey": "31cc948e-5f-566-2662b5-56ec7012b17c",
"QRCodeInfos": null,
"InitiationType": "PixKey",
"Tags": null,
"FromSPB": "22896431",
"ToSPB": "13203354",
"DocumentNumber": "238593658",
"EntryId": 5405287,
"Status": "Paid",
"PartnerId": 678,
"BusinessUnitId": 494,
"Method": "PixIn"
}
Description:
Parameter | Description | Type | Comments |
---|---|---|---|
FromName | Payer's name | STRING | - |
FromTaxNumber | Payer's tax number | STRING | - |
FromBankNumber | Payer's Bank Code | STRING | - |
FromBankBranch | Payer's Bank Agency Code | STRING | - |
FromBankAccount | Payer's Bank Account | STRING | - |
FromISPB | Code ISPB of the origin | INT | - |
FromBankAccountDigit | Payer's Bank Account Digit | STRING | - |
ToName | Receiver's name | STRING | - |
ToTaxNumber | Receiver's CPF/CNPJ | STRING | - |
ToBankNumber | Receiver's Bank Code | STRING | - |
ToISPB | Code ISPB of destination | INT | - |
ToBankBranch | Receiver's Bank Agency Code | STRING | - |
ToBankAccount | Receiver's Bank Account | STRING | - |
ToBankAccountDigit | Receiver's Bank Account Digit | STRING | - |
CustomerMessage | Message between customers | STRING | - |
Value | Payment value | NUMBER | - |
TransferDate | Operation date | STRING | - |
ReceiptUrl | Receipt's URL | STRING | - |
EndToEndId | Unique external operation identifier | STRING | - |
QRCodeInfos | Object containing PixQrCode data, if applicable | OBJECT | If the receiving PIX is a common PIX In, this object will be null |
DocumentNumber | Internal PIX key ID after registration request | STRING | - |
Type | QRcode Type | STRING | E.g.: "StaticQRCode" "DynamicDueDate" |
ConciliationId | Conciliation Id | STRING | For static or immediate QRcodes, the ConciliationId generated by FitBank is returned; for QRcodes with due, the TxId informed by the customer when generating the QRcode is returned. |
Identifier | Operation identifier | STRING | For static or immediate QRcodes, the Idenfier generated by the client when generating the QRcode is returned; for QRcodes with an due date, the identifier generated by FitBank is returned. |
Payer | Payer's infos | OBJECT | - |
Name | Payer's name | STRING | - |
TaxNumber | Payer's taxNumber | STRING | - |
Value | Value | OBJECT | - |
PrincipalValue | QRCode value | FLOAT | - |
DiscountValue | Discount value | FLOAT | Only for qrcode with due date |
RebateValue | Rebate value | FLOAT | Only for qrcode with due date |
FineValue | Fine value | FLOAT | Only for qrcode with due date |
InterestValue | Interest value | FLOAT | Only for qrcode with due date |
InitiatonType | Transaction initialization type | STRING | Manual = 0 PixKey = 1 StaticQRCode = 2 DynamicQRCode = 3 |
Tags | List of Tags | ARRAY OF STRINGS | E.g.: ‘Transfer’, ‘Teste API’ |
FromSPB | Code of the origin banking institution in Banco Central | STRING | - |
ToSPB | Code of the destination banking institution in Banco Central | STRING | - |
ReceiverPixKey | Key used to receive Pix | STRING | It will be returned if the Paying Bank sends the key |
PartnerId | Partner ID provided by FitBank | INT | - |
DocumentNumber | FitBank's internal operation ID | STRING | - |
EntryId | Internal identifier used to distinguish and track the operation within FitBank | NUMBER | FitBank internal data, can be disregarded |
Status | Operation status | STRING | - |
Method | Message pointing to the action performed in the operation | STRING | - |
BusinessUnitId | Business unit ID provided by FitBank | INT | - |
PIX In status sent in the webhooks:
- Registered: Transaction Received;
- Paid: Settled transaction.
Updated 16 days ago