Available Subscription Events

Applications

Event Type Description
APPLICATION_READY_FOR_SUBMISSION Generated when an application status changes to "ready_for_submission"
APPLICATION_SUBMITTED Generated when an application status changes to "submitted"
APPLICATION_PROCESSING Generated when an application status changes to "processing"
APPLICATION_CHANGE_REQUESTED Generated when an application status changes to "changes_requested"
APPLICATION_REJECTED Generated when an application status changes to "rejected"
APPLICATION_APPROVED Generated when an application status changes to "approved"

APPLICATION_READY_FOR_SUBMISSION

Copy
Copied
{
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_date": "2022-11-08T19:53:09",
  "event_type": "APPLICATION_READY_FOR_SUBMISSION",
  "event_data":{
    "application": {
        "id": "10000000-1000-1000-1000-100000000000",
        "status": "READY_FOR_SUBMISSION"
    }
  }
}

APPLICATION_SUBMITTED

Copy
Copied
{
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_date": "2022-11-08T19:53:09",
  "event_type": "APPLICATION_SUBMITTED",
  "event_data":{
    "application": {
        "id": "10000000-1000-1000-1000-100000000000",
        "status": "SUBMITTED"
    }
  }
}

APPLICATION_PROCESSING

Copy
Copied
{
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_date": "2022-11-08T19:53:09",
  "event_type": "APPLICATION_PROCESSING",
  "event_data":{
    "application": {
        "id": "10000000-1000-1000-1000-100000000000",
        "status": "PROCESSING"
    }
  }
}

APPLICATION_CHANGE_REQUESTED

Copy
Copied
{
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_date": "2022-11-08T19:53:09",
  "event_type": "APPLICATION_CHANGE_REQUESTED",
  "event_data":{  
    "application": {
        "id": "10000000-1000-1000-1000-100000000000",
        "status": "CHANGES_REQUESTED"
    }
  }
}

APPLICATION_REJECTED

Copy
Copied
{
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_date": "2022-11-08T19:53:09",
  "event_type": "APPLICATION_REJECTED",
  "event_data":{
    "application": {
        "id": "10000000-1000-1000-1000-100000000000",
        "status": "REJECTED"
    }
  }
}

APPLICATION_APPROVED

Copy
Copied
{
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_date": "2022-11-08T19:53:09",
  "event_type": "APPLICATION_APPROVED",
  "event_data":{
    "application": {
        "id": "10000000-1000-1000-1000-100000000000",
        "status": "APPROVED"
    }
  }
}

Customer

Event Type Description
CUSTOMER_ACTIVE Generated when an customer status is set to ‘active’
CUSTOMER_CLOSED Generated when an customer status is set to 'closed'
CUSTOMER_PENDING Generated when an customer status is set to ‘pending’
CUSTOMER_EDD Generated when an customer status is set to ‘edd’ (enhanced due diligence)
CUSTOMER_FROZEN Generated when an customer status is set to ‘frozen’
CUSTOMER_PENDING_L2F Generated when an customer status is set to ‘pending_l2f’
CUSTOMER_EDD_L2F Generated when an customer status is set to ‘edd_l2f’ (enhanced due diligence)
CUSTOMER_FROZEN_L2F Generated when an customer status is set to ‘frozen_l2f’

CUSTOMER_ACTIVE

Copy
Copied
{
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_date": "2022-11-08T19:53:09",
  "event_type": "CUSTOMER_ACTIVE",
  "event_data":{
    "customer": {
        "id": "CUSTOMER_ID_SET_DURING_ONBOARDING",
        "status": "ACTIVE"
    }
  }
}

CUSTOMER_CLOSED

Copy
Copied
{
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_date": "2022-11-08T19:53:09",
  "event_type": "CUSTOMER_CLOSED",
  "event_data":{
    "customer": {
        "id": "CUSTOMER_ID_SET_DURING_ONBOARDING",
        "status": "CLOSED"
    }
  }
}

CUSTOMER_PENDING

Copy
Copied
{
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_date": "2022-11-08T19:53:09",
  "event_type": "CUSTOMER_PENDING",
  "event_data":{
    "customer": {
        "id": "CUSTOMER_ID_SET_DURING_ONBOARDING",
        "status": "PENDING"
    }
  }
}

CUSTOMER_EDD

Copy
Copied
{
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_date": "2022-11-08T19:53:09",
  "event_type": "CUSTOMER_EDD",
  "event_data":{
    "customer": {
        "id": "CUSTOMER_ID_SET_DURING_ONBOARDING",
        "status": "EDD"
    }
  }
}

