A gateway service processes messages and proofs. Upon lifecycle state change, a new event message is generated. Clients retrieve events from the gateway service endpoint which is polled periodically by a Client:
GET /api/gateway/iso20022/gateway/event
Event Types are defined in API definition
MESSAGE_CREATED
Description: Triggered by a sender node when message is successfully created.
MESSAGE_SENT
Description: Triggered by a sender node when message is sent to a counterparty node.
MESSAGE_RECEIVED
Description: Triggered by a recipient node when a message is received and successfully created on a counterparty node.
MESSAGE_ACKNOWLEDGED
Description: Triggered by both (sender/recipient) nodes when a message is acknowledged by a counterparty node.
MESSAGE_NOT_ACKNOWLEDGED
Description: Triggered by both (sender/recipient) nodes when a message is not acknowledged by a counterparty node
PROOF_CREATED
Description: Triggered by a sender node when a proof is successfully created.
PROOF_SENT
Description: Triggered by a sender node when proof was sent to a counterparty.
PROOF_RECEIVED
Description: Triggered by a recipient node when a proof is received and successfully acknowledged by a counterparty node.
PROOF_ACKNOWLEDGED
Description: Triggered by both nodes when a proof is acknowledged by counterparty node.
PROOF_NOT_ACKNOWLEDGED
Description: Triggered by both nodes when a proof is not acknowledged by a counterparty node.
PROOF_COMMITTED
Description: Triggered by both nodes when a proof is successfully committed.
PROOF_APPROVED
Description: Triggered by both nodes when a proof is successfully approved.
PROOF_REJECTED
Description: Triggered by both nodes when a proof is rejected.
Impel's ISO 20022 API is an event driven system that contains defined events
An event represents a lifecycle state of a message and proof object. Learn more about event (computing) here on Wikipedia.
Description | |
---|---|
id
Platform identifier
type
Type of an event e.g. (MESSAGE_CREATED, MESSAGE_SENT, etc.)
timestamp
Date/time event was created
subjectId
Identifier of a subject of the event
subjectType
Type of a subject of the event
data
Platform event serialized to JSON