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

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

header Parameters
tracing-id
required
string

Tracing ID that can be used to track interactions.

auth_header
string

This is going to be where we send the API key. The header will consist of a custom api key or standardised JWT auth.

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

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.

header Parameters
tracing-id
required
string

Tracing ID that can be used to track interactions.

auth_header
string

This is going to be where we send the API key. The header will consist of a custom api key or standardised JWT auth.

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 linked below. Its content consists of a single mandatory root field (“status”) and several optional fields. Health Check Response Format for HTTP APIs: https://inadarei.github.io/rfc-healthcheck/

header Parameters
auth_header
string

This is going to be where we send the API key. The header will consist of a custom api key or standardised JWT auth.

Responses

Response samples

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