LogoLogo
Developer portal
  • Welcome
    • About cookbooks
  • Authentication
    • About authentication
    • Authenticate employee
    • Create customer credentials
    • Authenticate customer
    • Refresh JSON Web Token
    • Invalidate customer credentials
    • Export-import roles
      • Export selected roles
      • Import selected roles
      • Import all roles
  • Header parameters
    • About header parameters
    • Mandatory parameters
    • Optional parameters
      • Requests with same request ID
      • Requests without request ID
  • Employee
    • Create employee
    • Find employee by ID
    • Find employee by username
  • Person
    • Create private person
    • Create legal person
    • Activate person
    • Find person
      • Find person details
      • Find person addresses
    • Create person document
    • Update personal info
    • Update person address
    • Create customer group
    • Create additional contact
    • Assign person to group
    • Create person representation
    • Close person representation
    • Create person financial data
    • Inactivate person
    • Reactivate person
    • Reactivate person
    • Forget person
    • Remove person restoration key
  • ACCOUNTS
    • Create currency account
    • Create internal account
    • Create virtual account
    • Create account application
    • Set account access rights
    • Create account limit code
    • Create account limit type
    • Create account limit
    • Create account class code
    • Create account type class rule
    • Find person accounts
    • Search account transactions
  • Reports
    • Reports
    • Request to generate account transactions report
      • Account transactions report parameters
  • Check report generation status
  • Download requested report
  • DEPOSITS
    • Deposit product management
      • Create deposit class code
      • Create deposit product
      • Update deposit product
      • Activate deposit product
      • Find deposit product
      • Inactivate deposit product
    • Deposit flow
      • Create deposit application
      • Find deposit application
      • Create deposit offer
      • Find deposit offer
      • Edit deposit offer
      • Accept deposit offer
      • Decline deposit offer
      • Find deposit contract
    • Deposit contract management
      • Change payout details
      • Change contract prolongation status
      • Update contract header
      • Adjust deposit contract interest
      • Make premature termination
  • Payments
    • Create outgoing payments
      • Create SEPA payment
      • Create SWIFT payment
      • Create domestic UK payment
      • Create domestic US payment
    • Change payment
    • Cancel payment
    • Confirm payment
    • Find AML information of a payment
    • Find settled SEPA transaction
    • Create payment template
    • Initialise FX quote request
    • Get FX quote response
    • Initiate FX order
  • LOANS
    • Create loan application
    • Accept loan application
    • Find loan application offers
    • Create loan offer
    • Accept loan offer
    • Find person contracts
    • Accept loan contract
    • Disburse loan contract
    • Create contract fee booking
    • Default loan contract
  • CARDS
    • Create price list
    • Create price for the price list
    • Card counting and summing groups
      • Create counting group
      • Create summing group
      • Find counting values for card
      • Find summing values for account
    • Add BIN
    • Create upper limit group
    • Create upper usage group
    • Create card design
    • Create debit card product
    • Activate card product
    • Create debit card application
    • Create credit product
    • Create credit card offer
    • Accept credit card offer
  • Interest base rates
    • Add interest base rate type - periodic
    • Add interest base rate type - instant
  • Interest rate caps
    • Add interest rate cap type
  • Webhooks
    • About webhooks
    • Find available webhooks
    • Enable or disable notification for webhook
      • Enable with notification type and channel code
      • Enable with notification ID
      • Disable with notification type and channel code
      • Disable with notification ID
    • Search subscribed webhooks
    • Subscribe webhook
    • Update webhook subscription
    • Unsubscribe webhook
    • Webhooks with payloads
      • Person
      • Account
      • Deposit
      • Payments
      • AML processes
      • Loan
      • Card
      • Debt
      • Finance
      • Reports
      • Processes
  • Lookups
    • About lookups
    • Find existing lookup groups
    • Find lookup values
      • Find entities
      • Find lookup type codes
      • Find lookup types
      • Find translation of lookup type
    • Create lookup values
      • Create lookup type and codes
      • Create lookup code for existing type
      • Create lookup translation
    • Manage lookup values
      • Mark lookup code as default
      • Remove default lookup code
      • Delete lookup code
  • Custom fields
    • About custom fields
    • Create custom fields
      • Create field set
      • Create fields
      • Create fields with copied values
    • Find custom fields
      • Find field sets
      • Find fields
      • Search custom field sources
      • Get custom field value
    • Update custom fields
      • Update field set
      • Update field
      • Update custom field value
    • Manage custom fields
      • Insert custom field values
      • Copy custom field values
      • Deactivate field
      • Delete custom field value
  • Holidays
    • Create holiday
    • Search existing holidays
    • Search holiday by ID
    • Delete holiday
Powered by GitBook

© Tuum 2024

On this page

Was this helpful?

Export as PDF
  1. Webhooks
  2. Webhooks with payloads

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.

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

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

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

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

PreviousPaymentsNextLoan

Last updated 12 days ago

Was this helpful?