3 - Payment
Payments
There are several ways to make a Pix payment to transfer money quickly and seamlessly.
When requesting a payment (PixOut) the client application receives the user’s request and sends it to our API. FitBank communicates with the Central Bank (BC) and contacts the receiving institution, where the recipients account will be credited with the payment.
Pix Flow
PIX payments flow.
Payment Method's Flow
Illustration of the transaction flow for payments.
Pix Key information request
API Method = GetInfosPixKey
This method consults and validates the PIX key for the specific payment that is to be made and returns the associated bank information of the recipient. It can consult any PIX key registered in any bank instituition.
The TaxNumber used in the request can be of anyone consulting the key, as long as the user performing the search has a FitBank account.
{
"Method": "GetInfosPixKey",
"PartnerId": 20446,
"BusinessUnitId": 40883,
"PixKey": "[email protected]",
"TaxNumber": "20696707000191"
}
{
"Success": "true",
"Message": "ISI0001 - Método executado com sucesso",
"SearchProtocol": 20025734,
"Infos": {
"ReceiverBankName": "NU PAGAMENTOS - IP",
"ReceiverName": "Joao Victor Moreira Felix",
"TrandingName": null,
"ReceiverISPB": "18236120",
"ReceiverBank": "260",
"ReceiverBankBranch": null,
"ReceiverBankAccount": null,
"ReceiverBankAccountDigit": null,
"ReceiverAccountType": null,
"PixKeyType": "0",
"PixKeyValue": "[email protected]",
"ReceiverTaxNumber": "***.062.083-**"
}
}
Description:
| Parameter | Description | Mandatory | Type | Comments |
|---|---|---|---|---|
| Method | Method to be used | YES | STRING | - |
| PartnerId | Information provided by FitBank | YES | INT | - |
| BusinessUnitId | Information provided by FitBank | YES | INT | - |
| PixKey | Pix Key to be queried | YES | STRING | - |
| TaxNumber | CPF/CNPJ of who has a FitBank account and is consulting the informations | YES | STRING | - |
Valid ways to enter a Pix key in the GetInfosPixKey API method
CPF (11 numeric characters, no letters or special characters)
| Valid | Invalid |
|---|---|
| 12345678901 | 123.456.789-01 |
| 123AS678901 | |
| 123AS678901 |
CNPJ (14 numeric characters, no letters or special characters)
| Valid | Invalid |
|---|---|
| 98740555000174 | 98.740.555/0001-74 |
| 9874#0555000174 | |
| 9874PJ0555000174 |
PhoneNumber (+ sign and 14 numeric characters, no letters and/or special characters)
| Valid | Invalid |
|---|---|
| +5585900000000 | +558500000000 |
| +55(85)00000000 | |
| +55(85)900000000 | |
| +55(85)90000-0000 | |
| +85900000000 | |
| +8500000000 | |
| +5585AA0000000 | |
| -55(85)900000000 | |
| -5585900000000 | |
| -5585AA0000000 | |
| +5585#00000000 | |
| 5585900000000 | |
| 85900000000 |
RandomKeyCode
| Valid | Invalid |
|---|---|
| 123e4567-e89b-12d3-a456-426655440000 | 123e4567e89b12d3a456426655440000 |
| 123@4567-e89b-12d3-a456-426655440000 | |
| 123e4567-g89b-12d3-a456-426655440000 | |
| 123e4567-e89b-12z3-a456-426655440000 | |
| 123e4567-e89b-12d3-a456-42665k44000 |
According to the DICT (Directory of Transactional Account Identifiers), the supported PIX key formats are as follows:
| Type | Regular Expression | Example | Comments |
|---|---|---|---|
| CPF | ^[0-9]{11}$ | 12345678901 | |
| CNPJ | ^[0-9]{14}$ | 12345678901234 | |
| PHONE | ^+[1-9][0-9]\d{1,14}$ | +5510998765432 | |
| W3C HTML5 Valid e-mails | [email protected] | E-mail should have 77 characters at most and must be in lowercase | |
| EVP (Random Key) | [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12} | 123e4567-e89b-12d3-a456-426655440000 | Payment Virtual Address (Random Key) is a kind of key generated by DICT |
Pix Hash (QrCode copy and paste “Copia e Cola”) information retrieval
API Method = GetInfosPixHashCode
This method validates the PIX QrCode copy and paste “Copia e Cola” hash code for the specific payment that is to be made and returns the associated bank information of the recipient.
Important: The hash code is generated in base64 format, but to be queried in this API method, it must be decoded.
{
"Method": "GetInfosPixHashCode",
"PartnerId": 579,
"BusinessUnitId": 607,
"Hash": "00020101021226880014br.gov.bcb.pix2566qrcode-h.fitbank.com.br/QR/cob/868539F7748604AD6CB3B063997C874024A5204000053039865802BR5914Fagner Freitas6009Fortaleza61086054037462070503***6304629A",
"TaxNumber": "41801125317"
}
{
"Success": "true",
"Message": "ISI0001 - Método executado com sucesso",
"SearchProtocol": 188849,
"Infos": {
"Hash": "00020101021226880014br.gov.bcb.pix2566qrcode-h.fitbank.com.br/QR/cob/868539F7748604AD6CB3B063997C874024A5204000053039865802BR5914Fagner Freitas6009Fortaleza61086054037462070503***6304629A",
"ReceiverBankName": "FITBANK IP",
"ReceiverBank": "450",
"ReceiverISPB": "13203354",
"ReceiverBankBranch": "0001",
"ReceiverBankAccount": "21080593",
"ReceiverBankAccountDigit": "5",
"ReceiverAccountType": "0",
"Type": "1",
"Status": "0",
"PixKeyValue": "6a903677-b7e4-46bf-acdf-cc15bf42bc92",
"ExternalIdentifier": null,
"ReceiverName": "Fagner Freitas",
"ReceiverTaxNumber": "41801125317",
"Description": null,
"PayerName": "Pagador",
"PayerTaxNumber": null,
"ZipCode": "60540374",
"City": "Fortaleza",
"OriginalValue": "1",
"ExpirationDate": "2024-08-28T12:16:39.748",
"OriginalCreationDate": "2024-08-09T15:37:25.748",
"Url": "qrcode-h.fitbank.com.br/QR/cob/868539F7748604AD6CB3B063997C874024A",
"Reusable": "false",
"UF": null,
"RebateValue": null,
"DiscountValue": null,
"InterestValue": null,
"FinalValue": null,
"FineValue": null,
"DueDate": null,
"DaysAfterDueDate": null,
"PaymentDate": null,
"CategoryCode": null,
"AdditionalData": "null",
"PayerRequest": "Testando",
"ExpirationQrCode": "1629554",
"ReceiverTradingName": null,
"ReceiverPublicPlace": null,
"IspbPss": null,
"ChangeType": "0",
"WithdrawTransactionValue": null,
"TransactionChangeType": null,
"WithdrawIspbPss": null,
"WithdrawAgentModality": null,
"PurchaseWithChangeValue": null,
"PurchaseWithChangeTransactionChangeType": null,
"PurchaseWithChangeIspbPss": null,
"PurchaseWithChangeAgentModality": null
}
}
Description:
| Parameter | Description | Mandatory | Type |
|---|---|---|---|
| Method | Method to be used | YES | STRING |
| PartnerId | Information provided by FitBank | YES | INT |
| BusinessUnitId | Information provided by FitBank | YES | INT |
| TaxNumber | CPF/CNPJ of who has the PIX key and FitBank account and is consulting the information | YES | STRING |
| Hash | QRCode image or copy and paste hash codes | YES | STRING |
Updated 12 days ago