Skip to main content

Webhooks – PIX IN

Webhooks são notificações automáticas que a Cashtime envia para o seu sistema sempre que o status de uma transação PIX IN mudar. Assim, você não precisa ficar consultando a API: basta receber e processar o evento quando ele chegar.

Como funciona

Defina seu endpoint
Ao criar a transação, informe o campo postbackUrl com a URL do seu servidor que receberá as notificações.
Receba o POST
Quando o status da transação for atualizado (por exemplo, de pending para paid), a Cashtime faz uma requisição POST para o postbackUrl com o JSON abaixo.
Confirme o recebimento
Seu servidor deve responder com HTTP 2xx para informar que processou a notificação.
Reenvios automáticos
Se não receber resposta 2xx, tentaremos reenviar a notificação algumas vezes até ter sucesso.

Campos do Payload

CampoDescrição
codeID interno da transação na Cashtime
externalCodeSeu identificador próprio (se tiver enviado)
orderIdID da transação gerado pela Cashtime
storeIdID da sua conta na Cashtime
paymentMethodSempre "pix"
statusNovo estado da transação

Status possíveis

  • paid — pagamento confirmado
  • refused — pagamento recusado
  • refunded — valor estornado
  • infraction— estorno por infração MED

Exemplo de Payload

{
"code": "782e84c0-5738-4cd0-a091-9406e58c84c2",
"externalCode": "pedido_123",
"orderId": "79f474c0-5738-4cd0-a091-951a858c84c2",
"storeId": "52a8b9e-3fd6-42f9-849b-f60a21d1099",
"paymentMethod": "pix",
"status": "paid"
}