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

Pagamentos da Assinatura/Recorrência

Consulte o histórico de pagamentos de uma assinatura (cobrança recorrente) específica, incluindo tentativas aprovadas, negadas e pendentes. Os resultados podem ser filtrados por status.

Endpoint

GET /api/subscription/{id}/payments

Parâmetros da URL

Parâmetro Tipo Obrigatório Descrição
id string (GUID) Sim ID único da assinatura gerado pela RecebeAqui

Exemplos de Requisição

# Todos os pagamentos da assinatura
curl -X GET "https://api.recebeaqui.com/v2/api/subscription/123e4567-e89b-12d3-a456-426614174000/payments" \
  -H "Authorization: Bearer {seu_token_de_api}"

const subscriptionId = "123e4567-e89b-12d3-a456-426614174000";
// Todos os pagamentos
const allPayments = await fetch(`https://api.recebeaqui.com/v2/api/subscription/${subscriptionId}/payments`, {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer {seu_token_de_api}',
    'Content-Type': 'application/json'
  }
});

const data = await allPayments.json();

var subscriptionId = "123e4567-e89b-12d3-a456-426614174000";

client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", "{seu_token_de_api}");

// Todos os pagamentos
var allPayments = await client.GetAsync($"https://api.recebeaqui.com/v2/api/subscription/{subscriptionId}/payments");

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

Resposta de Sucesso

Em caso de sucesso (código 200), você receberá os detalhes da assinatura com histórico de pagamentos:

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "externalReference": "assinatura-12345",
  "frequency": "MONTHLY",
  "status": "ativo",
  "maxCycles": 12,
  "value": 99.90,
  "paymentAttempts": [
    {
      "id": "789",
      "paymentDate": "2024-01-15T14:30:00",
      "paidBy": "João Silva",
      "cardType": "**** **** **** 1234",
      "cardBrand": "Visa",
      "status": "Aprovado"
    },
    {
      "id": "790",
      "paymentDate": "2023-12-15T14:30:00",
      "paidBy": "João Silva",
      "cardType": "**** **** **** 1234",
      "cardBrand": "Visa",
      "status": "Aprovado"
    },
    {
      "id": "791",
      "paymentDate": "2023-11-15T10:20:00",
      "paidBy": "João Silva",
      "cardType": "**** **** **** 5678",
      "cardBrand": "Mastercard",
      "status": "Negado"
    }
  ]
}

Status dos Pagamentos

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.

Frequências de Assinatura

Frequência Descrição
MENSAL Todas as recorrências ocorrem mensalmente