All pages
Powered by GitBook
1 of 12

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Debt

Debt management

DEBT_GB_INDICATOR_CHANGED
  • The debt API triggers the DEBT_GB_INDICATOR_CHANGED notification when the value of the good/bad indicator changes for a contract.

  • Event parameters are eventTypeCode/routing_code: ext.debts.contracts.gb-indicators.changed.

DEBT_CONTRACT_CHANGED
  • The debt API triggers the DEBT_CONTRACT_CHANGED notification when a new contract is created or debt status is changed.

  • Event parameters are eventTypeCode/routing_code: ext.debts.contracts.changed.

DEBT_LETTER_CREATED
  • The payment API triggers the DEBT_LETTER_CREATED notification when the debt letter is created.

  • Event parameters are eventTypeCode/routing_code: ext.debts.letters.events.created.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "DEBT_GB_INDICATOR_CHANGED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2025-01-09T09:12:26.026Z",
  "data": {
    "contractId": "ID-1000",
    "indicatorValueCode": "GB_01",
    "indicatorFlagCode": "GOOD",
    "endDate": "2025-01-09",
    "generationDtime": "2021-02-23T08:32:33.0759819Z"
  }
}
{
  "notificationId": "ID-9999",
  "notificationTypeCode": "DEBT_CONTRACT_CHANGED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2025-01-09T09:22:16.662Z",
  "data": {
    "contractId": "ID-1000",
    "debtStatusLevelCode": "string",
    "debtStatusReasonTypeCode": "CLERK_DECISION",
    "lastNotificationSent": "RL1",
    "nonPerforming": false,
    "oldestOverdueInvoiceDueDate": "2022-01-01",
    "oldestOverdueInvoiceId": "ID-1000",
    "personId": "ID-1000",
    "statusCode": "ACTIVE"
  }
}
{
  "notificationId": "ID-9999",
  "notificationTypeCode": "DEBT_LETTER_CREATED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2025-01-09T09:28:20.042Z",
  "data": {
    "letterHeader": {
      "productType": "LOAN_PRODUCT_01",
      "letterType": "RL1",
      "generationDtime": "2021-02-23T08:32:33.0759819Z",
      "additionalData": {
        "additionalProp1": {},
        "additionalProp2": {},
        "additionalProp3": {}
      }
    },
    "receiverInfo": {
      "personId": "ID-1000",
      "idNumber": "38802020176",
      "givenName": "Markko",
      "middleName": "Lee",
      "surname": "Martin",
      "companyName": "Modular Finance OU",
      "birthDate": "1960-01-15",
      "deathDate": "2021-03-15",
      "email": "[email protected]",
      "phoneNumber": "+3721234123",
      "language": "en",
      "deliveryMethodCode": "POST",
      "addressInfo": [
        {
          "addressTypeCode": "R for Registration, C for Contact",
          "street1": "Villardi 4-5",
          "street2": "Kassisaba",
          "cityCounty": "Tallinn",
          "stateRegion": "Harjumaa",
          "zip": "10136",
          "countryCode": "EE"
        }
      ]
    },
    "contractInfo": {
      "contractId": "ID-1000",
      "contractNumber": "KWR1044",
      "amounts": [
        {
          "contextTypeCode": "CURRENT_BALANCE",
          "contextDate": "2021-05-01",
          "money": {
            "amount": 1.22,
            "currencyCode": "EUR"
          },
          "balanceMoney": {
            "amount": 1.22,
            "currencyCode": "EUR"
          },
          "debtMoney": {
            "amount": 1.22,
            "currencyCode": "EUR"
          }
        }
      ]
    },
    "paymentInfo": {
      "referenceNumber": "00001234561",
      "dueDate": "2021-04-01"
    },
    "invoiceInfo": [
      {
        "invoiceId": "R000000001105",
        "invoiceNumber": "R000000001105",
        "billingDate": "2021-04-30",
        "dueDate": "2021-05-21",
        "money": {
          "amount": 1.22,
          "currencyCode": "EUR"
        },
        "debtMoney": {
          "amount": 1.22,
          "currencyCode": "EUR"
        }
      }
    ]
  }
}

AML processes

AML_PERSON_SUBPROCESS_CREATED
  • The AML API triggers the AML_PERSON_SUBPROCESS_CREATED event when a new person is created at Person API, and its status is set to PENDING.

  • Event parameters are eventTypeCode/routing_code: ext.aml-subprocess.waiting-for-external-provider-person.

AML_SUBPROCESS_CREATED
  • The AML API triggers the AML_SUBPROCESS_CREATED event when the payment AML subprocess starts and payment is set to WAITING_FOR_AML status.

  • Event parameters are eventTypeCode/routing_code: ext.aml.subprocess.created.

AML_SUBPROCESS_CREATED_COLLECTION
  • The AML API triggers the AML_SUBPROCESS_CREATED_COLLECTION event when the creation of the direct debit collection initiates AML service, and the AML subprocess sets the collection status to WAITING_FOR_EXTERNAL_PROVIDER.

  • Event parameters are eventTypeCode/routing_code: ext.aml.collection-subprocess.created.

AML_PAYMENT_TEMPLATE_SUBPROCESS_CREATED
  • The payment API triggers the AML_PAYMENT_TEMPLATE_SUBPROCESS_CREATED event when a payment template is created and the payment status is changed to WAITING_FOR_AML.

  • Event parameters are eventTypeCode/routing_code: ext.aml.payment-template-subprocess.created.

Note: This event only occurs if the AML_CHECK_PAYMENT_TEMPLATE system property is set to Yes and an external AML service provider is activated for the payment template screening.

AML_PAYMENT_RESULTS_PUBLISHED
  • The AML API triggers the AML_PAYMENT_RESULTS_PUBLISHED event when the payment AML process is completed, and the AML process status is set to APPROVED, DECLINED, or REVIEW.

  • Event parameters are eventTypeCode/routing_code: ext.aml-process.payment-results.published.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "AML_PERSON_SUBPROCESS_CREATED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-12-16T11:18:19.955Z",
  "data": {
    "messageDTime": "2022-07-08T09:04:37.108561Z",
    "amlProcessId": "ID-1000",
    "amlSubprocessId": "A000000001000",
    "personId": "ID-1000"
  }
}
{
  "notificationId": "ID-9999",
  "notificationTypeCode": "AML_SUBPROCESS_CREATED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-09-13T11:15:39.294Z",
  "data": {
    "messageDTime": "2022-07-08T09:04:37.108561Z",
    "amlProcessId": "ID-1000",
    "amlSubprocessId": "A000000001000",
    "paymentId": "PAYM-1000",
    "paymentTypeCode": "ACC2SEPA",
    "accountId": "ID-1000",
    "amount": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "directionCode": "OUT",
    "postingDate": "2022-07-08",
    "effectiveDate": "2022-07-08",
    "details": "TEST payment 123",
    "referenceNumber": "TEST payment 321",
    "statusCode": "WAITING_FOR_EXTERNAL_PROVIDER",
    "paymentParties": "Payment party information",
    "exchangeRate": "Exchange rate information",
    "initialBalance": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "transactionTypeCode": "OUT_PAYMENT_SETTLED",
    "feeTransactionTypeCode": "ACC2SEPA_FEE",
    "feeAmount": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "source": {
      "sourceName": "PAYMENT",
      "sourceRef": "ID-181922"
    },
    "residencyCountryCode": "EE",
    "endToEndId": "ID-1000",
    "contractSource": {
      "sourceName": "LOAN.CONTRACT",
      "sourceRef": "ID-181922",
      "contractNumber": "1122241515"
    },
    "paymentServiceProviderCode": "BC",
    "fxPaymentFlag": true,
    "fixedSide": "BUY",
    "coverAmount": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "paymentAmount": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "fxPaymentExchangeRate": 0.86,
    "paymentSchemeElements": "Payment scheme elements information",
    "purposeCode": "SALA",
    "preferredPaymentScheme": "SEPA_INSTANT",
    "selectedPaymentScheme": "SEPA_INSTANT"
  }
}
{
  "notificationId": "ID-9999",
  "notificationTypeCode": "AML_SUBPROCESS_CREATED_COLLECTION",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-12-16T11:38:42.706Z",
  "data": {
    "messageDTime": "2022-07-08T00:00:00Z",
    "amlProcessId": "ID-1000",
    "amlSubprocessId": "A000000001000",
    "collectionId": "ID-1000",
    "collectionTypeCode": "OUT_SEPA",
    "directionCode": "OUT",
    "statusCode": "WAITING_FOR_EXTERNAL_PROVIDER",
    "money": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "dueDate": "2022-07-08",
    "sequenceTypeCode": "FRST",
    "collectionDetails": "Details",
    "collectionReferenceNumber": "12345",
    "mandate": {
      "mandateReferenceNumber": "12345678",
      "mandateSignatureDate": "2022-07-08"
    },
    "creditorSchemeIdentification": "EE01285",
    "serviceProviderCode": "SEPA",
    "channelCode": "SYSTEM",
    "insertedDateTime": "2023-03-08T12:05:01.622775Z",
    "collectionSchemeCode": "SEPA",
    "source": {
      "sourceName": "PAYMENT",
      "sourceRef": "ID-181922"
    },
    "postingDate": "2022-07-08",
    "settlementDate": "2022-07-08",
    "requestDate": "2022-07-08",
    "collectionParties": [
      {
        "name": "Airport Hotel Gmbh",
        "typeCode": "CREDITOR",
        "accountNumber": {
          "value": "DE89370400440532013000",
          "type": "IBAN"
        },
        "accountNumberCountryCode": "EE",
        "financialInstitutionId": {
          "value": "MAINDE2XXXX",
          "type": "BIC"
        },
        "address": {
          "street1": "Hugo-Eckener-Ring 1",
          "street2": "Apartment Number 40",
          "cityCounty": "Frankfurt am Main",
          "stateRegion": "Hesse",
          "zip": "60549",
          "countryCode": "DE",
          "addressLine": "Hugo-Eckener-Ring 1, Frankfurt am Main, Hesse, 60549, Germany",
          "addressTypeCode": "R"
        },
        "accountId": "ID-1000",
        "personId": "ID-1000",
        "personTypeCode": "P"
      }
    ],
    "sepaScheme": "B2B",
    "residencyCountryCode": "EE",
    "instrumentCode": "PAYMENT.ACC2COLLECTION",
    "mandateId": "ID-1000"
  }
}
{
  "notificationId": "ID-9999",
  "notificationTypeCode": "AML_PAYMENT_TEMPLATE_SUBPROCESS_CREATED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-09-13T10:58:10.947Z",
  "data": {
    "messageDTime": "2022-07-08T09:04:37.108561Z",
    "amlProcessId": "ID-1000",
    "amlSubprocessId": "A000000001000",
    "accountId": "ID-1000",
    "amount": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "bankingDate": "2022-07-08",
    "details": "TEST payment 123",
    "paymentTypeCode": "ACC2SEPA",
    "referenceNumber": "TEST payment 321",
    "statusCode": "WAITING_FOR_AML",
    "templateId": "ID-1000",
    "templateName": "Lunch payment",
    "templateParties": "Payment template party information",
    "templateSchemeElements": "Payment template scheme elements information"
  }
}
{
  "notificationId": "ID-9999",
  "notificationTypeCode": "AML_PAYMENT_RESULTS_PUBLISHED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-09-13T11:06:32.924Z",
  "data": {
    "amlProcessId": "ID-1000",
    "amlProcessResultCode": "APPROVED",
    "subProcessResultReasons": "LEGAL_REASON, CODE_RED",
    "source": {
      "sourceName": "PAYMENT",
      "sourceRef": "ID-181922"
    }
  }
}

Processes

DAY_CHANGE_ENDED
  • The process engine Camunda triggers the DAY_CHANGE_ENDED event when it has completed the banking day change.

  • Event parameters are eventTypeCode/routing_code: ext.camunda.day-change.ended.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "DAY_CHANGE_ENDED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-12-17T08:36:10.489Z",
  "data": {
    "bankingDate": "2021-05-01"
  }
}

Reports

REPORT_GENERATED
  • The Reports API triggers the REPORT_GENERATED event whenever a report is created.

  • Event parameters are eventTypeCode/routing_code: ext.reports.generations.finished.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "REPORT_GENERATED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-12-17T08:30:17.778Z",
  "data": {
    "reportHeader": {
      "reportGroup": "FINANCE",
      "reportType": "SAP_REPORT",
      "generationId": "string",
      "generationDtime": "2021-02-23T08:32:33.0759819Z",
      "additionalData": {
        "additionalProp1": {},
        "additionalProp2": {},
        "additionalProp3": {}
      }
    },
    "reportInfo": {
      "Generated File ids": [
        "string"
      ],
      "File Ids": [
        "string"
      ]
    }
  }
}

Person

Person management

PERSON_CREATED
  • The person API triggers PERSON_CREATED event when a person is created at person details.

  • Event parameters are eventTypeCode/routing_code: ext.persons.created.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "PERSON_CREATED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "personId": "string",
    "givenName": "string",
    "middleName": "string",
    "surname": "string",
    "name": "string",
    "personTypeCode": "string",
    "birthDate": "2023-07-21",
    "registrationDate": "2023-07-21",
    "statusCode": "string",
    "statusCodeReason": "string",
    "email": "string",
    "phoneCountryCode": "string",
    "phoneNumber": "string",
    "residencyCountryCode": "string",
    "countryOfBirth": "string",
    "taxResidencyCountry": "string",
    "nationality": "string",
    "language": "string",
    "intraOrgCode": "string",
    "counterpartySectorCode": "string",
    "forgotten": true,
    "source": {
      "sourceName": "string",
      "sourceRef": "string",
      "sourceLink": "string"
    },
    "usResident": true,
    "pep": true
  }
}
PERSON_UPDATED
  • The person API triggers PERSON_UPDATED event when a person's status or details is changed.

  • Event parameters are eventTypeCode/routing_code: ext.persons.updated.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "PERSON_UPDATED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2025-05-16T13:10:54.172Z",
  "data": {
    "personId": "string",
    "givenName": "string",
    "middleName": "string",
    "surname": "string",
    "name": "string",
    "personTypeCode": "string",
    "birthDate": "2025-05-16",
    "registrationDate": "2025-05-16",
    "statusCode": "string",
    "statusCodeReason": "string",
    "email": "string",
    "phoneCountryCode": "string",
    "phoneNumber": "string",
    "residencyCountryCode": "string",
    "countryOfBirth": "string",
    "taxResidencyCountry": "string",
    "nationality": "string",
    "language": "string",
    "intraOrgCode": "string",
    "counterpartySectorCode": "string",
    "forgotten": true,
    "source": {
      "sourceName": "string",
      "sourceRef": "string",
      "sourceLink": "string"
    },
    "usResident": true,
    "pep": true,
    "pepExplanation": "string",
    "customerTypeCode": "string",
    "tenantCode": "string",
    "legalForm": "string",
    "creationDate": "2025-05-16",
    "dependantPersons": 0,
    "educationCode": "string",
    "maritalStatusCode": "string",
    "deathDate": "2025-05-16",
    "liquidationDate": "2025-05-16",
    "inactivationDate": "2025-05-16",
    "tradingName": "string",
    "webAddress": "string",
    "businessAreaCodes": [
      "string"
    ],
    "businessModelDescription": "string",
    "activityCode": "string",
    "employmentTimeCode": "string",
    "fixedEmploymentLength": "string",
    "buildingTypeCode": "string",
    "housingTypeCode": "string",
    "sex": "string",
    "moveInDate": "2025-05-16",
    "accessRestricted": true,
    "placeOfBirth": "string",
    "changedFields": [
      "string"
    ]
  }
}
PERSON_ID_NUMBER_CREATED
  • The person API triggers PERSON_ID_NUMBER_CREATED event when a person's id number is created at person details.

  • Event parameters are eventTypeCode/routing_code: ext.persons.id-numbers.created.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "PERSON_ID_NUMBER_CREATED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "idNumberId": "string",
    "personId": "string",
    "idNumber": "string",
    "idCountryCode": "string",
    "primary": true
  }
}
PERSON_ID_NUMBER_CHANGED
  • The person API triggers PERSON_ID_NUMBER_CHANGED event when a person's id number is changed at person details.

  • Event parameters are eventTypeCode/routing_code: ext.persons.id-numbers.updated.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "PERSON_ID_NUMBER_CHANGED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "idNumberId": "string",
    "personId": "string",
    "idNumber": "string",
    "idCountryCode": "string",
    "primary": true,
    "changedFields": [
      "string"
    ]
  }
}

Person document

PERSON_DOCUMENT_CREATED
  • The person API triggers PERSON_DOCUMENT_CREATED event when a person's document is created at person documents.

  • Event parameters are eventTypeCode/routing_code: ext.persons.documents.created.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "PERSON_DOCUMENT_CREATED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "docuID": "string",
    "personId": "string",
    "documentTypeCode": "string",
    "number": "string",
    "issuingCountry": "string",
    "expiryDate": "2023-07-21"
  }
}
PERSON_DOCUMENT_UPDATED
  • The person API triggers PERSON_DOCUMENT_UPDATED event when a person's document is updated at person documents.

  • Event parameters are eventTypeCode/routing_code: persons.documents.updated.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "PERSON_DOCUMENT_UPDATED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "personId": "string",
    "givenName": "string",
    "middleName": "string",
    "surname": "string",
    "name": "string",
    "personTypeCode": "string",
    "birthDate": "2023-07-21",
    "registrationDate": "2023-07-21",
    "statusCode": "string",
    "statusCodeReason": "string",
    "email": "string",
    "phoneCountryCode": "string",
    "phoneNumber": "string",
    "residencyCountryCode": "string",
    "countryOfBirth": "string",
    "taxResidencyCountry": "string",
    "nationality": "string",
    "language": "string",
    "intraOrgCode": "string",
    "counterpartySectorCode": "string",
    "forgotten": true,
    "source": {
      "sourceName": "string",
      "sourceRef": "string",
      "sourceLink": "string"
    },
    "usResident": true,
    "pep": true,
    "changedFields": [
      "string"
    ]
  }
}
PERSON_DOCUMENT_REMOVED
  • The person API triggers PERSON_DOCUMENT_REMOVED event when a person's document is removed at person documents.

  • Event parameters are eventTypeCode/routing_code: ext.persons.documents.deleted.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "PERSON_DOCUMENT_REMOVED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "docuId": "string",
    "personId": "string"
  }
}

Person address

PERSON_ADDRESS_CREATED
  • The person API triggers PERSON_ADDRESS_CREATED event when a person address is created at person details.

  • Event parameters are eventTypeCode/routing_code: ext.persons.addresses.created.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "PERSON_ADDRESS_CREATED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "addressId": "string",
    "personId": "string",
    "addressTypeCode": "string",
    "street1": "string",
    "street2": "string",
    "cityCounty": "string",
    "stateRegion": "string",
    "zip": "string",
    "countryCode": "string"
  }
}
PERSON_ADDRESS_UPDATED
  • The person API triggers PERSON_ADDRESS_UPDATED event when a person address is updated at person details.

  • Event parameters are eventTypeCode/routing_code: ext.persons.addresses.updated.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "PERSON_ADDRESS_UPDATED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "addressId": "string",
    "personId": "string",
    "addressTypeCode": "string",
    "street1": "string",
    "street2": "string",
    "cityCounty": "string",
    "stateRegion": "string",
    "zip": "string",
    "countryCode": "string",
    "changedFields": [
      "string"
    ]
  }
}
PERSON_ADDRESS_REMOVED
  • The person API triggers PERSON_ADDRESS_REMOVED event when a person address is deleted at person details.

  • Event parameters are eventTypeCode/routing_code: ext.persons.addresses.deleted.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "PERSON_ADDRESS_REMOVED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "personId": "string",
    "addressId": "string"
  }
}

Person additional contact

PERSON_ADDITIONAL_CONTACT_CREATED
  • The person API triggers PERSON_ADDITIONAL_CONTACT_CREATED event when an additional contact is created at person details.

  • Event parameters are eventTypeCode/routing_code: ext.persons.additional-contacts.created.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "PERSON_ADDITIONAL_CONTACT_CREATED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "personId": "string",
    "source": {
      "sourceName": "string",
      "sourceRef": "string",
      "sourceLink": "string"
    },
    "replacedId": "string"
  }
}
PERSON_ADDITIONAL_CONTACT_UPDATED
  • The person API triggers PERSON_ADDITIONAL_CONTACT_UPDATED event when an additional contact is updated at person details.

  • Event parameters are eventTypeCode/routing_code: ext.persons.additional-contacts.updated.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "PERSON_ADDITIONAL_CONTACT_UPDATED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-07-17T09:43:44.993Z",
  "data": {
    "personId": "string",
    "source": {
      "sourceName": "string",
      "sourceRef": "string"
    },
    "replacedId": "string"
  }
}
PERSON_ADDITIONAL_CONTACT_DELETED
  • The person API triggers PERSON_ADDITIONAL_CONTACT_DELETED event when an additional contact is deleted at person details.

  • Event parameters are eventTypeCode/routing_code: ext.persons.additional-contacts.deleted.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "PERSON_ADDITIONAL_CONTACT_DELETED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-07-17T09:47:05.470Z",
  "data": {
    "personId": "string",
    "source": {
      "sourceName": "string",
      "sourceRef": "string"
    },
    "replacedId": "string"
  }
}

Person relationship

PERSON_RELATIONSHIP_CREATED
  • The person API triggers PERSON_RELATIONSHIP_CREATED event when a person relationship is created at person details.

  • Event parameters are eventTypeCode/routing_code: ext.persons.relationships.created.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "PERSON_RELATIONSHIP_CREATED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "personRelationshipId": "string",
    "personId": "string",
    "parentPersonId": "string",
    "relationTypeCode": "string",
    "statusCode": "string",
    "percentageOfShares": 0,
    "percentageOfSignature": 0,
    "representingRange": {
      "startDate": "2023-07-21",
      "endDate": "2023-07-21"
    },
    "beneficiary": true
  }
}
PERSON_RELATIONSHIP_CHANGED
  • The person API triggers PERSON_RELATIONSHIP_CHANGED event when a person relationship is changed at person details.

  • Event parameters are eventTypeCode/routing_code: ext.persons.relationships.updated.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "PERSON_RELATIONSHIP_CHANGED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "personRelationshipId": "string",
    "personId": "string",
    "parentPersonId": "string",
    "relationTypeCode": "string",
    "statusCode": "string",
    "percentageOfShares": 0,
    "percentageOfSignature": 0,
    "representingRange": {
      "startDate": "2023-07-21",
      "endDate": "2023-07-21"
    },
    "changedFields": [
      "string"
    ],
    "beneficiary": true
  }
}
PERSON_RELATIONSHIP_REMOVED
  • The person API triggers PERSON_RELATIONSHIP_REMOVED event when a person relationship is deleted at person details.

  • Event parameters are eventTypeCode/routing_code: ext.persons.relationships.deleted.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "PERSON_RELATIONSHIP_REMOVED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "personRelationshipId": "string",
    "personId": "string"
  }
}

