API Internet BankingWebhooks

List available event types

Returns all event types available for webhook subscriptions.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Headers

X-Tenant-IdstringRequired
Tenant context used for authorization and routing.
X-Request-TimestampstringRequired

Unix seconds. Required on the signed host; tolerance is 300s either way (403 request_timestamp_skew).

X-Content-SHA256stringRequired

Lowercase hex SHA-256 of the body. An empty body hashes the empty string, so the header is always present. Mismatch returns 400 body_hash_mismatch.

X-Request-SignaturestringRequired

Detached JWS (<protected>..<signature>, ES256 or PS256) over METHOD\nPATH?QUERY\nTIMESTAMP\nIDEMPOTENCY_KEY_OR_EMPTY\nX_CONTENT_SHA256.

Response

List of event types.
eventTypeslist of enumsOptional

List of event types available for webhook subscription:

  • pix.in.completed - Incoming PIX completed
  • pix.out.completed - Outgoing PIX completed (carries late: true when it settles after a pix.out.timeout)
  • pix.out.failed - Outgoing PIX failed (carries late: true when rejected after a pix.out.timeout)
  • pix.out.timeout - Outgoing PIX timeout (call sent, response missed within deadline; carries hold when the settlement bank is holding the order, and may be corrected later by a late completed/failed event)
  • pix.refund.completed - Refund we initiated, completed
  • pix.refund.failed - Refund we initiated, failed
  • pix.refund.received - Refund received from receiver, without us asking
  • pix.med.opened - MED/Infraction opened
  • pix.med.updated - MED/Infraction updated
  • qrcode.paid - Dynamic QR Code paid
  • qrcode.expired - Dynamic QR Code expired without payment
  • qrcode.cancelled - Dynamic QR Code cancelled by integrator
  • boleto.paid - Boleto payment confirmed by issuer
  • boleto.failed - Boleto payment rejected by issuer
  • transfer.internal.in - Internal transfer credited to account
  • transfer.internal.out - Internal transfer debited from account
  • fee.charged - Banking fee charged
  • fee.refunded - Banking fee refunded

Errors

401
Unauthorized Error
500
Internal Server Error