Skip to main content
A wire (wire_*) sends USD from a wallet to an external party account over Fedwire. To learn more, see Pay over a specific rail.

Example

GET /wire/{wireId}
The object is everything inside data. The field names below are relative to it: attributes.amount is data.attributes.amount in the response.

Fields

string
required
Resource type. Always wire.
string
required
Wire ID (wire_*).
object
required
The wire’s details.
object
required
Related resources, each by type and ID.

Statuses

Events

  • wire.created: A domestic wire was created. The fee is assessed when the wire is submitted, so it’s always null on wire.created. Read it from wire.processing.
  • wire.processing: A domestic wire was submitted for processing.
  • wire.completed: A domestic wire settled.
  • wire.rejected: The bank rejected a domestic wire before settlement.
  • wire.failed: A domestic wire failed before completion.

Errors

See the error codes these endpoints return.

Sandbox simulations