Person tax number

PERSON_TAX_NUMBER_CREATED
  • The person API triggers PERSON_TAX_NUMBER_CREATED event when a person tax number is created at person details.

  • Event parameters are eventTypeCode/routing_code: ext.persons.tax-numbers.updated.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "PERSON_TAX_NUMBER_CREATED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "taxNumberId": "string",
    "personId": "string",
    "taxNumberTypeCode": "string",
    "taxNumber": "string",
    "taxCountryCode": "string",
    "primary": true
  }
}
PERSON_TAX_NUMBER_CHANGED
  • The person API triggers PERSON_TAX_NUMBER_CHANGED event when a person tax number is changed at person details.

  • Event parameters are eventTypeCode/routing_code: ext.persons.tax-numbers.updated.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "PERSON_TAX_NUMBER_CHANGED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "taxNumberId": "string",
    "personId": "string",
    "taxNumberTypeCode": "string",
    "taxNumber": "string",
    "taxCountryCode": "string",
    "primary": true,
    "changedFields": [
      "string"
    ]
  }
}

Person group

PERSON_PERSON_GROUP_CREATED
  • The person API triggers PERSON_PERSON_GROUP_CREATED event when a person group is created at person API.

  • Event parameters are eventTypeCode/routing_code: ext.persons.person-groups.created.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "PERSON_PERSON_GROUP_CREATED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "personId": "string",
    "personGroupId": "string",
    "personGroupCode": "string"
  }
}
PERSON_PERSON_GROUP_REMOVED
  • The person API triggers PERSON_PERSON_GROUP_REMOVED event when a person group is deleted at person API.

  • Event parameters are eventTypeCode/routing_code: ext.persons.person-groups.deleted.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "PERSON_PERSON_GROUP_REMOVED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "personId": "string",
    "personGroupId": "string",
    "personGroupCode": "string"
  }
}

Person risk

PERSON_RISK_CREATED
  • The person API triggers PERSON_RISK_CREATED event when a person risk is created at person API.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "PERSON_RISK_CREATED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2025-05-16T13:16:42.575Z",
  "data": {
    "date": "2025-05-16",
    "personId": "string",
    "riskId": "string",
    "riskLevelCode": "string",
    "riskTypeCode": "string",
    "source": {
      "sourceName": "string",
      "sourceRef": "string",
      "sourceLink": "string"
    },
    "validityRange": {
      "startTime": "2025-05-16T13:16:42.575Z",
      "endTime": "2025-05-16T13:16:42.575Z"
    },
    "value": 0
  }
}
PERSON_RISK_DELETED
  • The person API triggers PERSON_RISK_DELETED event when a person risk is deleted at person API.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "PERSON_RISK_DELETED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2025-05-16T13:18:33.425Z",
  "data": {
    "date": "2025-05-16",
    "personId": "string",
    "riskId": "string",
    "riskLevelCode": "string",
    "riskTypeCode": "string",
    "source": {
      "sourceName": "string",
      "sourceRef": "string",
      "sourceLink": "string"
    },
    "validityRange": {
      "startTime": "2025-05-16T13:18:33.425Z",
      "endTime": "2025-05-16T13:18:33.425Z"
    },
    "value": 0
  }
}

Person custom field

PERSON_CUSTOM_FIELD_CHANGED
  • The person API triggers PERSON_CUSTOM_FIELD_CHANGED event if a new custom field value inserted or updated.

  • Event parameters are eventTypeCode/routing_code: ext.persons.custom-fields.fields.changed.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "PERSON_CUSTOM_FIELD_CHANGED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "source": {
      "sourceName": "string",
      "sourceRef": "string",
      "sourceLink": "string"
    },
    "values": [
      {
        "fieldSetId": "PAYMENT_RIGHTS",
        "fieldId": "PAYMENT_SIGNATURE_WEIGHT",
        "valueType": "NUMBER",
        "fieldValue": "100"
      }
    ]
  }
}
PERSON_CUSTOM_FIELD_REMOVED
  • The person API triggers PERSON_CUSTOM_FIELD_REMOVED event if a new custom field value deleted.

  • Event parameters are eventTypeCode/routing_code: ext.persons.custom-fields.fields.deleted.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "PERSON_CUSTOM_FIELD_REMOVED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "source": {
      "sourceName": "string",
      "sourceRef": "string",
      "sourceLink": "string"
    },
    "values": [
      {
        "fieldSetId": "PAYMENT_RIGHTS",
        "fieldId": "PAYMENT_SIGNATURE_WEIGHT"
      }
    ]
  }
}

Finance

Finance management

JOURNAL_CREATED
  • The finance API triggers a JOURNAL_CREATED event when a journal is generated and ready for an external system to upload.

  • Event parameters are eventTypeCode/routing_code: ext.finances.journals.created.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "JOURNAL_CREATED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-12-17T08:13:35.145Z",
  "data": {
    "journalId": "ID-1000000001",
    "journalProcessId": "ID-1000000001",
    "statusCode": "CREATED",
    "journalDate": "2023-02-22",
    "tenantCode": "MB",
    "refNumber": "ID-1000000001",
    "ledgerType": "BALANCE",
    "transactionCurrency": "EUR"
  }
}

Deposit

Deposit management

DEPOSIT_EVENT_CREATED
  • The deposit API triggers the DEPOSIT_EVENT_CREATED event if any of the deposit creation-related events is created (for example, INTEREST_INCREASE or FUND_DEPOSIT).

  • Event parameters are eventTypeCode/routing_code: ext.deposits.events.created.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "DEPOSIT_EVENT_CREATED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "eventId": "string",
    "headerId": "string",
    "versionId": "string",
    "componentTypeCode": "string",
    "eventTypeCode": "string",
    "postingDate": "2023-07-21",
    "valueDate": "2023-07-21",
    "initialBalanceMoney": {
      "amount": 0,
      "currencyCode": "str"
    },
    "eventMoney": {
      "amount": 0,
      "currencyCode": "str"
    },
    "balanceDirectionCode": "string",
    "details": "string",
    "source": {
      "sourceName": "string",
      "sourceRef": "string",
      "sourceLink": "string"
    },
    "countryCode": "string",
    "depositGroupCode": "string",
    "depositClassCode": "string",
    "contractNumber": "string",
    "bankingDate": "2023-07-21",
    "eventDTime": "2023-07-21T07:47:15.254Z",
    "reversedEventId": "string"
  }
}
DEPOSIT_OFFER_PRESENTED_V2
  • The deposit API triggers the DEPOSIT_OFFER_PRESENTED_V2 event when a deposit offer is presented, and its status is set to PRESENTED.

  • Event parameters are eventTypeCode/routing_code: ext.deposits.offersV2.presented.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "DEPOSIT_OFFER_PRESENTED_V2",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-08-14T07:01:05.142Z",
  "data": {
    "interestRate": 0,
    "groupable": true,
    "taxExempt": true,
    "period": 0,
    "bankingDate": "2024-08-14",
    "endDate": "2024-08-14",
    "lastValidDate": "2024-08-14",
    "maturityDate": "2024-08-14",
    "postingDate": "2024-08-14",
    "offeredMoney": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "returnMoney": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "messageDTime": "2024-08-14T07:01:05.142Z",
    "accountId": "string",
    "applicationId": "string",
    "channelCode": "string",
    "countryCode": "string",
    "depositTypeCode": "string",
    "interestPaymentFreqCode": "string",
    "offerId": "string",
    "periodTypeCode": "string",
    "personId": "string",
    "personTypeCode": "string",
    "prolongationCode": "string",
    "reasonCode": "string",
    "statusCode": "string",
    "taxResidencyCountryCode": "string",
    "tenantCode": "string",
    "uniqueId": "string"
  }
}

Deposit contract

DEPOSIT_CONTRACT_ACTIVATED_V2
  • The deposit API triggers the DEPOSIT_CONTRACT_ACTIVATED_V2 event when a deposit contract is activated, and its status is set to ACTIVE.

  • Event parameters are eventTypeCode/routing_code: ext.deposits.contractsV2.activated.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "DEPOSIT_CONTRACT_ACTIVATED_V2",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-08-14T06:15:21.415Z",
  "data": {
    "contractId": "string",
    "personId": "string",
    "offerId": "string",
    "depositTypeCode": "string",
    "contractNumber": "string",
    "accountId": "string",
    "bankingDate": "2024-08-14",
    "countryCode": "string",
    "channelCode": "string",
    "tenantCode": "string",
    "activationDate": "2024-08-14",
    "closingDate": "2024-08-14",
    "personTypeCode": "string",
    "taxExempt": true,
    "taxResidencyCountryCode": "string",
    "activeVersion": {
      "contractId": "string",
      "versionId": "string",
      "statusCode": "string",
      "versionNumber": 0,
      "preparationDate": "2024-08-14",
      "signingDate": "2024-08-14",
      "activationDate": "2024-08-14",
      "endDate": "2024-08-14",
      "period": 0,
      "periodTypeCode": "string",
      "closingDate": "2024-08-14",
      "interestRate": 0,
      "prolongInterestRate": 0,
      "interestPaymentFrequencyCode": "string",
      "prolongationCode": "string",
      "countryCode": "string",
      "cancelReasonCode": "string",
      "lastSigningDate": "2024-08-14",
      "lastCreditReceiveDate": "2024-08-14",
      "changeTypeCode": "string",
      "totalInterestMoney": {
        "amount": 1.22,
        "currencyCode": "EUR"
      },
      "channelCode": "string",
      "tenantCode": "string",
      "terminationType": "string",
      "payoutDetails": {
        "name": "string",
        "accountNumber": {
          "value": "DE89370400440532013000",
          "type": "IBAN"
        },
        "accountNumberCountryCode": "string",
        "financialInstitutionId": {
          "value": "MAINDE2XXXX",
          "type": "BIC"
        },
        "referenceNumber": "string"
      },
      "components": [
        {
          "componentId": "string",
          "versionId": "string",
          "componentTypeCode": "string",
          "initialMoney": {
            "amount": 1.22,
            "currencyCode": "EUR"
          },
          "balanceMoney": {
            "amount": 1.22,
            "currencyCode": "EUR"
          },
          "calculationMethod": {
            "daysInMonth": "string",
            "daysInYear": 0
          },
          "rateBaseCode": "string",
          "rate": 0,
          "accruedUntil": "2024-08-14",
          "paymentDay": 0,
          "paymentInterval": 0,
          "baseInvalidFromDate": "2024-08-14"
        }
      ]
    }
  }
}
DEPOSIT_CONTRACT_PROLONGED_V2
  • The deposit API triggers the DEPOSIT_CONTRACT_PROLONGED_V2 event when a deposit contract is prolonged, and its status is set to PROLONGED.

  • Event parameters are eventTypeCode/routing_code: ext.deposits.contractsV2.prolonged.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "DEPOSIT_CONTRACT_PROLONGED_V2",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-08-14T06:31:37.763Z",
  "data": {
    "contractId": "string",
    "personId": "string",
    "offerId": "string",
    "depositTypeCode": "string",
    "contractNumber": "string",
    "accountId": "string",
    "bankingDate": "2024-08-14",
    "countryCode": "string",
    "channelCode": "string",
    "tenantCode": "string",
    "activationDate": "2024-08-14",
    "closingDate": "2024-08-14",
    "personTypeCode": "string",
    "taxExempt": true,
    "taxResidencyCountryCode": "string",
    "activeVersion": {
      "contractId": "string",
      "versionId": "string",
      "statusCode": "string",
      "versionNumber": 0,
      "preparationDate": "2024-08-14",
      "signingDate": "2024-08-14",
      "activationDate": "2024-08-14",
      "endDate": "2024-08-14",
      "period": 0,
      "periodTypeCode": "string",
      "closingDate": "2024-08-14",
      "interestRate": 0,
      "prolongInterestRate": 0,
      "interestPaymentFrequencyCode": "string",
      "prolongationCode": "string",
      "countryCode": "string",
      "cancelReasonCode": "string",
      "lastSigningDate": "2024-08-14",
      "lastCreditReceiveDate": "2024-08-14",
      "changeTypeCode": "string",
      "totalInterestMoney": {
        "amount": 1.22,
        "currencyCode": "EUR"
      },
      "channelCode": "string",
      "tenantCode": "string",
      "terminationType": "string",
      "payoutDetails": {
        "name": "string",
        "accountNumber": {
          "value": "DE89370400440532013000",
          "type": "IBAN"
        },
        "accountNumberCountryCode": "string",
        "financialInstitutionId": {
          "value": "MAINDE2XXXX",
          "type": "BIC"
        },
        "referenceNumber": "string"
      },
      "components": [
        {
          "componentId": "string",
          "versionId": "string",
          "componentTypeCode": "string",
          "initialMoney": {
            "amount": 1.22,
            "currencyCode": "EUR"
          },
          "balanceMoney": {
            "amount": 1.22,
            "currencyCode": "EUR"
          },
          "calculationMethod": {
            "daysInMonth": "string",
            "daysInYear": 0
          },
          "rateBaseCode": "string",
          "rate": 0,
          "accruedUntil": "2024-08-14",
          "paymentDay": 0,
          "paymentInterval": 0,
          "baseInvalidFromDate": "2024-08-14"
        }
      ]
    }
  }
}
DEPOSIT_CONTRACT_TERMINATED_V2
  • The deposit API triggers the DEPOSIT_CONTRACT_TERMINATED_V2 event when a deposit contract is terminated, and its status is set to TERMINATED.

  • Event parameters are eventTypeCode/routing_code: ext.deposits.contractsV2.terminated.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "DEPOSIT_CONTRACT_TERMINATED_V2",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-08-14T06:38:50.424Z",
  "data": {
    "contractId": "string",
    "personId": "string",
    "offerId": "string",
    "depositTypeCode": "string",
    "contractNumber": "string",
    "accountId": "string",
    "bankingDate": "2024-08-14",
    "countryCode": "string",
    "channelCode": "string",
    "tenantCode": "string",
    "activationDate": "2024-08-14",
    "closingDate": "2024-08-14",
    "personTypeCode": "string",
    "taxExempt": true,
    "taxResidencyCountryCode": "string",
    "activeVersion": {
      "contractId": "string",
      "versionId": "string",
      "statusCode": "string",
      "versionNumber": 0,
      "preparationDate": "2024-08-14",
      "signingDate": "2024-08-14",
      "activationDate": "2024-08-14",
      "endDate": "2024-08-14",
      "period": 0,
      "periodTypeCode": "string",
      "closingDate": "2024-08-14",
      "interestRate": 0,
      "prolongInterestRate": 0,
      "interestPaymentFrequencyCode": "string",
      "prolongationCode": "string",
      "countryCode": "string",
      "cancelReasonCode": "string",
      "lastSigningDate": "2024-08-14",
      "lastCreditReceiveDate": "2024-08-14",
      "changeTypeCode": "string",
      "totalInterestMoney": {
        "amount": 1.22,
        "currencyCode": "EUR"
      },
      "channelCode": "string",
      "tenantCode": "string",
      "terminationType": "string",
      "payoutDetails": {
        "name": "string",
        "accountNumber": {
          "value": "DE89370400440532013000",
          "type": "IBAN"
        },
        "accountNumberCountryCode": "string",
        "financialInstitutionId": {
          "value": "MAINDE2XXXX",
          "type": "BIC"
        },
        "referenceNumber": "string"
      },
      "components": [
        {
          "componentId": "string",
          "versionId": "string",
          "componentTypeCode": "string",
          "initialMoney": {
            "amount": 1.22,
            "currencyCode": "EUR"
          },
          "balanceMoney": {
            "amount": 1.22,
            "currencyCode": "EUR"
          },
          "calculationMethod": {
            "daysInMonth": "string",
            "daysInYear": 0
          },
          "rateBaseCode": "string",
          "rate": 0,
          "accruedUntil": "2024-08-14",
          "paymentDay": 0,
          "paymentInterval": 0,
          "baseInvalidFromDate": "2024-08-14"
        }
      ]
    }
  }
}
DEPOSIT_CONTRACT_CLOSED_V2
  • The deposit API triggers the DEPOSIT_CONTRACT_CLOSED_V2 event when a deposit contract is closed, and its status is set to CLOSED.

  • Event parameters are eventTypeCode/routing_code: ext.deposits.contractsV2.closed.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "DEPOSIT_CONTRACT_CLOSED_V2",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-08-14T06:25:39.174Z",
  "data": {
    "contractId": "string",
    "personId": "string",
    "offerId": "string",
    "depositTypeCode": "string",
    "contractNumber": "string",
    "accountId": "string",
    "bankingDate": "2024-08-14",
    "countryCode": "string",
    "channelCode": "string",
    "tenantCode": "string",
    "activationDate": "2024-08-14",
    "closingDate": "2024-08-14",
    "personTypeCode": "string",
    "taxExempt": true,
    "taxResidencyCountryCode": "string",
    "activeVersion": {
      "contractId": "string",
      "versionId": "string",
      "statusCode": "string",
      "versionNumber": 0,
      "preparationDate": "2024-08-14",
      "signingDate": "2024-08-14",
      "activationDate": "2024-08-14",
      "endDate": "2024-08-14",
      "period": 0,
      "periodTypeCode": "string",
      "closingDate": "2024-08-14",
      "interestRate": 0,
      "prolongInterestRate": 0,
      "interestPaymentFrequencyCode": "string",
      "prolongationCode": "string",
      "countryCode": "string",
      "cancelReasonCode": "string",
      "lastSigningDate": "2024-08-14",
      "lastCreditReceiveDate": "2024-08-14",
      "changeTypeCode": "string",
      "totalInterestMoney": {
        "amount": 1.22,
        "currencyCode": "EUR"
      },
      "channelCode": "string",
      "tenantCode": "string",
      "terminationType": "string",
      "payoutDetails": {
        "name": "string",
        "accountNumber": {
          "value": "DE89370400440532013000",
          "type": "IBAN"
        },
        "accountNumberCountryCode": "string",
        "financialInstitutionId": {
          "value": "MAINDE2XXXX",
          "type": "BIC"
        },
        "referenceNumber": "string"
      },
      "components": [
        {
          "componentId": "string",
          "versionId": "string",
          "componentTypeCode": "string",
          "initialMoney": {
            "amount": 1.22,
            "currencyCode": "EUR"
          },
          "balanceMoney": {
            "amount": 1.22,
            "currencyCode": "EUR"
          },
          "calculationMethod": {
            "daysInMonth": "string",
            "daysInYear": 0
          },
          "rateBaseCode": "string",
          "rate": 0,
          "accruedUntil": "2024-08-14",
          "paymentDay": 0,
          "paymentInterval": 0,
          "baseInvalidFromDate": "2024-08-14"
        }
      ]
    }
  }
}

Deposit custom field

DEPOSIT_CUSTOM_FIELD_CHANGED
  • The deposit API triggers the DEPOSIT_CUSTOM_FIELD_CHANGED event if a new custom field value inserted or updated.

  • Event parameters are eventTypeCode/routing_code: ext.deposits.custom-fields.fields.changed.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "DEPOSIT_CUSTOM_FIELD_CHANGED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "source": {
      "sourceName": "string",
      "sourceRef": "string",
      "sourceLink": "string"
    },
    "values": [
      {
        "fieldSetId": "PAYMENT_RIGHTS",
        "fieldId": "PAYMENT_SIGNATURE_WEIGHT",
        "valueType": "NUMBER",
        "fieldValue": "100"
      }
    ]
  }

}
DEPOSIT_CUSTOM_FIELD_REMOVED
  • The deposit API triggers the DEPOSIT_CUSTOM_FIELD_REMOVED event if a new custom field value deleted.

  • Event parameters are eventTypeCode/routing_code: ext.deposits.custom-fields.fields.deleted.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "DEPOSIT_CUSTOM_FIELD_REMOVED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "source": {
      "sourceName": "string",
      "sourceRef": "string",
      "sourceLink": "string"
    },
    "values": [
      {
        "fieldSetId": "PAYMENT_RIGHTS",
        "fieldId": "PAYMENT_SIGNATURE_WEIGHT"
      }
    ]
  }
}

Account

Account application

ACCOUNT_APPLICATION_CREATED
  • The account API triggers ACCOUNT_APPLICATION_CREATED event when a new account application is inserted, and its status is set to INSERTED.

  • Event parameters are eventTypeCode/routing_code: ext.accounts.applications.inserted.

Webhook content
{
  "notificationId": "ID-9999",
  "notificationTypeCode": "ACCOUNT_APPLICATION_CREATED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-06-03T06:34:00.008Z",
  "data": {
    "applicationId": "ID-1619523027",
    "personId": "ID-1048",
    "applicationDate": "2021-06-30",
    "serviceProviderCode": "LHV",
    "bankingDate": "2021-05-12",
    "accountTypeCode": "CURRENCY",
    "accountTypeSetupCode": "EXTERNAL_VIRTUAL",
    "statusCode": "INSERTED",
    "statusReasonCode": "ON_HOLD"
  }
}
ACCOUNT_APPLICATION_CONFIRMED
  • The account API triggers ACCOUNT_APPLICATION_CONFIRMED event when an account application is prepared, and its status is set to PREPARED.

  • Event parameters are eventTypeCode/routing_code: ext.accounts.applications.prepared.

Webhook content
{
  "notificationId": "ID-9999",
  "notificationTypeCode": "ACCOUNT_APPLICATION_CONFIRMED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-06-03T06:36:14.298Z",
  "data": {
    "applicationId": "ID-1619523027",
    "personId": "ID-1048",
    "applicationDate": "2021-06-30",
    "serviceProviderCode": "LHV",
    "bankingDate": "2021-05-12",
    "accountTypeCode": "CURRENCY",
    "accountTypeSetupCode": "EXTERNAL_VIRTUAL",
    "statusCode": "PREPARED",
    "statusReasonCode": "ON_HOLD"
  }
}
ACCOUNT_APPLICATION_PENDING
  • The account API triggers ACCOUNT_APPLICATION_PENDING event when an account application is pended, and its status is set to PENDING.

  • Event parameters are eventTypeCode/routing_code: ext.accounts.applications.pending

Webhook content
{
  "notificationId": "ID-9999",
  "notificationTypeCode": "ACCOUNT_APPLICATION_PENDING",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-06-03T06:49:36.193Z",
  "data": {
    "applicationId": "ID-1619523027",
    "personId": "ID-1048",
    "applicationDate": "2021-06-30",
    "serviceProviderCode": "LHV",
    "bankingDate": "2021-05-12",
    "accountTypeCode": "CURRENCY",
    "accountTypeSetupCode": "EXTERNAL_VIRTUAL",
    "statusCode": "PENDING",
    "statusReasonCode": "ON_HOLD"
  }
}
ACCOUNT_APPLICATION_ACCEPTED
  • The account API triggers ACCOUNT_APPLICATION_ACCEPTED event when an account application is accepted, and its status is set to ACCEPTED.

  • Event parameters are eventTypeCode/routing_code: ext.accounts.applications.accepted

Webhook content
{
  "notificationId": "ID-9999",
  "notificationTypeCode": "ACCOUNT_APPLICATION_ACCEPTED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-06-03T06:05:22.293Z",
  "data": {
    "applicationId": "ID-1619523027",
    "personId": "ID-1048",
    "applicationDate": "2021-06-30",
    "serviceProviderCode": "LHV",
    "bankingDate": "2021-05-12",
    "accountTypeCode": "CURRENCY",
    "accountTypeSetupCode": "EXTERNAL_VIRTUAL",
    "statusCode": "ACCEPTED",
    "statusReasonCode": "ON_HOLD"
  }
}
ACCOUNT_APPLICATION_CANCELLED
  • The account API triggers ACCOUNT_APPLICATION_CANCELLED event when an account application is canceled, and its status is set to CANCELLED.

  • Event parameters are eventTypeCode/routing_code: ext.accounts.applications.cancelled

Webhook content
{
  "notificationId": "ID-9999",
  "notificationTypeCode": "ACCOUNT_APPLICATION_CANCELLED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-06-03T06:27:18.115Z",
  "data": {
    "applicationId": "ID-1619523027",
    "personId": "ID-1048",
    "applicationDate": "2021-06-30",
    "serviceProviderCode": "LHV",
    "bankingDate": "2021-05-12",
    "accountTypeCode": "CURRENCY",
    "accountTypeSetupCode": "EXTERNAL_VIRTUAL",
    "statusCode": "CANCELLED",
    "statusReasonCode": "ON_HOLD"
  }
}
ACCOUNT_APPLICATION_REJECTED
  • The account API triggers ACCOUNT_APPLICATION_REJECTED event when an account application is rejected, and its status is set to REJECTED.

  • Event parameters are eventTypeCode/routing_code: ext.accounts.applications.rejected.

Webhook content
{
  "notificationId": "ID-9999",
  "notificationTypeCode": "ACCOUNT_APPLICATION_REJECTED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-06-03T06:58:09.062Z",
  "data": {
    "applicationId": "ID-1619523027",
    "personId": "ID-1048",
    "applicationDate": "2021-06-30",
    "serviceProviderCode": "LHV",
    "bankingDate": "2021-05-12",
    "accountTypeCode": "CURRENCY",
    "accountTypeSetupCode": "EXTERNAL_VIRTUAL",
    "statusCode": "REJECTED",
    "statusReasonCode": "ON_HOLD"
  }
}
ACCOUNT_APPLICATION_PROCESSED
  • The account API triggers ACCOUNT_APPLICATION_PROCESSED event when an account application is processed, and its status is set to PROCESSED.

  • Event parameters are eventTypeCode/routing_code: ext.accounts.applications.processed.

Webhook content
{
  "notificationId": "ID-9999",
  "notificationTypeCode": "ACCOUNT_APPLICATION_PROCESSED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-06-03T06:54:43.887Z",
  "data": {
    "applicationId": "ID-1619523027",
    "personId": "ID-1048",
    "applicationDate": "2021-06-30",
    "serviceProviderCode": "LHV",
    "bankingDate": "2021-05-12",
    "accountTypeCode": "CURRENCY",
    "accountTypeSetupCode": "EXTERNAL_VIRTUAL",
    "statusCode": "PROCESSED",
    "statusReasonCode": "ON_HOLD"
  }
}

Account management

ACCOUNT_CREATED
  • The account API triggers ACCOUNT_CREATED event when a new account is created, and its status is set to CREATED.

  • Event parameters are eventTypeCode/routing_code: ext.accounts.created.

Webhook content
{
  "notificationId": "ID-9999",
  "notificationTypeCode": "ACCOUNT_CREATED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2025-05-16T11:09:45.310Z",
  "data": {
    "accountId": "ID-9999",
    "personId": "ID-6969",
    "personName": "Peter Alexander Schmidt",
    "customerGroupCode": "string",
    "personTypeCode": "string",
    "accountTypeCode": "CURRENCY",
    "accountClassCode": "SAFEGUARDING",
    "accountTypeSetupCode": "EXTERNAL_VIRTUAL",
    "statusCode": "ACTIVE",
    "accountName": "My currency account",
    "iban": "EE10101019299",
    "bic": "HABAEE2X",
    "defaultCurrencyCode": "EUR",
    "countryCode": "EE",
    "taxResidencyCountryCode": "DE",
    "jurisdictionCountryCode": "ES",
    "activationDate": "2021-06-30",
    "bankingDate": "2021-05-12",
    "masterAccountId": "ID-9998",
    "source": {
      "sourceName": "string",
      "sourceRef": "string"
    },
    "tenantCode": "MB.EU",
    "serviceProviderCode": "TUUM",
    "interestMethodAssignmentCode": "EXTRA15",
    "intraOrgCode": "Schmidt inc.",
    "insertedBy": "Mary Smith",
    "accessRestricted": false,
    "statusReasonCode": "C01"
  }
}
ACCOUNT_ACTIVATED
  • The account API triggers ACCOUNT_ACTIVATED event when a new account is activated, and its status is set to ACTIVE.

  • Event parameters are eventTypeCode/routing_code: ext.accounts.activated.

Webhook content
{
  "notificationId": "ID-9999",
  "notificationTypeCode": "ACCOUNT_ACTIVATED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2025-05-16T11:15:21.289Z",
  "data": {
    "accountId": "ID-9999",
    "personId": "ID-6969",
    "personName": "Peter Alexander Schmidt",
    "customerGroupCode": "string",
    "personTypeCode": "string",
    "accountTypeCode": "CURRENCY",
    "accountClassCode": "SAFEGUARDING",
    "accountTypeSetupCode": "EXTERNAL_VIRTUAL",
    "statusCode": "ACTIVE",
    "accountName": "My currency account",
    "iban": "EE10101019299",
    "bic": "HABAEE2X",
    "defaultCurrencyCode": "EUR",
    "countryCode": "EE",
    "taxResidencyCountryCode": "DE",
    "jurisdictionCountryCode": "ES",
    "activationDate": "2021-06-30",
    "bankingDate": "2021-05-12",
    "masterAccountId": "ID-9998",
    "source": {
      "sourceName": "string",
      "sourceRef": "string"
    },
    "tenantCode": "MB.EU",
    "serviceProviderCode": "TUUM",
    "interestMethodAssignmentCode": "EXTRA15",
    "intraOrgCode": "Schmidt inc.",
    "insertedBy": "Mary Smith",
    "accessRestricted": false,
    "statusReasonCode": "C01"
  }
}
ACCOUNT_CHANGED
  • The account-API triggers the ACCOUNT_CHANGED event if account details have been changed. For example, changing the interest method, account access, class code, and other similar changes.

  • Event parameters are eventTypeCode/routing_code: ext.accounts.changed.

Webhook content
{
  "notificationId": "ID-9999",
  "notificationTypeCode": "ACCOUNT_CHANGED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2025-05-16T11:16:30.390Z",
  "data": {
    "accountId": "ID-9999",
    "personId": "ID-6969",
    "personName": "Peter Alexander Schmidt",
    "customerGroupCode": "string",
    "personTypeCode": "string",
    "accountTypeCode": "CURRENCY",
    "accountClassCode": "SAFEGUARDING",
    "accountTypeSetupCode": "EXTERNAL_VIRTUAL",
    "statusCode": "ACTIVE",
    "accountName": "My currency account",
    "iban": "EE10101019299",
    "bic": "HABAEE2X",
    "defaultCurrencyCode": "EUR",
    "countryCode": "EE",
    "taxResidencyCountryCode": "DE",
    "jurisdictionCountryCode": "ES",
    "activationDate": "2021-06-30",
    "bankingDate": "2021-05-12",
    "masterAccountId": "ID-9998",
    "source": {
      "sourceName": "string",
      "sourceRef": "string"
    },
    "tenantCode": "MB.EU",
    "serviceProviderCode": "TUUM",
    "interestMethodAssignmentCode": "EXTRA15",
    "intraOrgCode": "Schmidt inc.",
    "insertedBy": "Mary Smith",
    "accessRestricted": false,
    "statusReasonCode": "C01"
  }
}
ACCOUNT_BLOCKED
  • The account API triggers ACCOUNT_BLOCKED event when an account is blocked, and its status is set to BLOCKED.

  • Event parameters are eventTypeCode/routing_code: ext.accounts.blocked.

Webhook content
{
  "notificationId": "ID-9999",
  "notificationTypeCode": "ACCOUNT_BLOCKED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2025-05-16T11:17:24.712Z",
  "data": {
    "accountId": "ID-9999",
    "personId": "ID-6969",
    "personName": "Peter Alexander Schmidt",
    "customerGroupCode": "string",
    "personTypeCode": "string",
    "accountTypeCode": "CURRENCY",
    "accountClassCode": "SAFEGUARDING",
    "accountTypeSetupCode": "EXTERNAL_VIRTUAL",
    "statusCode": "ACTIVE",
    "accountName": "My currency account",
    "iban": "EE10101019299",
    "bic": "HABAEE2X",
    "defaultCurrencyCode": "EUR",
    "countryCode": "EE",
    "taxResidencyCountryCode": "DE",
    "jurisdictionCountryCode": "ES",
    "activationDate": "2021-06-30",
    "bankingDate": "2021-05-12",
    "masterAccountId": "ID-9998",
    "source": {
      "sourceName": "string",
      "sourceRef": "string"
    },
    "tenantCode": "MB.EU",
    "serviceProviderCode": "TUUM",
    "interestMethodAssignmentCode": "EXTRA15",
    "intraOrgCode": "Schmidt inc.",
    "insertedBy": "Mary Smith",
    "accessRestricted": false,
    "statusReasonCode": "C01"
  }
}
ACCOUNT_CLOSED
  • The account API triggers ACCOUNT_CLOSED event when an account is closed, and its status is set to CLOSED.

  • Event parameters are eventTypeCode/routing_code: ext.accounts.closed.

Webhook content
{
  "notificationId": "ID-9999",
  "notificationTypeCode": "ACCOUNT_CLOSED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2025-05-16T11:18:27.880Z",
  "data": {
    "accountId": "ID-9999",
    "personId": "ID-6969",
    "personName": "Peter Alexander Schmidt",
    "customerGroupCode": "string",
    "personTypeCode": "string",
    "accountTypeCode": "CURRENCY",
    "accountClassCode": "SAFEGUARDING",
    "accountTypeSetupCode": "EXTERNAL_VIRTUAL",
    "statusCode": "ACTIVE",
    "accountName": "My currency account",
    "iban": "EE10101019299",
    "bic": "HABAEE2X",
    "defaultCurrencyCode": "EUR",
    "countryCode": "EE",
    "taxResidencyCountryCode": "DE",
    "jurisdictionCountryCode": "ES",
    "activationDate": "2021-06-30",
    "bankingDate": "2021-05-12",
    "masterAccountId": "ID-9998",
    "source": {
      "sourceName": "string",
      "sourceRef": "string"
    },
    "tenantCode": "MB.EU",
    "serviceProviderCode": "TUUM",
    "interestMethodAssignmentCode": "EXTRA15",
    "intraOrgCode": "Schmidt inc.",
    "insertedBy": "Mary Smith",
    "accessRestricted": false,
    "statusReasonCode": "C01"
  }
}
ACCOUNT_NUMBER_CREATED
  • The account API triggers the ACCOUNT_NUMBER_CREATED event when a new bank account number is generated. This event occurs when a new account is created or additional account numbers are added to an existing account.

  • Event parameters are eventTypeCode/routing_code: ext.accounts.account-numbers.created.

Webhook content
{
  "notificationId": "ID-9999",
  "notificationTypeCode": "ACCOUNT_NUMBER_CREATED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2025-05-16T11:19:36.617Z",
  "data": {
    "accountId": "ID-1000",
    "accountNumberId": "ID-1000",
    "accountNumber": {
      "value": "DE89370400440532013000",
      "type": "IBAN"
    },
    "accountNumberSubtype": "BANKGIRO",
    "financialInstitutionId": {
      "value": "MAINDE2XXXX",
      "type": "BIC"
    },
    "countryCode": "EE",
    "defaultCurrencyCode": "EUR",
    "externalSyncEnabled": false,
    "statusCode": "ENABLED",
    "validityRange": {
      "startTime": "2025-05-16T11:19:36.618Z",
      "endTime": "2025-05-16T11:19:36.618Z"
    }
  }
}
ACCOUNT_NUMBER_CHANGED
  • The account-API triggers the ACCOUNT_NUMBER_CHANGED event if an unnecessary or unused account number or ALIAS identifier is invalidated.

  • Event parameters are eventTypeCode/routing_code: ext.accounts.account-numbers.changed.

Webhook content
{
  "notificationId": "ID-9999",
  "notificationTypeCode": "ACCOUNT_NUMBER_CHANGED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2025-05-16T11:20:31.653Z",
  "data": {
    "accountId": "ID-1000",
    "accountNumberId": "ID-1000",
    "accountNumber": {
      "value": "DE89370400440532013000",
      "type": "IBAN"
    },
    "accountNumberSubtype": "BANKGIRO",
    "financialInstitutionId": {
      "value": "MAINDE2XXXX",
      "type": "BIC"
    },
    "countryCode": "EE",
    "defaultCurrencyCode": "EUR",
    "externalSyncEnabled": false,
    "statusCode": "ENABLED",
    "validityRange": {
      "startTime": "2025-05-16T11:20:31.653Z",
      "endTime": "2025-05-16T11:20:31.653Z"
    }
  }
}

Account reservation

ACCOUNT_RESERVATION_CREATED_V3
  • The account API triggers ACCOUNT_RESERVATION_CREATED_V3 event if a new reservation at account was created.

  • Event parameters are eventTypeCode/routing_code: ext.accounts.reservationsV3.reserved.

Webhook content
{
  "notificationId": "ID-9999",
  "notificationTypeCode": "ACCOUNT_RESERVATION_CREATED_V3",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-12-20T11:34:47.767Z",
  "data": {
    "bankingDate": "2021-05-12",
    "reservationId": "ID-6969",
    "accountId": "ID-9999",
    "personId": "ID-6969",
    "amount": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "source": {
      "sourceName": "string",
      "sourceRef": "string",
      "sourceLink": "string"
    },
    "details": "Details data",
    "additionalInfo": "string",
    "reservedTime": "2024-12-20T11:34:47.767Z",
    "releasedTime": "2024-12-20T11:34:47.767Z",
    "virtualAccountId": "ID-1000",
    "postingDate": "2024-01-01",
    "usingLimit": false,
    "initialAmount": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "uniqueIdentifier": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "accountNumbers": [
      {
        "accountNumber": {
          "value": "DE89370400440532013000",
          "type": "IBAN"
        },
        "accountNumberSubtype": "BANKGIRO",
        "countryCode": "EE",
        "defaultCurrencyCode": "EUR",
        "financialInstitutionId": {
          "value": "MAINDE2XXXX",
          "type": "BIC"
        }
      }
    ],
    "virtualAccountNumbers": [
      {
        "accountNumber": {
          "value": "DE89370400440532013000",
          "type": "IBAN"
        },
        "accountNumberSubtype": "BANKGIRO",
        "countryCode": "EE",
        "defaultCurrencyCode": "EUR",
        "financialInstitutionId": {
          "value": "MAINDE2XXXX",
          "type": "BIC"
        }
      }
    ],
    "counterparty": {
      "name": "Peter Alexander Schmidt",
      "accountNumber": {
        "value": "DE89370400440532013000",
        "type": "IBAN"
      },
      "accountNumberSubtype": "BANKGIRO",
      "accountNumberCountryCode": "EE",
      "financialInstitutionId": {
        "value": "MAINDE2XXXX",
        "type": "BIC"
      }
    }
  }
}
ACCOUNT_RESERVATION_CHANGED_V3
  • The account API triggers ACCOUNT_RESERVATION_CHANGED_V3 event if an existing reservation was changed.

  • Event parameters are eventTypeCode/routing_code: ext.accounts.reservationsV3.changed.

Webhook content
{
  "notificationId": "ID-9999",
  "notificationTypeCode": "ACCOUNT_RESERVATION_CHANGED_V3",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-12-20T11:28:32.506Z",
  "data": {
    "bankingDate": "2021-05-12",
    "reservationId": "ID-6969",
    "accountId": "ID-9999",
    "personId": "ID-6969",
    "amount": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "source": {
      "sourceName": "string",
      "sourceRef": "string",
      "sourceLink": "string"
    },
    "details": "Details data",
    "additionalInfo": "string",
    "reservedTime": "2024-12-20T11:28:32.506Z",
    "releasedTime": "2024-12-20T11:28:32.506Z",
    "virtualAccountId": "ID-1000",
    "postingDate": "2024-01-01",
    "usingLimit": false,
    "initialAmount": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "uniqueIdentifier": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "accountNumbers": [
      {
        "accountNumber": {
          "value": "DE89370400440532013000",
          "type": "IBAN"
        },
        "accountNumberSubtype": "BANKGIRO",
        "countryCode": "EE",
        "defaultCurrencyCode": "EUR",
        "financialInstitutionId": {
          "value": "MAINDE2XXXX",
          "type": "BIC"
        }
      }
    ],
    "virtualAccountNumbers": [
      {
        "accountNumber": {
          "value": "DE89370400440532013000",
          "type": "IBAN"
        },
        "accountNumberSubtype": "BANKGIRO",
        "countryCode": "EE",
        "defaultCurrencyCode": "EUR",
        "financialInstitutionId": {
          "value": "MAINDE2XXXX",
          "type": "BIC"
        }
      }
    ],
    "counterparty": {
      "name": "Peter Alexander Schmidt",
      "accountNumber": {
        "value": "DE89370400440532013000",
        "type": "IBAN"
      },
      "accountNumberSubtype": "BANKGIRO",
      "accountNumberCountryCode": "EE",
      "financialInstitutionId": {
        "value": "MAINDE2XXXX",
        "type": "BIC"
      }
    }
  }
}
ACCOUNT_RESERVATION_RELEASED_V3
  • The account API triggers ACCOUNT_RESERVATION_RELEASED_V3 event if an existing reservation was released.

  • Event parameters are eventTypeCode/routing_code: ext.accounts.reservationsV3.released.

Webhook content
{
  "notificationId": "ID-9999",
  "notificationTypeCode": "ACCOUNT_RESERVATION_RELEASED_V3",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-12-20T11:32:16.751Z",
  "data": {
    "bankingDate": "2021-05-12",
    "reservationId": "ID-6969",
    "accountId": "ID-9999",
    "personId": "ID-6969",
    "amount": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "source": {
      "sourceName": "string",
      "sourceRef": "string",
      "sourceLink": "string"
    },
    "details": "Details data",
    "additionalInfo": "string",
    "reservedTime": "2024-12-20T11:32:16.751Z",
    "releasedTime": "2024-12-20T11:32:16.751Z",
    "virtualAccountId": "ID-1000",
    "postingDate": "2024-01-01",
    "usingLimit": false,
    "initialAmount": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "uniqueIdentifier": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "accountNumbers": [
      {
        "accountNumber": {
          "value": "DE89370400440532013000",
          "type": "IBAN"
        },
        "accountNumberSubtype": "BANKGIRO",
        "countryCode": "EE",
        "defaultCurrencyCode": "EUR",
        "financialInstitutionId": {
          "value": "MAINDE2XXXX",
          "type": "BIC"
        }
      }
    ],
    "virtualAccountNumbers": [
      {
        "accountNumber": {
          "value": "DE89370400440532013000",
          "type": "IBAN"
        },
        "accountNumberSubtype": "BANKGIRO",
        "countryCode": "EE",
        "defaultCurrencyCode": "EUR",
        "financialInstitutionId": {
          "value": "MAINDE2XXXX",
          "type": "BIC"
        }
      }
    ],
    "counterparty": {
      "name": "Peter Alexander Schmidt",
      "accountNumber": {
        "value": "DE89370400440532013000",
        "type": "IBAN"
      },
      "accountNumberSubtype": "BANKGIRO",
      "accountNumberCountryCode": "EE",
      "financialInstitutionId": {
        "value": "MAINDE2XXXX",
        "type": "BIC"
      }
    }
  }
}

Account transaction

ACCOUNT_TRANSACTION_CREATED_V3
  • The account API triggers ACCOUNT_TRANSACTION_CREATED_V3 event if a transaction was created at an account.

  • Event parameters are eventTypeCode/routing_code: ext.accounts.transactionsV3.created.

Webhook content
{
  "notificationId": "ID-9999",
  "notificationTypeCode": "ACCOUNT_TRANSACTION_CREATED_V3",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-12-20T11:38:30.197Z",
  "data": {
    "accountId": "ID-9999",
    "personId": "ID-6969",
    "accountTransactionId": "ID-102920",
    "postingDate": "2021-06-21",
    "valueDate": "2021-06-21",
    "transactionTypeCode": "CARD_CASH_MC_EU",
    "transactionSubtypeCode": "TRANS_SUB",
    "directionCode": "OUT",
    "amount": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "initialBalanceAmount": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "source": {
      "sourceName": "string",
      "sourceRef": "string",
      "sourceLink": "string"
    },
    "contractSource": {
      "sourceName": "LOAN.CONTRACT",
      "sourceRef": "ID-181922",
      "contractNumber": "1122241515"
    },
    "counterpartyIban": "string",
    "counterpartyName": "Edythe",
    "counterpartyBic": "string",
    "details": "string",
    "referenceNumber": "string",
    "countryCode": "FI",
    "merchantInfo": "string",
    "metaInfo": "string",
    "reconciliationReference": "ID-1515",
    "reconciliationReferenceSource": "PAYMENT",
    "tenantCode": "MB",
    "paymentCountryCode": "FI",
    "transactionDTime": "2021-04-30T09:04:37.108561Z",
    "reversedTransactionId": "ID-12992",
    "reversed": true,
    "reversal": true,
    "bankingDate": "2021-05-12",
    "virtualAccountId": "ID-1000",
    "uniqueIdentifier": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "reservationId": "ID-1001",
    "usingLimit": false,
    "accountNumbers": [
      {
        "accountNumber": {
          "value": "DE89370400440532013000",
          "type": "IBAN"
        },
        "accountNumberSubtype": "BANKGIRO",
        "countryCode": "EE",
        "defaultCurrencyCode": "EUR",
        "financialInstitutionId": {
          "value": "MAINDE2XXXX",
          "type": "BIC"
        }
      }
    ],
    "virtualAccountNumbers": [
      {
        "accountNumber": {
          "value": "DE89370400440532013000",
          "type": "IBAN"
        },
        "accountNumberSubtype": "BANKGIRO",
        "countryCode": "EE",
        "defaultCurrencyCode": "EUR",
        "financialInstitutionId": {
          "value": "MAINDE2XXXX",
          "type": "BIC"
        }
      }
    ],
    "counterparty": {
      "name": "Peter Alexander Schmidt",
      "accountNumber": {
        "value": "DE89370400440532013000",
        "type": "IBAN"
      },
      "accountNumberSubtype": "BANKGIRO",
      "accountNumberCountryCode": "EE",
      "financialInstitutionId": {
        "value": "MAINDE2XXXX",
        "type": "BIC"
      }
    }
  }
}
ACCOUNT_TRANSACTION_REVERSED_V3
  • The account API triggers ACCOUNT_TRANSACTION_REVERSED_V3 event if a transaction was reversed.

  • Event parameters are eventTypeCode/routing_code: ext.accounts.transactionsV3.reversed.

Webhook content
{
  "notificationId": "ID-9999",
  "notificationTypeCode": "LOAN_INVOICE_GENERATION",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-12-20T11:41:36.715Z",
  "data": {
    "accountId": "ID-9999",
    "personId": "ID-6969",
    "accountTransactionId": "ID-102920",
    "postingDate": "2021-06-21",
    "valueDate": "2021-06-21",
    "transactionTypeCode": "CARD_CASH_MC_EU",
    "transactionSubtypeCode": "TRANS_SUB",
    "directionCode": "OUT",
    "amount": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "initialBalanceAmount": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "source": {
      "sourceName": "string",
      "sourceRef": "string",
      "sourceLink": "string"
    },
    "contractSource": {
      "sourceName": "LOAN.CONTRACT",
      "sourceRef": "ID-181922",
      "contractNumber": "1122241515"
    },
    "counterpartyIban": "string",
    "counterpartyName": "Edythe",
    "counterpartyBic": "string",
    "details": "string",
    "referenceNumber": "string",
    "countryCode": "FI",
    "merchantInfo": "string",
    "metaInfo": "string",
    "reconciliationReference": "ID-1515",
    "reconciliationReferenceSource": "PAYMENT",
    "tenantCode": "MB",
    "paymentCountryCode": "FI",
    "transactionDTime": "2021-04-30T09:04:37.108561Z",
    "reversedTransactionId": "ID-12992",
    "reversed": true,
    "reversal": true,
    "bankingDate": "2021-05-12",
    "virtualAccountId": "ID-1000",
    "uniqueIdentifier": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "reservationId": "ID-1001",
    "usingLimit": false,
    "accountNumbers": [
      {
        "accountNumber": {
          "value": "DE89370400440532013000",
          "type": "IBAN"
        },
        "accountNumberSubtype": "BANKGIRO",
        "countryCode": "EE",
        "defaultCurrencyCode": "EUR",
        "financialInstitutionId": {
          "value": "MAINDE2XXXX",
          "type": "BIC"
        }
      }
    ],
    "virtualAccountNumbers": [
      {
        "accountNumber": {
          "value": "DE89370400440532013000",
          "type": "IBAN"
        },
        "accountNumberSubtype": "BANKGIRO",
        "countryCode": "EE",
        "defaultCurrencyCode": "EUR",
        "financialInstitutionId": {
          "value": "MAINDE2XXXX",
          "type": "BIC"
        }
      }
    ],
    "counterparty": {
      "name": "Peter Alexander Schmidt",
      "accountNumber": {
        "value": "DE89370400440532013000",
        "type": "IBAN"
      },
      "accountNumberSubtype": "BANKGIRO",
      "accountNumberCountryCode": "EE",
      "financialInstitutionId": {
        "value": "MAINDE2XXXX",
        "type": "BIC"
      }
    }
  }
}

Account balance

ACCOUNT_BALANCE_CHANGED
  • The account-API triggers the ACCOUNT_BALANCE_CHANGED event in scenarios such as:

    • Account transaction creation, update, or cancellation,

    • Reservation creation, update, release, or cancellation,

    • Overdraft limit updates.

Webhook content
{
  "notificationId": "ID-9999",
  "notificationTypeCode": "ACCOUNT_BALANCE_CHANGED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2025-05-16T11:20:31.669Z",
  "data": {
    "balanceId": "ID-1000",
    "accountId": "ID-2000",
    "personId": "ID-3000",
    "accountTypeCode": "CURRENCY",
    "accountClassCode": "SAFEGUARDED",
    "balanceAmount": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "reservedAmount": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "overdraftLimitAmount": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "availableBalanceAmount": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "availableBalanceInDefaultCcy": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "defaultCurrencyCode": "EUR"
  }
}

Account right

ACCOUNT_RIGHT_CREATED
  • The account API triggers ACCOUNT_RIGHT_CREATED event if an account access right was created or updated.

  • Event parameters are eventTypeCode/routing_code: ext.accounts.rights.created.

Webhook content
{
  "notificationId": "ID-9999",
  "notificationTypeCode": "ACCOUNT_RIGHT_CREATED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-06-03T08:42:39.259Z",
  "data": {
    "accountRightId": "string",
    "accountId": "string",
    "personId": "string",
    "rightCode": "string",
    "validityRange": {
      "startTime": "2024-06-03T08:42:39.259Z",
      "endTime": "2024-06-03T08:42:39.259Z"
    }
  }
}
ACCOUNT_RIGHT_REMOVED
  • The account API triggers ACCOUNT_RIGHT_REMOVED event if an existing access right was changed or terminated.

  • Event parameters are eventTypeCode/routing_code: ext.accounts.rights.closed.

Webhook content
{
  "notificationId": "ID-9999",
  "notificationTypeCode": "ACCOUNT_RIGHT_REMOVED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-06-03T08:45:41.595Z",
  "data": {
    "accountRightId": "string",
    "accountId": "string",
    "personId": "string",
    "rightCode": "string",
    "validityRange": {
      "startTime": "2024-06-03T08:45:41.595Z",
      "endTime": "2024-06-03T08:45:41.595Z"
    }
  }
}

Account custom field

ACCOUNT_CUSTOM_FIELD_CHANGED
  • The account API triggers ACCOUNT_CUSTOM_FIELD_CHANGED event if a new custom field value inserted or updated.

  • Event parameters are eventTypeCode/routing_code: ext.accounts.custom-fields.fields.changed.

Webhook content
{
  "notificationId": "ID-9999",
  "notificationTypeCode": "ACCOUNT_CUSTOM_FIELD_CHANGED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-06-03T08:21:55.169Z",
  "data": {
    "source": {
      "sourceName": "string",
      "sourceRef": "string",
      "sourceLink": "string"
    },
    "values": [
      {
        "fieldSetId": "PAYMENT_RIGHTS",
        "fieldId": "PAYMENT_SIGNATURE_WEIGHT",
        "valueType": "NUMBER",
        "fieldValue": "100"
      }
    ]
  }
}
ACCOUNT_CUSTOM_FIELD_REMOVED
  • The account API triggers ACCOUNT_CUSTOM_FIELD_REMOVED event if a new custom field value deleted.

  • Event parameters are eventTypeCode/routing_code: ext.accounts.custom-fields.fields.deleted.

Webhook content
{
  "notificationId": "ID-9999",
  "notificationTypeCode": "ACCOUNT_CUSTOM_FIELD_REMOVED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-06-03T08:26:33.236Z",
  "data": {
    "source": {
      "sourceName": "string",
      "sourceRef": "string",
      "sourceLink": "string"
    },
    "values": [
      {
        "fieldSetId": "PAYMENT_RIGHTS",
        "fieldId": "PAYMENT_SIGNATURE_WEIGHT"
      }
    ]
  }
}

Account import

ACCOUNT_IMPORT_PROCESS_PROCESSED
  • The account API triggers the ACCOUNT_IMPORT_PROCESS_PROCESSED event when the account data import process is complete, and all imported account data entities have been created.

  • Event parameters are eventTypeCode/routing_code: ext.accounts.import-processes.processed.

Webhook content
{
  "notificationId": "ID-9999",
  "notificationTypeCode": "ACCOUNT_IMPORT_PROCESS_PROCESSED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-12-20T11:17:57.322Z",
  "data": {
    "importProcessId": "ID-100000000000",
    "typeCode": "ACCOUNT_TRANSACTIONS",
    "statusCode": "PROCESSED",
    "errorCode": "err.allRowsValidationsFailed",
    "errorDetails": null,
    "totalCount": 1000,
    "processedCount": 950,
    "errorCount": 50,
    "postingDate": "2024-01-01",
    "expectedProcessingDTime": "2021-05-31T14:11:16Z",
    "source": {
      "sourceName": "PAYMENT",
      "sourceRef": "ID-181922"
    }
  }
}
ACCOUNT_IMPORT_PROCESS_PARTIALLY_PROCESSED
  • The account API triggers the ACCOUNT_IMPORT_PROCESS_PARTIALLY_PROCESSED event when the account data import process is partially successful and only part of imported account data entities have been created.

  • Event parameters are eventTypeCode/routing_code: ext.accounts.import-processes.partially-processed.

Webhook content
{
  "notificationId": "ID-9999",
  "notificationTypeCode": "ACCOUNT_IMPORT_PROCESS_PARTIALLY_PROCESSED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-12-20T10:01:58.546Z",
  "data": {
    "importProcessId": "ID-100000000000",
    "typeCode": "ACCOUNT_TRANSACTIONS",
    "statusCode": "PROCESSED",
    "errorCode": "err.allRowsValidationsFailed",
    "errorDetails": null,
    "totalCount": 1000,
    "processedCount": 950,
    "errorCount": 50,
    "postingDate": "2024-01-01",
    "expectedProcessingDTime": "2021-05-31T14:11:16Z",
    "source": {
      "sourceName": "PAYMENT",
      "sourceRef": "ID-181922"
    }
  }
}
ACCOUNT_IMPORT_PROCESS_ERROR
  • The account API triggers an ACCOUNT_IMPORT_PROCESS_ERROR event when the account data import process completes with failure, and no imported account data entities have been created.

  • Event parameters are eventTypeCode/routing_code: ext.accounts.import-processes.error.

Webhook content
{
  "notificationId": "ID-9999",
  "notificationTypeCode": "ACCOUNT_IMPORT_PROCESS_ERROR",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-12-20T09:53:00.375Z",
  "data": {
    "importProcessId": "ID-100000000000",
    "typeCode": "ACCOUNT_TRANSACTIONS",
    "statusCode": "PROCESSED",
    "errorCode": "err.allRowsValidationsFailed",
    "errorDetails": null,
    "totalCount": 1000,
    "processedCount": 950,
    "errorCount": 50,
    "postingDate": "2024-01-01",
    "expectedProcessingDTime": "2021-05-31T14:11:16Z",
    "source": {
      "sourceName": "PAYMENT",
      "sourceRef": "ID-181922"
    }
  }
}

Payments

Payment management

PAYMENT_SETTLED
  • The payment-api triggers PAYMENT_SETTLED event when payment is settled by payment scheme and its status is set to SETTLED.

  • Event parameters are eventTypeCode/routing_code: ext.paymentsV2.payment.settled.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "PAYMENT_SETTLED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-09-13T05:53:10.871Z",
  "data": {
    "accountId": "ID-1000",
    "paymentId": "ID-1000",
    "amount": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "feeAmount": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "directionCode": "IN",
    "effectiveDate": "2024-09-13",
    "statusCode": "PROCESSED",
    "details": "Payment for hotel",
    "referenceNumber": "54321",
    "postingDate": "2024-09-13",
    "paymentTypeCode": "SEPA2ACC",
    "source": {
      "sourceName": "PAYMENT",
      "sourceRef": "ID-181922"
    },
    "residencyCountryCode": "EE",
    "returnReason": "AC01",
    "returnComment": "Return payment",
    "lastStatusRequestDate": "2024-09-13T05:53:10.871Z",
    "cancellationRequestStatusCode": "string",
    "refuseReason": "Reason",
    "cancellationReason": "Reason",
    "recallCancellationReason": "Reason",
    "endToEndId": "NOTPROVIDED",
    "paymentTransferTypeCode": "INSTANTREGULAR",
    "contractSource": {
      "sourceName": "LOAN.CONTRACT",
      "sourceRef": "ID-181922",
      "contractNumber": "1122241515"
    },
    "insertedDateTime": "2024-09-13T05:53:10.871Z",
    "returnSettlementDate": "2021-02-03",
    "creditTransferSettlementDate": "2021-02-03",
    "originalIban": "string",
    "reservationId": "ID-1000",
    "paymentTransactionTypeCode": "SEPA2ACC_PAY",
    "paymentFeeTransactionTypeCode": "string",
    "chargeBearer": "SHA",
    "instrumentCode": "PAYMENT.SEPA2ACC",
    "paymentServiceProviderCode": "SHA",
    "accountTypeCode": "CURRENCY",
    "fxPaymentFlag": true,
    "fixedSide": "PAYMENT",
    "fxQuoteRequestId": "ID-2000",
    "fxQuoteResponseId": "ID-3000",
    "exchangeRate": 0.84,
    "coverMoney": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "paymentMoney": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "reservationMoney": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "initialBalance": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "fxMarginMoney": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "errorCode": "err.technical",
    "paymentDetails": [
      {
        "amount": {
          "amount": 1.22,
          "currencyCode": "EUR"
        },
        "typeCode": "OUR_FEE"
      }
    ],
    "paymentParties": [
      {
        "name": "Airport Hotel Gmbh",
        "address": {
          "street1": "Hugo-Eckener-Ring 1",
          "street2": "Apartment Number 40",
          "cityCounty": "Frankfurt am Main",
          "stateRegion": "Hesse",
          "zip": "60549",
          "countryCode": "DE",
          "addressLine": "Hugo-Eckener-Ring 1, Frankfurt am Main, Hesse, 60549, Germany"
        },
        "typeCode": "OUR_CORRESPONDENT",
        "accountNumber": {
          "value": "DE89370400440532013000",
          "type": "IBAN"
        },
        "accountNumberCountryCode": "EE",
        "accountNumberBankCode": "HABA",
        "financialInstitutionId": {
          "value": "MAINDE2XXXX",
          "type": "BIC"
        },
        "personId": "ID-1000",
        "personTypeCode": "P",
        "givenName": "John",
        "surname": "Smith",
        "accountId": "ID-1000",
        "identificationTypeCode": "PASSPORT",
        "identificationValue": "0124R5M1P5",
        "birthDate": "1965-11-24",
        "registrationDate": "2022-09-01",
        "residencyCountryCode": "EE",
        "accountClassCode": "SAFEGUARDED",
        "accountTypeCode": "CURRENCY",
        "countryCode": "EE",
        "roleCode": "PAYER"
      }
    ],
    "paymentSchemeElements": [
      {
        "fieldValueCountryCode": "EE",
        "fieldValueSchemeTypeCode": "SEPA",
        "fieldValueTypeCode": "FATHER_NAME",
        "fieldValue": "Chuck Norris"
      }
    ],
    "deleted": false,
    "selectedPaymentScheme": "SEPA_INSTANT",
    "purposeCode": "SEPA_INSTANT",
    "amlDeclineReason": "TECHNICAL"
  }
}
PAYMENT_PROCESSED
  • The payment API triggers the PAYMENT_PROCESSED event when a payment is processed and its status is set to PROCESSED. The event message includes the full set of payment data.

  • Event parameters are eventTypeCode/routing_code: ext.accounts.paymentsV2.return.processed.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "PAYMENT_PROCESSED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-09-13T06:31:37.067Z",
  "data": {
    "accountId": "ID-1000",
    "paymentId": "ID-1000",
    "amount": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "feeAmount": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "directionCode": "IN",
    "effectiveDate": "2024-09-13",
    "statusCode": "PROCESSED",
    "details": "Payment for hotel",
    "referenceNumber": "54321",
    "postingDate": "2024-09-13",
    "paymentTypeCode": "SEPA2ACC",
    "source": {
      "sourceName": "PAYMENT",
      "sourceRef": "ID-181922"
    },
    "residencyCountryCode": "EE",
    "returnReason": "AC01",
    "returnComment": "Return payment",
    "lastStatusRequestDate": "2024-09-13T06:31:37.067Z",
    "cancellationRequestStatusCode": "string",
    "refuseReason": "Reason",
    "cancellationReason": "Reason",
    "recallCancellationReason": "Reason",
    "endToEndId": "NOTPROVIDED",
    "paymentTransferTypeCode": "INSTANTREGULAR",
    "contractSource": {
      "sourceName": "LOAN.CONTRACT",
      "sourceRef": "ID-181922",
      "contractNumber": "1122241515"
    },
    "insertedDateTime": "2024-09-13T06:31:37.067Z",
    "returnSettlementDate": "2021-02-03",
    "creditTransferSettlementDate": "2021-02-03",
    "originalIban": "string",
    "reservationId": "ID-1000",
    "paymentTransactionTypeCode": "SEPA2ACC_PAY",
    "paymentFeeTransactionTypeCode": "string",
    "chargeBearer": "SHA",
    "instrumentCode": "PAYMENT.SEPA2ACC",
    "paymentServiceProviderCode": "SHA",
    "accountTypeCode": "CURRENCY",
    "fxPaymentFlag": true,
    "fixedSide": "PAYMENT",
    "fxQuoteRequestId": "ID-2000",
    "fxQuoteResponseId": "ID-3000",
    "exchangeRate": 0.84,
    "coverMoney": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "paymentMoney": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "reservationMoney": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "initialBalance": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "fxMarginMoney": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "errorCode": "err.technical",
    "paymentDetails": [
      {
        "amount": {
          "amount": 1.22,
          "currencyCode": "EUR"
        },
        "typeCode": "OUR_FEE"
      }
    ],
    "paymentParties": [
      {
        "name": "Airport Hotel Gmbh",
        "address": {
          "street1": "Hugo-Eckener-Ring 1",
          "street2": "Apartment Number 40",
          "cityCounty": "Frankfurt am Main",
          "stateRegion": "Hesse",
          "zip": "60549",
          "countryCode": "DE",
          "addressLine": "Hugo-Eckener-Ring 1, Frankfurt am Main, Hesse, 60549, Germany"
        },
        "typeCode": "OUR_CORRESPONDENT",
        "accountNumber": {
          "value": "DE89370400440532013000",
          "type": "IBAN"
        },
        "accountNumberCountryCode": "EE",
        "accountNumberBankCode": "HABA",
        "financialInstitutionId": {
          "value": "MAINDE2XXXX",
          "type": "BIC"
        },
        "personId": "ID-1000",
        "personTypeCode": "P",
        "givenName": "John",
        "surname": "Smith",
        "accountId": "ID-1000",
        "identificationTypeCode": "PASSPORT",
        "identificationValue": "0124R5M1P5",
        "birthDate": "1965-11-24",
        "registrationDate": "2022-09-01",
        "residencyCountryCode": "EE",
        "accountClassCode": "SAFEGUARDED",
        "accountTypeCode": "CURRENCY",
        "countryCode": "EE",
        "roleCode": "PAYER"
      }
    ],
    "paymentSchemeElements": [
      {
        "fieldValueCountryCode": "EE",
        "fieldValueSchemeTypeCode": "SEPA",
        "fieldValueTypeCode": "FATHER_NAME",
        "fieldValue": "Chuck Norris"
      }
    ],
    "deleted": false,
    "selectedPaymentScheme": "SEPA_INSTANT",
    "purposeCode": "SEPA_INSTANT",
    "amlDeclineReason": "TECHNICAL"
  }
}
PAYMENT_WAITING_FOR_CONFIRMATION
  • The payment API triggers the PAYMENT_WAITING_FOR_CONFIRMATION event when a payment is created, and for further processing, it waits for additional confirmation with a status set to WAITING_FOR_CONFIRMATION.

  • Event parameters are eventTypeCode/routing_code: ext.paymentsV2.payment.waiting.confirmation.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "PAYMENT_WAITING_FOR_CONFIRMATION",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-12-16T12:42:29.042Z",
  "data": {
    "accountId": "ID-1000",
    "paymentId": "ID-1000",
    "amount": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "feeAmount": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "directionCode": "IN",
    "effectiveDate": "2024-12-16",
    "statusCode": "PROCESSED",
    "details": "Payment for hotel",
    "referenceNumber": "54321",
    "postingDate": "2024-12-16",
    "paymentTypeCode": "SEPA2ACC",
    "source": {
      "sourceName": "PAYMENT",
      "sourceRef": "ID-181922"
    },
    "residencyCountryCode": "EE",
    "returnReason": "AC01",
    "returnComment": "Return payment",
    "lastStatusRequestDate": "2024-12-16T12:42:29.042Z",
    "cancellationRequestStatusCode": "string",
    "refuseReason": "Reason",
    "cancellationReason": "Reason",
    "recallCancellationReason": "Reason",
    "endToEndId": "NOTPROVIDED",
    "paymentTransferTypeCode": "INSTANTREGULAR",
    "contractSource": {
      "sourceName": "LOAN.CONTRACT",
      "sourceRef": "ID-181922",
      "contractNumber": "1122241515"
    },
    "insertedDateTime": "2024-12-16T12:42:29.042Z",
    "returnSettlementDate": "2021-02-03",
    "creditTransferSettlementDate": "2021-02-03",
    "originalIban": "string",
    "reservationId": "ID-1000",
    "paymentTransactionTypeCode": "SEPA2ACC_PAY",
    "paymentFeeTransactionTypeCode": "string",
    "chargeBearer": "SHA",
    "instrumentCode": "PAYMENT.SEPA2ACC",
    "paymentServiceProviderCode": "SHA",
    "accountTypeCode": "CURRENCY",
    "fxPaymentFlag": true,
    "fixedSide": "PAYMENT",
    "fxQuoteRequestId": "ID-2000",
    "fxQuoteResponseId": "ID-3000",
    "exchangeRate": 0.84,
    "coverMoney": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "paymentMoney": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "reservationMoney": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "initialBalance": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "fxMarginMoney": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "errorCode": "err.technical",
    "paymentDetails": [
      {
        "amount": {
          "amount": 1.22,
          "currencyCode": "EUR"
        },
        "typeCode": "OUR_FEE"
      }
    ],
    "paymentParties": [
      {
        "name": "Airport Hotel Gmbh",
        "address": {
          "street1": "Hugo-Eckener-Ring 1",
          "street2": "Apartment Number 40",
          "cityCounty": "Frankfurt am Main",
          "stateRegion": "Hesse",
          "zip": "60549",
          "countryCode": "DE",
          "addressLine": "Hugo-Eckener-Ring 1, Frankfurt am Main, Hesse, 60549, Germany",
          "addressTypeCode": "R"
        },
        "typeCode": "OUR_CORRESPONDENT",
        "accountNumber": {
          "value": "DE89370400440532013000",
          "type": "IBAN"
        },
        "accountNumberSubtype": "BANKGIRO",
        "accountNumberCountryCode": "EE",
        "accountNumberBankCode": "HABA",
        "financialInstitutionId": {
          "value": "MAINDE2XXXX",
          "type": "BIC"
        },
        "personId": "ID-1000",
        "personTypeCode": "P",
        "givenName": "John",
        "surname": "Smith",
        "accountId": "ID-1000",
        "identificationTypeCode": "PASSPORT",
        "identificationValue": "0124R5M1P5",
        "birthDate": "1965-11-24",
        "registrationDate": "2022-09-01",
        "residencyCountryCode": "EE",
        "accountClassCode": "SAFEGUARDED",
        "accountTypeCode": "CURRENCY",
        "countryCode": "EE",
        "roleCode": "PAYER",
        "allAccountNumbers": [
          {
            "accountNumber": {
              "value": "DE89370400440532013000",
              "type": "IBAN"
            },
            "accountNumberSubtype": "BANKGIRO",
            "financialInstitutionId": {
              "value": "MAINDE2XXXX",
              "type": "BIC"
            },
            "accountNumberCountryCode": "EE"
          }
        ],
        "allAddresses": [
          {
            "street1": "Hugo-Eckener-Ring 1",
            "street2": "Apartment Number 40",
            "cityCounty": "Frankfurt am Main",
            "stateRegion": "Hesse",
            "zip": "60549",
            "countryCode": "DE",
            "addressLine": "Hugo-Eckener-Ring 1, Frankfurt am Main, Hesse, 60549, Germany",
            "addressTypeCode": "R"
          }
        ]
      }
    ],
    "paymentSchemeElements": [
      {
        "fieldValueCountryCode": "EE",
        "fieldValueSchemeTypeCode": "SEPA",
        "fieldValueTypeCode": "FATHER_NAME",
        "fieldValue": "Chuck Norris"
      }
    ],
    "deleted": false,
    "selectedPaymentScheme": "SEPA_INSTANT",
    "purposeCode": "SEPA_INSTANT",
    "amlDeclineReason": "TECHNICAL",
    "externalServiceProviderCode": "PROVIDER_A"
  }
}
PAYMENT_ERROR
  • The payment API triggers the PAYMENT_ERROR event when a payment has failed system validations and its status is set to ERROR.

  • Event parameters are eventTypeCode/routing_code: ext.paymentsV2.payment.error.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "PAYMENT_ERROR",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-09-13T06:44:34.126Z",
  "data": {
    "accountId": "ID-1000",
    "paymentId": "ID-1000",
    "amount": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "feeAmount": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "directionCode": "IN",
    "effectiveDate": "2024-09-13",
    "statusCode": "PROCESSED",
    "details": "Payment for hotel",
    "referenceNumber": "54321",
    "postingDate": "2024-09-13",
    "paymentTypeCode": "SEPA2ACC",
    "source": {
      "sourceName": "PAYMENT",
      "sourceRef": "ID-181922"
    },
    "residencyCountryCode": "EE",
    "returnReason": "AC01",
    "returnComment": "Return payment",
    "lastStatusRequestDate": "2024-09-13T06:44:34.126Z",
    "cancellationRequestStatusCode": "string",
    "refuseReason": "Reason",
    "cancellationReason": "Reason",
    "recallCancellationReason": "Reason",
    "endToEndId": "NOTPROVIDED",
    "paymentTransferTypeCode": "INSTANTREGULAR",
    "contractSource": {
      "sourceName": "LOAN.CONTRACT",
      "sourceRef": "ID-181922",
      "contractNumber": "1122241515"
    },
    "insertedDateTime": "2024-09-13T06:44:34.126Z",
    "returnSettlementDate": "2021-02-03",
    "creditTransferSettlementDate": "2021-02-03",
    "originalIban": "string",
    "reservationId": "ID-1000",
    "paymentTransactionTypeCode": "SEPA2ACC_PAY",
    "paymentFeeTransactionTypeCode": "string",
    "chargeBearer": "SHA",
    "instrumentCode": "PAYMENT.SEPA2ACC",
    "paymentServiceProviderCode": "SHA",
    "accountTypeCode": "CURRENCY",
    "fxPaymentFlag": true,
    "fixedSide": "PAYMENT",
    "fxQuoteRequestId": "ID-2000",
    "fxQuoteResponseId": "ID-3000",
    "exchangeRate": 0.84,
    "coverMoney": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "paymentMoney": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "reservationMoney": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "initialBalance": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "fxMarginMoney": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "errorCode": "err.technical",
    "paymentDetails": [
      {
        "amount": {
          "amount": 1.22,
          "currencyCode": "EUR"
        },
        "typeCode": "OUR_FEE"
      }
    ],
    "paymentParties": [
      {
        "name": "Airport Hotel Gmbh",
        "address": {
          "street1": "Hugo-Eckener-Ring 1",
          "street2": "Apartment Number 40",
          "cityCounty": "Frankfurt am Main",
          "stateRegion": "Hesse",
          "zip": "60549",
          "countryCode": "DE",
          "addressLine": "Hugo-Eckener-Ring 1, Frankfurt am Main, Hesse, 60549, Germany"
        },
        "typeCode": "OUR_CORRESPONDENT",
        "accountNumber": {
          "value": "DE89370400440532013000",
          "type": "IBAN"
        },
        "accountNumberCountryCode": "EE",
        "accountNumberBankCode": "HABA",
        "financialInstitutionId": {
          "value": "MAINDE2XXXX",
          "type": "BIC"
        },
        "personId": "ID-1000",
        "personTypeCode": "P",
        "givenName": "John",
        "surname": "Smith",
        "accountId": "ID-1000",
        "identificationTypeCode": "PASSPORT",
        "identificationValue": "0124R5M1P5",
        "birthDate": "1965-11-24",
        "registrationDate": "2022-09-01",
        "residencyCountryCode": "EE",
        "accountClassCode": "SAFEGUARDED",
        "accountTypeCode": "CURRENCY",
        "countryCode": "EE",
        "roleCode": "PAYER"
      }
    ],
    "paymentSchemeElements": [
      {
        "fieldValueCountryCode": "EE",
        "fieldValueSchemeTypeCode": "SEPA",
        "fieldValueTypeCode": "FATHER_NAME",
        "fieldValue": "Chuck Norris"
      }
    ],
    "deleted": false,
    "selectedPaymentScheme": "SEPA_INSTANT",
    "purposeCode": "SEPA_INSTANT",
    "amlDeclineReason": "TECHNICAL"
  }
}
PAYMENT_CANCELLED
  • The payment API triggers a PAYMENT_CANCELLED event when an outgoing payment is canceled and its status is set to CANCELLED. This event occurs when an initiated payment is canceled before confirmation, or after confirmation due to an AML decline or rejection by the settlement system.

  • Event parameters are eventTypeCode/routing_code: ext.paymentsV2.payment.cancelled.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "PAYMENT_CANCELLED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-09-13T06:46:28.614Z",
  "data": {
    "accountId": "ID-1000",
    "paymentId": "ID-1000",
    "amount": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "feeAmount": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "directionCode": "IN",
    "effectiveDate": "2024-09-13",
    "statusCode": "PROCESSED",
    "details": "Payment for hotel",
    "referenceNumber": "54321",
    "postingDate": "2024-09-13",
    "paymentTypeCode": "SEPA2ACC",
    "source": {
      "sourceName": "PAYMENT",
      "sourceRef": "ID-181922"
    },
    "residencyCountryCode": "EE",
    "returnReason": "AC01",
    "returnComment": "Return payment",
    "lastStatusRequestDate": "2024-09-13T06:46:28.614Z",
    "cancellationRequestStatusCode": "string",
    "refuseReason": "Reason",
    "cancellationReason": "Reason",
    "recallCancellationReason": "Reason",
    "endToEndId": "NOTPROVIDED",
    "paymentTransferTypeCode": "INSTANTREGULAR",
    "contractSource": {
      "sourceName": "LOAN.CONTRACT",
      "sourceRef": "ID-181922",
      "contractNumber": "1122241515"
    },
    "insertedDateTime": "2024-09-13T06:46:28.614Z",
    "returnSettlementDate": "2021-02-03",
    "creditTransferSettlementDate": "2021-02-03",
    "originalIban": "string",
    "reservationId": "ID-1000",
    "paymentTransactionTypeCode": "SEPA2ACC_PAY",
    "paymentFeeTransactionTypeCode": "string",
    "chargeBearer": "SHA",
    "instrumentCode": "PAYMENT.SEPA2ACC",
    "paymentServiceProviderCode": "SHA",
    "accountTypeCode": "CURRENCY",
    "fxPaymentFlag": true,
    "fixedSide": "PAYMENT",
    "fxQuoteRequestId": "ID-2000",
    "fxQuoteResponseId": "ID-3000",
    "exchangeRate": 0.84,
    "coverMoney": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "paymentMoney": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "reservationMoney": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "initialBalance": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "fxMarginMoney": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "errorCode": "err.technical",
    "paymentDetails": [
      {
        "amount": {
          "amount": 1.22,
          "currencyCode": "EUR"
        },
        "typeCode": "OUR_FEE"
      }
    ],
    "paymentParties": [
      {
        "name": "Airport Hotel Gmbh",
        "address": {
          "street1": "Hugo-Eckener-Ring 1",
          "street2": "Apartment Number 40",
          "cityCounty": "Frankfurt am Main",
          "stateRegion": "Hesse",
          "zip": "60549",
          "countryCode": "DE",
          "addressLine": "Hugo-Eckener-Ring 1, Frankfurt am Main, Hesse, 60549, Germany"
        },
        "typeCode": "OUR_CORRESPONDENT",
        "accountNumber": {
          "value": "DE89370400440532013000",
          "type": "IBAN"
        },
        "accountNumberCountryCode": "EE",
        "accountNumberBankCode": "HABA",
        "financialInstitutionId": {
          "value": "MAINDE2XXXX",
          "type": "BIC"
        },
        "personId": "ID-1000",
        "personTypeCode": "P",
        "givenName": "John",
        "surname": "Smith",
        "accountId": "ID-1000",
        "identificationTypeCode": "PASSPORT",
        "identificationValue": "0124R5M1P5",
        "birthDate": "1965-11-24",
        "registrationDate": "2022-09-01",
        "residencyCountryCode": "EE",
        "accountClassCode": "SAFEGUARDED",
        "accountTypeCode": "CURRENCY",
        "countryCode": "EE",
        "roleCode": "PAYER"
      }
    ],
    "paymentSchemeElements": [
      {
        "fieldValueCountryCode": "EE",
        "fieldValueSchemeTypeCode": "SEPA",
        "fieldValueTypeCode": "FATHER_NAME",
        "fieldValue": "Chuck Norris"
      }
    ],
    "deleted": false,
    "selectedPaymentScheme": "SEPA_INSTANT",
    "purposeCode": "SEPA_INSTANT",
    "amlDeclineReason": "TECHNICAL"
  }
}
PAYMENT_AML_DECLINED
  • The payment API triggers the PAYMENT_AML_DECLINED event when an incoming or outgoing payment is declined by AML check, and its status is set to AML_DECLINED.

  • Event parameters are eventTypeCode/routing_code: ext.paymentsV2.payment.aml.declined.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "PAYMENT_AML_DECLINED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-09-13T10:46:31.926Z",
  "data": {
    "accountId": "ID-1000",
    "paymentId": "ID-1000",
    "amount": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "feeAmount": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "directionCode": "IN",
    "effectiveDate": "2024-09-13",
    "statusCode": "PROCESSED",
    "details": "Payment for hotel",
    "referenceNumber": "54321",
    "postingDate": "2024-09-13",
    "paymentTypeCode": "SEPA2ACC",
    "source": {
      "sourceName": "PAYMENT",
      "sourceRef": "ID-181922"
    },
    "residencyCountryCode": "EE",
    "returnReason": "AC01",
    "returnComment": "Return payment",
    "lastStatusRequestDate": "2024-09-13T10:46:31.926Z",
    "cancellationRequestStatusCode": "string",
    "refuseReason": "Reason",
    "cancellationReason": "Reason",
    "recallCancellationReason": "Reason",
    "endToEndId": "NOTPROVIDED",
    "paymentTransferTypeCode": "INSTANTREGULAR",
    "contractSource": {
      "sourceName": "LOAN.CONTRACT",
      "sourceRef": "ID-181922",
      "contractNumber": "1122241515"
    },
    "insertedDateTime": "2024-09-13T10:46:31.927Z",
    "returnSettlementDate": "2021-02-03",
    "creditTransferSettlementDate": "2021-02-03",
    "originalIban": "string",
    "reservationId": "ID-1000",
    "paymentTransactionTypeCode": "SEPA2ACC_PAY",
    "paymentFeeTransactionTypeCode": "string",
    "chargeBearer": "SHA",
    "instrumentCode": "PAYMENT.SEPA2ACC",
    "paymentServiceProviderCode": "SHA",
    "accountTypeCode": "CURRENCY",
    "fxPaymentFlag": true,
    "fixedSide": "PAYMENT",
    "fxQuoteRequestId": "ID-2000",
    "fxQuoteResponseId": "ID-3000",
    "exchangeRate": 0.84,
    "coverMoney": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "paymentMoney": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "reservationMoney": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "initialBalance": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "fxMarginMoney": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "errorCode": "err.technical",
    "paymentDetails": [
      {
        "amount": {
          "amount": 1.22,
          "currencyCode": "EUR"
        },
        "typeCode": "OUR_FEE"
      }
    ],
    "paymentParties": [
      {
        "name": "Airport Hotel Gmbh",
        "address": {
          "street1": "Hugo-Eckener-Ring 1",
          "street2": "Apartment Number 40",
          "cityCounty": "Frankfurt am Main",
          "stateRegion": "Hesse",
          "zip": "60549",
          "countryCode": "DE",
          "addressLine": "Hugo-Eckener-Ring 1, Frankfurt am Main, Hesse, 60549, Germany"
        },
        "typeCode": "OUR_CORRESPONDENT",
        "accountNumber": {
          "value": "DE89370400440532013000",
          "type": "IBAN"
        },
        "accountNumberCountryCode": "EE",
        "accountNumberBankCode": "HABA",
        "financialInstitutionId": {
          "value": "MAINDE2XXXX",
          "type": "BIC"
        },
        "personId": "ID-1000",
        "personTypeCode": "P",
        "givenName": "John",
        "surname": "Smith",
        "accountId": "ID-1000",
        "identificationTypeCode": "PASSPORT",
        "identificationValue": "0124R5M1P5",
        "birthDate": "1965-11-24",
        "registrationDate": "2022-09-01",
        "residencyCountryCode": "EE",
        "accountClassCode": "SAFEGUARDED",
        "accountTypeCode": "CURRENCY",
        "countryCode": "EE",
        "roleCode": "PAYER"
      }
    ],
    "paymentSchemeElements": [
      {
        "fieldValueCountryCode": "EE",
        "fieldValueSchemeTypeCode": "SEPA",
        "fieldValueTypeCode": "FATHER_NAME",
        "fieldValue": "Chuck Norris"
      }
    ],
    "deleted": false,
    "selectedPaymentScheme": "SEPA_INSTANT",
    "purposeCode": "SEPA_INSTANT",
    "amlDeclineReason": "TECHNICAL"
  }
}
PAYMENT_RETURNED
  • The payment API triggers PAYMENT_RETURNED event when a processed payment is returned, and its status set to RETURNED.

  • Event parameters are eventTypeCode/routing_code: ext.accounts.paymentsV2.return.processed.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "PAYMENT_RETURNED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-09-13T06:24:57.941Z",
  "data": {
    "accountId": "ID-1000",
    "paymentId": "ID-1000",
    "amount": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "feeAmount": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "directionCode": "IN",
    "effectiveDate": "2024-09-13",
    "statusCode": "PROCESSED",
    "details": "Payment for hotel",
    "referenceNumber": "54321",
    "postingDate": "2024-09-13",
    "paymentTypeCode": "SEPA2ACC",
    "source": {
      "sourceName": "PAYMENT",
      "sourceRef": "ID-181922"
    },
    "residencyCountryCode": "EE",
    "returnReason": "AC01",
    "returnComment": "Return payment",
    "lastStatusRequestDate": "2024-09-13T06:24:57.942Z",
    "cancellationRequestStatusCode": "string",
    "refuseReason": "Reason",
    "cancellationReason": "Reason",
    "recallCancellationReason": "Reason",
    "endToEndId": "NOTPROVIDED",
    "paymentTransferTypeCode": "INSTANTREGULAR",
    "contractSource": {
      "sourceName": "LOAN.CONTRACT",
      "sourceRef": "ID-181922",
      "contractNumber": "1122241515"
    },
    "insertedDateTime": "2024-09-13T06:24:57.942Z",
    "returnSettlementDate": "2021-02-03",
    "creditTransferSettlementDate": "2021-02-03",
    "originalIban": "string",
    "reservationId": "ID-1000",
    "paymentTransactionTypeCode": "SEPA2ACC_PAY",
    "paymentFeeTransactionTypeCode": "string",
    "chargeBearer": "SHA",
    "instrumentCode": "PAYMENT.SEPA2ACC",
    "paymentServiceProviderCode": "SHA",
    "accountTypeCode": "CURRENCY",
    "fxPaymentFlag": true,
    "fixedSide": "PAYMENT",
    "fxQuoteRequestId": "ID-2000",
    "fxQuoteResponseId": "ID-3000",
    "exchangeRate": 0.84,
    "coverMoney": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "paymentMoney": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "reservationMoney": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "initialBalance": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "fxMarginMoney": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "errorCode": "err.technical",
    "paymentDetails": [
      {
        "amount": {
          "amount": 1.22,
          "currencyCode": "EUR"
        },
        "typeCode": "OUR_FEE"
      }
    ],
    "paymentParties": [
      {
        "name": "Airport Hotel Gmbh",
        "address": {
          "street1": "Hugo-Eckener-Ring 1",
          "street2": "Apartment Number 40",
          "cityCounty": "Frankfurt am Main",
          "stateRegion": "Hesse",
          "zip": "60549",
          "countryCode": "DE",
          "addressLine": "Hugo-Eckener-Ring 1, Frankfurt am Main, Hesse, 60549, Germany"
        },
        "typeCode": "OUR_CORRESPONDENT",
        "accountNumber": {
          "value": "DE89370400440532013000",
          "type": "IBAN"
        },
        "accountNumberCountryCode": "EE",
        "accountNumberBankCode": "HABA",
        "financialInstitutionId": {
          "value": "MAINDE2XXXX",
          "type": "BIC"
        },
        "personId": "ID-1000",
        "personTypeCode": "P",
        "givenName": "John",
        "surname": "Smith",
        "accountId": "ID-1000",
        "identificationTypeCode": "PASSPORT",
        "identificationValue": "0124R5M1P5",
        "birthDate": "1965-11-24",
        "registrationDate": "2022-09-01",
        "residencyCountryCode": "EE",
        "accountClassCode": "SAFEGUARDED",
        "accountTypeCode": "CURRENCY",
        "countryCode": "EE",
        "roleCode": "PAYER"
      }
    ],
    "paymentSchemeElements": [
      {
        "fieldValueCountryCode": "EE",
        "fieldValueSchemeTypeCode": "SEPA",
        "fieldValueTypeCode": "FATHER_NAME",
        "fieldValue": "Chuck Norris"
      }
    ],
    "deleted": false,
    "selectedPaymentScheme": "SEPA_INSTANT",
    "purposeCode": "SEPA_INSTANT",
    "amlDeclineReason": "TECHNICAL"
  }
}

Payment router transfer

PAYMENT_ROUTER_TRANSFER_SENT
  • The payment-router API triggers the PAYMENT_ROUTER_TRANSFER_SENT event when an outgoing payment has been sent, and the payment transfer status is set to SENT.

  • Event parameters are eventTypeCode/routing_code: ext.paymentRouters.transfersV2.sent.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "PAYMENT_ROUTER_TRANSFER_SENT",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-12-18T07:06:08.343Z",
  "data": {
    "transferId": "ID-1000",
    "directionCode": "IN",
    "statusCode": "REJECTED",
    "statusCodeReason": "Checksum verification failed",
    "statusReasonCode": "OTHER",
    "valueDate": "2023-11-04",
    "postingDate": "2023-11-04",
    "settlementDate": "2024-12-18",
    "details": "Loan contract TEST_DK_R-1101: Loan amount disbursement",
    "referenceNumber": "123",
    "archiveId": "64cfad3b-8eec-447f-84df-542c9ce07069",
    "endToEndId": "string",
    "instructedId": "string",
    "money": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "fxPaymentFlag": false,
    "fxPayment": {
      "quoteRequestId": "ID-1000",
      "coverMoney": {
        "amount": 1.22,
        "currencyCode": "EUR"
      },
      "exchangeRate": 0.86
    },
    "sentDTime": "2024-12-18T07:06:08.343Z",
    "source": {
      "sourceName": "PAYMENT",
      "sourceRef": "ID-181922"
    },
    "paymentChannelCode": "TRUSTLY",
    "contextTypeCode": "PAYMENT; RETURN",
    "instrumentCode": "string",
    "reconciliation": {
      "reference": "string",
      "referenceSource": "string"
    },
    "tenantCode": "TUUM",
    "countryCode": "DK",
    "contractSource": {
      "sourceName": "LOAN.CONTRACT",
      "sourceRef": "ID-181922",
      "contractNumber": "1122241515"
    },
    "paymentSchemeElements": [
      {
        "fieldValueCountryCode": "EE",
        "fieldValueSchemeTypeCode": "SEPA",
        "fieldValueTypeCode": "FATHER_NAME",
        "fieldValue": "Chuck Norris"
      }
    ],
    "paymentParties": [
      {
        "name": "Airport Hotel Gmbh",
        "address": {
          "street1": "Hugo-Eckener-Ring 1",
          "street2": "Apartment Number 40",
          "cityCounty": "Frankfurt am Main",
          "stateRegion": "Hesse",
          "zip": "60549",
          "countryCode": "DE",
          "addressLine": "Hugo-Eckener-Ring 1, Frankfurt am Main, Hesse, 60549, Germany",
          "addressTypeCode": "R"
        },
        "typeCode": "OUR_CORRESPONDENT",
        "accountNumber": {
          "value": "DE89370400440532013000",
          "type": "IBAN"
        },
        "accountNumberSubtype": "BANKGIRO",
        "accountNumberCountryCode": "EE",
        "accountNumberBankCode": "HABA",
        "financialInstitutionId": {
          "value": "MAINDE2XXXX",
          "type": "BIC"
        },
        "personId": "ID-1000",
        "personTypeCode": "P",
        "givenName": "John",
        "surname": "Smith",
        "accountId": "ID-1000",
        "identificationTypeCode": "PASSPORT",
        "identificationValue": "0124R5M1P5",
        "birthDate": "1965-11-24",
        "registrationDate": "2022-09-01",
        "residencyCountryCode": "EE",
        "accountClassCode": "SAFEGUARDED",
        "accountTypeCode": "CURRENCY",
        "countryCode": "EE",
        "roleCode": "PAYER",
        "allAccountNumbers": [
          {
            "accountNumber": {
              "value": "DE89370400440532013000",
              "type": "IBAN"
            },
            "accountNumberSubtype": "BANKGIRO",
            "financialInstitutionId": {
              "value": "MAINDE2XXXX",
              "type": "BIC"
            },
            "accountNumberCountryCode": "EE"
          }
        ],
        "allAddresses": [
          {
            "street1": "Hugo-Eckener-Ring 1",
            "street2": "Apartment Number 40",
            "cityCounty": "Frankfurt am Main",
            "stateRegion": "Hesse",
            "zip": "60549",
            "countryCode": "DE",
            "addressLine": "Hugo-Eckener-Ring 1, Frankfurt am Main, Hesse, 60549, Germany",
            "addressTypeCode": "R"
          }
        ]
      }
    ],
    "preferredScheme": "string",
    "returnReason": "string",
    "returnReasonText": "string",
    "purposeCode": "string",
    "recallReason": "string",
    "recallRejectReason": "string",
    "chargeBearer": "string",
    "originalTransferId": "string"
  }
}
PAYMENT_ROUTER_TRANSFER_REJECTED_V2
  • The payment-router API triggers the PAYMENT_ROUTER_TRANSFER_REJECTED_V2 event when an outgoing payment has been rejected, and the payment transfer status is set to CANCELLED.

  • Event parameters are eventTypeCode/routing_code: ext.paymentRouters.transfersV2.rejected.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "PAYMENT_ROUTER_TRANSFER_REJECTED_V2",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-12-18T07:18:07.365Z",
  "data": {
    "transferId": "ID-10428",
    "directionCode": "IN",
    "statusCode": "REJECTED",
    "statusCodeReason": "Checksum verification failed",
    "statusReasonCode": "OTHER",
    "valueDate": "2023-11-04",
    "postingDate": "2023-11-04",
    "settlementDate": "2024-12-18",
    "paymentDate": "2023-11-04",
    "referenceNumber": "123",
    "details": "Loan contract TEST_DK_R-1101: Loan amount disbursement",
    "archiveId": "64cfad3b-8eec-447f-84df-542c9ce07069",
    "endToEndId": "string",
    "instructedId": "string",
    "money": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "sentDTime": "2024-12-18T07:18:07.365Z",
    "source": {
      "sourceName": "PAYMENT",
      "sourceRef": "ID-181922"
    },
    "paymentChannelCode": "TRUSTLY",
    "instrumentCode": "string",
    "reconciliation": {
      "reference": "string",
      "referenceSource": "string"
    },
    "tenantCode": "TUUM",
    "countryCode": "DK",
    "contractSource": {
      "sourceName": "LOAN.CONTRACT",
      "sourceRef": "ID-181922",
      "contractNumber": "1122241515"
    },
    "purposeCode": "SALA",
    "contextTypeCode": "string",
    "paymentParties": [
      {
        "name": "Airport Hotel Gmbh",
        "address": {
          "street1": "Hugo-Eckener-Ring 1",
          "street2": "Apartment Number 40",
          "cityCounty": "Frankfurt am Main",
          "stateRegion": "Hesse",
          "zip": "60549",
          "countryCode": "DE",
          "addressLine": "Hugo-Eckener-Ring 1, Frankfurt am Main, Hesse, 60549, Germany",
          "addressTypeCode": "R"
        },
        "typeCode": "OUR_CORRESPONDENT",
        "accountNumber": {
          "value": "DE89370400440532013000",
          "type": "IBAN"
        },
        "accountNumberSubtype": "BANKGIRO",
        "accountNumberCountryCode": "EE",
        "accountNumberBankCode": "HABA",
        "financialInstitutionId": {
          "value": "MAINDE2XXXX",
          "type": "BIC"
        },
        "personId": "ID-1000",
        "personTypeCode": "P",
        "givenName": "John",
        "surname": "Smith",
        "accountId": "ID-1000",
        "identificationTypeCode": "PASSPORT",
        "identificationValue": "0124R5M1P5",
        "birthDate": "1965-11-24",
        "registrationDate": "2022-09-01",
        "residencyCountryCode": "EE",
        "accountClassCode": "SAFEGUARDED",
        "accountTypeCode": "CURRENCY",
        "countryCode": "EE",
        "roleCode": "PAYER",
        "allAccountNumbers": [
          {
            "accountNumber": {
              "value": "DE89370400440532013000",
              "type": "IBAN"
            },
            "accountNumberSubtype": "BANKGIRO",
            "financialInstitutionId": {
              "value": "MAINDE2XXXX",
              "type": "BIC"
            },
            "accountNumberCountryCode": "EE"
          }
        ],
        "allAddresses": [
          {
            "street1": "Hugo-Eckener-Ring 1",
            "street2": "Apartment Number 40",
            "cityCounty": "Frankfurt am Main",
            "stateRegion": "Hesse",
            "zip": "60549",
            "countryCode": "DE",
            "addressLine": "Hugo-Eckener-Ring 1, Frankfurt am Main, Hesse, 60549, Germany",
            "addressTypeCode": "R"
          }
        ]
      }
    ],
    "paymentSchemeElements": [
      {
        "fieldValueCountryCode": "EE",
        "fieldValueSchemeTypeCode": "SEPA",
        "fieldValueTypeCode": "FATHER_NAME",
        "fieldValue": "Chuck Norris"
      }
    ],
    "selectedScheme": "string",
    "preferredScheme": "string",
    "returnReason": "string",
    "returnReasonText": "string",
    "originalTransferId": "string",
    "paymentId": "string",
    "fileReferenceId": "string",
    "settlementAccount": "string",
    "originalPaymentTransferId": "string",
    "sentCount": 0,
    "fileHeaderId": "string",
    "externalTransactionId": "string",
    "chargeBearer": "string",
    "externalServiceProviderCode": "PROVIDER_A"
  }
}
PAYMENT_ROUTER_FX_QUOTE_REQUEST_WAITING
  • The payment-router API triggers the PAYMENT_ROUTER_FX_QUOTE_REQUEST_WAITING event when the FX quote request has been initialised and the payment transfer status is set to WAITING_QUOTE.

  • Event parameters are eventTypeCode/routing_code: ext.paymentRouters.fx-quote-requests.waiting.quote.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "PAYMENT_ROUTER_FX_QUOTE_REQUEST_WAITING",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-09-13T11:03:35.923Z",
  "data": {
    "quoteRequestId": "ID-1000",
    "statusCode": "WAITING_QUOTE",
    "sellCurrencyCode": "DKK",
    "buyCurrencyCode": "EUR",
    "money": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "tenor": "TODAY",
    "requestReasonCode": "PAYMENT",
    "quoteDTime": "2024-09-13T11:03:35.923Z",
    "source": {
      "sourceName": "PAYMENT",
      "sourceRef": "ID-181922"
    }
  }
}

Webhooks with payloads

In this section, you can find the webhooks and their corresponding payloads.

Person
Account
Deposit
Payments
AML processes
Loan
Card
Debt
Finance
Reports
Processes

Loan

Loan application

LOAN_APPLICATION_ACCEPTED
  • The loan-api triggers a LOAN_APPLICATION_ACCEPTED event when a loan application is accepted and its status is set to ACCEPTED.

  • Event parameters are eventTypeCode/routing_code: ext.loans.applications.accepted.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "LOAN_APPLICATION_ACCEPTED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "applicationId": "ID-1619519371",
    "personId": "ID-1000",
    "statusCode": "ACCEPTED",
    "messageDTime": "2021-02-23T08:32:33.0759819Z",
    "bankingDate": "2021-05-01"
  }
}
LOAN_APPLICATION_DECLINED
  • The loan-api triggers a LOAN_APPLICATION_DECLINED event when a loan application is declined and its status is set to DECLINED.

  • Event parameters are eventTypeCode/routing_code: ext.loans.applications.declined.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "LOAN_APPLICATION_DECLINED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "applicationId": "ID-1619519371",
    "personId": "ID-1000",
    "statusCode": "ACCEPTED",
    "messageDTime": "2021-02-23T08:32:33.0759819Z",
    "bankingDate": "2021-05-01"
  }
}

Loan offer

LOAN_OFFER_ACCEPTED
  • The loan-api triggers a LOAN_OFFER_ACCEPTED event when a loan offer is accepted.

  • Event parameters are eventTypeCode/routing_code: ext.loans.offers.accepted.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "LOAN_OFFER_ACCEPTED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "offerId": "ID-1619519375",
    "applicationId": "ID-1619519371",
    "personId": "ID-1000",
    "statusCode": "ACCEPTED",
    "messageDTime": "2021-02-23T08:32:33.0759819Z",
    "bankingDate": "2021-05-01"
  }
}
LOAN_OFFER_PRESENTED
  • The loan API triggers a LOAN_OFFER_PRESENTED event when a loan offer is presented.

  • Event parameters are eventTypeCode/routing_code: ext.loans.offers.presented.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "LOAN_OFFER_PRESENTED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2025-01-30T14:34:18.165Z",
  "data": {
    "offerId": "ID-1619519375",
    "applicationId": "ID-1619519371",
    "personId": "ID-1000",
    "statusCode": "ACCEPTED",
    "messageDTime": "2021-02-23T08:32:33.0759819Z",
    "bankingDate": "2021-05-01"
  }
}

Loan contract

LOAN_CONTRACT_CREATED
  • The loan-api triggers a LOAN_CONTRACT_CREATED event when a loan contract is created.

  • Event parameters are eventTypeCode/routing_code: ext.loans.contracts.created.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "LOAN_CONTRACT_CREATED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "headerId": "ID-1000",
    "personId": "ID-1001",
    "contractNumber": "DC-1483240923",
    "referenceNumber": "12345",
    "repaymentMethod": "RECEIVABLE",
    "offerId": "C000000100018",
    "countryCode": "DE",
    "loanTypeCode": "LOAN01",
    "tenantCode": "RECHT.MAIN",
    "currentVersion": {
      "versionId": "ID-1000",
      "statusCode": "CREATED"
    }
  }
}
LOAN_CONTRACT_ACCEPTED
  • The loan-api triggers a LOAN_CONTRACT_ACCEPTED event when a loan contract is accepted.

  • Event parameters are eventTypeCode/routing_code: ext.loans.contracts.accepted.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "LOAN_CONTRACT_ACCEPTED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "headerId": "ID-1000",
    "personId": "ID-1001",
    "contractNumber": "DC-1483240923",
    "referenceNumber": "12345",
    "repaymentMethod": "RECEIVABLE",
    "offerId": "C000000100018",
    "countryCode": "DE",
    "loanTypeCode": "LOAN01",
    "tenantCode": "RECHT.MAIN",
    "activeVersion": {
      "versionId": "ID-1000",
      "statusCode": "CREATED"
    }
  }
}
LOAN_CONTRACT_WAITING_FOR_ACTIVATION
  • The loan-api triggers a LOAN_CONTRACT_WAITING_FOR_ACTIVATION event if a loan contract is ready for activation and contract status set to WAITING_FOR_ACTIVATION.

  • Event parameters are eventTypeCode/routing_code: ext.loans.contracts.waiting-for-activation.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "LOAN_CONTRACT_WAITING_FOR_ACTIVATION",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2025-01-30T14:55:30.293Z",
  "data": {
    "headerId": "ID-1000",
    "personId": "ID-1001",
    "contractNumber": "DC-1483240923",
    "referenceNumber": "12345",
    "repaymentMethod": "RECEIVABLE",
    "offerId": "C000000100018",
    "countryCode": "DE",
    "loanTypeCode": "LOAN01",
    "tenantCode": "RECHT.MAIN",
    "currentVersion": {
      "versionId": "ID-1000",
      "statusCode": "CREATED"
    }
  }
}
LOAN_CONTRACT_ACTIVATED
  • The loan-api triggers a LOAN_CONTRACT_ACTIVATED event when a loan contract is activated.

  • Event parameters are eventTypeCode/routing_code: ext.loans.contracts.activated.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "LOAN_CONTRACT_ACTIVATED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "headerId": "ID-1000",
    "personId": "ID-1001",
    "contractNumber": "DC-1483240923",
    "referenceNumber": "12345",
    "repaymentMethod": "RECEIVABLE",
    "offerId": "C000000100018",
    "applicationId": "ID-1000",
    "countryCode": "DE",
    "loanTypeCode": "LOAN01",
    "tenantCode": "RECHT.MAIN",
    "currentVersion": {
      "versionId": "ID-1000",
      "statusCode": "CREATED"
    }
  }
}
LOAN_CONTRACT_IMPORTED
  • The loan-api triggers a LOAN_CONTRACT_IMPORTED event when a loan contract is successfully imported.

  • Event parameters are eventTypeCode/routing_code: ext.loans.contracts.imported.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "LOAN_CONTRACT_IMPORTED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "headerId": "ID-1000",
    "personId": "ID-1001",
    "contractNumber": "DC-1483240923",
    "referenceNumber": "12345",
    "repaymentMethod": "RECEIVABLE",
    "offerId": "C000000100018",
    "countryCode": "DE",
    "loanTypeCode": "LOAN01",
    "tenantCode": "RECHT.MAIN",
    "currentVersion": {
      "versionId": "ID-1000",
      "statusCode": "CREATED"
    }
  }
}
LOAN_CONTRACT_REPLACED
  • The loan API triggers a LOAN_CONTRACT_REPLACED event when a loan contract version is replaced and is set to the REPLACED status.

  • Event parameters are eventTypeCode/routing_code: ext.loans.contracts.replaced.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "LOAN_CONTRACT_REPLACED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "headerId": "ID-1000",
    "personId": "ID-1001",
    "contractNumber": "DC-1483240923",
    "referenceNumber": "12345",
    "repaymentMethod": "RECEIVABLE",
    "offerId": "C000000100018",
    "countryCode": "DE",
    "loanTypeCode": "LOAN01",
    "tenantCode": "RECHT.MAIN",
    "currentVersion": {
      "versionId": "ID-1000",
      "statusCode": "CREATED"
    }
  }
}
LOAN_CONTRACT_BLOCKED
  • The loan API triggers a LOAN_CONTRACT_BLOCKED event when a loan contract is blocked.

  • Event parameters are eventTypeCode/routing_code: ext.loans.contracts.blocked.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "LOAN_CONTRACT_BLOCKED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "headerId": "ID-1000",
    "personId": "ID-1001",
    "contractNumber": "DC-1483240923",
    "referenceNumber": "12345",
    "repaymentMethod": "RECEIVABLE",
    "offerId": "C000000100018",
    "applicationId": "ID-1000",
    "countryCode": "DE",
    "loanTypeCode": "LOAN01",
    "tenantCode": "RECHT.MAIN",
    "currentVersion": {
      "versionId": "ID-1000",
      "statusCode": "CREATED"
    }
  }
}
LOAN_CONTRACT_CANCELED
  • The loan-api triggers a LOAN_CONTRACT_CANCELED event when a loan contract is canceled.

  • Event parameters are eventTypeCode/routing_code: ext.loans.contracts.canceled.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "LOAN_CONTRACT_CANCELED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "headerId": "ID-1000",
    "personId": "ID-1001",
    "contractNumber": "DC-1483240923",
    "referenceNumber": "12345",
    "repaymentMethod": "RECEIVABLE",
    "offerId": "C000000100018",
    "countryCode": "DE",
    "loanTypeCode": "LOAN01",
    "tenantCode": "RECHT.MAIN",
    "currentVersion": {
      "versionId": "ID-1000",
      "statusCode": "CREATED"
    }
  }
}

Loan type

LOAN_TYPE_CHANGED
  • The loan-api triggers a LOAN_TYPE_CHANGED event if loan product settings was changed.

  • Event parameters are eventTypeCode/routing_code: ext.loans.products.loan-type.changed.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "LOAN_TYPE_CHANGED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2025-01-30T15:33:12.180Z",
  "data": {
    "loanTypeCode": "string",
    "tenantCode": "string",
    "statusCode": "string",
    "bankingDate": "2025-01-30"
  }
}

Loan repayment management

LOAN_RECEIVABLE_CREATED
  • The loan-api triggers a LOAN_RECEIVABLE_CREATED event with details of a receivable if it is created.

  • Event parameters are eventTypeCode/routing_code: ext.loans.receivables.receivable.created.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "LOAN_RECEIVABLE_CREATED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "receivable": {
      "receivableId": "R000000001028",
      "contractId": "ID-1643361137",
      "receivableGroupCode": "INVOICE",
      "receivableTypeCode": "PERIODIC",
      "invoiceReason": "PERIODIC",
      "receivableNumber": "R000000001028",
      "statusCode": "CREATED",
      "billingDate": "2022-02-09",
      "dueDate": "2022-02-09",
      "receivableAmountMoney": {
        "amount": 0,
        "currencyCode": "str"
      },
      "billingPeriodRange": {
        "startDate": "2023-07-21",
        "endDate": "2023-07-21"
      },
      "interestPeriodRange": {
        "startDate": "2023-07-21",
        "endDate": "2023-07-21"
      },
      "description": "Testing",
      "previousReceivableId": "string",
      "solvencyLevelCode": "string",
      "changeReasonCode": "string",
      "generationDtime": "2022-02-01T11:20:11.248524Z"
    },
    "contract": {
      "contractNumber": "TEST_DK_R-1010",
      "productType": "TEST_DK_1.0_RECE",
      "countryCode": "DK",
      "personId": "ID-1010",
      "referenceNumber": "RF1550048",
      "invoiceDeliveryMethodCode": "POST",
      "repaymentChannelCode": "TRUSTLY"
    },
    "receivableLines": [
      {
        "receivableLineId": "R000000001000",
        "creditedReceivableLineId": "string",
        "lineTypeCode": "COF",
        "lineSubtypeCode": "string",
        "description": "string",
        "amountMoney": {
          "amount": 0,
          "currencyCode": "str"
        },
        "source": {
          "sourceName": "string",
          "sourceRef": "string"
        },
        "originalSource": {
          "sourceName": "string",
          "sourceRef": "string"
        }
      }
    ]
  }
}

LOAN_INVOICE_CREATED
  • The loan-api triggers a LOAN_INVOICE_CREATED event if invoice created.

  • Event parameters are eventTypeCode/routing_code: ext.loans.contracts.invoices.created.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "LOAN_INVOICE_CREATED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "invoiceHeader": {
      "productType": "LOAN_PRODUCT_01",
      "contractId": "ID-1000",
      "contractNumber": "KWR1044",
      "invoiceId": "ID-1000",
      "invoiceType": "PERIODIC",
      "invoiceNumber": "R000000001105",
      "invoiceReason": "PERIODIC",
      "language": "en",
      "billingDate": "2021-04-30",
      "dueDate": "2021-05-21",
      "billingPeriodRange": {
        "startDate": "2023-07-21",
        "endDate": "2023-07-21"
      },
      "interestPeriodRange": {
        "startDate": "2023-07-21",
        "endDate": "2023-07-21"
      },
      "monthlyRepaymentMoney": {
        "amount": 0,
        "currencyCode": "str"
      },
      "generationDtime": "2021-02-23T08:32:33.0759819Z",
      "additionalData": {
        "paymentFreeMonths": [
          "FEBRUARY",
          "JULY"
        ]
      }
    },
    "receiverInfo": {
      "personId": "ID-1000",
      "idNumber": "38802020176",
      "givenName": "Markko",
      "middleName": "Lee",
      "surname": "Martin",
      "companyName": "Modular Finance OU",
      "deliveryMethodCode": "POST",
      "email": "[email protected]",
      "phoneNumber": "+3721234123",
      "addressInfo": [
        {
          "addressTypeCode": "R for Registration, C for Contact",
          "street1": "Villardi 4-5",
          "street2": "Kassisaba",
          "cityCounty": "Tallinn",
          "stateRegion": "Harjumaa",
          "zip": "10136",
          "countryCode": "EE"
        }
      ],
      "additionalData": {
        "additionalProp1": {},
        "additionalProp2": {},
        "additionalProp3": {}
      }
    },
    "paymentInfo": {
      "referenceNumber": "00001234561",
      "paymentMoney": {
        "amount": 0,
        "currencyCode": "str"
      }
    },
    "lines": [
      {
        "lineGroupCode": "INVOICE_LINE",
        "lineTypeCode": "PRI",
        "lineSubtypeCode": "INTEREST_STATEMENT",
        "lineText": "string",
        "lineMoney": {
          "amount": 0,
          "currencyCode": "str"
        },
        "lineRate": {
          "baseRate": -0.254,
          "marginRate": 7.265,
          "rate": 7.011,
          "periodRange": {
            "startDate": "2023-07-21",
            "endDate": "2023-07-21"
          },
          "referenceRateType": "EURIBOR-3M"
        },
        "lineDate": "2021-04-30",
        "additionalData": {
          "dueInvoiceNumber": "INV-10000234"
        }
      }
    ]
  }
}

LOAN_CREDIT_NOTE_CREATED
  • The loan-api triggers a LOAN_CREDIT_NOTE_CREATED event when a credit note is created.

  • Event parameters are eventTypeCode/routing_code: ext.loans.receivables.credit-note.created.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "LOAN_CREDIT_NOTE_CREATED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "creditNoteHeader": {
      "creditNoteId": "ID-1000",
      "creditNoteReason": "AUTOMATIC",
      "creditedInvoiceId": "R000000001105",
      "generationDtime": "2021-02-23T08:32:33.0759819Z",
      "language": "en",
      "billingDate": "2021-04-30",
      "dueDate": "2021-05-21",
      "contractId": "ID-1000",
      "contractNumber": "KWR1044",
      "additionalData": {
        "paymentFreeMonths": [
          "FEBRUARY",
          "JULY"
        ]
      }
    },
    "receiverInfo": {
      "personId": "ID-1000",
      "idNumber": "38802020176",
      "givenName": "Markko",
      "middleName": "Lee",
      "surname": "Martin",
      "companyName": "Modular Finance OU",
      "deliveryMethodCode": "POST",
      "email": "[email protected]",
      "phoneNumber": "+3721234123",
      "addressInfo": [
        {
          "addressTypeCode": "R for Registration, C for Contact",
          "street1": "Villardi 4-5",
          "street2": "Kassisaba",
          "cityCounty": "Tallinn",
          "stateRegion": "Harjumaa",
          "zip": "10136",
          "countryCode": "EE"
        }
      ],
      "additionalData": {
        "additionalProp1": {},
        "additionalProp2": {},
        "additionalProp3": {}
      }
    },
    "paymentInfo": {
      "referenceNumber": "00001234561",
      "paymentMoney": {
        "amount": 0,
        "currencyCode": "str"
      }
    },
    "lines": [
      {
        "lineGroupCode": "INVOICE_LINE",
        "lineTypeCode": "PRI",
        "lineSubtypeCode": "INTEREST_STATEMENT",
        "lineText": "string",
        "lineMoney": {
          "amount": 0,
          "currencyCode": "str"
        },
        "lineRate": {
          "baseRate": -0.254,
          "marginRate": 7.265,
          "rate": 7.011,
          "periodRange": {
            "startDate": "2023-07-21",
            "endDate": "2023-07-21"
          },
          "referenceRateType": "EURIBOR-3M"
        },
        "lineDate": "2021-04-30",
        "additionalData": {
          "dueInvoiceNumber": "INV-10000234"
        }
      }
    ]
  }
}

LOAN_REPAYMENT_REGISTERED
  • The loan-api triggers a LOAN_REPAYMENT_REGISTERED event if a loan contract repayment is registered.

  • Event parameters are eventTypeCode/routing_code: ext.loans.receivables.cash-events.repayments.registered.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "LOAN_REPAYMENT_REGISTERED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "receivableEventTypeCode": "INCOMING",
    "contractId": "ID-1619519590",
    "referenceNumber": "referenceNumber",
    "cashId": "R000000001059",
    "valueDate": "2023-07-21",
    "postingDate": "2023-07-21",
    "description": "string",
    "money": {
      "amount": 0,
      "currencyCode": "str"
    },
    "source": {
      "sourceName": "string",
      "sourceRef": "string"
    },
    "originalSource": {
      "sourceName": "string",
      "sourceRef": "string"
    },
    "accountSource": {
      "sourceName": "string",
      "sourceRef": "string"
    },
    "payerName": "John Smith",
    "paymentChannelCode": "TRUSTLY",
    "endToEndId": "12345678"
  }
}
LOAN_REPAYMENT_CONFIRMED
  • The loan-api triggers a LOAN_REPAYMENT_CONFIRMED event if a loan contract repayment is confirmed.

  • Event parameters are eventTypeCode/routing_code: ext.loans.receivables.cash-events.repayments.confirmed.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "LOAN_REPAYMENT_CONFIRMED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "receivableEventTypeCode": "PREMATURE_REPAYMENT",
    "valueDate": "2023-07-21",
    "postingDate": "2023-07-21",
    "description": "string",
    "money": {
      "amount": 0,
      "currencyCode": "str"
    },
    "cashEventId": "string",
    "balanceDirectionCode": "string",
    "source": {
      "sourceName": "string",
      "sourceRef": "string"
    },
    "originalSource": {
      "sourceName": "string",
      "sourceRef": "string"
    },
    "cash": {
      "contractId": "string",
      "referenceNumber": "string",
      "cashId": "string",
      "statusCode": "string",
      "balanceAmount": {
        "amount": 0,
        "currencyCode": "str"
      },
      "source": {
        "sourceName": "string",
        "sourceRef": "string"
      },
      "originalSource": {
        "sourceName": "string",
        "sourceRef": "string"
      },
      "accountSource": {
        "sourceName": "string",
        "sourceRef": "string"
      },
      "endToEndId": "string"
    },
    "receivableEvent": {
      "receivableEventId": "string",
      "receivableId": "string",
      "receivableLineId": "string",
      "itemTypeCode": "string"
    }
  }
}

Loan death notification

LOAN_CUSTOMER_DEATH_NOTIFICATION
  • The loan-api triggers a LOAN_CUSTOMER_DEATH_NOTIFICATION notification in the event when a customer's death is detected, provided there are active loan contracts with an outstanding balance greater than zero.

  • Event parameters are eventTypeCode/routing_code: ext.loans.contracts.letters.created.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "LOAN_CUSTOMER_DEATH_NOTIFICATION",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "letterHeader": {
      "productType": "LOAN_PRODUCT_01",
      "letterType": "RL1",
      "generationDtime": "2021-02-23T08:32:33.0759819Z",
      "additionalData": {
        "additionalProp1": {},
        "additionalProp2": {},
        "additionalProp3": {}
      }
    },
    "receiverInfo": {
      "personId": "ID-1000",
      "idNumber": "38802020176",
      "givenName": "Markko",
      "middleName": "Lee",
      "surname": "Martin",
      "companyName": "Modular Finance OU",
      "birthDate": "1960-01-15",
      "deathDate": "2021-03-15",
      "email": "[email protected]",
      "phoneNumber": "+3721234123",
      "language": "en",
      "deliveryMethodCode": "POST",
      "addressInfo": [
        {
          "addressTypeCode": "R for Registration, C for Contact",
          "street1": "Villardi 4-5",
          "street2": "Kassisaba",
          "cityCounty": "Tallinn",
          "stateRegion": "Harjumaa",
          "zip": "10136",
          "countryCode": "EE"
        }
      ]
    },
    "contractInfo": {
      "contractId": "ID-1000",
      "contractNumber": "KWR1044",
      "amounts": [
        {
          "contextTypeCode": "CURRENT_BALANCE",
          "contextDate": "2021-05-01",
          "money": {
            "amount": 0,
            "currencyCode": "str"
          },
          "balanceMoney": {
            "amount": 0,
            "currencyCode": "str"
          },
          "debtMoney": {
            "amount": 0,
            "currencyCode": "str"
          }
        }
      ]
    },
    "paymentInfo": {
      "referenceNumber": "00001234561",
      "dueDate": "2021-04-01"
    },
    "invoiceInfo": [
      {
        "invoiceId": "R000000001105",
        "invoiceNumber": "R000000001105",
        "billingDate": "2021-04-30",
        "dueDate": "2021-05-21",
        "money": {
          "amount": 0,
          "currencyCode": "str"
        },
        "debtMoney": {
          "amount": 0,
          "currencyCode": "str"
        }
      }
    ]
  }
}

Loan outgoing transfer

LOAN_OUTGOING_TRANSFER
  • The payment-router API triggers the LOAN_OUTGOING_TRANSFER event when an outgoing payment as the loan disbursement has been sent and the payment transfer status is set to SENT.

  • Event parameters are eventTypeCode/routing_code: ext.paymentRouters.transfers.sent.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "LOAN_INVOICE_GENERATION",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-12-18T07:36:38.175Z",
  "data": {
    "transferId": "ID-1000",
    "money": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "contractSource": {
      "sourceName": "PAYMENT",
      "sourceRef": "ID-181922"
    },
    "creditor": {
      "iban": "string",
      "bic": "string",
      "name": "string",
      "accountNumber": "123456",
      "accountNumberCountryCode": "string",
      "bankCode": "string"
    },
    "details": "Details",
    "eventDTime": "2024-12-18T07:36:38.175Z",
    "referenceNumber": "12345",
    "paymentTypeCode": "Return"
  }
}

Card

Card product

CARD_PRODUCT_CHANGED
  • The card API triggers the CARD_PRODUCT_CHANGED notification when a card product is created, activated, updated, or settings changed.

  • Event parameters are eventTypeCode/routing_code: ext.cards.products.changed.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "CARD_PRODUCT_CHANGED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-07-17T13:29:07.768Z",
  "data": {
    "accountOwnerTypeCode": "PRIVATE",
    "applicationStatusCode": "WAITING",
    "bin": "483312",
    "binAdditional": "12",
    "cardDeliveryMethod": "POST",
    "cardVendorId": "11",
    "creditTypeCode": "REVOLVING_MONTHLY",
    "currencyCode": "EUR",
    "defaultExpiryMonths": 5,
    "additionalCardAllowed": true,
    "avsRequired": true,
    "cardAccount": true,
    "closedLoop": true,
    "renewable": true,
    "replaceable": true,
    "usableBeforeDelivery": true,
    "xpaysAllowed": true,
    "issuingCountryCode": "EE",
    "orderPlasticAutomatically": true,
    "panLength": 16,
    "panNumberRange": {
      "startValue": 0,
      "endValue": 0
    },
    "panServiceCode": "201",
    "pinDeliveryMethod": "DIGIPIN",
    "productClass": "DEBIT",
    "productCode": "PRODUCT-1",
    "productName": "Example product",
    "productScheme": "MASTERCARD",
    "productType": "PHYSICAL",
    "profileId": "ID-1",
    "reportingProductCode": "CCP001",
    "settlementCurrencyCode": "EUR",
    "statusCode": "ACTIVE",
    "tenantCode": "TUUM.BRANCH1",
    "tokenisationAuthenticationRequired": true,
    "design": {
      "defaultDesignId": "ID1",
      "allowedDesignIds": [
        "string"
      ]
    },
    "pricing": {
      "defaultPriceListCode": "DEFAULT-PRICE-1",
      "allowedPriceListCodes": [
        "string"
      ]
    },
    "limitGroups": {
      "upperGroupName": "GROUP1",
      "defaultGroupName": "string",
      "allowedGroupNames": [
        "string"
      ]
    },
    "usageGroups": {
      "upperGroupName": "GROUP1",
      "defaultGroupName": "string",
      "allowedGroupNames": [
        "string"
      ]
    },
    "mccGroups": {
      "defaultGroupName": "MCC_GROUP",
      "allowedGroupNames": [
        "string"
      ]
    },
    "panStockWarningThreshold": 0,
    "panThresholdReached": true
  }
}
CARD_PRODUCT_PAN_STOCK_DEPLETED
  • The card API triggers the CARD_PRODUCT_PAN_STOCK_DEPLETED notification when PAN stock exceeds the threshold.

  • Event parameters are eventTypeCode/routing_code: ext.cards.products.pan-stock.depleted.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "CARD_PRODUCT_PAN_STOCK_DEPLETED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-07-17T13:34:39.059Z",
  "data": {
    "accountOwnerTypeCode": "PRIVATE",
    "applicationStatusCode": "WAITING",
    "bin": "483312",
    "binAdditional": "12",
    "cardDeliveryMethod": "POST",
    "cardVendorId": "11",
    "creditTypeCode": "REVOLVING_MONTHLY",
    "currencyCode": "EUR",
    "defaultExpiryMonths": 5,
    "additionalCardAllowed": true,
    "avsRequired": true,
    "cardAccount": true,
    "closedLoop": true,
    "renewable": true,
    "replaceable": true,
    "usableBeforeDelivery": true,
    "xpaysAllowed": true,
    "issuingCountryCode": "EE",
    "orderPlasticAutomatically": true,
    "panLength": 16,
    "panNumberRange": {
      "startValue": 0,
      "endValue": 0
    },
    "panServiceCode": "201",
    "pinDeliveryMethod": "DIGIPIN",
    "productClass": "DEBIT",
    "productCode": "PRODUCT-1",
    "productName": "Example product",
    "productScheme": "MASTERCARD",
    "productType": "PHYSICAL",
    "profileId": "ID-1",
    "reportingProductCode": "CCP001",
    "settlementCurrencyCode": "EUR",
    "statusCode": "ACTIVE",
    "tenantCode": "TUUM.BRANCH1",
    "tokenisationAuthenticationRequired": true,
    "design": {
      "defaultDesignId": "ID1",
      "allowedDesignIds": [
        "string"
      ]
    },
    "pricing": {
      "defaultPriceListCode": "DEFAULT-PRICE-1",
      "allowedPriceListCodes": [
        "string"
      ]
    },
    "limitGroups": {
      "upperGroupName": "GROUP1",
      "defaultGroupName": "string",
      "allowedGroupNames": [
        "string"
      ]
    },
    "usageGroups": {
      "upperGroupName": "GROUP1",
      "defaultGroupName": "string",
      "allowedGroupNames": [
        "string"
      ]
    },
    "mccGroups": {
      "defaultGroupName": "MCC_GROUP",
      "allowedGroupNames": [
        "string"
      ]
    },
    "panStockWarningThreshold": 0,
    "panThresholdReached": true
  }
}

Card management

CARD_CHANGED
  • The card API triggers the CARD_CHANGED notification when a card is created, renewed, or settings changed.

  • Event parameters are eventTypeCode/routing_code: ext.cards.cards.changed.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "CARD_CHANGED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "activationDate": "2023-07-21",
    "cardId": "string",
    "panReference": "string",
    "changedByUserId": "string",
    "changedByUsername": "string",
    "changedTime": "2023-07-21T07:58:57.639Z",
    "contactlessAllowed": true,
    "designCode": "string",
    "oldCardId": "string",
    "personId": "string",
    "productClass": "string",
    "productCode": "string",
    "statusChangeReasonCode": "string",
    "statusCode": "string",
    "tokenisationAuthenticationRequired": true,
    "xpaysAllowed": true
  }
}
CARD_RENEWAL_CREATED
  • The card API triggers the CARD_RENEWAL_CREATED notification when a card renewal event has been created.

  • Event parameters are eventTypeCode/routing_code: ext.cards.card-renewals.created.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "CARD_RENEWAL_CREATED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "cardRenewalId": "C000000100001",
    "cardId": "C000000100008",
    "productCode": "VISA_STUDENT",
    "productScheme": "VISA",
    "productClass": "DEBIT",
    "productType": "STANDARD",
    "accountId": "C000000100008",
    "personId": "ID-1000",
    "statusCode": "ACTIVE",
    "expiryDate": "2023-07-21",
    "designCode": "Design_1",
    "mainCardId": "C000000100001",
    "accountOwnerPersonId": "ID-1000",
    "countryCode": "EE",
    "addressId": "C000000100001",
    "cardDeliveryMethod": "POST",
    "tenantCode": "TUUM",
    "hasTransactions": true
  }
}
MASTERCARD_DIGITIZATION_REQUESTED

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "MASTERCARD_DIGITIZATION_REQUESTED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-10-18T12:57:22.121Z",
  "data": {
    "cardId": "C000000100008",
    "tokenType": "CLOUD",
    "walletId": "123",
    "tokenRequestorId": "12345678888",
    "decision": "APPROVED",
    "tokenId": "MC001718024102",
    "token": "512345******5026",
    "tokenUniqueReference": "DWSPMC000000000132d72d4fcb2f4136a0532d3093ff1a46",
    "tokenExpiry": "2405",
    "activationMethods": [
      {
        "type": "TEXT_TO_CARDHOLDER_NUMBER",
        "value": "+3*******05"
      }
    ]
  }
}
MASTERCARD_TOKEN_UPDATED

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "MASTERCARD_TOKEN_UPDATED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-10-18T12:54:35.283Z",
  "data": {
    "tokenId": "string",
    "cardId": "string",
    "token": "string",
    "tokenUniqueReference": "string",
    "tokenExpiry": "string",
    "tokenType": "string",
    "walletId": "string",
    "deviceName": "string",
    "tokenRequestorId": "string",
    "status": "string",
    "reasonCode": "string",
    "suspendedBy": "string"
  }
}
MASTERCARD_TOKEN_ACTIVATION_CODE_DELIVERED
  • The mastercard API triggers the MASTERCARD_TOKEN_ACTIVATION_CODE_DELIVERED notification when it receives the Mastercard-generated Activation Code from the MDES deliverActivationCode API.

  • Event parameters are eventTypeCode/routing_code: ext.mastercard.token-activation-codes.delivered.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "MASTERCARD_TOKEN_ACTIVATION_CODE_DELIVERED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "cardId": "C000000100008",
    "activationCode": "A1B2C3D4",
    "expirationDateTime": "2023-07-21T08:51:44.867Z",
    "activationMethodType": "TEXT_TO_CARDHOLDER_NUMBER",
    "activationMethodValue": "+372555555",
    "reasonCodes": [
      "string"
    ],
    "consumerFacingEntityName": "My Merchant",
    "walletId": "123",
    "correlationId": "D98765432104"
  }
}
MASTERCARD_TOKEN_SERVICE_ACTIVATED

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "MASTERCARD_TOKEN_SERVICE_ACTIVATED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-10-18T12:59:34.847Z",
  "data": {
    "tokenId": "string",
    "cardId": "string",
    "token": "string",
    "tokenUniqueReference": "string",
    "tokenExpiry": "string",
    "tokenType": "string",
    "walletId": "string",
    "deviceName": "string",
    "tokenRequestorId": "string"
  }
}

Card operations

CARD_AUTHORISATION_CREATED
  • The card API triggers the CARD_AUTHORISATION_CREATED notification with authorisation information (positive or negative outcome) when the card transaction receives the response to the authorisation request.

  • Event parameters are eventTypeCode/routing_code: ext.cards. authorisations.created.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "CARD_AUTHORISATION_CREATED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "transactionId": "string",
    "messageType": "string",
    "transactionTypeCode": "string",
    "accountOwnerPersonId": "string",
    "cardholderPersonId": "string",
    "cardAcceptorNameLocation": "string",
    "purchaseCountryCode": "string",
    "posData": "string",
    "merchantCategoryCode": "string",
    "transactionMoney": {
      "amount": 0,
      "currencyCode": "str"
    },
    "dateLocal": "string",
    "authorisationTime": "2023-07-21T11:47:17.169Z",
    "actionCode": "string",
    "cardId": "string",
    "panReference": "string"
  }
}
CARD_RESERVATION_RESERVED
  • The card API triggers the CARD_RESERVATION_RESERVED notification when it creates a new card reservation.

  • Event parameters are eventTypeCode/routing_code: ext.cards.reservations.reserved.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "CARD_RESERVATION_RESERVED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-07-17T13:47:04.337Z",
  "data": {
    "reservationId": "C000000001000",
    "accountId": "C000000100008",
    "directionCode": "OUT",
    "amount": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "source": {
      "sourceName": "PAYMENT",
      "sourceRef": "ID-181922"
    },
    "details": "string",
    "merchantInfo": "string",
    "additionalInfo": "string",
    "reservedTime": "2024-07-17T13:47:04.337Z"
  }
}
CARD_ACCOUNT_TRANSACTION_CREATED
  • The card API triggers the CARD_ACCOUNT_TRANSACTION_CREATED notification when the card account balance changes.

  • Event parameters are eventTypeCode/routing_code: ext.cards.accounts.transactions.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "CARD_ACCOUNT_TRANSACTION_CREATED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "accountGroupCode": "CREDIT",
    "accountId": "C000000100008",
    "accountTransactionId": "C000000100010",
    "accountTypeCode": "CREDIT1",
    "additionalInfo": "string",
    "amount": {
      "amount": 0,
      "currencyCode": "str"
    },
    "componentTypeCode": "string",
    "contractSource": {
      "sourceName": "string",
      "sourceRef": "string",
      "sourceLink": "string",
      "contractNumber": "string"
    },
    "counterpartyAccountId": "ID-1000",
    "counterpartyBic": "string",
    "counterpartyIban": "string",
    "counterpartyName": "Dan Ficher",
    "countryCode": "EE",
    "details": "Details",
    "directionCode": "IN",
    "groupId": "ID-3000",
    "initialBalanceAmount": {
      "amount": 10,
      "currencyCode": "EUR"
    },
    "merchantInfo": "string",
    "originalDTime": "2020-04-06T14:11:16+01:00",
    "postingDate": "2021-05-31",
    "productClass": "DEBIT",
    "productScheme": "MASTERCARD",
    "reportingProductCode": "CCP001",
    "reversal": true,
    "source": {
      "sourceName": "string",
      "sourceRef": "string",
      "sourceLink": "string"
    },
    "tenantCode": "TUUM",
    "transactionDTime": "2021-05-31T14:11:16Z",
    "transactionTypeCode": "CARD_PUR",
    "valueDate": "2020-12-21"
  }
}
CARD_INVOICE_CREATED
  • The card API triggers the CARD_INVOICE_CREATED notification when it creates a new invoice with receivable lines and card contract details.

  • Event parameters are eventTypeCode/routing_code: ext.cards.receivables.receivable.created.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "CARD_INVOICE_CREATED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "invoiceHeader": {
      "productType": "LOAN_PRODUCT_01",
      "contractId": "ID-1000",
      "contractNumber": "KWR1044",
      "invoiceId": "ID-1000",
      "invoiceType": "PERIODIC",
      "invoiceNumber": "R000000001105",
      "invoiceReason": "PERIODIC",
      "language": "en",
      "billingDate": "2021-04-30",
      "dueDate": "2021-05-21",
      "billingPeriodRange": {
        "startDate": "2023-07-21",
        "endDate": "2023-07-21"
      },
      "interestPeriodRange": {
        "startDate": "2023-07-21",
        "endDate": "2023-07-21"
      },
      "monthlyRepaymentMoney": {
        "amount": 0,
        "currencyCode": "str"
      },
      "generationDtime": "2021-02-23T08:32:33.0759819Z",
      "additionalData": {
        "paymentFreeMonths": [
          "FEBRUARY",
          "JULY"
        ]
      }
    },
    "receiverInfo": {
      "personId": "ID-1000",
      "idNumber": "38802020176",
      "givenName": "Markko",
      "middleName": "Lee",
      "surname": "Martin",
      "companyName": "Modular Finance OU",
      "deliveryMethodCode": "POST",
      "email": "[email protected]",
      "phoneNumber": "+3721234123",
      "addressInfo": [
        {
          "addressTypeCode": "R for Registration, C for Contact",
          "street1": "Villardi 4-5",
          "street2": "Kassisaba",
          "cityCounty": "Tallinn",
          "stateRegion": "Harjumaa",
          "zip": "10136",
          "countryCode": "EE"
        }
      ],
      "additionalData": {
        "additionalProp1": {},
        "additionalProp2": {},
        "additionalProp3": {}
      }
    },
    "paymentInfo": {
      "referenceNumber": "00001234561",
      "paymentMoney": {
        "amount": 0,
        "currencyCode": "str"
      }
    },
    "lines": [
      {
        "lineGroupCode": "INVOICE_LINE",
        "lineTypeCode": "PRI",
        "lineSubtypeCode": "INTEREST_STATEMENT",
        "lineText": "string",
        "lineMoney": {
          "amount": 0,
          "currencyCode": "str"
        },
        "lineRate": {
          "baseRate": -0.254,
          "marginRate": 7.265,
          "rate": 7.011,
          "periodRange": {
            "startDate": "2023-07-21",
            "endDate": "2023-07-21"
          },
          "referenceRateType": "EURIBOR-3M"
        },
        "lineDate": "2021-04-30",
        "additionalData": {
          "dueInvoiceNumber": "INV-10000234"
        }
      }
    ]
  }
}
CARD_RECEIVABLE_BALANCE_CHANGED
  • The card API triggers the CARD_RECEIVABLE_BALANCE_CHANGED notification when the balance of an invoice (invoice line) changes or a credit note is created.

  • Event parameters are eventTypeCode/routing_code: ext.cards.receivables.receivable-balances.changed.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "CARD_RECEIVABLE_BALANCE_CHANGED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-07-17T13:37:25.869Z",
  "data": {
    "receivableId": "R000000001028",
    "contractId": "ID-1643361137",
    "receivableTypeCode": "PERIODIC",
    "receivableNumber": "R000000001028",
    "receivableReasonCode": "PERIODIC",
    "billingDate": "2022-02-09",
    "dueDate": "2022-02-09",
    "paidDate": "2022-02-09",
    "statusCode": "CREATED",
    "receivableLines": [
      {
        "receivableLineId": "R000000001000",
        "creditNoteReceivableId": "string",
        "creditedReceivableLineId": "string",
        "itemTypeCode": "COF",
        "money": {
          "amount": 1.22,
          "currencyCode": "EUR"
        },
        "balanceMoney": {
          "amount": 1.22,
          "currencyCode": "EUR"
        },
        "debtMoney": {
          "amount": 1.22,
          "currencyCode": "EUR"
        },
        "debtStartDate": "2024-07-17",
        "paidDate": "2024-07-17",
        "source": {
          "sourceName": "PAYMENT",
          "sourceRef": "ID-181922"
        }
      }
    ]
  }
}
CARD_REPAYMENT_CONFIRMED
  • The card API triggers the CARD_REPAYMENT_CONFIRMED notification when repayment is allocated to an invoice at card credit contract.

  • Event parameters are eventTypeCode/routing_code: ext.cards.receivables.cash-events.repayments.confirmed.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "CARD_REPAYMENT_CONFIRMED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-07-18T10:29:50.557Z",
  "data": {
    "receivableEventTypeCode": "PREMATURE_REPAYMENT",
    "valueDate": "2024-07-18",
    "postingDate": "2024-07-18",
    "description": "string",
    "money": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "cashEventId": "string",
    "balanceDirectionCode": "string",
    "source": {
      "sourceName": "PAYMENT",
      "sourceRef": "ID-181922"
    },
    "originalSource": {
      "sourceName": "PAYMENT",
      "sourceRef": "ID-181922"
    },
    "cash": {
      "contractId": "string",
      "referenceNumber": "string",
      "cashId": "string",
      "statusCode": "string",
      "balanceAmount": {
        "amount": 1.22,
        "currencyCode": "EUR"
      },
      "source": {
        "sourceName": "PAYMENT",
        "sourceRef": "ID-181922"
      },
      "originalSource": {
        "sourceName": "PAYMENT",
        "sourceRef": "ID-181922"
      },
      "accountSource": {
        "sourceName": "PAYMENT",
        "sourceRef": "ID-181922"
      },
      "endToEndId": "string"
    },
    "receivableEvent": {
      "receivableEventId": "string",
      "receivableId": "string",
      "receivableLineId": "string",
      "itemTypeCode": "string"
    }
  }
}

Card credit offer

CARD_CREDIT_OFFER_ACCEPTED
  • The card API triggers the CARD_CREDIT_OFFER_ACCEPTED event when a customer accepts a credit card offer, and the offer status is set to ACCEPTED.

  • Event parameters are eventTypeCode/routing_code: ext.cards.offers.accepted.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "CARD_CREDIT_OFFER_ACCEPTED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-07-17T10:24:26.217Z",
  "data": {
    "offerId": "C000000100018",
    "cardApplicationId": "C00000000001",
    "contractHeaderId": "C000000100001",
    "contractVersionId": "C000000100001",
    "creditTypeCode": "REVOLVING_MONTHLY",
    "priceListCode": "STANDARD",
    "offerTypeCode": "NEW_CREDIT",
    "personId": "C000000100001",
    "serviceAccount": {
      "sourceName": "PAYMENT",
      "sourceRef": "ID-181922"
    },
    "serviceAccountNumber": "MT99123456789012345678"
  }
}
CARD_CREDIT_OFFER_CHANGED
  • The card API triggers the CARD_CREDIT_OFFER_CHANGED event when a credit card offer is changed, and the offer status is set to PRESENTED.

  • Event parameters are eventTypeCode/routing_code: ext.cards.offers.changed.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "CARD_CREDIT_OFFER_CHANGED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-07-17T10:42:59.678Z",
  "data": {
    "offerId": "C000000100018",
    "cardApplicationId": "C00000000001",
    "contractHeaderId": "C000000100001",
    "contractVersionId": "C000000100001",
    "creditTypeCode": "REVOLVING_MONTHLY",
    "priceListCode": "STANDARD",
    "offerTypeCode": "NEW_CREDIT",
    "personId": "C000000100001",
    "serviceAccount": {
      "sourceName": "PAYMENT",
      "sourceRef": "ID-181922"
    },
    "serviceAccountNumber": "MT99123456789012345678"
  }
}
CARD_CREDIT_OFFER_CANCELLED
  • The card API triggers the CARD_CREDIT_OFFER_CANCELLED event when a bank cancels a credit card offer, and the offer status is set to CANCELLED.

  • Event parameters are eventTypeCode/routing_code: ext.cards.offers.cancelled.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "CARD_CREDIT_OFFER_CANCELLED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-07-17T10:37:43.683Z",
  "data": {
    "offerId": "C000000100018",
    "cardApplicationId": "C00000000001",
    "contractHeaderId": "C000000100001",
    "contractVersionId": "C000000100001",
    "creditTypeCode": "REVOLVING_MONTHLY",
    "priceListCode": "STANDARD",
    "offerTypeCode": "NEW_CREDIT",
    "personId": "C000000100001",
    "serviceAccount": {
      "sourceName": "PAYMENT",
      "sourceRef": "ID-181922"
    },
    "serviceAccountNumber": "MT99123456789012345678"
  }
}
CARD_CREDIT_OFFER_DECLINED
  • The card API triggers CARD_CREDIT_OFFER_DECLINED event when a customer declines a credit card offer, and the offer status is set to DECLINED.

  • Event parameters are eventTypeCode/routing_code: ext.cards.offers.changed.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "CARD_CREDIT_OFFER_DECLINED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-07-17T10:46:53.598Z",
  "data": {
    "offerId": "C000000100018",
    "cardApplicationId": "C00000000001",
    "contractHeaderId": "C000000100001",
    "contractVersionId": "C000000100001",
    "creditTypeCode": "REVOLVING_MONTHLY",
    "priceListCode": "STANDARD",
    "offerTypeCode": "NEW_CREDIT",
    "personId": "C000000100001",
    "serviceAccount": {
      "sourceName": "PAYMENT",
      "sourceRef": "ID-181922"
    },
    "serviceAccountNumber": "MT99123456789012345678"
  }
}

Credit card contract

CARD_CREDIT_CONTRACT_ACTIVATED
  • The card API triggers CARD_CREDIT_CONTRACT_ACTIVATED notification when the card credit contract is activated, and the contract version status is set to ACTIVE.

  • Event parameters are eventTypeCode/routing_code: ext.cards.credit-contracts.activated.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "CARD_CREDIT_CONTRACT_ACTIVATED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-07-17T10:53:51.525Z",
  "data": {
    "contractHeaderId": "C000000100001",
    "contractNumber": "CC1643360320",
    "creditAccountId": "C000000100001",
    "serviceAccountId": "C000000100001",
    "personId": "C000000100001",
    "currentContractVersionId": "C000000100001",
    "firstContractVersionId": "C000000100001",
    "creditOfferId": "C000000100001",
    "creditTypeCode": "C000000100001",
    "tenantCode": "TUUM"
  }
}
CARD_CREDIT_CONTRACT_VERSION_ACTIVATED
  • The card API triggers the CARD_CREDIT_CONTRACT_VERSION_ACTIVATED notification when the credit contract status is changed from BLOCKED to ACTIVE.

  • Event parameters are eventTypeCode/routing_code: ext.cards.credit-contracts.version-activated.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "CARD_CREDIT_CONTRACT_VERSION_ACTIVATED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "contractHeaderId": "C000000100001",
    "contractNumber": "CC1643360320",
    "creditAccountId": "C000000100001",
    "serviceAccountId": "C000000100001",
    "personId": "C000000100001",
    "currentContractVersionId": "C000000100001",
    "firstContractVersionId": "C000000100001",
    "creditOfferId": "C000000100001",
    "creditTypeCode": "C000000100001",
    "tenantCode": "TUUM"
  }
}
CARD_CREDIT_CONTRACT_BLOCKED
  • The card API triggers CARD_CREDIT_CONTRACT_BLOCKED notification when the card credit contract status is set to BLOCKED.

  • Event parameters are eventTypeCode/routing_code: ext.cards.credit-contracts.blocked.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "CARD_CREDIT_CONTRACT_BLOCKED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "contractHeaderId": "C000000100001",
    "contractNumber": "CC1643360320",
    "creditAccountId": "C000000100001",
    "serviceAccountId": "C000000100001",
    "personId": "C000000100001",
    "currentContractVersionId": "C000000100001",
    "firstContractVersionId": "C000000100001",
    "creditOfferId": "C000000100001",
    "creditTypeCode": "C000000100001",
    "tenantCode": "TUUM"
  }
}
CARD_CREDIT_CONTRACT_CLOSED
  • The card API triggers CARD_CREDIT_CONTRACT_CLOSED notification when the card credit contract status is set to CLOSED.

  • Event parameters are eventTypeCode/routing_code: ext.cards.contracts.closed.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "CARD_CREDIT_CONTRACT_CLOSED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "contractHeaderId": "C000000100001",
    "contractNumber": "CC1643360320",
    "creditAccountId": "C000000100001",
    "serviceAccountId": "C000000100001",
    "personId": "C000000100001",
    "currentContractVersionId": "C000000100001",
    "firstContractVersionId": "C000000100001",
    "creditOfferId": "C000000100001",
    "creditTypeCode": "C000000100001",
    "tenantCode": "TUUM"
  }
}
CREDIT_CARD_CONTRACT_DEFAULTED
  • The card API triggers CARD_CREDIT_CONTRACT_DEFAULTED notification when the card credit contract status is set to DEFAULTED.

  • Event parameters are eventTypeCode/routing_code: ext.cards.credit-contracts.defaulted.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "CREDIT_CARD_CONTRACT_DEFAULTED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "contractHeaderId": "C000000100001",
    "contractNumber": "CC1643360320",
    "creditAccountId": "C000000100001",
    "serviceAccountId": "C000000100001",
    "personId": "C000000100001",
    "currentContractVersionId": "C000000100001",
    "firstContractVersionId": "C000000100001",
    "creditOfferId": "C000000100001",
    "creditTypeCode": "C000000100001",
    "tenantCode": "TUUM"
  }
}

Card clearing

CARD_CLEARING_SECOND_PRESENTMENT_RECEIVED
  • CARD_CLEARING_SECOND_PRESENTMENT_RECEIVED notification when it receives a second presentment message within clearing data, and corrective actions will be performed automatically.

  • Event parameters are eventTypeCode/routing_code: cards.clearings.second-presentment.received.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "CARD_CLEARING_SECOND_PRESENTMENT_RECEIVED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-07-17T12:43:15.553Z",
  "data": {
    "clearingTransactionId": "string",
    "presentmentType": "SECOND_PRESENTMENT_FULL",
    "transactionTypeCode": "string",
    "reasonCode": "string",
    "cardId": "C000000100008",
    "cardNumber": "5167371003750356",
    "panReference": "6195391456662197287",
    "cardholderPersonId": "ID-1002",
    "acqReferenceNumber": "string",
    "approvalCode": "string",
    "dateLocal": "string",
    "cardAcceptorNameLocation": "string",
    "purchaseCountryCode": "EST",
    "merchantCategoryCode": "5732",
    "transactionMoney": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "cardMoney": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "statusCode": "string",
    "tenantCode": "string",
    "mastercardData": {
      "messageType": "string",
      "funcCode": "string",
      "reversal": true,
      "reconciliationMoney": {
        "amount": 1.22,
        "currencyCode": "EUR"
      },
      "originalAmount": 0
    },
    "visaData": {
      "usageCode": "string"
    }
  }
}
CARD_CLEARING_TOTALS_RECEIVED
  • The card API triggers the CARD_CLEARING_TOTALS_RECEIVED notification when it receives clearing totals within clearing data.

  • Event parameters are eventTypeCode/routing_code: ext.cards.clearing-totals.loaded.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "CARD_CLEARING_TOTALS_RECEIVED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-07-17T12:50:47.775Z",
  "data": {
    "financialPositionId": "string",
    "fileDate": "2024-07-17",
    "fileId": "string",
    "message": "string"
  }
}
CARD_CLEARING_TRANSACTION_COMPLETED
  • The card API triggers the CARD_CLEARING_TRANSACTION_COMPLETED notification when it receives a clearing transaction and successfully processes it, setting the transaction status_code to C.

  • Event parameters are eventTypeCode/routing_code: ext.cards.clearings.transactions.completed.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "CARD_CLEARING_TRANSACTION_COMPLETED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-07-17T12:58:40.232Z",
  "data": {
    "clearingTransactionId": "string",
    "messageType": "1100",
    "transactionTypeCode": "00",
    "cardholderPersonId": "ID-1002",
    "accountOwnerPersonId": "ID-1000",
    "cardNumber": "5167371003750356",
    "panReference": "6195391456662197287",
    "cardId": "C000000100008",
    "cardAcceptorNameLocation": "string",
    "cardAcceptorId": "10379733",
    "cardAcceptorTerminalId": "QTR20233",
    "purchaseCountryCode": "EE",
    "merchantCategoryCode": "5732",
    "transactionMoney": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "cardMoney": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "posLocalTime": "string",
    "posData22": "500301610000",
    "retrievalReferenceNumber": "string",
    "processedDTime": "2024-07-17T12:58:40.232Z",
    "tenantCode": "string",
    "reversal": true,
    "feeAmount": 0,
    "conversionFee": 0,
    "approvalCode": "string",
    "statusCode": "string",
    "errorCode": "string",
    "presentmentType": "FIRST_PRESENTMENT",
    "acqReferenceNumber": "string"
  }
}
CARD_CLEARING_TRANSACTION_UNMATCHED
  • The card API triggers the CARD_CLEARING_TRANSACTION_UNMATCHED notification when it receives a clearing transaction and successfully processes it, setting the transaction status_code to PROCESSED.

  • Event parameters are eventTypeCode/routing_code: ext.cards.clearings.transactions.unmatched.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "CARD_CLEARING_TRANSACTION_UNMATCHED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-07-17T13:14:44.224Z",
  "data": {
    "clearingTransactionId": "string",
    "messageType": "1100",
    "transactionTypeCode": "00",
    "cardholderPersonId": "ID-1002",
    "accountOwnerPersonId": "ID-1000",
    "cardNumber": "5167371003750356",
    "panReference": "6195391456662197287",
    "cardId": "C000000100008",
    "cardAcceptorNameLocation": "string",
    "cardAcceptorId": "10379733",
    "cardAcceptorTerminalId": "QTR20233",
    "purchaseCountryCode": "EE",
    "merchantCategoryCode": "5732",
    "transactionMoney": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "cardMoney": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "posLocalTime": "string",
    "posData22": "500301610000",
    "retrievalReferenceNumber": "string",
    "processedDTime": "2024-07-17T13:14:44.224Z",
    "tenantCode": "string",
    "reversal": true,
    "feeAmount": 0,
    "conversionFee": 0,
    "approvalCode": "string",
    "statusCode": "string",
    "errorCode": "string",
    "presentmentType": "FIRST_PRESENTMENT",
    "acqReferenceNumber": "string"
  }
}
CARD_CLEARING_TRANSACTION_ERROR
  • The card API triggers the CARD_CLEARING_TRANSACTION_ERROR notification when it receives a clearing transaction and successfully processes it, setting the transaction status_code to E.

  • Event parameters are eventTypeCode/routing_code: ext.cards.clearings.transactions.error.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "CARD_CLEARING_TRANSACTION_ERROR",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-07-17T13:10:40.828Z",
  "data": {
    "clearingTransactionId": "string",
    "messageType": "1100",
    "transactionTypeCode": "00",
    "cardholderPersonId": "ID-1002",
    "accountOwnerPersonId": "ID-1000",
    "cardNumber": "5167371003750356",
    "panReference": "6195391456662197287",
    "cardId": "C000000100008",
    "cardAcceptorNameLocation": "string",
    "cardAcceptorId": "10379733",
    "cardAcceptorTerminalId": "QTR20233",
    "purchaseCountryCode": "EE",
    "merchantCategoryCode": "5732",
    "transactionMoney": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "cardMoney": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "posLocalTime": "string",
    "posData22": "500301610000",
    "retrievalReferenceNumber": "string",
    "processedDTime": "2024-07-17T13:10:40.828Z",
    "tenantCode": "string",
    "reversal": true,
    "feeAmount": 0,
    "conversionFee": 0,
    "approvalCode": "string",
    "statusCode": "string",
    "errorCode": "string",
    "presentmentType": "FIRST_PRESENTMENT",
    "acqReferenceNumber": "string"
  }
}
CARD_CHARGEBACK_RECEIVED
  • The card API triggers the CARD_CHARGEBACK_RECEIVED notification when it receives a chargeback request within clearing data, and the chargeback will be processed automatically.

  • Event parameters are eventTypeCode/routing_code: ext.cards.chargebacks.received.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "CARD_CHARGEBACK_RECEIVED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-07-17T12:28:13.300Z",
  "data": {
    "transactionId": "string",
    "presentmentType": "FIRST_CHARGEBACK_FULL",
    "transactionTypeCode": "00",
    "reasonCode": "string",
    "cardId": "C000000100008",
    "cardNumber": "5167371003750356",
    "panReference": "6195391456662197287",
    "cardholderPersonId": "ID-1002",
    "arn": "string",
    "approvalCode": "string",
    "dateLocal": "string",
    "cardAcceptorNameLocation": "string",
    "purchaseCountryCode": "EST",
    "merchantCategoryCode": "5732",
    "transactionMoney": {
      "amount": 1.22,
      "currencyCode": "EUR"
    },
    "statusCode": "string",
    "tenantCode": "string",
    "mastercardData": {
      "messageType": "string",
      "funcCode": "string",
      "reversal": true,
      "reconciliationMoney": {
        "amount": 1.22,
        "currencyCode": "EUR"
      },
      "originalAmount": 0
    },
    "visaData": {
      "usageCode": "string"
    }
  }
}
CARD_SOURCE_CURRENCY_TOTALS_RECEIVED
  • The card API triggers the CARD_SOURCE_CURRENCY_TOTALS_RECEIVED notification when it receives a currency summary file within clearing data.

  • Event parameters are eventTypeCode/routing_code: ext.cards.source-currency-totals.loaded.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "CARD_SOURCE_CURRENCY_TOTALS_RECEIVED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-07-18T05:57:19.735Z",
  "data": {
    "financialPositionId": "string",
    "fileDate": "2024-07-18",
    "fileId": "string",
    "message": "string"
  }
}
CARD_FEE_COLLECTION_LOADED
  • The card API triggers the CARD_FEE_COLLECTION_LOADED event when it receives a fee collection message with function code 783 within clearing data.

  • Event parameters are eventTypeCode/routing_code: ext.cards.fee-collection.loaded.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "CARD_FEE_COLLECTION_LOADED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-07-18T10:24:46.701Z",
  "data": {
    "feeCollectionId": "string",
    "fileDate": "2024-07-18",
    "fileId": "string",
    "message": "string"
  }
}