Skip to content
/Payment Events

Banking Events (1.0.0)

Webhook event payloads emitted by the Banking API. Events are delivered through the Aritma Events API using the CloudEvents specification.

Event payloads closely mirror the responses from the corresponding Banking API endpoints, so the data structures will already be familiar if you use the REST API.

Download OpenAPI description
banking-events-openapi.json
banking-events-openapi.yaml
Languages
Servers
Mock server
https://developer.aritma.com/_mock/apis/banking/v4/openapi/banking-events-openapi

Account Events

Webhooks

Payment Events

Webhooks

Payment status changedWebhook

Request

Fired when the status of a payment has been updated. Includes the current transaction status and any TPP messages providing additional details.

Related endpoint: Get payment status

Bodyapplication/jsonrequired
paymentIdstringrequired

Unique identifier of the payment.

endToEndIdentificationstring or null

End-to-end identification of the payment.

transactionStatusstring(TransactionStatus)required

ISO 20022 transaction status code.

Enum"accc""accp""acsc""acsp""actc""acwc""acwp""rcvd""pdng""rjct"
tppMessagesArray of objects(TppMessage)

Messages on operational issues from the ASPSP.

_linksobject(PaymentLinks)

HATEOAS links for payment events.

application/json
{
  "paymentId": "string",
  "endToEndIdentification": "string",
  "transactionStatus": "accc",
  "tppMessages": [
    { … }
  ],
  "_links": {
    "self": { … },
    "bulkPayment": { … }
  }
}

Payment authorizedWebhook

Request

Fired when a payment has been successfully authorized by a user. Includes the count of required and remaining authorizations for multi-approval flows.

Related endpoint: Get payment information

Bodyapplication/jsonrequired
paymentIdstringrequired

Unique identifier of the payment.

authorizationIdstringrequired

Unique identifier of the authorization.

userIdstringrequired

Identifier of the user who authorized the payment.

requiredAuthorizationsinteger(int32)

Total number of authorizations required.

remainingAuthorizationsinteger(int32)

Number of authorizations still remaining.

_linksobject(Links)

HATEOAS links.

application/json
{
  "paymentId": "string",
  "authorizationId": "string",
  "userId": "string",
  "requiredAuthorizations": 0,
  "remainingAuthorizations": 0,
  "_links": {
    "self": { … }
  }
}

Bulk payment status changedWebhook

Request

Fired when the status of a bulk payment or one of its related payment lines has been updated.

Related endpoint: Get bulk-payment information

Bodyapplication/jsonrequired
paymentIdstringrequired

Unique identifier of the payment.

transactionStatusstring(TransactionStatus)required

ISO 20022 transaction status code.

Enum"accc""accp""acsc""acsp""actc""acwc""acwp""rcvd""pdng""rjct"
tppMessagesArray of objects(TppMessage)

Messages on operational issues from the ASPSP.

_linksobject(Links)

HATEOAS links.

application/json
{
  "paymentId": "string",
  "transactionStatus": "accc",
  "tppMessages": [
    { … }
  ],
  "_links": {
    "self": { … }
  }
}

Mandate Events

Webhooks