Receipt
In this section, we provide operations that allow monitoring of receipts in the client's account.
Receipt - Check by parameters
This functionality allows retrieving receipts in the specified period, being able to inform the TxId of the transaction for a specific check.
We request the fields:
| Field | Description | Format | Mandatory |
|---|---|---|---|
| Inicio | Start of desired search period | date-time | Yes |
| Fim | End of desired search period | date-time | Yes |
| TxId | Collection transaction identifier | string | No |
Response:
| Field | Description | Format | Nullablle |
|---|---|---|---|
| endToEndId | Pix transaction identifier | string | Yes |
| recebimentoId | Receipt identifier | integer | No |
| txId | Collection transaction identifier | string | Yes |
| data | Receipt date | string | No |
| valor | Pix transaction amount | number | No |
| status | Receipt status, which can be: Completed, Rejected, Validated and Confirmed | string | No |
| pagador | Pix payer data (bank, branch, account, document) | object | Yes |
| recebedor | Pix receiver data (bank, branch, account, document) | object | Yes |
| chaveDict | Receiver's DICT key | string | Yes |
| campoLivre | Message informed by the payer to the receiver, if desired | string | Yes |
| situacao | Pix transaction status, which can be: ACCC (transaction completed), ACSP (transitory receipt status) and RJCT (transaction rejected) | string | No |
| devolucoes | Return information, if there was any associated with receipt | Array | Yes |
Recebimento - Consultar por parâmetros
Receipt - Check by EndToEndId
This functionality allows retrieving a receipt using EndToEndId, which is the unique identifier of a Pix transaction.
We request the fields:
| Field | Description | Format | Mandatory |
|---|---|---|---|
| endToEndId | Pix transaction identifier | string | Yes |
| Inicio | Start of desired search period | date-time | No |
| Fim | End of desired search period | date-time | No |
| TxId | Collection transaction identifier | string | No |
Response:
| Field | Description | Format | Nullablle |
|---|---|---|---|
| endToEndId | Pix transaction identifier | string | Yes |
| recebimentoId | Receipt identifier | integer | No |
| txId | Collection transaction identifier | string | Yes |
| data | Receipt date | string | No |
| valor | Pix transaction amount | number | No |
| status | Receipt status, which can be: Completed, Rejected, Validated and Confirmed | string | No |
| pagador | Pix payer data (bank, branch, account, document) | object | Yes |
| recebedor | Pix receiver data (bank, branch, account, document) | object | Yes |
| chaveDict | Receiver's DICT key | string | Yes |
| campoLivre | Message intended for the receiver | string | Yes |
| situacao | Pix transaction status, which can be: ACCC (transaction completed), ACSP (transitory receipt status) and RJCT (transaction rejected) | string | No |
| devolucoes | Return information, if there was any associated with receipt | Array | Yes |
Recebimento - Consultar por EndToEndId
Receipt - Check by Receipt Id - RecebimentoId
This functionality allows retrieving a receipt by the receipt identifier.
We request the field:
| Field | Description | Format | Mandatory |
|---|---|---|---|
| recebimentoId | Receipt identifier | integer | Yes |
Response:
| Field | Description | Format | Nullablle |
|---|---|---|---|
| endToEndId | Pix transaction identifier | string | Yes |
| recebimentoId | Receipt identifier | integer | No |
| txId | Collection transaction identifier | string | Yes |
| data | Receipt date | string | No |
| valor | Pix transaction amount | number | No |
| status | Receipt status, which can be: Completed, Rejected, Validated and Confirmed | string | No |
| pagador | Pix payer data (bank, branch, account, document | object | Yes |
| recebedor | Pix receiver data (bank, branch, account, document) | object | Yes |
| chaveDict | Receiver's DICT key | string | Yes |
| campoLivre | Message intended for the receiver | string | Yes |
| situacao | Pix transaction status, which can be: ACCC (transaction completed), ACSP (transitory receipt status) and RJCT (transaction rejected) | string | No |
| devolucoes | Return information, if there was any associated with receipt | Array | Yes |
Recebimento - Consultar por RecebimentoId
Receipt - Check by QRCodeId
This functionality allows retrieving a receipt using the QR CODE identifier.
We request the fields:
| Field | Description | Format | Mandatory |
|---|---|---|---|
| qrCodeId | QR CODE identifier | integer | Yes |
Response:
| Field | Description | Format | Nullablle |
|---|---|---|---|
| id | Receipt identifier | integer | No |
| identificadorTransacao | Collection transaction identifier | string | Yes |
| data | Receipt date | date-time | No |
| valor | Pix transaction amount | number | No |
| status | Receipt status, which can be: Completed, Rejected, Validated and Confirmed | string | No |
| pagadorConta | Pix payer's bank details | object | Yes |
| pagadorDocumento | Pix payer data (document, name, business name) | object | Yes |
| recebedorConta | Bank details of the Pix receiver | object | Yes |
| recebedorDocumento | Pix receiver data (document, name, business name) | object | Yes |
| chaveDict | Receiver's DICT key | string | Yes |
| msgId | Message informed in the QR CODE for the payer | object | Yes |
| endToEndId | Pix transaction identifier | string | Yes |
| campoLivre | Message intended for the receiver | object | Yes |
| msgId2 | Message informed in the QR CODE for the payer | object | Yes |
| originalId | Original identifier | string | Yes |
| endToEndId2 | Pix transaction identifier | object | Yes |
| situacao | PIX transaction status, which can be: ACCC (transaction completed), ACSP (transitory receipt status) and RJCT (transaction rejected) | string | No |
| devolucoes | Return information, if there was any associated with receipt | Array | Yes |
Updated 6 months ago