Dados da conta Listar de vendas

Suas de vendas

Endpoint com a finalidade de listar todas as suas vendas.

Listar vendas!

O endpoint abaixo exibe todas as vendas na sua conta!

GET /v2/sales

Requer autorização para o escopo: account_sales.read

Parâmetros de requisição

HEADER

~~Authorization~~ Bearer obrigatório

Token de autorização gerado a partir do APP_ID e APP_TOKEN.

QUERY

~~state~~ string

Valores aceitos: pending, approved, canceled

~~date~~ string

Valores aceitos: hoje, ontem, 7dias, 2025-04-15

~~start~~ date

Valor aceito: 2025-04-08 no formate date.

~~end~~ date opcional

Valor aceito: 2025-04-16 no formate date

~~pagina~~ int

Valor aceito: número inteiro

PD9waHAKCiRBY2Nlc3NUb2tlbiA9ICd7QUNDRVNTX1RPS0VOfSc7CiRoZWFkZXJzID0gYXJyYXkoCgknQXV0aG9yaXphdGlvbjogQmVhcmVyICcuJEFjY2Vzc1Rva2VuLAoJJ0NvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbicsCik7CiRjaCA9IGN1cmxfaW5pdCgpOwpjdXJsX3NldG9wdCgkY2gsIENVUkxPUFRfVVJMLCAne0FQSV9VUkx9L3YyL3NhbGVzJyk7CmN1cmxfc2V0b3B0KCRjaCwgQ1VSTE9QVF9IVFRQSEVBREVSLCAkaGVhZGVycyk7CmN1cmxfc2V0b3B0KCRjaCwgQ1VSTE9QVF9SRVRVUk5UUkFOU0ZFUiwgVFJVRSk7CmN1cmxfc2V0b3B0KCRjaCwgQ1VSTE9QVF9DVVNUT01SRVFVRVNUICwgJ0dFVCcpOwpjdXJsX3NldG9wdCgkY2gsIENVUkxPUFRfU1NMX1ZFUklGWVBFRVIsIEZBTFNFKTsKJHJlc3BvbnNlID0gY3VybF9leGVjKCRjaCk7CQpjdXJsX2Nsb3NlKCRjaCk7CgplY2hvICRyZXNwb25zZTsKPz4=

Respostas possíveis

200 403

/* Esse exemplo de resposta de sucesso! */
{
  "access": "granted",
  "sales": {
    "parameters": {
      "date": "2024-12-27",
      "pagination": {
        "pagina_atual": 1,
        "itens_por_pagina": 25,
        "quantidade_de_paginas": 12,
        "quantidade_total_de_itens": "283"
      }
    },
    "vendas": [
      {
        "id": "SEO-000000000000000000000",
        "intent": "sale",
        "state": "approved",
        "amount": "17.39",
        "received_amount": "16.52",
        "payment_method": "pix",
        "description": "compra [18]",
        "aproved_date": "2025-04-18 15:08:32",
        "create_date": "2025-04-18 15:05:32",
        "expiration_date": "",
        "payer_email": "[email protected]",
        "payer_name": "Jhon Doe",
        "payer_fone": "",
        "payer_document": "",
        "split": {
          "partner": "Laura Muller",
          "username": "ID-000000000TRNC",
          "percentage": 10,
          "amount": "0.47"
        }
      },
      {
        "id": "APP-00000000000000000",
        "intent": "sale",
        "state": "already-approved",
        "amount": "22.00",
        "received_amount": "20.90",
        "payment_method": "gift-card",
        "aproved_time": 2025-04-18 17:31:32,
        "create_time": "2025-04-18 18:29:32",
        "payer_email": "[email protected]",
        "payer_name": "Jhon Doe",
        "reference_id": "739"
      }
    ]
  }
}

/* Esse exemplo de resposta ocorre quando o aplictivo não tem permissão no escopo para usar esse endpoint */
{
  "access": "unauthorized",
  "sales": {
    "error": "App sem permissão para usar este endpoint",
    "error_code": 36,
    "error_status": 403
  }
}

A tabela abaixo descreve os atributos presentes no JSON retornado.

access

Retorna granted informado sobre o sucesso da solicitação.

sales Sem resultados retorna um objeto vazio.

parameters Sem resultados retorna um objeto vazio.

state Estado dos pagamentos filtrados. string

date Data atual do filtro, quando selecionada. date

start Data de início do filtro, quando selecionada. date

end Data de final do filtro, quando selecionada. date

pagination Objeto para navegar entres os resultados

pagina_atual Número da pagina atual. int

itens_por_pagina Quantidade total de ítens por página. int

quantidade_de_paginas Quantidade total de páginas. int

quantidade_total_de_itens Quantidade total de ítens por página. int

vendas Sem resultados retorna um objeto vazio.

id ID do pagamento atual. string

intent Tipo de intenção. string

state Estado do pagamento. string

amount Valor atual do pagamento. float

received_amount Valor disponibilizado em carteira. float

payment_method Método do pagamento. string

description Descrição informada na criação do pagamento. string

aproved_time Data e hora que o pagamento foi confirmado. date_time

create_time Data e hora que o pagamento foi gerado. date_time

payer_email E-mail do pagador. string

payer_name Nome do pagador. string

payer_fone Telefone do pagador. string

split Sem resultados esse objeto não vem na resposta.

partner Nome do usuário que recebeu o split. string

username Username do usuário que recebeu o split. string

percentage Porcentagem que o usuário recebeu. int

amount Valor que o usuário recebeu. float

Última atualização em 27 de dez. de 2024