Skip to content
/Deadletter

Events Subscriptions API (v1)

Introduction

Welcome to the Aritma Events API!

Over time there will be introduced changes to the API as we continuously introduce improvements. You have the option to use a specific version or the most recent version, supported versions are available in the response header api-supported-versions. Use a specific version of the API by specifying the api-version header, for example api-version: 1.0. If you don't specify the header, the latest version will be used. If a version has been scheduled to be removed, it will be reported through the api-supported-versions header.

Our API uses resource-oriented endpoint paths, accepts Json-Encoded request bodies, returns Json-Encoded responses, and uses standard HTTP response codes and verbs.

Download OpenAPI description
events-openapi.json
events-openapi.yaml
Overview
URL
https://aritma.com/general-inquiry/
Languages
Servers
Mock server
https://developer.aritma.com/_mock/apis/platform/events/openapi/events-openapi
Subscriptions API Dev
https://events.dev.aritma.io
Subscriptions API
https://events.aritma.io

Deadletter

Operations

Gets a list of deadletters for a container.

Request

Security
authorization_code_dev(Required scopes:
api
) or client_credentials_dev(Required scopes:
api
) or authorization_code(Required scopes:
api
) or client_credentials(Required scopes:
api
)
Query
subscriptionNamestring

If specified restricts result to a specific subscription.

pageSizeinteger(int32)

Divides the result into pages. (Default = 10, max = 100, min = 1)

Default 10
cursorinteger(int64)

Reference for next page.

fromDatestring

If specified restricts result to a time period newer than this value.

toDatestring

If specified restricts result to a time period older than this value.

Headers
ResourceUristring

ResourceUri to create the event subscriptions under.

TenantIdstring(uuid)

TenantId used by the customer.

No request payload

Responses

Success

Bodyapplication/json
dataArray of objects or null(FailedEventDataDto)

A list of failed events.

pageSizeinteger(int32)

The max number of items per page.

Example: 10
cursorinteger or null(int64)

A reference for the next page.

Example: 1718451900000
Response
application/json
{
  "data": [
    { … }
  ],
  "pageSize": 10,
  "cursor": 1718451900000
}

Downloads a failed event.

Request

Security
authorization_code_dev(Required scopes:
api
) or client_credentials_dev(Required scopes:
api
) or authorization_code(Required scopes:
api
) or client_credentials(Required scopes:
api
)
Path
eventIdstring(uuid)required

The unique event id.

Headers
ResourceUristring

ResourceUri to create the event subscriptions under.

TenantIdstring(uuid)

TenantId used by the customer.

No request payload

Responses

Success

Bodyapplication/json
idstring or null

The unique identifier of the event.

Example: "550e8400-e29b-41d4-a716-446655440000"
eventTimestring(date-time)

The date and time the event was originally created.

subjectstring or null

The subject or resource path associated with the event.

Example: "/subscriptions/b547f0fa-52a1-4ba7-b9ef-21a8e744bba6/resource-group/9f12f079-2824-4b79-a0b4-d85028ee85cd/providers/aritma.openbanking/accounts/d2aab6d9fd7a4e6eb99c49ec6e129cb2"
eventTypestring or null

The type of event that was published.

Example: "banking.payment.status.updated"
deliveryAttemptsinteger(int32)

The total number of delivery attempts made for this event.

Example: 11
lastHttpStatusCodeinteger(int32)

The HTTP status code returned by the last delivery attempt.

Example: 500
lastDeliveryOutcomestring or null

The outcome description of the last delivery attempt.

Example: "GenericError"
publishTimestring(date-time)

The date and time the event was published.

lastDeliveryAttemptTimestring(date-time)

The date and time of the last delivery attempt.

failureReasonstring or null

The reason the event delivery failed.

Example: "TimeToLiveExceeded"
dataany or null

The event payload data. This may vary given the event type.

Example: {"paymentId":"p1pd127721fce494cfaa4b0311c39c12d6c","endToEndIdentification":"0c8de8c7dcb24f0b980f9a0485dbf66f","transactionStatus":"ACCP","tppMessages":[],"_links":{"bulkPayment":{"href":"https://banking.aritma.io/api/bulk-payments/credit-transfer/p1b8060ed9e4e82412d9e6d781ffc1d405b","verb":"get"},"self":{"href":"https://banking.aritma.io/api/payments/credit-transfer/p1pd127721fce494cfaa4b0311c39c12d6c","verb":"get"}}}
Response
application/json
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "eventTime": "2019-08-24T14:15:22Z",
  "subject": "/subscriptions/b547f0fa-52a1-4ba7-b9ef-21a8e744bba6/resource-group/9f12f079-2824-4b79-a0b4-d85028ee85cd/providers/aritma.openbanking/accounts/d2aab6d9fd7a4e6eb99c49ec6e129cb2",
  "eventType": "banking.payment.status.updated",
  "deliveryAttempts": 11,
  "lastHttpStatusCode": 500,
  "lastDeliveryOutcome": "GenericError",
  "publishTime": "2019-08-24T14:15:22Z",
  "lastDeliveryAttemptTime": "2019-08-24T14:15:22Z",
  "failureReason": "TimeToLiveExceeded",
  "data": {
    "paymentId": "p1pd127721fce494cfaa4b0311c39c12d6c",
    "endToEndIdentification": "0c8de8c7dcb24f0b980f9a0485dbf66f",
    "transactionStatus": "ACCP",
    "tppMessages": [],
    "_links": { … }
  }
}

Deletes a failed event.

Request

Security
authorization_code_dev(Required scopes:
api
) or client_credentials_dev(Required scopes:
api
) or authorization_code(Required scopes:
api
) or client_credentials(Required scopes:
api
)
Path
eventIdstring(uuid)required

The unique event id.

Headers
ResourceUristring

ResourceUri to create the event subscriptions under.

TenantIdstring(uuid)

TenantId used by the customer.

No request payload

Responses

No Content

Response
No content

Subscriptions

Operations