Outbound Wires

Overview

An outbound wire is a WIRE_OUTBOUND workflow execution. You create it, Twisp generates its pacs.008, and the Fed's reply settles or rejects it.

Copy          generateFile         pacs.002 ACSC          pacs.004
CREATE ───────────────> SUBMIT ─────────────> SETTLE ─────────> RETURN
  │                       │
  │ CANCEL                │ pacs.002 RJCT / admi.002
  ▼                       ▼
CANCEL                  REJECT  (also from CREATE)

The funds are held in the customer account's pending layer from CREATE until the wire settles or is released.

Create a Wire

Execute CREATE with Mutation.workflow.execute() and code WIRE_OUTBOUND:

Copymutation SendWire {
  workflow {
    execute(
      input: {
        executionId: "7c1d4e2a-0f3b-4c5d-8e9f-1a2b3c4d5e6f"
        code: "WIRE_OUTBOUND"
        task: "CREATE"
        params: {
          configId: "5d1c6a0e-8b7f-4e2a-9c3d-2e1f0a9b8c7d"
          accountId: "6b879478-27e0-4fde-9038-ef81b028bb51"
          amount: "25000.00"
          debtorName: "Jane Debtor"
          debtorAccount: "123456789"
          debtorAddress: "{\"streetName\":\"Main St\",\"buildingNumber\":\"1\",\"townName\":\"Springfield\",\"countrySubDivision\":\"IL\",\"postCode\":\"62701\",\"country\":\"US\"}"
          creditorName: "John Creditor"
          creditorAccount: "987654321"
          creditorRoutingNumber: "021000021"
          remittance: "Invoice 42"
        }
      }
    ) {
      executionId
      output {
        state
      }
    }
  }
}

CREATE Parameters

The debtor agent's name and address, the charge bearer and the account scheme come from the configuration.

An address is a JSON object with any of streetName, buildingNumber, postCode, townName, countrySubDivision, country (ISO 3166 alpha-2) and lines (up to three unstructured lines of 35 characters).

CREATE:

1. Builds the wire's pacs.008 and checks it against the Fed usage guidelines. Every problem with the parameters is returned together as BAD_REQUEST.
2. Sets the wire's UETR. It is derived from the execution id, so it is stable, and it is returned in the execution context as uetr.
3. Posts SYS_WIRE_OUTBOUND_PENDING_DR, holding the amount in the customer's pending layer. Velocity controls on the account apply: a control that rejects the posting declines the wire, and CREATE fails.
4. Queues the wire for the next generateFile.

Tasks

All parameters are optional except where noted for CREATE and SUBMIT. A parameter a task does not accept is BAD_REQUEST. A task that does not follow the wire's current state fails with INVALID_STATE_TRANSITION and changes nothing.

RETURN may return part of the wire: amount defaults to the wire's amount and cannot exceed it. A partial return is recorded in the execution context as returnAmount.

You normally run only CREATE and, before generation, CANCEL. Twisp runs SUBMIT during generation and the other tasks when it processes the Fed's replies.

Replies From the Fed

Process each reply file with Mutation.wire.processFile(). Twisp finds the wire by UETR, or by message id for an admi.002, and runs the task:

A reply that matches no wire is recorded as IGNORED. The exception is a pacs.004: returned funds have arrived, so a pacs.004 that matches no wire is credited to the configuration's exception account as an inbound wire.

A reply that does not apply to the wire's state, such as a second pacs.002 for a settled wire, is recorded as IGNORED and changes nothing.

Balances

For a $25,000.00 wire from a customer account:

Postings after the Fed has acted (SETTLE, REJECT, RETURN) are not blocked by velocity controls.