Consultar link de pagamento

Consulte os dados atuais de um link de pagamento da My Gateway: atributos da resposta e status possíveis do link.

Nesta página

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

Retorna os dados atuais de um link.

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

Requisição

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

const response = await fetch("https://api.mygateway.com.br/payments/v1/checkout/f4d8488c-aed0-4828-8b46-723ab7249f08", {
  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/f4d8488c-aed0-4828-8b46-723ab7249f08');
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/f4d8488c-aed0-4828-8b46-723ab7249f08",
    headers={
        "Authorization": token,
        "x-api-key": os.environ["MYGATEWAY_API_KEY"],
    },
)
result = response.json()

Respostas

Dados do link. Valores em reais, exceto dentro de checkout_items.

JSON

{
  "data": {
    "id": "f4d8488c-aed0-4828-8b46-723ab7249f08",
    "link": "https://checkout.mygateway.com.br/AbC123xYz789",
    "value": 150,
    "main_title": "Pagamento do pedido 12345",
    "title": "Pedido 12345",
    "description": "Pagamento referente aos produtos do pedido 12345",
    "validity": "2027-04-03 23:59:59",
    "status": "Ativo",
    "minimum_number_of_installments": 1,
    "maximum_number_of_installments": 3,
    "number_of_allowed_sales": 1,
    "is_show_form_address": true,
    "is_customer_interest": false,
    "accepted_payments_type": [
      "PIX",
      "Credit"
    ],
    "checkout_items": {
      "discount": 1000,
      "coupons": [
        {
          "name": "PROMO10",
          "value": 1000
        }
      ],
      "items": [
        {
          "name": "Produto A",
          "total_value": 10000,
          "quantity": 1,
          "image": "https://integrador.exemplo.com/assets/produto-a.png"
        },
        {
          "name": "Produto B",
          "total_value": 6000,
          "quantity": 2,
          "image": "https://integrador.exemplo.com/assets/produto-b.png"
        }
      ]
    },
    "origin": "https://integrador.exemplo.com/pedidos/12345",
    "segment": "ecommerce"
  }
}

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 data

idUUIDobrigatório
Identificador do link.
linkstring (URL)obrigatório
URL pública do checkout.
valuenumberobrigatório
Valor total em reais.
main_titlestringobrigatório
Título principal.
titlestringobrigatório
Título do link ou pedido.
descriptionstringobrigatório
Descrição do pagamento.
validitystringobrigatório
Validade no formato yyyy-MM-dd HH:mm:ss.
statusstringobrigatório
Situação atual do link. Veja os status do link.
minimum_number_of_installmentsintegerobrigatório
Menor quantidade de parcelas permitida.
maximum_number_of_installmentsintegerobrigatório
Maior quantidade de parcelas permitida.
number_of_allowed_salesintegerobrigatório
Quantidade máxima de pagamentos permitidos.
is_show_form_addressbooleanobrigatório
Indica se o formulário pede endereço.
is_customer_interestbooleanobrigatório
Indica se os juros ficam com o pagador.
accepted_payments_typearray de stringobrigatório
Formas de pagamento habilitadas (PIX ou Credit).
checkout_itemsobjectopcional
Itens, cupons e desconto informados na criação. Pode ser omitido. Os valores internos continuam em centavos.
originstring (URL)opcional
Origem informada na criação. Pode ser omitida.
segmentstringopcional
Segmento informado na criação. Pode ser omitido.

Status do link#

Valor	Significado
`Nenhum`	Sem status definido.
`Ativo`	Link disponível para pagamento.
`Pago`	Link pago.
`Cancelado`	Link cancelado.
`CanceladoTentativa`	Link cancelado depois de uma tentativa de pagamento.
`Expirado`	Validade encerrada.

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

Consultar link de pagamento

Status do link#

Soluções

Taxa

Empresa

Políticas

Suporte