CUSTOMER_FROZEN

Copy
Copied
{
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_date": "2022-11-08T19:53:09",
  "event_type": "CUSTOMER_FROZEN",
  "event_data":{
    "customer": {
        "id": "CUSTOMER_ID_SET_DURING_ONBOARDING",
        "status": "FROZEN"
    }
  }
}

CUSTOMER_PENDING_L2F

Copy
Copied
{
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_date": "2022-11-08T19:53:09",
  "event_type": "CUSTOMER_PENDING_L2F",
  "event_data":{
    "customer": {
        "id": "CUSTOMER_ID_SET_DURING_ONBOARDING",
        "status": "PENDING_L2F"
    }
  }
}

CUSTOMER_EDD_L2F

Copy
Copied
{
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_date": "2022-11-08T19:53:09",
  "event_type": "CUSTOMER_EDD_L2F",
  "event_data":{
    "customer": {
        "id": "CUSTOMER_ID_SET_DURING_ONBOARDING",
        "status": "EDD_L2F"
    }
  }
}

CUSTOMER_FROZEN_L2F

Copy
Copied
{
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_date": "2022-11-08T19:53:09",
  "event_type": "CUSTOMER_FROZEN_L2F",
  "event_data":{
    "customer": {
        "id": "CUSTOMER_ID_SET_DURING_ONBOARDING",
        "status": "FROZEN_L2F"
    }
  }
}

Account

Event Type Description
ACCOUNT_OPEN Generated when an account status is set to ‘open’
ACCOUNT_CLOSED Generated when an account status is set to ‘closed’
ACCOUNT_FROZEN Generated when an account status is set to ‘frozen’
ACCOUNT_PENDING Generated when an account status is set to ‘pending’
ACCOUNT_EDD Generated when an account status is set to ‘edd’ (enhanced due diligence)
ACCOUNT_DORMANT Generated when an account status is set to ‘dormant’
ACCOUNT_FROZEN_L2F Generated when an account status is set to ‘frozen_l2f’
ACCOUNT_PENDING_L2F Generated when an account status is set to ‘pending_l2f’
ACCOUNT_EDD_L2F Generated when an account status is set to ‘edd_l2f’ (enhanced due diligence)
ACCOUNT_DEPOSIT_INSTRUCTIONS_UPDATE Generated the deposit instructions of an account have been created or updated

ACCOUNT_OPEN

Copy
Copied
{
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_date": "2022-11-08T19:53:09",
  "event_type": "ACCOUNT_OPEN",
  "event_data":{
    "account": {
        "id": "{ACCOUNT_ID}",
        "status": "OPEN"
    }
  }
}

ACCOUNT_CLOSED

Copy
Copied
{
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_date": "2022-11-08T19:53:09",
  "event_type": "ACCOUNT_CLOSED",
  "event_data":{
    "account": {
        "id": "{ACCOUNT_ID}",
        "status": "CLOSED"
    }
  }
}

ACCOUNT_FROZEN

Copy
Copied
{
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_date": "2022-11-08T19:53:09",
  "event_type": "ACCOUNT_FROZEN",
  "event_data":{
    "account": {
        "id": "{ACCOUNT_ID}",
        "status": "FROZEN"
    }
  }
}

ACCOUNT_PENDING

Copy
Copied
{
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_date": "2022-11-08T19:53:09",
  "event_type": "ACCOUNT_PENDING",
  "event_data":{
    "account": {
        "id": "{ACCOUNT_ID}",
        "status": "PENDING"
    }
  }
}

ACCOUNT_EDD

Copy
Copied
{
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_date": "2022-11-08T19:53:09",
  "event_type": "ACCOUNT_EDD",
  "event_data":{
    "account": {
        "id": "{ACCOUNT_ID}",
        "status": "EDD"
    }
  }
}

ACCOUNT_DORMANT

Copy
Copied
{
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_date": "2022-11-08T19:53:09",
  "event_type": "ACCOUNT_DORMANT",
  "event_data":{
    "account": {
        "id": "{ACCOUNT_ID}",
        "status": "DORMANT"
    }
  }
}

ACCOUNT_FROZEN_L2F

Copy
Copied
{
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_date": "2022-11-08T19:53:09",
  "event_type": "ACCOUNT_FROZEN_L2F",
  "event_data":{
    "account": {
        "id": "{ACCOUNT_ID}",
        "status": "FROZEN_L2F"
    }
  }
}

ACCOUNT_PENDING_L2F

