API RecebeAqui
Introdução
Comece por aqui Autenticação Limite de Requisições Webhook
Checkout
POST Criar Checkout GET Consultar Checkout PUT Cancelar Checkout POST Criar Checkout transparente
Gerenciamento de Pagamentos
Cancelar Pagamento Realizado
Assinaturas/Recorrências
POST Criar Recorrência GET Consultar Recorrências GET Pagamentos da Recorrência
GET

Consultar Checkout

Consulte os detalhes de um checkout, incluindo tentativas de pagamento e status atual. Você pode buscar por ID do checkout ou por sua referência externa.

Endpoint

GET /api/checkout

Parâmetros da Consulta

Parâmetro Tipo Obrigatório Descrição
id string Condicional ID do checkout

Obrigatório se externalReference não informado

externalReference string Condicional Referência externa

Obrigatório se id não informado

pageNumber int Não Número da página para paginação

(padrão: 1)

itemsPerPage int Não Itens por página

(padrão: 150, máximo: 150)

Exemplos de Requisição

# Consulta por ID
curl -X GET "https://api.recebeaqui.com/v2/api/checkout?id=123e4567-e89b-12d3-a456-426614174000" \
  -H "Authorization: Bearer {seu_token_de_api}"

# Consulta por referência externa
curl -X GET "https://api.recebeaqui.com/v2/api/checkout?externalReference=pedido-12345" \
  -H "Authorization: Bearer {seu_token_de_api}"
// Consulta por ID
const responseById = await fetch('https://api.recebeaqui.com/v2/api/checkout?id=123e4567-e89b-12d3-a456-426614174000', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer {seu_token_de_api}',
    'Content-Type': 'application/json'
  }
});

// Consulta por referência externa
const responseByRef = await fetch('https://api.recebeaqui.com/v2/api/checkout?externalReference=pedido-12345', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer {seu_token_de_api}',
    'Content-Type': 'application/json'
  }
});

const data = await responseById.json();
// Consulta por ID
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", "{seu_token_de_api}");
var responseById = await client.GetAsync("https://api.recebeaqui.com/v2/api/checkout?id=123e4567-e89b-12d3-a456-426614174000");

// Consulta por referência externa
var responseByRef = await client.GetAsync("https://api.recebeaqui.com/v2/api/checkout?externalReference=pedido-12345");

var content = await responseById.Content.ReadAsStringAsync();

Resposta de Sucesso

Em caso de sucesso (código 200), você receberá os detalhes completos do checkout:

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "description": "Produto XYZ",
  "value": 100.50,
  "maxInstallmentCount": 12,
  "expirationDate": "2024-02-15T23:59:59",
  "recurrent": null,
  "billingType": "ALL",
  "externalReference": "pedido-12345",
  "successCallback": "https://seusite.com/sucesso",
  "errorCallback": "https://seusite.com/erro",
  "dateFirstRecurringPayment": null,
  "antifraud": true,
  "dueDate": "2024-02-15T00:00:00",
  "customerName": "João Silva",
  "customerEmail": "joao@email.com",
  "taxId": "12345678901",
  "fine": 0,
  "interest": 0,
  "paymentLink": "https://app.recebeaqui.com.br/Pagar/123e4567-e89b-12d3-a456-426614174000",
  "totalPaymentAttempts": 2,
  "pageNumber": 1,
  "itemsPerPage": 2,
  "paymentAttempts": [
    {
      "id": "456",
      "paymentDate": "2024-01-15T14:30:00",
      "paidBy": "João Silva",
      "cardType": "**** **** **** 1234",
      "cardBrand": "Visa",
      "status": "Aprovado"
    },
    {
      "id": "789",
      "paymentDate": "2024-01-10T10:15:00",
      "paidBy": "João Silva",
      "cardType": "**** **** **** 5678",
      "cardBrand": "Mastercard",
      "status": "Negado"
    }
  ]
}

Status das Tentativas de Pagamento

Status Descrição
Ativa Pagamento aprovado e em vigor, sem cancelamento.
Não autorizada Pagamento recusado pela operadora ou instituição financeira.
Cancelada Pagamento cancelado pelo estabelecimento.
Chargeback Pagamento contestado pelo portador do cartão junto à operadora.
Em análise Pagamento em processo de verificação de chargeback pela bandeira.