Consultar cobranças do link

Consulte as cobranças geradas por um link de pagamento da My Gateway, com filtro por status, atributos de cada cobrança e status de liquidação.

Nesta página

GET/payments/v1/checkout/charges/{payment-link-id}

Retorna as tentativas e cobranças do link, da mais antiga para a mais recente.

Cabeçalhos

Authorizationstringobrigatório
Valor de authenticationToken retornado na autenticação, sem o prefixo Bearer.

x-api-keystringobrigatório
Chave do API Gateway do ambiente.

Parâmetros de caminho

payment-link-idUUIDobrigatório
Identificador retornado em data.id na criação do link. Não pode ser o UUID vazio (00000000-0000-0000-0000-000000000000).

Parâmetros de consulta

statusintegeropcional
Filtra pelo código numérico do status da cobrança. Envie só números. Para trazer todos os registros, omita o parâmetro em vez de enviar ?status= vazio.

Requisição

curl --request GET \
  --url 'https://api.mygateway.com.br/payments/v1/checkout/charges/f4d8488c-aed0-4828-8b46-723ab7249f08?status=2' \
  --header 'Authorization: TOKEN_DE_AUTENTICACAO' \
  --header 'x-api-key: SUA_API_KEY'

const response = await fetch("https://api.mygateway.com.br/payments/v1/checkout/charges/f4d8488c-aed0-4828-8b46-723ab7249f08?status=2", {
  method: "GET",
  headers: {
    Authorization: token,
    "x-api-key": process.env.MYGATEWAY_API_KEY,
  },
});

const result = await response.json();

<?php
$ch = curl_init('https://api.mygateway.com.br/payments/v1/checkout/charges/f4d8488c-aed0-4828-8b46-723ab7249f08?status=2');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => [
        'Authorization: ' . $token,
        'x-api-key: ' . getenv('MYGATEWAY_API_KEY'),
    ],
    CURLOPT_RETURNTRANSFER => true,
]);
$result = json_decode(curl_exec($ch), true);

import os
import requests

response = requests.get(
    "https://api.mygateway.com.br/payments/v1/checkout/charges/f4d8488c-aed0-4828-8b46-723ab7249f08?status=2",
    headers={
        "Authorization": token,
        "x-api-key": os.environ["MYGATEWAY_API_KEY"],
    },
)
result = response.json()

Respostas

Cobranças do link.

Com cobranças

{
  "data": [
    {
      "id": "0aeb34bf-c3ed-4bbb-aa6e-8663068c6701",
      "code": "CHARGE-000123",
      "value": 150,
      "status": 2,
      "status_string": "Pago",
      "settlement_status": 20,
      "settlement_date": "2026-10-29 14:35:12",
      "installments": 1,
      "due_date": "2026-10-30 23:59:59",
      "value_rate": 0.025,
      "value_rate_fixed": 0.3,
      "chargeback_reversal": 0,
      "nsu": "123456789",
      "tid": "TID123456789",
      "payment_type": "PIX",
      "external_order_number": "PEDIDO-12345",
      "brand": "Visa",
      "created_at": "2026-10-29 14:34:50",
      "order_code": "ORDER-000123",
      "customer_name": "Cliente Exemplo",
      "customer_email": "[email protected]",
      "customer_document": "12345678901",
      "number_obfuscate": "4111********1111",
      "card_holder_name": "CLIENTE EXEMPLO",
      "card_holder_document": "12345678901",
      "card_holder_phone": "999999999",
      "card_holder_phone_ddd": "11",
      "origin_link": "Pedido 12345",
      "checkout_id": "f4d8488c-aed0-4828-8b46-723ab7249f08"
    }
  ]
}

Sem cobranças

{
  "data": []
}

Payload inválido, regra de negócio não atendida, UUID vazio ou inválido, ou registro não localizado. Veja Erros.

ValidationError

{
  "notificationErrors": {
    "error": {
      "errors": [
        {
          "propertyName": "Value",
          "propertyErrors": [
            "O valor informado não pode ser igual ou menor que zero"
          ]
        }
      ]
    }
  },
  "errorTypeDescription": "ValidationError",
  "errorType": 1
}

Token ausente, inválido, expirado ou sem autorização.

JSON

{
  "errorId": "identificador-para-suporte",
  "message": "Não autorizado",
  "encryptdetail": "detalhe-tecnico",
  "timestamp": "2026-10-29T17:40:00Z",
  "ip": "203.0.113.10"
}

Atributos de cada cobrança

