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.
Hide attributes
integer
required
Amount in cents.
string
required
Currency code. Always USD.
object | null
required
Fee added to your cost as the sender. Null when no fee applies, the wire ended before network submission, the fee was voided, or your party is not the fee payer.
Hide fee
integer
required
Fee amount in cents.
string
required
Currency of the fee. Always USD.
string
required
Party role charged the fee. Always sender.
string
required
The fee is added to the sender’s cost without reducing the principal amount. Always on_top.
string
required
Wire status, in lifecycle order: CREATED, AWAITING_APPROVAL, PROCESSING, COMPLETED; APPROVAL_DENIED, REJECTED, FAILED, or CANCELED end it. One of: CREATED, AWAITING_APPROVAL, APPROVAL_DENIED, PROCESSING, COMPLETED, REJECTED, FAILED, CANCELED. See Statuses.
string | null
required
Remittance information delivered to the beneficiary, or null.
string
required
Payment description stored for the sender’s records. Not sent over Fedwire.
string | null
required
Description for your internal reference, or null. Never shared with the counterparty or the banking network.
object | null
required
Failure details when the wire failed, or null.
Hide failure
string | null
required
Failure reason, or null.
string | null
required
Failure code, or null.
string | null
required
RFC 3339 timestamp when the wire was submitted, or null.
string | null
required
RFC 3339 timestamp when the wire was rejected, or null.
string | null
required
RFC 3339 estimate of when the wire completes, or null. Not a guarantee.
string | null
required
RFC 3339 timestamp when the wire completed, or null.
string | null
required
RFC 3339 timestamp when the wire reached a terminal status, or null.
string
required
RFC 3339 timestamp when the wire was created.
string
required
RFC 3339 timestamp when the wire was last updated.
object
required
Related resources, each by type and ID.
Hide relationships
object
required
Agent that initiated this resource, or null when no agent can be reliably attributed.
Hide initiatorAgent
object | null
required
Related resource identifier.
Hide data
string
required
Resource type. Always agent.
string
required
Agent ID (agt_*).
object
required
Party the wire was created for.
Hide customerParty
object
required
Related resource identifier.
Hide data
string
required
Resource type. Always party.
string
required
Party ID (pty_*).
object
required
Wallet the wire pays from.
Hide wallet
object
required
Related resource identifier.
Hide data
string
required
Resource type. Always wallet.
string
required
Wallet ID (wal_*).
object
required
External party paid.
Hide externalParty
object
required
Related resource identifier.
Hide data
string
required
Resource type. Always externalParty.
string
required
External party ID (epty_*).
object
required
External party account paid.
Hide externalPartyAccount
object
required
Related resource identifier.
Hide data
string
required
Resource type. Always externalPartyAccount.
string
required
External party account ID (epa_*).
Statuses
Status
Meaning
Can become
CREATED
Natural saved the wire and hasn’t sent it to the bank yet.
Your approval policy or an approver denied the wire before it was sent.
Final
PROCESSING
Sent to the bank and not finished yet.
COMPLETED, REJECTED, FAILED
COMPLETED
The wire settled. A settled wire can’t be returned.
Final
REJECTED
The bank refused the wire after it was sent. rejectedAt says when and failure says why.
Final
FAILED
The wire didn’t go through for a reason other than a bank rejection, such as a refusal before it was sent. failure says why.
Final
CANCELED
Canceled before it was sent, for example by you or when its approval was canceled.
Final
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.