Services

Clients are responsible for implementing services to consume and process messages published on each subscription they would like to establish.
Clients can use the language of their choice to develop the services that will subscribe to and consume RMQ messages.

Customer

Category	Event Name	Trigger	Topic Name
Customer	Customer Status Changed	Sent any time a Customer's status is updated	`<client>.<env>.customer`

{
 "event_type":"status_change",
 "details":{
  "customer_uid":"A1B2C3D48I7H6G5F",
  "external_uid":"h5B7h11M89Yt6R54",
  "new_status":"approved",
  "prior_status":"manual_review"
    }
 }

Category	Event Name	Trigger	Topic Name
Customer	Customer Lock/Unlock	A Customer has been locked or unlocked.	`<client>.<env>.customer`

{
     "event_type": "lock",
      "details": {
       "customer_uid": "TjqM5Rq3RmT2vpW5",
        "external_uid": "40973cf7-c90d-4629-87e2-20dee143c4d7"
      }
    }

Category	Event Name	Trigger	Topic Name
Customer	Document Available	A new document is available.	`<client>.<env>.customer`

{
  "event_type": "document_available",
  "details": {
    "uid": "41tvhZqbUKAUxp4M",
    "name": "v3GBQ1XreY6Bki3N-October-2020",
    "year": 2020,
    "month": 10,
    "pool_uids": ["22CqHKHB6er3Mhez"],
    "customer_uid": "v3GBQ1XreY6Bki3N",
    "document_type": "monthly_statement",
    "period_ended_at": "2020-11-01T00:00:00.000Z",
    "period_started_at": "2020-10-01T00:00:00.000Z"
  }
}

{
  "event_type": "document_available",
  "details": {
    "uid": "UyuKXxx78CigGftr",
    "customer_uid": "1R8csxtA37zraL9T",
    "document_type": "1042",
    "name": "2019 Tax Document 1042",
    "period_started_at": "2019-01-01T00:00:00.000Z",
    "period_ended_at": "2020-01-01T00:00:00.000Z",
    "pool_uids": ["cJLk7KjExtoKKcBQ"],
    "year": 2019
  }
}

Transfer

Category	Event Name	Trigger	Topic Name
Transfer	Transfer Initiated	A transfer has been initiated	`<client>.<env>.transfer`

{
"event_type": "created",
"details": {
 "customer_external_uid":
"A5B4C6F9h51j2j3j",
 "customer_uid": "ab12cd34ef56gh78",
 "transfer_uid": "Zb12cd34ef56gh7X",
 "usd_transfer_amount": "321.00",
 "transaction_uid": "s8J7J6J5J5h31A28"
 }
}

Category	Event Name	Trigger	Topic Name
Transfer	Transfer Status Changed	The status of a transfer has been updated	`<client>.<env>.transfer`

{
"event_type": "status_change",
"details": {
 "customer_external_uid"
"rb12cd34ef56ghd4",
 "customer_uid": "Zb12cd34ef56gh7X",
 "new_status": "finished",
 "transfer_uid": "fb12cd34ef563gq2",
 "transaction_uid": "s8J7J6J5J5h31A28"
  }
 }

Transaction

Category	Event Name	Trigger	Topic Name
Transaction	Transaction Created	A transaction record has been created	`<client>.<env>.transaction`

{
  "event_type":"created",
  "details":{
    "asset_breakdown":[{
        "asset_quantity":"-5.0",
        "asset_type":"USD",
        "synthetic_account_uid":"y3mgbw9CdzMWa2m7",
        "us_dollar_amount":"-5.00"
      },{
        "asset_quantity":"0.25",
        "asset_type":"LPL",
        "synthetic_account_uid":"hpqbJpevVzafUc1T",
        "us_dollar_amount":"5.00"
      }
    ],
    "customer_external_uid":"business-partner-unique-identifier-27",
    "customer_uid":"zK7DSmQiqFVue624",
    "description":"description",
    "destination_synthetic_account_uid":"hpqbJpevVzafUc1T",
    "new_status":"queued",
    "settled_index":null,
    "source_synthetic_account_uid":"y3mgbw9CdzMWa2m7",
    "transaction_uid":"c2c7Kws8cR8ZCBLn",
    "type":"atm_withdrawal",
    "us_dollar_amount":"1.23"
  }
}

Category	Event Name	Trigger	Topic Name
Transaction	Transaction Status Updated	The status of a transaction has been updated	`<client>.<env>.transaction`

{
  "event_type":"updated",
  "details":{
    "asset_breakdown":[{
        "asset_quantity":"-5.0",
        "asset_type":"USD",
        "synthetic_account_uid":"zoPodA7UtHKm9APD",
        "us_dollar_amount":"-5.00"
      },{
        "asset_quantity":"0.25",
        "asset_type":"LPL",
        "synthetic_account_uid":"phBEeJ4CN8EVuBAU",
        "us_dollar_amount":"5.00"
      }
    ],
    "customer_external_uid":"business-partner-unique-identifier-8",
    "customer_uid":"gXjG87TQEUmsdVSg",
    "description":"description",
    "destination_synthetic_account_uid":"phBEeJ4CN8EVuBAU",
    "new_status":"queued",
    "settled_index":null,
    "source_synthetic_account_uid":"zoPodA7UtHKm9APD",
    "transaction_uid":"exJmgX7ABWX4DFU4",
    "type":"atm_withdrawal",
    "us_dollar_amount":"1.23",
  }
}

Adjustments

