Jump to Content

Obter Payin

Retorna todos os dados de uma cobrança específica originada pela sua conta. Use este endpoint para verificar o status atual, calcular taxas ou recuperar os dados de pagamento (QR Code, código de barras) caso o webhook não tenha sido recebido.

GET https://api.legacyecombr.com.br/payin/{id}

📘
Webhook vs. polling
Prefira o uso de Webhooks para receber atualizações de status em tempo real. Utilize este endpoint apenas como fallback quando um evento específico não tiver sido entregue.

Parâmetros de rota

Parâmetro	Tipo	Descrição
`id`	`string`	ID único do Payin (ex.: `payin_1A2B3C`)

Exemplo de requisição

GET /payin/payin_1A2B3C
Host: api.holdinglegacy.io
Authorization: Basic base64(pk_live_xxxx:sk_live_yyyy)

Resposta `200 OK`

{
  "id": "payin_1A2B3C",
  "externalId": "tx_998879",
  "referenceId": "pedido-001",
  "status": "PENDING",
  "amount": 54000,
  "currency": "BRL",
  "paymentMethod": "BOLETO",
  "installments": 1,
  "customer": {
    "name": "João Oliveira",
    "document": "12345678900",
    "email": "[email protected]",
    "phone": "5511999999999",
    "address": {
      "street": "Rua Teste",
      "number": "10",
      "zipCode": "01000-000",
      "city": "São Paulo",
      "state": "SP"
    }
  },
  "items": [
    {
      "title": "Plano Anual",
      "quantity": 1,
      "unitPrice": 54000
    }
  ],
  "pixCopyAndPaste": null,
  "boletoBarcode": "34191.09008 00000.000004 00000.000006 1 800000000054000",
  "boletoUrl": "https://boleto.holdinglegacy.io/435.pdf",
  "netAmount": 52380,
  "reservedAmount": 1620,
  "createdAt": "2026-03-02T13:00:00.000Z",
  "updatedAt": "2026-03-02T13:00:00.000Z"
}

Campos da resposta

Campo	Tipo	Descrição
`id`	`string`	Identificador único do Payin na plataforma
`externalId`	`string \| null`	ID gerado pela adquirente
`referenceId`	`string \| null`	ID no seu sistema
`status`	`string`	Status atual — veja todos os status
`amount`	`integer`	Valor bruto em centavos
`currency`	`string`	Moeda — sempre `BRL`
`paymentMethod`	`string`	`PIX`, `BOLETO` ou `CREDIT_CARD`
`installments`	`integer`	Número de parcelas (Cartão de Crédito)
`customer`	`object`	Dados do pagador
`items`	`array`	Itens da cobrança
`pixCopyAndPaste`	`string \| null`	Código PIX Copia e Cola (apenas para PIX)
`boletoBarcode`	`string \| null`	Linha digitável do Boleto
`boletoUrl`	`string \| null`	URL do PDF do Boleto
`netAmount`	`integer \| null`	Valor líquido após dedução de taxas
`reservedAmount`	`integer \| null`	Valor retido como reserva
`createdAt`	`string (ISO 8601)`	Data e hora de criação
`updatedAt`	`string (ISO 8601)`	Data e hora da última atualização

Erros

Status	Código	Descrição
`401`	—	Credenciais inválidas ou ausentes
`404`	—	Payin não encontrado ou não pertence à sua conta

Updated 40 minutes ago