Receipts/Proof of Payment
We provide operations for consulting and exporting PDF payment receipts.
Checking receipts/proof of payment
This functionality allows checking a proof of payment.
We request the fields:
Field | Description | Format | Mandatory |
---|---|---|---|
dataInicial | Search start date | date-time | Yes |
dataFinal | Search end date | date-time | Yes |
tipoFiltro | Filter type code, see table [Filter type] | integer | Yes |
Resposta:
Field | Description | Format | Nullable |
---|---|---|---|
comprovanteId | Unique Receipt/ Proof of payment identifier | string | No |
empresa | Company data | Object | Yes |
EfetuadoEm | Date the payment was made | date-time | Yes |
EfetuarEm | Date on which payment will be made, in which case payment is scheduled | date-time | Yes |
tipo | Receipt/ Proof of payment type code, see table [Type of Receipt/ Proof of payment] | integer | No |
protocolo | Payment protocol number | string | Yes |
dadosTransferencia | Displays the amount, beneficiary and bank details of the beneficiary | object | Yes |
dadosPagamento | Displays beneficiary, guarantor drawer, payer, assignor, payment issuing bank, sequence of numerical digits, due date and amounts (paid, discount, interest on arrears, deductions, additions, charges, etc.) of the bank slip | object | Yes |
dadosTributo | Displays data of the tax payer, final payer, due date, amounts (paid, interest, etc.) | object | Yes |
dadosPagamentoPix | Displays beneficiary data (name, CPF/CNPJ and bank details), amount, fee amount, key and endToEndId | objetc | Yes |
Generating a PDF receipt
This functionality allows generating proof of payment in PDF format.
We request the fields:
Field | Description | Format | Mandatory |
---|---|---|---|
comprovanteId | Receipt/ Proof of payment identifier | string | Sim |
TipoComprovante | Receipt/ Proof of payment type code, see table [Type of Receipt/ Proof of payment] | integer | Sim |
E como resultado é efetuado o download do PDF.
Filter type
In the table below, we list the types of filters:
Enumeration | Description |
---|---|
1 | Transfer |
2 | Payment |
3 | Transfer Scheduling |
4 | Payment Scheduling |
5 | Made |
6 | Scheduled |
Receipt type
In the following table, the types of receipts/Proof of payment are listed:
Enumeration | Description |
---|---|
1 | Transfer |
2 | Payment |
3 | Tax Payment |
4 | Transfer Scheduling |
5 | Payment Scheduling |
6 | Tax Payment Scheduling |
7 | Pix Payment |
Updated 7 months ago