Gift Cards Consultar Gift Card

Consultar Gift Cards

Nesta página você encontra informações sobre como cobrar um cliente que tenha comprado um GIFT CARD i9GiftPay

Endpoint em dois passos

Para manter o eco sistema seguro a cobrança de Gift Cards é feita em dois passos CONSULTA e COBRANÇA.

ATENÇÃO

Este endpoint tem a mesma finalidade para iniciar uma cobrança e consultar uma cobrança ja executada.

Consultar o Gift Card

O endopint de consulta de cartão tem o propósito de consultar o número do cartão para ver se o número é de um cartão válido e consultar também se está disponível ou não!

GET /v2/giftcards/:id

Requer autorização para o escopo: giftcard.get e giftcard.post

PD9waHAKCiRBY2Nlc3NUb2tlbiA9ICd7QUNDRVNTX1RPS0VOfSc7CiRnaWZ0Q2FyZCA9ICd7SUR9JzsKJGhlYWRlcnMgPSBhcnJheSgKCSdBdXRob3JpemF0aW9uOiBCZWFyZXIgJy4kQWNjZXNzVG9rZW4sCgknQ29udGVudC1UeXBlOiBhcHBsaWNhdGlvbi9qc29uJywKKTsKJGNoID0gY3VybF9pbml0KCk7CmN1cmxfc2V0b3B0KCRjaCwgQ1VSTE9QVF9VUkwsICd7QVBJX1VSTH0vdjIvZ2lmdGNhcmRzLycuJGdpZnRDYXJkKTsKY3VybF9zZXRvcHQoJGNoLCBDVVJMT1BUX0hUVFBIRUFERVIsICRoZWFkZXJzKTsKY3VybF9zZXRvcHQoJGNoLCBDVVJMT1BUX1JFVFVSTlRSQU5TRkVSLCBUUlVFKTsKY3VybF9zZXRvcHQoJGNoLCBDVVJMT1BUX0NVU1RPTVJFUVVFU1QgLCAnR0VUJyk7CmN1cmxfc2V0b3B0KCRjaCwgQ1VSTE9QVF9TU0xfVkVSSUZZUEVFUiwgRkFMU0UpOwokcmVzcG9uc2UgPSBjdXJsX2V4ZWMoJGNoKTsJCmN1cmxfY2xvc2UoJGNoKTsKCmVjaG8gJHJlc3BvbnNlOwo/Pg==

Respostas possíveis

201 200 400 403

/* Esse exemplo de resposta ocorre quando o Gift Card está disponível para executar uma cobrança! */
{
  "access": "granted",
  "giftcards": {
    "id": "APP-0000000000000000",
    "intent": "authorization",
    "authorization": {
      "token": "FbtVmBA766TmgBy1TanCarUasPpw0CzgnyEEnV07VpkDzECWHG7ywlzyZu8MXlxwHjnA",
      "created_time_token": "2025-04-18 22:01:59",
      "expires_time_token": "2025-04-18 22:02:29"
    },
    "card": {
      "state": "active",
      "amount": "22.00",
      "toreceive_amount": "20.90",
      "aproved_date": "2025-04-17 15:06:59",
      "create_date": "2025-04-17 15:02:59",
      "payer_email": "[email protected]",
      "payer_name": "Jhon Doe"
    }
  }
}

/* Esse exemplo de resposta ocorre quando o Gift Card já foi cobrado por sua conta! */
{
  "access": "granted",
  "giftcards": {
    "id": "APP-0343185511498330",
    "intent": "sale",
    "state": "already-approved",
    "amount": "17.39",
    "received_amount": "16.52",
    "payment_method": "gift-card",
    "aproved_time": "2025-04-18 20:52:59",
    "create_time": "2025-04-18 20:53:06",
    "payer_email": "[email protected]",
    "payer_name": "Michel Modolo",
    "reference_id": "739",
    "split": {
      "partner": "Laura Muller",
      "username": "ID-000000000TRNC",
      "percentage": 8,
      "amount": "1.32"
    }
  }
}

/* Esse exemplo de resposta ocorre quando o número do Gift Card foi enviado de forma incorreta! */
{
  "access": "bad-request",
  "giftcards": {
    "error": "Gift Card ID incorreto!",
    "error_code": 41,
    "error_status": 400
  }
}

/* Esse exemplo de resposta ocorre quando o número do Gift Card foi utilizado em outro aplicativo! */
{
  "access": "forbidden",
  "giftcards": {
    "error": "O saldo desse Gift Card já foi utilizado!",
    "error_code": 42,
    "error_status": 403
  }
}

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.

id ID do Gift Card. string
intent Tipo de intenção. string
authorization Dados para executar a compra. objeto

token Token responsável para executar a compra. string

created_time_token Data e hora do criação do token. date_time

expires_time_token Data e hora de expiração do token (padrão 30 segundos). date_time

card Dados do Gift Card. objeto

state Estado do cartão. string

amount Valor do cartão. float

toreceive_amount Valor que você vai receber em carteira. float

aproved_date Data e hora que o pagamento do cartão foi aprovado. date_time

create_date Data e hora da compra do cartão. date_time

payer_email Email do usuário do cartão. string

payer_name Nome do usuário do cartão. string

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