Pular para o conteúdo

Envelope e payloads

Todos os eventos usam o mesmo envelope, que é o corpo JSON do POST:

Envelope
{
"event": "transaction.paid",
"occurredAt": "2026-07-16T12:03:00.000Z",
"data": { }
}

Campos de data por evento (valores monetários em centavos):

{
"companyId": "string",
"transactionId": "string",
"subTransactionId": "string",
"providerTransactionId": "string",
"paymentMethod": "PIX",
"integration": "string",
"status": "PAID",
"amount": 10000,
"currency": "BRL"
}
{
"companyId": "string",
"refundId": "string",
"subTransactionId": "string",
"transactionId": "string | undefined",
"refundStatus": "COMPLETED",
"transactionStatus": "REFUNDED | undefined",
"amount": 10000,
"currency": "BRL"
}
{
"companyId": "string",
"withdrawId": "string",
"status": "string",
"amount": 5000,
"currency": "BRL",
"providerEndToEndId": "string",
"providerPaymentId": "string",
"providerTid": "string"
}
{
"companyId": "string",
"withdrawId": "string",
"status": "string",
"amount": 5000,
"currency": "BRL",
"reason": "string | undefined"
}
{
"companyId": "string",
"medCaseId": "string",
"status": "string",
"contestedAmountCents": 10000,
"subTransactionId": "string"
}

(uma de duas formas de decisão)

// RETURN
{ "companyId": "string", "medCaseId": "string", "status": "string", "decision": "RETURN", "returnedCents": 10000 }
// CONTEST
{ "companyId": "string", "medCaseId": "string", "status": "CONTESTED", "decision": "CONTEST" }
{
"companyId": "string",
"kycStatus": "string",
"rejectReason": "string | null"
}

(usa recipientCompanyId, não companyId)

{
"recipientCompanyId": "string",
"subTransactionId": "string",
"splitEntryId": "string",
"amount": 10000,
"currency": "BRL"
}

(usa recipientCompanyId, não companyId; enviado quando o saque da empresa indicada é confirmado)

{
"recipientCompanyId": "string",
"withdrawId": "string",
"amount": 1000,
"currency": "BRL"
}

(foto completa das taxas efetivas — PSP + plataforma; pctApplied é fração, 0.0399 = 3,99%; método sem adquirente ativo não aparece)

{
"companyId": "string",
"reason": "FEES_CHANGED | PROVIDER_CHANGED",
"fees": [
{
"paymentMethod": "PIX | BOLETO | CARD",
"provider": "BEMPAGGO",
"pctApplied": 0.0399,
"fixedFeeCents": 50,
"description": "3.99% + R$ 0.50"
}
]
}