Gift Cards Cobrar com Gift Card

Consultar Gift Cards

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

Executando uma cobrança

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

ATENÇÃO

Para fazer executar cobrança certique-se de ter o AUTORIZATION TOKEN para usar esse endpoint.

Cobrar o Gift Card

Exemplo abaixo tem a finalidade de executar uma cobraça de GiftCard sem split.

POST /v2/giftcards/

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

Parâmetros de requisição

HEADER

~~Authorization~~ Bearer obrigatório

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

BODY

~~Token~~ string obrigatório

Token do Gift Card gerado na consulta do GiftCard.

~~cvv~~ int obrigatório

Código de segurança 3 digitos único do GiftCard gerado na compra do cliente.

~~reference_id~~ int obrigatório

ID de referência do seu sistema.

PD9waHAKJEFjY2Vzc1Rva2VuID0gJ3tBQ0NFU1NfVE9LRU59JzsKJGhlYWRlcnMgPSBhcnJheSgKCSdBdXRob3JpemF0aW9uOiBCZWFyZXIgJy4kQWNjZXNzVG9rZW4sCgknQ29udGVudC1UeXBlOiBhcHBsaWNhdGlvbi9qc29uJywKKTsKCiRkYXRhID0gKHNtbUFycmF5UEhQKTsKCiRjaCA9IGN1cmxfaW5pdCgpOwpjdXJsX3NldG9wdCgkY2gsIENVUkxPUFRfVVJMLCAne0FQSV9VUkx9L3YyL2dpZnRjYXJkcycpOwpjdXJsX3NldG9wdCgkY2gsIENVUkxPUFRfSFRUUEhFQURFUiwgJGhlYWRlcnMpOwpjdXJsX3NldG9wdCgkY2gsIENVUkxPUFRfUkVUVVJOVFJBTlNGRVIsIFRSVUUpOwpjdXJsX3NldG9wdCgkY2gsIENVUkxPUFRfQ1VTVE9NUkVRVUVTVCAsICdQT1NUJyk7CmN1cmxfc2V0b3B0KCRjaCwgQ1VSTE9QVF9QT1NUICwgdHJ1ZSk7CmN1cmxfc2V0b3B0KCRjaCwgQ1VSTE9QVF9QT1NURklFTERTICwgJGRhdGEpOwpjdXJsX3NldG9wdCgkY2gsIENVUkxPUFRfU1NMX1ZFUklGWVBFRVIsIEZBTFNFKTsKJHJlc3BvbnNlID0gY3VybF9leGVjKCRjaCk7CQpjdXJsX2Nsb3NlKCRjaCk7CgplY2hvICRyZXNwb25zZTsKPz4=

Cobrar o Gift Card com Split

Exemplo abaixo tem a finalidade de executar uma cobraça de GiftCard com split.

POST /v2/giftcards/

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

Parâmetros de requisição

HEADER

~~Authorization~~ Bearer obrigatório

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

BODY

~~token~~ string obrigatório

Token do Gift Card gerado na consulta do GiftCard.

~~cvv~~ int obrigatório

Código de segurança 3 digitos único do GiftCard gerado na compra do cliente.

~~reference_id~~ int obrigatório

ID de referência do seu sistema.

~~split~~ object

Para redirecionar parte da transação para outra conta de forma automática e instantânea você precisa adicionar o objeto split junto ao "payload" ao executar a cobrança do Gift Card.

~~username~~ string obrigatório

Usuário que irá receber porcentagem referente a transação.

~~percentage~~ int obrigatório

Porcentagem que o usuário acima receberá (max: 50).

PD9waHAKJEFjY2Vzc1Rva2VuID0gJ3tBQ0NFU1NfVE9LRU59JzsKJGhlYWRlcnMgPSBhcnJheSgKCSdBdXRob3JpemF0aW9uOiBCZWFyZXIgJy4kQWNjZXNzVG9rZW4sCgknQ29udGVudC1UeXBlOiBhcHBsaWNhdGlvbi9qc29uJywKKTsKCiRkYXRhID0gKHNtbUFycmF5UEhQKTsKCiRjaCA9IGN1cmxfaW5pdCgpOwpjdXJsX3NldG9wdCgkY2gsIENVUkxPUFRfVVJMLCAne0FQSV9VUkx9L3YyL2dpZnRjYXJkcycpOwpjdXJsX3NldG9wdCgkY2gsIENVUkxPUFRfSFRUUEhFQURFUiwgJGhlYWRlcnMpOwpjdXJsX3NldG9wdCgkY2gsIENVUkxPUFRfUkVUVVJOVFJBTlNGRVIsIFRSVUUpOwpjdXJsX3NldG9wdCgkY2gsIENVUkxPUFRfQ1VTVE9NUkVRVUVTVCAsICdQT1NUJyk7CmN1cmxfc2V0b3B0KCRjaCwgQ1VSTE9QVF9QT1NUICwgdHJ1ZSk7CmN1cmxfc2V0b3B0KCRjaCwgQ1VSTE9QVF9QT1NURklFTERTICwgJGRhdGEpOwpjdXJsX3NldG9wdCgkY2gsIENVUkxPUFRfU1NMX1ZFUklGWVBFRVIsIEZBTFNFKTsKJHJlc3BvbnNlID0gY3VybF9leGVjKCRjaCk7CQpjdXJsX2Nsb3NlKCRjaCk7CgplY2hvICRyZXNwb25zZTsKPz4=

Respostas possíveis

201 422 400 403

/* Esse exemplo de resposta ocorre quando a cobrança do Gift Card foi executada com sucesso! */
{
  "access": "granted",
  "giftcards": {
    "id": "APP-0000000000000000",
    "intent": "sale",
    "state": "approved",
    "amount": "22.00",
    "received_amount": "20.90",
    "payment_method": "gift-card",
    "aproved_time": "2025-04-17 02:00:43",
    "create_time": "2025-04-17 02:00:40",
    "payer_email": "[email protected]",
    "payer_name": "Jhon Doe",
    "reference_id": "1448"
  }
}

/* Esse exemplo de resposta ocorre quando você informou o campo BODY com parâmetros incorretos*/
{
  "access": "unprocessable-entity",
  "giftcards": {
    "error": "Json incorreto ou faltando parâmetros",
    "error_code": 45,
    "error_status": 422
  }
}

/* Esse exemplo de resposta ocorre quando o token do GiftCard expirou! */
{
  "access": "bad-request",
  "giftcards": {
    "error": "Token do GiftCard expirado!",
    "error_code": 49,
    "error_status": 400
  }
}

/* Esse exemplo de resposta ocorre quando o Gift Card não está mais disponível! */
{
  "access": "forbidden",
  "giftcards": {
    "error": "Token do GiftCard expirado!",
    "error_code": 49,
    "error_status": 400
  }
}

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 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
reference_id ID de referência que foi passado na execução da cobrança. string

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