Skip to content
/Account 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

Account createdWebhook

Request

Fired when a new banking account has been created. Includes account identifiers (IBAN/BBAN), BIC, currency, and display name.

Related endpoint: Get account

Bodyapplication/jsonrequired
idstringrequired

Unique identifier of the account.

bicstringrequired

BICFI of the account's servicing institution.

ibanstring or null[A-Z]{2}[0-9]{2}[a-zA-Z0-9]{1,30}

International Bank Account Number.

bbanstring or null

Basic Bank Account Number (ISO 20022).

namestring or null

Name of the account given by the bank.

currencystring or null

ISO 4217 Alpha 3 currency code.

displayNamestring or null

Name of the account for display in online channels.

application/json
{
  "id": "string",
  "bic": "string",
  "iban": "string",
  "bban": "string",
  "name": "string",
  "currency": "string",
  "displayName": "string"
}

Approval settings changedWebhook

Request

Fired when the approval settings for an account have been changed, such as toggling pre-approval or updating the number of required approvers.

Related endpoint: Get account parameters

Bodyapplication/jsonrequired
idstringrequired

Unique identifier of the account.

namestring or null

Name of the account.

displayNamestring or null

Display name of the account.

preApprovalboolean

Whether pre-approval is enabled for the account.

numberOfApproversinteger(int32)

Number of required approvers for payments from this account.

_linksobject(Links)

HATEOAS links.

application/json
{
  "id": "string",
  "name": "string",
  "displayName": "string",
  "preApproval": true,
  "numberOfApprovers": 0,
  "_links": {
    "self": { … }
  }
}

Account status changedWebhook

Request

Fired when the status of an account has been updated. The accountStatus field indicates the new status.

Related endpoint: Get account

Bodyapplication/jsonrequired
idstringrequired

Unique identifier of the account.

namestring or null

Name of the account.

displayNamestring or null

Display name of the account.

accountStatusstring(AccountStatus)

Status of a banking account.

Enum"Active""Blocked""Deleted"
_linksobject(Links)

HATEOAS links.

application/json
{
  "id": "string",
  "name": "string",
  "displayName": "string",
  "accountStatus": "Active",
  "_links": {
    "self": { … }
  }
}

Balance updatedWebhook

Request

Fired when the balance of a banking account has been added or updated. Contains the current balances and account identifiers.

Related endpoint: Get account balances

Bodyapplication/jsonrequired
idstringrequired

Unique identifier of the account.

ibanstring or null

International Bank Account Number.

bbanstring or null

Basic Bank Account Number.

currencystring or null

ISO 4217 Alpha 3 currency code.

balancesArray of objects(AccountBalance)

Current balances of the account.

_linksobject(Links)

HATEOAS links.

application/json
{
  "id": "string",
  "iban": "string",
  "bban": "string",
  "currency": "string",
  "balances": [
    { … }
  ],
  "_links": {
    "self": { … }
  }
}

Transaction receivedWebhook

Request

Fired when a new transaction has been received for an account. The payload contains the full transaction information including amounts, parties, and remittance data.

Related endpoint: Get transaction details

Bodyapplication/jsonrequired
transactionIdstringrequired

Unique identifier of the transaction.

accountIdstringrequired

Identifier of the account the transaction belongs to.

referencesobject(TransactionReferences)

References associated with a transaction.

entryReferencestring or null

Entry reference of the transaction.

valueDatestring or null(date-time)

The date the amount becomes available.

bookingDatestring or null(date-time)

The date the transaction was booked.

transactionAmountobject(Money)required

An amount with currency.

currencystring

ISO 4217 Alpha 3 currency code.

amountstring

The amount as a decimal string.

amountDetailsobject(AmountDetails)

Detailed amount information with exchange rate details.

chargeobject(Charge)

Transaction charge information.

currencyExchangeArray of objects(ReportExchangeRate)

Currency exchange information.

creditorobject(TransactionParty)

A party (creditor or debtor) in a transaction.

creditorAccountobject(AccountReference)

Reference to an account using various identification schemes.

debtorobject(TransactionParty)

A party (creditor or debtor) in a transaction.

debtorAccountobject(AccountReference)

Reference to an account using various identification schemes.

remittanceInformationUnstructuredArray of strings

Unstructured remittance information.

remittanceInformationStructuredArray of objects(RemittanceInformationStructured)

Structured remittance information.

purposeCodestring or null

ISO 20022 ExternalPurpose1Code.

purposeProprietarystring or null

Proprietary purpose code.

bankTransactionCodestring or null

ISO 20022 bank transaction code.

bankTransactionCodeProprietarystring or null

Proprietary bank transaction code.

additionalInformationstring or null

Additional information provided by the ASPSP.

entryDetailsCountinteger(int32)

Count of entry details (batch entries).

transactionSourcestring(TransactionSource)

Source of the transaction.

Enum"Default""CreditDebitNotification""Statement"
_linksobject(Links)

HATEOAS links.

application/json
{
  "transactionId": "string",
  "accountId": "string",
  "references": {
    "endToEndIds": [ … ],
    "instructionId": "string",
    "accountServicerReference": "string",
    "mandateId": "string",
    "checkNumber": "string"
  },
  "entryReference": "string",
  "valueDate": "2019-08-24T14:15:22Z",
  "bookingDate": "2019-08-24T14:15:22Z",
  "transactionAmount": {
    "currency": "string",
    "amount": "string"
  },
  "amountDetails": {
    "instructedAmount": { … },
    "transactionAmount": { … }
  },
  "charge": {
    "amount": { … },
    "chargeBearer": "debt"
  },
  "currencyExchange": [
    { … }
  ],
  "creditor": {
    "name": "string",
    "postalAddress": { … }
  },
  "creditorAccount": {
    "iban": "string",
    "bban": "string",
    "other": { … },
    "currency": "string",
    "pan": "string",
    "maskedPan": "string",
    "msisdn": "string"
  },
  "debtor": {
    "name": "string",
    "postalAddress": { … }
  },
  "debtorAccount": {
    "iban": "string",
    "bban": "string",
    "other": { … },
    "currency": "string",
    "pan": "string",
    "maskedPan": "string",
    "msisdn": "string"
  },
  "remittanceInformationUnstructured": [
    "string"
  ],
  "remittanceInformationStructured": [
    { … }
  ],
  "purposeCode": "string",
  "purposeProprietary": "string",
  "bankTransactionCode": "string",
  "bankTransactionCodeProprietary": "string",
  "additionalInformation": "string",
  "entryDetailsCount": 0,
  "transactionSource": "Default",
  "_links": {
    "self": { … }
  }
}

Payment Events

Webhooks

Mandate Events

Webhooks