Pagamentos Consultar pagamento

Consultar um pagamento

Endpoint para cadastrar uma cobrança com um identificador de transação ID.

Buscando um pagamento

Para buscar um pagamento e o seu status envie um GET para a rota /v2/payments/{ID}. Em resposta, você receberá o objeto com as informações do pagamento solicitado.

GET /v2/payments/:id

Requer autorização para o escopo: payments.get

PD9waHAKCiRBY2Nlc3NUb2tlbiA9ICd7QUNDRVNTX1RPS0VOfSc7CiRQYXltZW50SUQgPSAne0lEfSc7CiRoZWFkZXJzID0gYXJyYXkoCgknQXV0aG9yaXphdGlvbjogQmVhcmVyICcuJEFjY2Vzc1Rva2VuLAoJJ0NvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbicsCik7CiRjaCA9IGN1cmxfaW5pdCgpOwpjdXJsX3NldG9wdCgkY2gsIENVUkxPUFRfVVJMLCAne0FQSV9VUkx9L3YyL3BheW1lbnRzLycuJFBheW1lbnRJRCk7CmN1cmxfc2V0b3B0KCRjaCwgQ1VSTE9QVF9IVFRQSEVBREVSLCAkaGVhZGVycyk7CmN1cmxfc2V0b3B0KCRjaCwgQ1VSTE9QVF9SRVRVUk5UUkFOU0ZFUiwgVFJVRSk7CmN1cmxfc2V0b3B0KCRjaCwgQ1VSTE9QVF9DVVNUT01SRVFVRVNUICwgJ0dFVCcpOwpjdXJsX3NldG9wdCgkY2gsIENVUkxPUFRfU1NMX1ZFUklGWVBFRVIsIEZBTFNFKTsKJHJlc3BvbnNlID0gY3VybF9leGVjKCRjaCk7CQpjdXJsX2Nsb3NlKCRjaCk7CgplY2hvICRyZXNwb25zZTsKPz4=

Status do pagamento

O status do pagamento sempre é exibido no campo state informando o status atual do pagamento!

Status	Descrição
pending	Aguardando pagamento.
approved	Pagamento aprovado.
canceled	Pagamento cancelado.
back-out	Voltou para o site antes de pagar.

Respostas possíveis

201 404 403

/* Esse exemplo de resposta ocorre quando o pagamento foi encontrado com sucesso! */
{
  "access": "granted",
  "payments": {
    "id": "TRR-00000000000000000000",
    "intent": "sale",
    "state": "approved",
    "amount": "17.39",
    "received_amount": "16.52",
    "payment_method": "pix",
    "description": "compra do usuário",
    "aproved_time": "2025-04-17 15:20:58",
    "create_time": "2025-04-17 15:16:58",
    "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",
    "webhook": {
      "state": "success",
      "date": "2025-04-17 15:21:00"
    }
  }
}

/* Esse exemplo de resposta ocorre quando o número do Gift Card foi enviado de forma incorreta! */
{
  "access": "not-found",
  "payments": {
    "error": "Payment ID não encontrado",
    "error_code": 62,
    "error_status": 404
  }
}

/* Esse exemplo de resposta ocorre quando o número do Gift Card foi utilizado em outro aplicativo! */
{
  "access": "unauthorized",
  "payments": {
    "error": "Payment ID em formato incorreto",
    "error_code": 63,
    "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.

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
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

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 26 de dez. de 2024