Copy
Copied
{
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_date": "2022-11-08T19:53:09",
  "event_type": "ACCOUNT_PENDING_L2F",
  "event_data":{
    "account": {
        "id": "{ACCOUNT_ID}",
        "status": "PENDING_L2F"
    }
  }
}

ACCOUNT_EDD_L2F

Copy
Copied
{
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_date": "2022-11-08T19:53:09",
  "event_type": "ACCOUNT_EDD_L2F",
  "event_data":{
    "account": {
        "id": "{ACCOUNT_ID}",
        "status": "EDD_L2F"
    }
  }
}

ACCOUNT_DEPOSIT_INSTRUCTIONS_UPDATE

The ACCOUNT_DEPOSIT_INSTRUCTIONS_UPDATE event is sent when the deposit instructions on an account are available or have been updated.

Copy
Copied
{
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_date": "2022-11-08T19:53:09",
  "event_type": "ACCOUNT_DEPOSIT_INSTRUCTIONS_UPDATE",
  "event_data":{
    "account": {
        "id": "{ACCOUNT_ID}"
    }
  }
}

Transaction

Event Type Description
TRANSACTION_AUTHORIZED Generated when a transaction is created with status ‘authorized’. See Get Transaction for field details.
TRANSACTION_PENDING Generated when a transaction status changes to status ‘pending’. See Get Transaction for field details.
TRANSACTION_POSTED Generated when a transaction status changes to status ‘posted’. See Get Transaction for field details.
TRANSACTION_CANCELLED Generated when a transaction status changes to status ‘cancelled’. See Get Transaction for field details.

TRANSACTION_AUTHORIZED

Copy
Copied
{
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_date": "2022-11-08T19:53:09",
  "event_type": "TRANSACTION_AUTHORIZED",
  "event_data":{
    "transaction": {
        "id": "10000000-1000-1000-1000-100000000000",
        "account_id": "ID_OF_ACCOUNT_WHERE_TRANSACTION_OCCURRED",
        "value": 99.99,
        "transaction_date": "2022-11-08T19:53:09Z",
        "transaction_posted_date": null,
        "transaction_status": "AUTHORIZED",
        "transaction_type": "TRANSFER_IN",
        "category_type": "DEPOSIT",
        "category_id": "00000000-0000-1234-0000-000012340000"
    }
  }
}

TRANSACTION_PENDING

Copy
Copied
{
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_date": "2022-11-08T19:53:09",
  "event_type": "TRANSACTION_PENDING",
  "event_data":{
    "transaction": {
        "id": "10000000-1000-1000-1000-100000000000",
        "account_id": "ID_OF_ACCOUNT_WHERE_TRANSACTION_OCCURRED",
        "value": 99.99,
        "transaction_date": "2022-11-08T19:53:09Z",
        "transaction_posted_date": null,
        "transaction_status": "PENDING",
        "transaction_type": "TRANSFER_IN",
        "category_type": "DEPOSIT",
        "category_id": "00000000-0000-1234-0000-000012340000"
    }
  }
}

TRANSACTION_POSTED

Copy
Copied
{
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_date": "2022-11-08T19:53:09",
  "event_type": "TRANSACTION_POSTED",
  "event_data":{
    "transaction": {
        "id": "10000000-1000-1000-1000-100000000000",
        "account_id": "ID_OF_ACCOUNT_WHERE_TRANSACTION_OCCURRED",
        "value": 99.99,
        "transaction_date": "2022-11-08T19:53:09Z",
        "transaction_posted_date": "2022-11-08T19:53:09Z",
        "transaction_status": "POSTED",
        "transaction_type": "TRANSFER_IN",
        "category_type": "DEPOSIT",
        "category_id": "00000000-0000-1234-0000-000012340000"
    }
  }
}

TRANSACTION_CANCELLED

Copy
Copied
{
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_date": "2022-11-08T19:53:09",
  "event_type": "TRANSACTION_CANCELLED",
  "event_data":{
    "transaction": {
        "id": "10000000-1000-1000-1000-100000000000",
        "account_id": "ID_OF_ACCOUNT_WHERE_TRANSACTION_OCCURRED",
        "value": 99.99,
        "transaction_date": "2022-11-08T19:53:09Z",
        "transaction_posted_date": "2022-11-08T19:53:09Z",
        "transaction_status": "CANCELLED",
        "transaction_type": "TRANSFER_IN",
        "category_type": "DEPOSIT",
        "category_id": "00000000-0000-1234-0000-000012340000"
    }
  }
}

Counterparty

