DDSE: direct_deposit_switch_event

webhook

direct_deposit_switch_event

The status of a direct deposit switch has changed.

Trigger — The status of a direct deposit switch changes.
Processes — These processes contain the event trigger:
- Account holder initiates a direct deposit switch.

Payload

company_payroll_provider_name

string

The name of the payroll provider.

ddswitch_event_type

string

Type of direct deposit switch event. Example: "SWITCH_INITIATED"

distribution_amount

string

The amount of the direct deposit switch.

distribution_type

string

enum

The type of amount in distribution_amount: amount or percent.

Allowed:

event_ts

string

Timestamp when the message was ingested by SoFi Tech Solutions (Mountain Standard Time). Format: "YYYY-MM-DD hh:mm:ss MST". Legacy fields: timestamp, tran_timestamp.

external_customer_id

string

Identifier used to associate multiple accounts under the same customer. This identifier is supplied by the provider, not SoFi Tech Solutions.

idempotent_token

string

Idempotency token for the direct deposit switch request.

method

string

Event category. Indicates the type of event.

msg_event_id

string

Unique system-generated identifier for this message.

msg_id

string

The four-letter code to identify this event.

prn

string

SoFi Tech Solutions 12-digit payment reference number (PRN) for the account. Legacy field: pmt_ref_no.

prod_id

string

The product ID of the account.

prog_id

string

The program ID of the account.

status

string

enum

The new status of the direct deposit switch: processing, completed, failed

Allowed:

status_reason

string

The reason for the new status when status: failed. See Direct Deposit Switch Failure Status Reasons for valid values.

task

string

Transaction ID for a sign-up attempt.

type

string

The name of this event: "direct_deposit_switch_event"