Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Supported events
The table below lists all payment and A2A transfer events that you can subscribe to and receive the event notification using Webhooks webhooks. Keep watching this page for more supported events that you can add into your webhooks based on the business process flow.
| Event Object | Event Type | Short Description |
|---|---|---|
| Payment | PAYMENT_REQUESTED | Appears when a new payment request is created. |
PAYMENT_AUTHORIZATION_REQUESTED | Appears when a new payment request is submitted for authorization. | |
PAYMENT_AUTHORIZATION_RECEIVED | Appears when a new payment request is authorized and a payment plan is prepared. | |
PAYMENT_EFFECTED | Appears when a new payment request is successfully posted in the system. | |
PAYMENT_CAPTURED | Appears when the response to a new payment request is successfully captured and acknowledged by the network or requesting entity. | |
PAYMENT_REVERSED | Appears when a payment transaction has been reversed. | |
| PAYMENT_REQUEST_DECLINED | Appears when a payment request is invalid. | |
| Account transfer | TRANSFER_CREATED | Appears when an A2A transfer has been created. |
Event structure
A typical incoming webhook notification contains the following event attributes.
| Attribute | Description |
|---|---|
| topic | Fintech-specific object to which the event is emitted from a business logic |
| name | String identifying the specific type of this event |
| eventId | Unique identifier of the event |
| source | Description of the source entity emitting the event |
| source.uri | URL format identifying the entity emitting the event |
| source.tags | Array of fintech tag URIs that specify the fintech access to the source objects and resultant events |
| source.state | State of the object when the event is emitted. |
| data | JSON payload (less than 2 KB size) that gives information about the specific change that triggered this event |
| origin | Description of the service instance emitting the event |
| origin.instance | URL identifying the app instance emitting the event |
| origin.time | Time at the origin when the event is emitted (in epoch milliseconds) |
| origin.flowId | Unique identifier of flow from which the event is emitted |
Below is an example of a standard event structure:
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"topic": "Fintech specific object",
"name": "event name",
"eventId": "event identifier",
"source": {
"uri": "entity source URL emitting the event",
"tags": [
"tag://vbo/v0001",
"Fintech tag that has access to the source objects"
],
"state": "object state when an event is triggered"
},
"data": {event details covering the key changes},
"origin": {
"instance": "app URL emitting the event",
"time": "event generation time in epoch millis",
"flowId": "uuid of flow from which the event is emitted."
}
} |
Related articles
| HTML Table | |||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||
|
| Panel | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|