Event Type Description
COUNTERPARTY_ACTIVE Generated when an counterparty status is set to ‘active’
COUNTERPARTY_CLOSED Generated when an counterparty status is set to 'closed'
COUNTERPARTY_PENDING Generated when an counterparty status is set to ‘pending’
COUNTERPARTY_EDD Generated when an counterparty status is set to ‘edd’ (enhanced due diligence)
COUNTERPARTY_FROZEN Generated when an counterparty status is set to ‘frozen’
COUNTERPARTY_PENDING_L2F Generated when an counterparty status is set to ‘pending_l2f’
COUNTERPARTY_EDD_L2F Generated when an counterparty status is set to ‘edd_l2f’ (enhanced due diligence)
COUNTERPARTY_FROZEN_L2F Generated when an counterparty status is set to ‘frozen_l2f’

COUNTERPARTY_ACTIVE

Copy
Copied
{
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_date": "2022-11-08T19:53:09",
  "event_type": "COUNTERPARTY_ACTIVE",
  "event_data":{
    "counterparty": {
        "id": "10000000-1000-1000-1000-100000000000",
        "status": "ACTIVE"
    }
  }
}

COUNTERPARTY_CLOSED

Copy
Copied
{
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_date": "2022-11-08T19:53:09",
  "event_type": "COUNTERPARTY_CLOSED",
  "event_data":{
    "counterparty": {
        "id": "10000000-1000-1000-1000-100000000000",
        "status": "CLOSED"
    }
  }
}

COUNTERPARTY_PENDING

Copy
Copied
{
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_date": "2022-11-08T19:53:09",
  "event_type": "COUNTERPARTY_PENDING",
  "event_data":{
    "counter_party": {
        "id": "10000000-1000-1000-1000-100000000000",
        "status": "PENDING"
    }
  }
}

COUNTERPARTY_EDD

Copy
Copied
{
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_date": "2022-11-08T19:53:09",
  "event_type": "COUNTERPARTY_EDD",
  "event_data":{
    "counterparty": {
        "id": "10000000-1000-1000-1000-100000000000",
        "status": "EDD"
    }
  }
}

COUNTERPARTY_FROZEN

Copy
Copied
{
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_date": "2022-11-08T19:53:09",
  "event_type": "COUNTERPARTY_FROZEN",
  "event_data":{
    "counterparty": {
        "id": "10000000-1000-1000-1000-100000000000",
        "status": "FROZEN"
    }
  }
}

COUNTERPARTY_PENDING_L2F

Copy
Copied
{
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_date": "2022-11-08T19:53:09",
  "event_type": "COUNTERPARTY_PENDING_L2F",
  "event_data":{
    "counter_party": {
        "id": "10000000-1000-1000-1000-100000000000",
        "status": "PENDING_L2F"
    }
  }
}

COUNTERPARTY_EDD_L2F

Copy
Copied
{
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_date": "2022-11-08T19:53:09",
  "event_type": "COUNTERPARTY_EDD_L2F",
  "event_data":{
    "counterparty": {
        "id": "10000000-1000-1000-1000-100000000000",
        "status": "EDD_L2F"
    }
  }
}

COUNTERPARTY_FROZEN_L2F

Copy
Copied
{
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_date": "2022-11-08T19:53:09",
  "event_type": "COUNTERPARTY_FROZEN_L2F",
  "event_data":{
    "counterparty": {
        "id": "10000000-1000-1000-1000-100000000000",
        "status": "FROZEN_L2F"
    }
  }
}

Withdrawal

Event Type Description
WITHDRAWAL_CHANGES_REQUESTED Generated when a withdrawal's status is updated to "CHANGES_REQUESTED".

WITHDRAWAL_CHANGES_REQUESTED

Copy
Copied
{
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_date": "2022-11-08T19:53:09",
  "event_type": "WITHDRAWAL_CHANGES_REQUESTED",
  "event_data":{
    "withdrawal": {
        "id": "10000000-1000-1000-1000-100000000000",
        "status": "CHANGES_REQUESTED"
    }
  }
}

Payment

Event Type Description
PAYMENT_CHANGES_REQUESTED Generated when a payment's status is updated to "CHANGES_REQUESTED".

PAYMENT_CHANGES_REQUESTED

Copy
Copied
{
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_date": "2022-11-08T19:53:09",
  "event_type": "PAYMENT_CHANGES_REQUESTED",
  "event_data":{
    "withdrawal": {
        "id": "10000000-1000-1000-1000-100000000000",
        "status": "CHANGES_REQUESTED"
    }
  }
}
© 2024 Rail. All Rights Reserved.