curl -X GET 'https://api.wovepay.com/v1/billings/get/clx_billing' \
-H 'X-API-Key: wp_live_SUA_CHAVE'
{
"success": true,
"message": "Cobrança encontrada",
"data": {
"id": "clx_billing",
"status": "RECEIVED",
"statusLabel": "Pago",
"method": "PIX",
"amount": 79.9,
"netAmount": 76.91,
"feeAmount": 2.99,
"notificationFeeAmount": 0,
"installmentCount": 1,
"description": "Pedido 123",
"dueAt": "2026-06-15",
"dueDate": "2026-06-15",
"paidAt": "2026-05-31T14:22:00.000Z",
"estimatedCreditDate": "2026-06-02T00:00:00.000Z",
"invoiceUrl": "https://...",
"bankSlipUrl": null,
"digitableLine": null,
"pixCopyPaste": "00020101021226730014br.gov.bcb.pix...",
"pixEncodedImage": "iVBORw0KGgo...",
"externalId": "pay_abc123",
"externalReference": "pedido-123",
"accountTransactionId": "clx_ledger",
"createdAt": "2026-05-30T10:00:00.000Z",
"customer": {
"id": "clx_customer",
"name": "Cliente Exemplo",
"taxId": "12345678909"
}
},
"requestId": "req_abc123"
}
Consultar cobrança avulsa
Por id interno ou externalId do provider (pay_...).
GET
/
billings
/
get
/
{id}
curl -X GET 'https://api.wovepay.com/v1/billings/get/clx_billing' \
-H 'X-API-Key: wp_live_SUA_CHAVE'
{
"success": true,
"message": "Cobrança encontrada",
"data": {
"id": "clx_billing",
"status": "RECEIVED",
"statusLabel": "Pago",
"method": "PIX",
"amount": 79.9,
"netAmount": 76.91,
"feeAmount": 2.99,
"notificationFeeAmount": 0,
"installmentCount": 1,
"description": "Pedido 123",
"dueAt": "2026-06-15",
"dueDate": "2026-06-15",
"paidAt": "2026-05-31T14:22:00.000Z",
"estimatedCreditDate": "2026-06-02T00:00:00.000Z",
"invoiceUrl": "https://...",
"bankSlipUrl": null,
"digitableLine": null,
"pixCopyPaste": "00020101021226730014br.gov.bcb.pix...",
"pixEncodedImage": "iVBORw0KGgo...",
"externalId": "pay_abc123",
"externalReference": "pedido-123",
"accountTransactionId": "clx_ledger",
"createdAt": "2026-05-30T10:00:00.000Z",
"customer": {
"id": "clx_customer",
"name": "Cliente Exemplo",
"taxId": "12345678909"
}
},
"requestId": "req_abc123"
}
curl -X GET 'https://api.wovepay.com/v1/billings/get/clx_billing' \
-H 'X-API-Key: wp_live_SUA_CHAVE'
{
"success": true,
"message": "Cobrança encontrada",
"data": {
"id": "clx_billing",
"status": "RECEIVED",
"statusLabel": "Pago",
"method": "PIX",
"amount": 79.9,
"netAmount": 76.91,
"feeAmount": 2.99,
"notificationFeeAmount": 0,
"installmentCount": 1,
"description": "Pedido 123",
"dueAt": "2026-06-15",
"dueDate": "2026-06-15",
"paidAt": "2026-05-31T14:22:00.000Z",
"estimatedCreditDate": "2026-06-02T00:00:00.000Z",
"invoiceUrl": "https://...",
"bankSlipUrl": null,
"digitableLine": null,
"pixCopyPaste": "00020101021226730014br.gov.bcb.pix...",
"pixEncodedImage": "iVBORw0KGgo...",
"externalId": "pay_abc123",
"externalReference": "pedido-123",
"accountTransactionId": "clx_ledger",
"createdAt": "2026-05-30T10:00:00.000Z",
"customer": {
"id": "clx_customer",
"name": "Cliente Exemplo",
"taxId": "12345678909"
}
},
"requestId": "req_abc123"
}
Status em data.status
| Status | statusLabel | Significado |
|---|---|---|
| PENDING | Pendente | Aguardando pagamento |
| CONFIRMED | Confirmado | Pagamento confirmado (cartão) |
| RECEIVED | Pago | Valor recebido |
| OVERDUE | Vencido | Passou do vencimento sem pagamento |
| CANCELED | Cancelado | Cobrança cancelada |
| REFUNDED | Estornado | Estorno realizado |
| PARTIALLY_REFUNDED | Estornado parcial | Estorno parcial |
| FAILED | Falhou | Falha na cobrança |
Campos em data
| Campo | Descrição |
|---|---|
| method | PIX, BOLETO, CARD_CREDIT, CARD_DEBIT, CARD_VOUCHER |
| externalId | ID da cobrança no provider (pay_...) |
| amount | Valor bruto |
| pixCopyPaste / pixEncodedImage | QR PIX (quando method é PIX) |
| invoiceUrl | Link da fatura (boleto, débito ou cartão) |
| bankSlipUrl / digitableLine | Boleto |
| paidAt | Data do pagamento |
| customer | Cliente vinculado (se houver) |
Parâmetros de rota
string
required
ID interno da cobrança (
clx_...) ou externalId (pay_...).Authorizations
Chave wp_live_... criada em Integrações → Chaves de API no dashboard.
Path Parameters
ID do recurso (transação, cobrança, webhook, etc.)
⌘I