Pagamentos Listar pagamentos

Listar pagamentos

Nesta página você encontra informações sobre como listar os pagamentos que foram cobrados através do seu aplicativo.

Consultar todos os pagamentos com e sem split

Exemplo abaixo tem a finalidade de listar as suas cobranças de pagamentos com e sem split.

GET /v2/payments/cob

Requer autorização para o escopo: payments.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

Valor aceito: 2025-04-16 no formate date

~~pagina~~ int

Valor aceito: número inteiro

PD9waHAKCiRBY2Nlc3NUb2tlbiA9ICd7QUNDRVNTX1RPS0VOfSc7CiRoZWFkZXJzID0gYXJyYXkoCgknQXV0aG9yaXphdGlvbjogQmVhcmVyICcuJEFjY2Vzc1Rva2VuLAoJJ0NvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbicsCik7CiRjaCA9IGN1cmxfaW5pdCgpOwpjdXJsX3NldG9wdCgkY2gsIENVUkxPUFRfVVJMLCAne0FQSV9VUkx9L3YyL3BheW1lbnRzL2NvYicpOwpjdXJsX3NldG9wdCgkY2gsIENVUkxPUFRfSFRUUEhFQURFUiwgJGhlYWRlcnMpOwpjdXJsX3NldG9wdCgkY2gsIENVUkxPUFRfUkVUVVJOVFJBTlNGRVIsIFRSVUUpOwpjdXJsX3NldG9wdCgkY2gsIENVUkxPUFRfQ1VTVE9NUkVRVUVTVCAsICdHRVQnKTsKY3VybF9zZXRvcHQoJGNoLCBDVVJMT1BUX1NTTF9WRVJJRllQRUVSLCBGQUxTRSk7CiRyZXNwb25zZSA9IGN1cmxfZXhlYygkY2gpOwkKY3VybF9jbG9zZSgkY2gpOwoKZWNobyAkcmVzcG9uc2U7Cj8+

Consultar pagamentos cobrados com split

Exemplo abaixo tem a finalidade de listar as suas cobranças de pagamentos com split.

GET /v2/payments/split

Requer autorização para o escopo: payments.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

~~date~~ string

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

~~start~~ date

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

~~end~~ date

Valor aceito: 2025-04-16 no formate date

~~pagina~~ int

Valor aceito: número inteiro

PD9waHAKCiRBY2Nlc3NUb2tlbiA9ICd7QUNDRVNTX1RPS0VOfSc7CiRoZWFkZXJzID0gYXJyYXkoCgknQXV0aG9yaXphdGlvbjogQmVhcmVyICcuJEFjY2Vzc1Rva2VuLAoJJ0NvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbicsCik7CiRjaCA9IGN1cmxfaW5pdCgpOwpjdXJsX3NldG9wdCgkY2gsIENVUkxPUFRfVVJMLCAne0FQSV9VUkx9L3YyL3BheW1lbnRzL3NwbGl0Jyk7CmN1cmxfc2V0b3B0KCRjaCwgQ1VSTE9QVF9IVFRQSEVBREVSLCAkaGVhZGVycyk7CmN1cmxfc2V0b3B0KCRjaCwgQ1VSTE9QVF9SRVRVUk5UUkFOU0ZFUiwgVFJVRSk7CmN1cmxfc2V0b3B0KCRjaCwgQ1VSTE9QVF9DVVNUT01SRVFVRVNUICwgJ0dFVCcpOwpjdXJsX3NldG9wdCgkY2gsIENVUkxPUFRfU1NMX1ZFUklGWVBFRVIsIEZBTFNFKTsKJHJlc3BvbnNlID0gY3VybF9leGVjKCRjaCk7CQpjdXJsX2Nsb3NlKCRjaCk7CgplY2hvICRyZXNwb25zZTsKPz4=

Respostas possíveis

200 200 403

/* Esse exemplo de resposta ocorre quando voce recebe 1 ou mais resultados no objeto [cob] ou [split]! */
{
  "access": "granted",
  "payments": {
    "parameters": {
      "date": "2025-04-18",
      "pagination": {
        "pagina_atual": 1,
        "itens_por_pagina": 25,
        "quantidade_de_paginas": 1,
        "quantidade_total_de_itens": "1"
      }
    },
    "cob": [
      {
        "id": "TRR-00000000000000000000",
        "intent": "sale",
        "state": "approved",
        "amount": "17.39",
        "received_amount": "16.52",
        "payment_method": "pix",
        "description": "compra do usuário",
        "aproved_date": "2025-04-17 15:19:51",
        "create_date": "2025-04-17 15:15:51",
        "expiration_date": '',
        "payer_email": "[email protected]",
        "payer_name": "Jhon Doe",
        "payer_fone": "",
        "payer_document": "",
        "payment_url": "https://payment.i9giftcard.com/payment/TRR-00000000000000000000",
        "callback_return_url": "https://seusite.com/?token=TRR-00000000000000000000",
        "callback_reference_id": "1",
        "callback_custom_id": "1"
      }
    ]
  }
}

/* Esse exemplo de resposta ocorre quando voce não recebe resultos no objeto [cob] ou [split] */
{
  "access": "granted",
  "payments": {
    "parameters": {
      "date": "2025-04-17",
      "pagination": {
        "pagina_atual": 0,
        "itens_por_pagina": 25,
        "quantidade_de_paginas": 0,
        "quantidade_total_de_itens": "0"
      }
    },
    "split": []
  }
}

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

A tabela abaixo descreve os atributos presentes no JSON retornado.

access

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

payments 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

cob 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

payer_document Documento do pagador. string

payment_url Link para o comprador efetuar a venda. string

callback_return_url Endereço que o pagador vai ser redirecionado após o pagamento. string

callback_reference_id ID de referência que foi passado na criação do pagamento. string

callback_custom_id ID do produto que foi passado na criação do pagamento. string

webhook Sem resultados retorna um objeto vazio.

state Sucesso ou falha da cominicação. string

date_sent Data e hora que o disparo foi enviado. date_time

Última atualização em 23 de dez de 2024