API docs by Redocly

Issuer Bank Integration APIs - Event Notification (1.0)

Download OpenAPI specification:Download

Operations exposed by the Issuer Bank for Amiko to send events.

Amiko Events

Submit an event (deprecated) Deprecated

Deprecated — use the Events V2 API instead (POST /event/v2, operation createDomainEvent).

Legacy event notification API. It remains supported for existing integrations, but new integrations should use Events V2, which provides a stable event id, per-entity ordering via serial (for deduplication), caused-by information, and at-least-once delivery with retry and backoff.

Virtual Agent (dialogue) legacy → V2 event-name mapping:

Legacy (type) V2 (event_name)
new_conversation conversation_created
new_dialogue dialogue_added
reminder dialogue_reminder
dialogue_completed dialogue_completed
dialogue_rejected dialogue_rejected
dialogue_canceled dialogue_canceled
conversation_canceled conversation_discarded

Case and transaction legacy events (case_created, transaction_completed) are likewise available on Events V2.

header Parameters
tracing-id
required
string

Internal Tracing ID that can be used to track interactions.

auth_header
string

The given http header "auth_header" should be considered only a placeholder in this OpenAPI spec. The actual header name and header value must match the configured authentication strategy e.g. API Key or JWT.

external-tracing-id
string

External tracing ID that can be used to track interactions with issuers. Supplied by the Issuer, only available when this Issuer API call originates from an Amiko external API operation with header 'tracing-id'.

Request Body schema: application/json
required
required
object (event.event_notification_header)
required
any (event.event_notification_body)

Responses

Request samples

Content type
application/json
{
  • "header": {
    },
  • "event": {
    }
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Amiko Events V2

Submit a domain event

Submit a domain event related to Amiko. See the details for the different types of events.

Events V2 supersedes the deprecated POST /event (V1) API.

header Parameters
tracing-id
required
string

Internal Tracing ID that can be used to track interactions.

auth_header
string

The given http header "auth_header" should be considered only a placeholder in this OpenAPI spec. The actual header name and header value must match the configured authentication strategy e.g. API Key or JWT.

external-tracing-id
string

External tracing ID that can be used to track interactions with issuers. Supplied by the Issuer, only available when this Issuer API call originates from an Amiko external API operation with header 'tracing-id'.

Request Body schema: application/json
required
required
object (domain_event.header)
required
any (domain_event.body)

Responses

Request samples

Content type
application/json
{
  • "header": {
    },
  • "event": {
    }
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Utility

Returns the health status for this API

The specification is based on the IETF draft https://inadarei.github.io/rfc-healthcheck/.

Please refer to our Health Check documentation for more information.

header Parameters
auth_header
string

The given http header "auth_header" should be considered only a placeholder in this OpenAPI spec. The actual header name and header value must match the configured authentication strategy e.g. API Key or JWT.

Responses

Response samples

Content type
application/json
{
  • "status": "fail"
}