POST api/pix/ConsultarPixPeriodo
Request Information
URI Parameters
None.
Body Parameters
CobRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| provider | string |
None. |
|
| calendario | CalendarioBase |
None. |
|
| devedor | Devedor |
None. |
|
| parametros | Parametros |
None. |
|
| txId | string |
None. |
|
| DataInicio | string |
None. |
|
| DataFim | string |
None. |
|
| chave | string |
None. |
|
| solicitacaoPagador | string |
None. |
|
| infoAdicionais | Collection of InfoAdicional |
None. |
|
| valor | Valor |
None. |
|
| merchant | Merchant |
None. |
|
| qrstring | string |
None. |
|
| qrCode | string |
None. |
Request Formats
application/json, text/json, application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
CobConsultaResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| parametros |
None. |
Response Formats
application/json, text/json
Sample:
{
"parametros": {
"inicio": "2026-08-05T11:10:29.7913239-03:00",
"fim": "2026-08-05T11:10:29.7913239-03:00",
"paginacao": {
"paginaAtual": 1,
"itensPorPagina": 2,
"quantidadeDePaginas": 3,
"quantidadeTotalDeItens": 4
}
},
"cobs": null
}
application/xml, text/xml
Sample:
<CobConsultaResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Negocio.Responses">
<Cobs xmlns:d2p1="http://schemas.datacontract.org/2004/07/Negocio.Models" i:nil="true" />
<Parametros xmlns:d2p1="http://schemas.datacontract.org/2004/07/Negocio.Responses.Base">
<d2p1:Fim>2026-08-05T11:10:29.7913239-03:00</d2p1:Fim>
<d2p1:Inicio>2026-08-05T11:10:29.7913239-03:00</d2p1:Inicio>
<d2p1:Paginacao>
<d2p1:ItensPorPagina>2</d2p1:ItensPorPagina>
<d2p1:PaginaAtual>1</d2p1:PaginaAtual>
<d2p1:QuantidadeDePaginas>3</d2p1:QuantidadeDePaginas>
<d2p1:QuantidadeTotalDeItens>4</d2p1:QuantidadeTotalDeItens>
</d2p1:Paginacao>
</Parametros>
</CobConsultaResponse>