Category	Event Name	Trigger	Topic Name
Adjustments	Adjustment Created	An adjustment has been created	`<client>.<env>.adjustment`

{
        "event_type": "created",
        "details": {
          "customer_external_uid": "4c7575aa-2738-4327-9ac5-84ccd66f1418",
          "customer_uid": "vZDPGJxdcXzYv72Z",
          "adjustment_uid": "f8fk7tuDzyapV5dy",
          "adjustment_type_uid": "pmr1urvkJLkMVTd1",
          "quantity": "12.21",
          "transaction_uid": "yBiL3XboaSCHa7CK"
        }
      }

Category	Event Name	Trigger	Topic Name
Adjustments	Adjustment Status Updated	The status of an adjustments has been updated	`<client>.<env>.adjustment`

{
        "event_type": "status_change",
        "details": {
          "adjustment_uid": "QB74AR5XqALuYFWu",
          "customer_external_uid": "356acbe8-5959-4aa5-a309-fd5360862b87",
          "customer_uid": "fLM7hjs5MqfDNnvd",
          "new_status": "settled",
          "old_status": "initiated",
          "transaction_uid": "yBiL3XboaSCHa7CK"
        }
      }

Debit Card

Category	Event Name	Trigger	Topic Name
Debit Card	Debit Card PIN Commit Failed	An exception is raised during a request to Galileo to change the PIN	`<client>.<env>.debit_card`

{
  "event_type":"pin_commit_failed",
  "details":{
    "card_last_four":"0001",
    "customer_uid":"x36cG3iqxKvpPcip",
    "debit_card_uid":"v3UtRfwaccDKCFgA",
    "external_uid":"external-uid-1",
    "pool_uid":"jwRqFrWsjbzPAtiy"
  }
}

Category	Event Name	Trigger	Topic Name
Debit Card	Debit Card Requested	A customer has requested a new debit card for an account	`<client>.<env>.debit_card`

{
 "event_type": "requested",
"details": {
 "card_last_four": "1243",
 "customer_uid": "A7A7b8b85D3D3D3D"
 "debit_card_uid": "jfidKFgdiPogem6B",
 "external_uid": "2E2D2E3W4e5r6t7y",
 "pool_uid": "AbCdEfGh12983874"
 }
}

Category	Event Name	Trigger	Topic Name
Debit Card	Debit Card Status Updated	The status of a debit card has been updated	`<client>.<env>.debit_card`

{
 "event_type": "status_change",
"details":{
 "card_last_four": "3421",
 "customer_uid": "Q9A7b8b85D3D3D3D",
 "debit_card_uid": "jfidKFgdiPogem6B",
 "external_uid": "H7A7b8b85D3D5D3E",
 "new_status": "normal",
 "pool_uid": "4E2D2E3W4e5r6t7y",
 "prior_status": "shipped",
 "ready_to_use": "true"
 }
}

Category	Event Name	Trigger	Topic Name
Debit Card	Debit Card Issued	A debit card has been issued	`<client>,<env>.debit_card`

{
 "event_type": "issued",
 "details": {
  "card_last_four": "1243",
  "customer_uid": "A7A7b8b85D3D3D3D",
  "debit_card_uid": "jfidKFgdiPogem6B",
  "external_uid": "2E2D2E3W4e5r6t7y",
  "pool_uid": "AbCdEfGh12983874"
  }
 }

Category	Event Name	Trigger	Topic Name
Debit Card	Debit Card Reissue Requested	A debit card reissue has been requested	`<client>.<env>.debit_card`

{
"event_type": "reissue_requested",
"details": {
 "card_last_four": "3421",
 "customer_uid": "Q9A7b8b85D3D3D3D",
 "debit_card_uid": "jfidKFgdiPogem6B",
 "external_uid": "H7A7b8b85D3D5D3E",
 "reason": "damaged",
 "pool_uid": "4E2D2E3W4e5r6t7y"
 }
}

Category	Event Name	Trigger	Topic Name
Debit Card	Debit Card Lock/Unlock	A debit card has been locked or unlocked	`<client>.<env>.debit_card`

{
      event_type: "lock",
      details: {
        debit_card_uid: "hWqvosBLynaD9J1Y",
        external_uid: "48fce2be-728e-4624-90ff-f26e01a46bf5"
      }
    }

Synthetic Account

Category	Event Name	Trigger	Topic Name
Synthetic Account	Synthetic Account Status Changed	The status of a synthetic account has been updated	`<client>.<env>.synthetic_account`

{ 
"event_type": "status_change",
"details": {
 "additional_info": {
  "message": "error message; additional_info could be null",
 "plaid": {
  "error_code": "code from plaid if plaid_external",
  "error_message": "code from plaid if plaid_external",
  "error_type": "type from plaid if plaid_external",
  "request_id": "request_id from plaid if plaid_external"
  "error_type": "type from plaid if plaid_external",
  "request_id": "request_id from plaid if plaid_external"
 }
},
 "external_uid": "client-generated-id",
 "new_status": "failed",
 "old_status": "initiated",
 "synthetic_account_category": "plaid_external",
 "synthetic_account_uid": "6NrMNrdB4hVHDXbx"
 }
}

Category	Event Name	Trigger	Topic Name
Synthetic Account	Synthetic Account Created	A synthetic account record has been created	`<client>.<env>.synthetic_account`

{
 "event_type": "created",
 "details": {
  "external_uid": "client-generated-id",
  "status": "active",
  "synthetic_account_category": "general",
  "synthetic_account_uid": "6NrMNrdB4hVHDXbx"
  }
 }