# Available Subscription Events

# Applications

| Event Type | Description |
|  --- | --- |
| [APPLICATION_READY_FOR_SUBMISSION](#application_ready_for_submission) | Generated when an application status changes to "ready_for_submission" |
| [APPLICATION_SUBMITTED](#application_submitted) | Generated when an application status changes to "submitted" |
| [APPLICATION_PROCESSING](#application_processing) | Generated when an application status changes to "processing" |
| [APPLICATION_CHANGE_REQUESTED](#application_change_requested) | Generated when an application status changes to "changes_requested" |
| [APPLICATION_REJECTED](#application_rejected) | Generated when an application status changes to "rejected" |
| [APPLICATION_APPROVED](#application_approved) | Generated when an application status changes to "approved" |


## APPLICATION_READY_FOR_SUBMISSION


```json
{
  "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


```json
{
  "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


```json
{
  "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


```json
{
  "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


```json
{
  "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


```json
{
  "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](#customer_active) | Generated when an customer status is set to ‘active’ |
| [CUSTOMER_CLOSED](#customer_closed) | Generated when an customer status is set to 'closed' |
| [CUSTOMER_PENDING](#customer_pending) | Generated when an customer status is set to ‘pending’ |
| [CUSTOMER_EDD](#customer_edd) | Generated when an customer status is set to ‘edd’ (enhanced due diligence) |
| [CUSTOMER_FROZEN](#customer_frozen) | Generated when an customer status is set to ‘frozen’ |
| [CUSTOMER_PENDING_L2F](#customer_pending_l2f) | Generated when an customer status is set to ‘pending_l2f’ |
| [CUSTOMER_EDD_L2F](#customer_edd_l2f) | Generated when an customer status is set to ‘edd_l2f’ (enhanced due diligence) |
| [CUSTOMER_FROZEN_L2F](#customer_frozen_l2f) | Generated when an customer status is set to ‘frozen_l2f’ |


## CUSTOMER_ACTIVE


```json
{
  "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


```json
{
  "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


```json
{
  "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


```json
{
  "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


```json
{
  "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


```json
{
  "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


```json
{
  "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


```json
{
  "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](#account_open) | Generated when an account status is set to ‘open’ |
| [ACCOUNT_CLOSED](#account_closed) | Generated when an account status is set to ‘closed’ |
| [ACCOUNT_FROZEN](#account_frozen) | Generated when an account status is set to ‘frozen’ |
| [ACCOUNT_PENDING](#account_pending) | Generated when an account status is set to ‘pending’ |
| [ACCOUNT_EDD](#account_edd) | Generated when an account status is set to ‘edd’ (enhanced due diligence) |
| [ACCOUNT_DORMANT](#account_dormant) | Generated when an account status is set to ‘dormant’ |
| [ACCOUNT_FROZEN_L2F](#account_frozen_l2f) | Generated when an account status is set to ‘frozen_l2f’ |
| [ACCOUNT_PENDING_L2F](#account_pending_l2f) | Generated when an account status is set to ‘pending_l2f’ |
| [ACCOUNT_EDD_L2F](#account_edd_l2f) | Generated when an account status is set to ‘edd_l2f’ (enhanced due diligence) |
| [ACCOUNT_DEPOSIT_INSTRUCTIONS_UPDATE](#account_deposit_instructions_update) | Generated the deposit instructions of an account have been created or updated |


## ACCOUNT_OPEN


```json
{
  "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


```json
{
  "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


```json
{
  "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


```json
{
  "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


```json
{
  "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


```json
{
  "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


```json
{
  "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


```json
{
  "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


```json
{
  "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.


```json
{
  "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](#transaction_authorized) | Generated when a transaction is created with status ‘authorized’. See [Get Transaction](/api-docs/openapi/rail-spec#operation/getTransaction) for field details. |
| [TRANSACTION_PENDING](#transaction_pending) | Generated when a transaction status changes to status ‘pending’. See [Get Transaction](/api-docs/openapi/rail-spec#operation/getTransaction) for field details. |
| [TRANSACTION_POSTED](#transaction_posted) | Generated when a transaction status changes to status ‘posted’. See [Get Transaction](/api-docs/openapi/rail-spec#operation/getTransaction) for field details. |
| [TRANSACTION_CANCELLED](#transaction_cancelled) | Generated when a transaction status changes to status ‘cancelled’. See [Get Transaction](/api-docs/openapi/rail-spec#operation/getTransaction) for field details. |


## TRANSACTION_AUTHORIZED


```json
{
  "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


```json
{
  "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


```json
{
  "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


```json
{
  "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](#counterparty_active) | Generated when an counterparty status is set to ‘active’ |
| [COUNTERPARTY_CLOSED](#counterparty_closed) | Generated when an counterparty status is set to 'closed' |
| [COUNTERPARTY_PENDING](#counterparty_pending) | Generated when an counterparty status is set to ‘pending’ |
| [COUNTERPARTY_EDD](#counterparty_edd) | Generated when an counterparty status is set to ‘edd’ (enhanced due diligence) |
| [COUNTERPARTY_FROZEN](#counterparty_frozen) | Generated when an counterparty status is set to ‘frozen’ |
| [COUNTERPARTY_PENDING_L2F](#counterparty_pending_l2f) | Generated when an counterparty status is set to ‘pending_l2f’ |
| [COUNTERPARTY_EDD_L2F](#counterparty_edd_l2f) | Generated when an counterparty status is set to ‘edd_l2f’ (enhanced due diligence) |
| [COUNTERPARTY_FROZEN_L2F](#counterparty_frozen_l2f) | Generated when an counterparty status is set to ‘frozen_l2f’ |


## COUNTERPARTY_ACTIVE


```json
{
  "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


```json
{
  "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


```json
{
  "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


```json
{
  "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


```json
{
  "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


```json
{
  "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


```json
{
  "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


```json
{
  "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](#withdrawal_changes_requested) | Generated when a withdrawal's status is updated to "CHANGES_REQUESTED". |


## WITHDRAWAL_CHANGES_REQUESTED


```json
{
  "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](#payment_changes_requested) | Generated when a payment's status is updated to "CHANGES_REQUESTED". |


## PAYMENT_CHANGES_REQUESTED


```json
{
  "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"
    }
  }
}
```