Gift Cards cobrados

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

Consultar cobranças executadas sem split

Exemplo abaixo tem a finalidade de listar as suas cobranças de GiftCard sem split.
GET /v2/giftcards/cob
Requer autorização para o escopo: giftcard.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
PD9waHAKCiRBY2Nlc3NUb2tlbiA9ICd7QUNDRVNTX1RPS0VOfSc7CiRoZWFkZXJzID0gYXJyYXkoCgknQXV0aG9yaXphdGlvbjogQmVhcmVyICcuJEFjY2Vzc1Rva2VuLAoJJ0NvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbicsCik7CiRjaCA9IGN1cmxfaW5pdCgpOwpjdXJsX3NldG9wdCgkY2gsIENVUkxPUFRfVVJMLCAne0FQSV9VUkx9L3YyL2dpZnRjYXJkcy9jb2InKTsKY3VybF9zZXRvcHQoJGNoLCBDVVJMT1BUX0hUVFBIRUFERVIsICRoZWFkZXJzKTsKY3VybF9zZXRvcHQoJGNoLCBDVVJMT1BUX1JFVFVSTlRSQU5TRkVSLCBUUlVFKTsKY3VybF9zZXRvcHQoJGNoLCBDVVJMT1BUX0NVU1RPTVJFUVVFU1QgLCAnR0VUJyk7CmN1cmxfc2V0b3B0KCRjaCwgQ1VSTE9QVF9TU0xfVkVSSUZZUEVFUiwgRkFMU0UpOwokcmVzcG9uc2UgPSBjdXJsX2V4ZWMoJGNoKTsJCmN1cmxfY2xvc2UoJGNoKTsKCmVjaG8gJHJlc3BvbnNlOwo/Pg==

Consultar cobranças executadas com split

Exemplo abaixo tem a finalidade de listar as suas cobranças de GiftCard com split.
GET /v2/giftcards/split
Requer autorização para o escopo: giftcard.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 opcional
Valor aceito: 2025-04-16 no formate date
pagina int
Valor aceito: número inteiro
PD9waHAKCiRBY2Nlc3NUb2tlbiA9ICd7QUNDRVNTX1RPS0VOfSc7CiRoZWFkZXJzID0gYXJyYXkoCgknQXV0aG9yaXphdGlvbjogQmVhcmVyICcuJEFjY2Vzc1Rva2VuLAoJJ0NvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbicsCik7CiRjaCA9IGN1cmxfaW5pdCgpOwpjdXJsX3NldG9wdCgkY2gsIENVUkxPUFRfVVJMLCAne0FQSV9VUkx9L3YyL2dpZnRjYXJkcy9zcGxpdCcpOwpjdXJsX3NldG9wdCgkY2gsIENVUkxPUFRfSFRUUEhFQURFUiwgJGhlYWRlcnMpOwpjdXJsX3NldG9wdCgkY2gsIENVUkxPUFRfUkVUVVJOVFJBTlNGRVIsIFRSVUUpOwpjdXJsX3NldG9wdCgkY2gsIENVUkxPUFRfQ1VTVE9NUkVRVUVTVCAsICdHRVQnKTsKY3VybF9zZXRvcHQoJGNoLCBDVVJMT1BUX1NTTF9WRVJJRllQRUVSLCBGQUxTRSk7CiRyZXNwb25zZSA9IGN1cmxfZXhlYygkY2gpOwkKY3VybF9jbG9zZSgkY2gpOwoKZWNobyAkcmVzcG9uc2U7Cj8+

Respostas possíveis

/* Esse exemplo de resposta ocorre quando voce recebe 1 ou mais resultados no objeto [cob] ou [split]! */
{
  "access": "granted",
  "giftcards": {
    "parameters": {
      "date": "2025-04-18",
      "pagination": {
        "pagina_atual": 1,
        "itens_por_pagina": 25,
        "quantidade_de_paginas": 1,
        "quantidade_total_de_itens": "1"
      }
    },
    "cob": [
      {
        "id": "APP-9357187000339814",
        "intent": "sale",
        "state": "already-approved",
        "amount": "22.00",
        "received_amount": "20.90",
        "payment_method": "gift-card",
        "aproved_time": "2025-04-18 15:05:32",
        "create_time": "2025-04-17 21:57:32",
        "payer_email": "[email protected]",
        "payer_name": "Jhon Doe",
        "reference_id": "309"
      }
    ]
  }
}
A tabela abaixo descreve os atributos presentes no JSON retornado.
access
Retorna granted informado sobre o sucesso da solicitação.
giftcards Sem resultados retorna um objeto vazio.
  1. parameters  Sem resultados retorna um objeto vazio.
  2. date  Data atual do filtro, quando selecionada.  date
  3. start  Data de início do filtro, quando selecionada.  date
  4. end  Data de final do filtro, quando selecionada.  date
  5. pagination  Objeto para navegar entres os resultados
  6. pagina_atual  Número da pagina atual.  int
  7. itens_por_pagina  Quantidade total de ítens por página.  int
  8. quantidade_de_paginas  Quantidade total de páginas.  int
  9. quantidade_total_de_itens  Quantidade total de ítens por página.  int
  10. cob  Sem resultados retorna um objeto vazio.
  11. id  ID do pagamento atual.  string
  12. intent  Tipo de intenção.  string
  13. state  Estado do pagamento.  string
  14. amount  Valor atual do pagamento.  float
  15. received_amount  Valor disponibilizado em carteira.  float
  16. payment_method  Método do pagamento.  string
  17. description  Descrição informada na criação do pagamento.  string
  18. aproved_time  Data e hora que o pagamento foi confirmado.  date_time
  19. create_time  Data e hora que o pagamento foi gerado.  date_time
  20. payer_email  E-mail do pagador.  string
  21. payer_name  Nome do pagador.  string
  22. reference_id  ID de referência que foi passado na execução da cobrança.  string

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

i9 Gitf Card
i9 Gitf Card seu gateway sem limites

Whatsapp +55 51 993710985
Atendimento 9h às 12h - 14h às 20h
© 2025 i9GiftCard - Todos os direitos reservados
Gerar autorização
Basic:

						
Política de Cookies

Os cookies nos permitem entender a forma como você navega pelas nossas páginas e manter o funcionamento delas. Com essas informações, fica mais fácil, rápido e seguro usar sua conta. Ao desativar certos cookies, é possível que você não consiga aproveitar alguns recursos dos nossos sites.

Confira para que eles servem: