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"
    }
  }
}