Skip to main content

​
Resumo

Cria cash-in (cobrança / QR de recebimento). O valor no request vem em BRL (float); a resposta pode incluir valueCents e campos irmãos (conforme padrão do serviço).
  • Método: POST
  • Rota: /api/pix/cash-in
  • Autenticação: Authorization: Bearer <seu_api_token>

​
Headers

NomeObrigatório
AuthorizationSim
Content-TypeSim (application/json)
X-Correlation-IDRecomendado

​
Corpo (estrutura documentada)

{
  "transaction": {
    "value": 150.75,
    "externalId": "pedido-12345",
    "description": "string opcional",
    "expirationTime": 3600,
    "generateQrCode": true
  },
  "payer": {
    "fullName": "João da Silva",
    "document": "123.456.789-00"
  }
}
TODO: exigência de payer (obrigatório vs opcional) — a origem mostra o bloco, mas não cita tabela de obrigatoriedade; confirme no schema da API.

​
Exemplo (curl)

curl -X POST https://api.clearpago.com.br/api/pix/cash-in \
  -H "Authorization: Bearer <seu_api_token>" \
  -H "Content-Type: application/json" \
  -H "X-Correlation-ID: req-001" \
  -d '{
    "transaction": {
      "value": 150.75,
      "externalId": "pedido-12345",
      "description": "Pagamento Pedido #12345",
      "expirationTime": 3600,
      "generateQrCode": true
    },
    "payer": {
      "fullName": "João da Silva",
      "document": "123.456.789-00"
    }
  }'

​
Resposta 201 (campos principais)

CampoUso
idUUID do cash-in — persista; base de consultas.
statusGeralmente PENDING na criação.
pixCodeString EMV se generateQrCode: true.
expirationDateValidade do QR.
providerTransactionIdReferência do parceiro.
TODO: corpo de erro completo e schema JSON Schema — a origem não fornece OpenAPI; expandir com spec oficial.

​
HTTP e erros

  • 201 Criado.
  • 400 Validação (payload).
  • 401 Token inválido.
  • 409 Conflito (ex.: externalId duplicado) — tabela geral.
  • 422 Regra de negócio.
  • 500 Interno.

​
Relacionado