Faturas Internas

Consultar Fatura Interna

GET/v1/internal-invoice/:id

Retorna os detalhes completos de uma fatura interna específica, incluindo dados do recebedor e status atual.

Rate limit: 30 requisições por 60 segundos

Parâmetros de URL

Campo	Tipo	Descrição
`id`obrigatório	`string (UUID)`	ID único da fatura a ser consultada.

Campos da Resposta

Campo	Tipo	Descrição
`id`	`string (UUID)`	ID único da fatura
`code`	`string`	Código de identificação da fatura no painel
`amount`	`number`	Valor bruto da cobrança
`fee`	`number`	Taxa calculada automaticamente
`net_amount`	`number`	Valor líquido (amount - fee)
`status`	`string`	PENDING \| PAID \| CANCELLED \| EXPIRED
`description`	`string`	Descrição da fatura
`due_date`	`string \| null`	Data de vencimento em ISO 8601
`created_at`	`string (ISO 8601)`	Data e hora de criação
`updated_at`	`string (ISO 8601)`	Data e hora da última atualização
`is_expired`	`boolean`	true se due_date passou e status ainda é PENDING
`receiver.name`	`string`	Nome do recebedor
`receiver.document`	`string`	CPF ou CNPJ formatado do recebedor
`receiver.receiver_type`	`string`	"PF" \| "PJ" \| null

Status da Fatura

PENDINGAguardando pagamento

PAIDFatura paga

CANCELLEDFatura cancelada

EXPIREDFatura expirada

Erros Possíveis

401

Não autenticado

"API Secret não fornecida"

403

Acesso negado

"Transferências internas estão desabilitadas"

404

Não encontrado

"Fatura não encontrada"
"Usuário não encontrado"

GEThttps://api.connectpay.vc/v1/internal-invoice/{id}

Headers

api-secret: sua-api-secret-aqui

cURL

curl -X GET "https://api.connectpay.vc/v1/internal-invoice/uuid-da-cobranca" \
  -H "api-secret: sua-api-secret-aqui"

Response 200

{
  "hasError": false,
  "data": {
    "id": "uuid-da-cobranca",
    "code": "ABC12345",
    "amount": 100.50,
    "fee": 2.50,
    "net_amount": 98.00,
    "status": "PENDING",
    "description": "Pagamento de serviços mensais",
    "due_date": "2026-02-15T10:00:00Z",
    "created_at": "2026-01-28T10:00:00Z",
    "is_expired": false,
    "receiver": {
      "name": "Nome do Recebedor",
      "document": "123.456.789-00",
      "receiver_type": "PF"
    }
  }
}