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

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.

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

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.

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"
}