{
  "event": "payment",
  "data": {
    "externalTransactionId": "order_8f2c1a9e-...",
    "paymentStatus": "CON",
    "referenceNumber": "987654321",
    "amount": 15000
  }
}

API Reference

Notificação de estado de pagamento

O webhook é um callback ao nível da conta: a equipa FaciPay regista o URL de destino contra as credenciais do parceiro (no onboarding/suporte). Sempre que o estado de um pagamento muda, a FaciPay envia um POST para esse URL registado. O URL não é lido de additionalInfo nem é definido por ordem; o mesmo endpoint recebe todas as notificações do parceiro.

O corpo é assinado: o header x-facipay-content-token contém o HMAC SHA-256 do body cru usando o webhookSecret. Verifique-o antes de fazer JSON.parse. Responda 200 em menos de 5s.

WEBHOOK

paymentStatus

{
  "event": "payment",
  "data": {
    "externalTransactionId": "order_8f2c1a9e-...",
    "paymentStatus": "CON",
    "referenceNumber": "987654321",
    "amount": 15000
  }
}

Autorizações

Authorization

string

header

obrigatório

Access token obtido em POST /token.

Cabeçalhos

x-facipay-content-token

string

obrigatório

HMAC SHA-256 do body cru, calculado com o webhookSecret.

Corpo

application/json

event

string

Exemplo:

"payment"

data

object

Show child attributes

Resposta

200

Recebido. Sempre responda 200 após validar a assinatura.

Consultar pagamento por externalTransactionId