Rotina responsável por efetuar a consulta de um Pix cobrança com vencimento através de uma Query.
GET
Sandbox:
https://pix.tecnospeed.com.br/sandbox/pix/charge/query
Produção:
https://pix.tecnospeed.com.br/api/v1/pix/charge/query
Headers
| Nome | Descrição | Exemplo |
| Content-Type | Indica o tipo de arquivo | application/json |
| Authorization | Bearer | eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9eyJ1c2VyIjp7ImVtYWlsIjoicGVkc... |
QUERYPARAMETERS
| queryType |
string
Enum:"CREATE""PAYMENT"
Example:queryType=CREATE
Tipo da consulta. Define o campo que será consultado, data de criação ou data de pagamento. Por padrão será utilizado o "CREATE" |
| date |
date
Example:date=2021-08-25
Data para consulta. Caso seja preenchido não informar os paramêtros "betweenDateStart" e "betweenDateEnd" |
| betweenDateStart |
date
Example:betweenDateStart=2021-08-01
Data inicial para consulta. Caso seja preenchido o paramêtro "betweenDateEnd" é obrigatório e não informar o paramêtro "date" |
| betweenDateEnd |
date
Example:betweenDateEnd=2021-08-31
Data final para consulta. Caso seja preenchido o paramêtro "betweenDateStart" é obrigatório e não informar o paramêtro "date" |
| status |
string
Enum:"SAVED""ACTIVE""LIQUIDATED""REJECTED""USER_REMOVED""PSP_REMOVED""EXPIRED"
Example:status=ACTIVE
Status a ser consultado. Por padrão será consultado como "ACTIVE", caso o parametro "queryType" seja "PAYMENT" será desconsiderado. |
| dueDate |
date
Example:dueDate=2021-08-25
Data de vencimento do PIX |
| payerCpfCnpj |
string
Example:payerCpfCnpj=01001001000113
CPF ou CNPJ do pagador. |
| emv |
string
Example:emv=00000000000000000000br.gov.bcb.pix000qrcodes.banco.com.br/v1/AAAA000000000BR
EMV do PIX |
| limit |
number
Example:limit=10
Número máximo de registros por página |
| page |
number
Example:page=2
Pagina que será exibida |
| sort |
string
Enum:"ASC""DESC"
Example:sort=DESC
Tipo de ordenação dos registros por data de criação, podendo ser crescente (ASC) ou decrescente (DESC) |
Responses
RESPONSE SCHEMA:application/json
| id |
string
|
| surrogateKey
required
|
string
|
| status
required
|
string
|
| amount
required
|
number
|
| dueDate |
date
|
| paymentDate |
date
|
| payerCpfCnpj
required
|
string
|
| payerName |
string
|
| emv |
string
|
| createdAt
required
|
date
|
RESPONSE SCHEMA:application/json
| code
required
|
number
Código HTTP |
| errors
required
|
Array ofobjects(SubErrorsFormat)
Lista dos erros de validação |
Json de erro:
{
"code": 422,
"errors": [
{
"type": "business_logic",
"property": "dueDate",
"message": "email should not be empty"
}
]
}
Comentários
0 comentário
Por favor, entre para comentar.