Skip to main content
POST
/
api
/
v1
/
webhook
Criar webhook
curl --request POST \
  --url https://api.quantumpay.com.br/api/v1/webhook \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "https://exemplo.com.br/webhook",
  "events": [
    "transaction_paid",
    "transfer_completed"
  ]
}
'
{
  "id": "webhook_abc123xyz",
  "url": "https://exemplo.com.br/webhook",
  "events": [
    "transaction_paid",
    "transfer_completed"
  ],
  "active": true,
  "createdAt": "2024-12-31T12:00:00Z"
}

Authorizations

​
Authorization
string
header
required

Token JWT no cabeçalho Authorization

Body

application/json
​
url
string<uri>
required

URL que receberá as notificações

Example:

"https://exemplo.com.br/webhook"

​
events
enum<string>[]
required

Lista de eventos para notificar

Available options:
transaction_created,
transaction_paid,
transaction_refunded,
transaction_infraction,
transfer_created,
transfer_updated,
transfer_completed,
transfer_canceled
Example:
["transaction_paid", "transfer_completed"]

Response

Webhook criado com sucesso

​
id
string

ID único do webhook

Example:

"webhook_abc123xyz"

​
url
string<uri>

URL do webhook

Example:

"https://exemplo.com.br/webhook"

​
events
string[]

Eventos configurados

Example:
["transaction_paid", "transfer_completed"]
​
active
boolean

Se o webhook está ativo

Example:

true

​
createdAt
string<date-time>

Data de criação

Example:

"2024-12-31T12:00:00Z"