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

Mandate Events

Webhooks

Mandate status changedWebhook

Request

Fired when the status of a mandate has been updated. Includes rejection reason codes and proprietary text if the mandate was rejected.

Bodyapplication/jsonrequired
mandateIdstringrequired

Unique identifier of the mandate.

mandateStatusstring(MandateStatus)required

Status of a direct debit mandate.

Enum"RCVD""RJCT""PATC""ACTV""EXPI""CANC""SUSP""PNDG"
rejectReasonCodestring(MandateStatusReasonCode)

Reason code for mandate rejection.

Enum"AC01""AC04""AC06""AC13""AG01""AG02""AM01""AM02""AM03""BE05"
rejectReasonProprietarystring or null

Proprietary rejection reason text.

application/json
{
  "mandateId": "string",
  "mandateStatus": "RCVD",
  "rejectReasonCode": "AC01",
  "rejectReasonProprietary": "string"
}

Mandate createdWebhook

Request

Fired when a new direct debit mandate has been created. Contains the mandate status, reference, and the date of the last action.

Bodyapplication/jsonrequired
mandateIdstringrequired

Unique identifier of the mandate.

maximumAmountobject(Money)

An amount with currency.

occurrencesobject(Occurrence)

Occurrence information for a mandate.

creditorAccountobject(MandateAccount)required

Account reference for mandates.

bbanstring

Basic Bank Account Number.

creditorobject(Creditor)required

Creditor party for a mandate.

namestring or null<= 140 characters

Creditor name.

identificationobject(CreditorIdentification)

Identification of a creditor.

debtorobject(Debtor)required

Debtor party for a mandate.

namestring or null<= 140 characters

Debtor name.

postalAddressobject(PostalAddress)

Postal address of a party.

identificationobject(DebtorIdentification)

Identification of a debtor.

debtorAccountobject(MandateAccount)required

Account reference for mandates.

bbanstring

Basic Bank Account Number.

mandateReferencestring or null

Mandate reference identifier.

mandateStatusstring(MandateStatus)required

Status of a direct debit mandate.

Enum"RCVD""RJCT""PATC""ACTV""EXPI""CANC""SUSP""PNDG"
rejectedReasonCodestring(MandateStatusReasonCode)

Reason code for mandate rejection.

Enum"AC01""AC04""AC06""AC13""AG01""AG02""AM01""AM02""AM03""BE05"
rejectReasonProprietarystring or null

Proprietary rejection reason text.

lastActionDatestring(date)required

Date of the last action on this mandate.

application/json
{
  "mandateId": "string",
  "maximumAmount": {
    "currency": "string",
    "amount": "string"
  },
  "occurrences": {
    "frequencyType": "YEAR",
    "duration": { … }
  },
  "creditorAccount": {
    "bban": "string"
  },
  "creditor": {
    "name": "string",
    "identification": { … }
  },
  "debtor": {
    "name": "string",
    "postalAddress": { … },
    "identification": { … }
  },
  "debtorAccount": {
    "bban": "string"
  },
  "mandateReference": "string",
  "mandateStatus": "RCVD",
  "rejectedReasonCode": "AC01",
  "rejectReasonProprietary": "string",
  "lastActionDate": "2019-08-24"
}

Mandate updatedWebhook

Request

Fired when an existing mandate has been updated. Contains the current mandate status, reference, and the date of the last action.

Bodyapplication/jsonrequired
mandateIdstringrequired

Unique identifier of the mandate.

maximumAmountobject(Money)

An amount with currency.

occurrencesobject(Occurrence)

Occurrence information for a mandate.

creditorAccountobject(MandateAccount)required

Account reference for mandates.

bbanstring

Basic Bank Account Number.

creditorobject(Creditor)required

Creditor party for a mandate.

namestring or null<= 140 characters

Creditor name.

identificationobject(CreditorIdentification)

Identification of a creditor.

debtorobject(Debtor)required

Debtor party for a mandate.

namestring or null<= 140 characters

Debtor name.

postalAddressobject(PostalAddress)

Postal address of a party.

identificationobject(DebtorIdentification)

Identification of a debtor.

debtorAccountobject(MandateAccount)required

Account reference for mandates.

bbanstring

Basic Bank Account Number.

mandateReferencestring or null

Mandate reference identifier.

mandateStatusstring(MandateStatus)required

Status of a direct debit mandate.

Enum"RCVD""RJCT""PATC""ACTV""EXPI""CANC""SUSP""PNDG"
rejectedReasonCodestring(MandateStatusReasonCode)

Reason code for mandate rejection.

Enum"AC01""AC04""AC06""AC13""AG01""AG02""AM01""AM02""AM03""BE05"
rejectReasonProprietarystring or null

Proprietary rejection reason text.

lastActionDatestring(date)required

Date of the last action on this mandate.

application/json
{
  "mandateId": "string",
  "maximumAmount": {
    "currency": "string",
    "amount": "string"
  },
  "occurrences": {
    "frequencyType": "YEAR",
    "duration": { … }
  },
  "creditorAccount": {
    "bban": "string"
  },
  "creditor": {
    "name": "string",
    "identification": { … }
  },
  "debtor": {
    "name": "string",
    "postalAddress": { … },
    "identification": { … }
  },
  "debtorAccount": {
    "bban": "string"
  },
  "mandateReference": "string",
  "mandateStatus": "RCVD",
  "rejectedReasonCode": "AC01",
  "rejectReasonProprietary": "string",
  "lastActionDate": "2019-08-24"
}