Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

EBANX Payment Notifications

Signed HTTP POST callbacks delivered to a merchant-configured Notification URL whenever a payment, refund, chargeback, or Pix MED return request changes state. Each callback carries the EBANX hash so the merchant can re-query the Direct API for authoritative payment state.

EBANX Payment Notifications is one of 6 APIs that EBANX publishes on the APIs.io network, described by an AsyncAPI event-driven specification.

Tagged areas include Webhooks, Notifications, and Events. The published artifact set on APIs.io includes API documentation and an AsyncAPI specification.

This event API exposes 4 operations across 4 channels, and defines 4 schemas. It is described by AsyncAPI 2.6.0, at version 1.0.

The API connects through a single server, {merchantNotificationUrl} (https).

4 operations 4 channels 4 schemas

Metadata

The identity and technical contract details declared by the specification.

Specification
AsyncAPI 2.6.0
API Version
1.0
Server
{merchantNotificationUrl} (https)
Resource Areas
1

Channels & Operations 4

Across 4 channels, the API surfaces 4 operations. Each is listed below with its action, channel, parameters, and response codes.

Channels 4
SUB
payment.update
Receive payment status update
receivePaymentUpdate body
SUB
payment.refund
Receive refund status update
receiveRefundNotification body
SUB
payment.chargeback
Receive chargeback notification
receiveChargebackNotification body
SUB
payment.med-pix
Receive Pix MED notification
receiveMedPixNotification body

Messages & Schemas 4

The contract defines 4 schemas that model the data carried by its messages. Each schema is shown below with its type and property counts.

PaymentNotification
message
RefundNotification
message
ChargebackNotification
message
MedPixNotification
message

Specification

The full machine-readable AsyncAPI contract behind this narrative.

Source

ebanx-notifications-asyncapi.yml Raw ↑

Other APIs EBANX publishes across the network.

EBANX Tokenization API
EBANX FX API
EBANX PaymentPage API
EBANX Payments API
EBANX Payouts API