Skip to main content
GET
/
billings
/
get
/
{id}
curl -X GET 'https://api.goatpay.com.br/v1/billings/get/clx_billing' \
  -H 'X-API-Key: gp_live_SUA_CHAVE'

{
  "success": true,
  "message": "Cobrança avulsa encontrada",
  "data": {
    "id": "clx_billing",
    "status": "RECEIVED",
    "statusLabel": "Pago",
    "billingType": "PIX",
    "amount": 79.9,
    "netAmount": 76.91,
    "feeAmount": 2.99,
    "notificationFeeAmount": 0,
    "installmentCount": 1,
    "description": "Pedido 123",
    "dueAt": "2026-06-15T23:59:59.000Z",
    "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...",
    "accountTransactionId": "clx_ledger",
    "externalReference": "pedido-123",
    "createdAt": "2026-05-30T10:00:00.000Z",
    "customer": {
      "id": "clx_customer",
      "name": "Cliente Exemplo",
      "taxId": "12345678909"
    }
  },
  "requestId": "req_abc123"
}

curl -X GET 'https://api.goatpay.com.br/v1/billings/get/clx_billing' \
  -H 'X-API-Key: gp_live_SUA_CHAVE'

{
  "success": true,
  "message": "Cobrança avulsa encontrada",
  "data": {
    "id": "clx_billing",
    "status": "RECEIVED",
    "statusLabel": "Pago",
    "billingType": "PIX",
    "amount": 79.9,
    "netAmount": 76.91,
    "feeAmount": 2.99,
    "notificationFeeAmount": 0,
    "installmentCount": 1,
    "description": "Pedido 123",
    "dueAt": "2026-06-15T23:59:59.000Z",
    "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...",
    "accountTransactionId": "clx_ledger",
    "externalReference": "pedido-123",
    "createdAt": "2026-05-30T10:00:00.000Z",
    "customer": {
      "id": "clx_customer",
      "name": "Cliente Exemplo",
      "taxId": "12345678909"
    }
  },
  "requestId": "req_abc123"
}

​
Envelope da resposta

CampoTipoDescrição
successbooleantrue em sucesso HTTP 2xx
messagestringMensagem legível (ex.: “Transação PIX encontrada”)
dataobjectPayload do recurso (formato abaixo)
requestIdstringID da requisição para suporte (req_...)

​
Status em data.status (cobrança avulsa)

StatusstatusLabelSignificado
PENDINGPendenteAguardando pagamento
CONFIRMEDConfirmadoPagamento confirmado (cartão)
RECEIVEDPagoValor recebido
OVERDUEVencidoPassou do vencimento sem pagamento
CANCELEDCanceladoCobrança cancelada
REFUNDEDEstornadoEstorno realizado
FAILEDFalhouFalha na cobrança

​
Campos em data

CampoDescrição
billingTypePIX, BOLETO, CREDIT_CARD, DEBIT_CARD, VOUCHER
amountValor bruto
pixCopyPaste / pixEncodedImageQR PIX (quando billingType é PIX)
invoiceUrlLink da fatura
bankSlipUrl / digitableLineBoleto
paidAtData do pagamento
customerCliente vinculado (se houver)

​
Parâmetros de rota

​
id
string
required
ID interno da cobrança ou pay_....

Authorizations

​
X-API-Key
string
header
required

Chave gp_live_... criada em Integrações → Chaves de API no dashboard.

Path Parameters

​
id
string
required

ID do recurso (transação, cobrança, webhook, etc.)

Response

Operação concluída.

​
success
boolean
required
Example:

true

​
message
string
required
Example:

"Operação concluída com sucesso"

​
data
object
required
​
requestId
string