idUUIDobrigatório
Identificador da cobrança.
codestringobrigatório
Código interno ou comercial da cobrança.
valuenumberobrigatório
Valor bruto da cobrança em reais.
statusintegerobrigatório
Código do status da cobrança.
status_stringstringobrigatório
Descrição em português correspondente a status.
settlement_statusintegerobrigatório
Código do status de liquidação.
settlement_datestringopcional
Data da liquidação no formato yyyy-MM-dd HH:mm:ss. Pode ser omitida quando ainda não liquidada.
installmentsintegerobrigatório
Quantidade de parcelas.
due_datestringopcional
Vencimento no formato yyyy-MM-dd HH:mm:ss. Pode ser omitido quando não se aplica.
value_ratenumberobrigatório
Taxa variável aplicada, como fração decimal conforme o contrato comercial. Ex.: 0.025 equivale a 2,5%.
value_rate_fixednumberobrigatório
Parcela fixa da tarifa, em reais.
chargeback_reversalnumberobrigatório
Valor associado à reversão ou ao chargeback, em reais.
nsustringopcional
Número sequencial único retornado pelo arranjo ou adquirente.
tidstringopcional
Identificador da transação no provedor ou adquirente.
payment_typestringobrigatório
Forma de pagamento (PIX ou Credit).
external_order_numberstringopcional
Número do pedido no sistema externo.
brandstringopcional
Bandeira do cartão. Pode ser omitida em meios sem bandeira.
created_atstringobrigatório
Data de criação no formato yyyy-MM-dd HH:mm:ss.
order_codestringobrigatório
Código do pedido associado à cobrança.
customer_namestringobrigatório
Nome do pagador.
customer_emailstringobrigatório
E-mail do pagador.
customer_documentstringobrigatório
CPF ou CNPJ do pagador, normalmente só com dígitos.
number_obfuscatestringopcional
Número do cartão mascarado. Em meios sem cartão, pode vir vazio ou ser omitido.
card_holder_namestringopcional
Nome do titular do cartão.
card_holder_documentstringopcional
Documento do titular do cartão.
card_holder_phonestringopcional
Telefone do titular, sem DDD.
card_holder_phone_dddstringopcional
DDD do telefone do titular.
origin_linkstringobrigatório
Título ou identificação do link que originou a cobrança.
checkout_idUUIDobrigatório
Identificador do link consultado.

Status da cobrança#

Código	status_string	Significado
`-1`	`Nenhum`	Sem status definido.
`0`	`Novo`	Cobrança criada.
`1`	`Cancelado`	Cobrança cancelada.
`2`	`Pago`	Pagamento confirmado.
`3`	`ChargeBack`	Chargeback registrado.
`4`	`Extornado`	Valor estornado integralmente.
`5`	`Parcialmente Extornado`	Valor estornado parcialmente.
`6`	`Reprovado`	Pagamento reprovado.
`7`	`Pendente`	Aguardando conclusão.
`8`	`Falha`	O processamento falhou.
`9`	`Desafio 3DS`	Aguardando ou processando desafio 3DS.

Status de liquidação#

O atributo settlement_status indica em que ponto está a liquidação financeira da cobrança.

Ver todos os status de liquidação

Código	Status	Significado
`0`	`None`	Sem status inicial.
`1`	`Pending`	Aguardando processamento.
`2`	`Validating`	Dados em validação.
`3`	`Approved`	Aprovado internamente.
`4`	`Scheduled`	Liquidação agendada.
`5`	`Processing`	Em processamento.
`6`	`SentToBank`	Enviado ao banco.
`7`	`BankProcessing`	Em processamento pelo banco.
`8`	`WaitingFunds`	Aguardando saldo.
`9`	`WaitingConfirmation`	Aguardando confirmação externa.
`10`	`Indeterminate`	Estado ainda não determinado.
`20`	`Settled`	Liquidado com sucesso.
`21`	`PartiallySettled`	Liquidado parcialmente.
`30`	`Rejected`	Liquidação rejeitada.
`31`	`Failed`	Falha no processamento.
`32`	`Cancelled`	Liquidação cancelada.
`33`	`Expired`	Liquidação expirada.
`34`	`InsufficientFunds`	Saldo insuficiente.
`35`	`BankError`	Erro bancário.
`36`	`Timeout`	Tempo limite excedido.
`37`	`Unknown`	Status externo desconhecido.
`40`	`Reversed`	Liquidação revertida.
`41`	`RefundPending`	Reembolso em processamento.
`42`	`Refunded`	Reembolsado.
`43`	`Chargeback`	Chargeback da liquidação.

Última atualização em 29 de outubro de 2026

Consultar cobranças do link

Status da cobrança#

Status de liquidação#

Soluções

Taxa

Empresa

Políticas

Suporte