Sending Wires - Lead | API Docs

Send outgoing wire transfers: request requirements, statuses, and webhooks. Wires sent over Fedwire are same-day and irrevocable. Once a wire is posted, the only way to recover funds is by submitting a return request.

Prerequisites

Your token requires the wire/read_write scope.
The sending account number must be active, and its outgoing wire controls must permit the counterparty. By default, all counterparties are permitted.
Account-level wire limits must be configured with Lead before going live. Contact your Technical Account Manager to set these up.

Endpoints

Endpoint	Description
`POST /v1/wires`	Create an outgoing wire. Requires `Idempotency-Key` header.
`POST /v1/wires/{wire_id}/cancel`	Cancel a wire

Request Requirements

Field	Requirement
`account_number_id`	The account number from which the wire will be debited.
`amount`	Amount in cents.
`currency_code`	ISO 4217 currency code (e.g. `USD`).
`creditor_agent`	The receiving financial institution. Provide `routing_number` for domestic wires or `business_identifier_code` for international wires.
`creditor`	The beneficiary. Requires `name`, `account_identifier`, and `address`.
`remittance_details`	Remittance information. `transfer_purpose` is required.

See Create a Wire for the full schema and The Wire Object for every response field.

{
  "account_number_id": "account_number_xyz",
  "amount": 100000,
  "currency_code": "USD",
  "creditor_agent": {
    "routing_number": "021000021"
  },
  "creditor": {
    "name": "Alex Smith",
    "account_identifier": {
      "type": "account_number",
      "value": "9900000001"
    },
    "address": {
      "line_one": "123 Main St",
      "line_two": "New York, NY 10001"
    }
  },
  "remittance_details": {
    "transfer_purpose": {
      "type": "invoice_payment"
    }
  }
}

A successful response returns the wire object in created status.

Statuses

Status	Description	Cancellable	Webhook
`created`	Wire object has been created and is pending processing.	Yes	No
`under_review`	Wire has been flagged for manual review by Lead.	Yes	Yes
`scheduled`	Wire is scheduled to be sent.	Yes	Yes
`processing`	Wire is being submitted to Fedwire.	No	Yes
`posted`	Wire has been sent over Fedwire.	No	Yes
`rejected`	Wire was rejected. See the `rejection` object for details.	No	Yes
`cancel_pending`	A cancellation has been requested and is pending confirmation.	No	No
`canceled`	Wire was successfully canceled.	No	Yes

Webhook Events

Event	What happened	Recommended action
`wire.under_review`	Wire flagged for manual review.	Notify your customer of the delay. The wire will proceed or be rejected following review.
`wire.posted`	Wire debited from the account and sent.	Notify your customer the payment has been sent.
`wire.rejected`	Wire was rejected.	Inspect the `rejection` object for the reason and resubmit if appropriate.
`wire.canceled`	Wire was successfully canceled.	Notify your customer the payment was not sent.

⌘I