3 - Query
To query the internal transfer, we have two methods: GetInternalTransferById (ID querying method) and GetInternalTransferByDate (date querying method).
GetInternalTransferById – ID querying method
Query by transaction ID, which is returned in the InternalTransfer response.
| PARAMETER | TYPE | MANDATORY | DESCRIPTION |
|---|---|---|---|
| Method | String | YES | Method Identification Name |
| BusinessUnitId | Long | YES | Business Unit ID reported by Fitbank |
| PartnerId | Long | YES | Partner ID reported by Fitbank |
| DocumentNumber | Decimal | YES | Transaction ID, returned in InternalTransfer response |
Requisition:
{ "Method": "GetInternalTransferById",
"PartnerId": 820,
"BusinessUnitId": 1099,
"DocumentNumber": "103854" }
Response
{ "Success": "true", "InternalTransfer": "{\"DocumentNumber\":103858,\"FromName\":\"Marcus Fabi o\",\"FromTaxNumber\":\"65371653341\",\"ToTaxNumber\":\"44699677266\",\"ToName \":\"João Vitor\",\"Status\":0,\"PrincipalValue\":1.00,\"TransferDate\":\"2022 -07- 24T00:00:00\",\"ReceiptUrl\":\"https://sandboxreceipt.fitbank.com.br/receipt/p df?filename=2022-07- 24/n4cvqmb5.pdf\",\"ProtocolId\":\"86485e4931044fad90fabab6313fe612\",\"Creati onDate\":\"2022-07- 24T15:16:47.263\",\"Tags\":[\"Commercial\",\"Financial\",\"Tax\"],\"Descriptio n\":\"Descrição do pagamento\"}" }
Through the returned status, it is possible to know at what point of the process the transfer is. The types of statuses there are below:
0 - The transfer was created
1 - The transfer was settled
2 - The transfer was canceled
3 - ErrorBalance
GetInternalTransferByDate – date querying method
Query by transaction date. It is possible to query a date through InternalTransfer's extract.
| PARAMETER | TYPE | MANDATORY | DESCRIPTION |
|---|---|---|---|
| Method | String | YES | Method Identification Name |
| BusinessUnitId | Long | YES | Business Unit ID reported by Fitbank |
| PartnerId | Long | YES | Partner ID reported by Fitbank |
| TaxNumber | String | YES | CPF/CNPJ that you want to pull the P2P statement from |
| TransferDate | String | YES | Date you want to pull P2P extract |
Requisition:
{ "Method": "GetInternalTransferByDate",
"PartnerId": 820,
"BusinessUnitId": 1099,
"TaxNumber": "55197836830",
"TransferDate": "2022/07/24" }
Response
{ "Success": "true", "InternalTransfer": "[{\"DocumentNumber\":103855,\"FromName\":\"Brenna Nob re\",\"FromTaxNumber\":\"55197836830\",\"ToTaxNumber\":\"48969329277\",\"ToNam e\":\"Aurora Sena\",\"Status\":1,\"PrincipalValue\":20.00,\"TransferDate\":\"2 022-07- 24T14:06:17.17\",\"ReceiptUrl\":null,\"ProtocolId\":\"5e43232e863e48a2817ccac6 4a0c0e8a] }
Updated almost 2 years ago