API Reference

Retornar Vendas

Consulta de Vendas realizadas.

Log in to see full request history

Retornar Vendas

Retorna as vendas realizadas de um estabelecimento de acordo com algumas informaçõs fornecidas.

É necessário passar o token do estabelecimento no header "Authorization".

Abaixo temos um exemplo de como inserir estes dados usando JSON.

{ "Authorization": "125SEBXXXXXX20150821" }

No Body devemos passar alguns valores para realizar a consulta.

Abaixo temos um exemplo de como inserir estes dados usando JSON.

{ "cpf_cnpj": "12345678900000", "autorizacao":"123456", "numero_cartao": "1234", "data_venda_inicial": "2022-09-30", "data_venda_final": "2023-09-30", "data_pagamento_inicial": "2022-10-02", "data_pagamento_final": "2022-10-04", "pagina": 0 }

A seguir, apresentam-se todos os possíveis status, parâmetro "status_id", que uma venda pode assumir e o detalhamento destes:


Status_IDDescrição
3PREVISTO: Venda processada, mas ainda pendente de confirmação pela adquirente.
4CONFIRMADO: Venda com pagamento confirmado pela adquirente.
6CANCELADO: Venda cancelada após 24 horas da realização.
5LIQUIDADO: Venda que já foi depositada na conta do estabelecimento.
2AGUARDANDO PROCESSAMENTO: Venda em fase de processamento do pagamento, aguardando conclusão.
1EM ANALISE: Venda sob análise do setor financeiro da Fix Pay para verificação adicional.
7ANTECIPACAO: Venda futura com valor antecipado ao estabelecimento.
19ANTECIPACAO TAXA DIRETA: Crédito antecipado de uma venda futura com aplicação de taxa direta.

Com base nessas informações, a API retornará as informações sobre as vendas, incluindo as parcelas correspondentes, em formato JSON.

Body Params
string
required

CPF ou CNPJ do estabelecimento. Ex.: CPF: 12345678900

string
required

Número da autorização da venda.

string
required

Ultimos 4 digitos do número do cartão. Ex.: 4321

string
required

Data inicial das vendas. Ex.: 2020-03-02

string
required

Data final das vendas. Ex.: 2020-06-10

string
required

Data inical do pagamento Ex.: 2020-03-02

string
required

Data final do pagamento. Ex: 2020-06-10

int32
required

Número da página requerida. Pagina inicial: 0

Headers
string
required

Token Api do estabelecimento. Ex.: 125SEBXXXXXX20150821

Responses

Language
Click Try It! to start a request and see the response here! Or choose an example:
application/json