Get incoming wire by id

Get an incoming wire by id

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

wire_id · string<uuid> · required

The unique identifier of a wire transfer.

Example:

"b01db9c7-78f2-4a99-8aca-1231d32f9b96"

Response

200

application/json

wire

amount · integer · required

Transfer amount in cents ($100 would be 10000)

Example:

10000

creation_time · string<date-time> · required

Example:

"2010-05-06T12:23:34.321Z"

id · string<uuid> · required

wire ID

is_return · boolean · required

Indicates if the wire is a return of an outgoing wire

receiver · object · required

Information about a party in a wire transfer

Show child attributes

receiving_account_number · string<string> · required

The account number representing the recipient account. If the incoming wire is a return, it refers to the recipient of the initial wire not the destination of the return.

Example:

1961234745

sender · object · required

Information about a party in a wire transfer

Show child attributes

sender_reference_id · string · required

Sender's id associated with fedwire transfer

Example:

"9F564A6124E65"

status · enum<string> · required

The current status of the transfer

Available options:

BLOCKED,

POSTED,

READY,

RETURNED

Example:

"READY"

tenant · string · required

The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.

Example:

"abcdef_ghijkl"

account_id · string<uuid>

The internal account uuid representing the recipient of the wire.

Example:

"b01db9c7-78f2-4a99-8aca-1231d32f9b96"

bank_message · string

Information from the sending bank to the receiving bank.

currency · string

3-character currency code

Example:

"USD"

customer_id · string<uuid>

The customer UUID representing the person initiating the Wire transfer

Example:

"b01db9c7-78f2-4a99-8aca-1231d32f9b96"

decline_reason · string

Description of the reason the transfer was declined

effective_date · string<date>

The effective date of the transaction once it gets posted

Example:

"2022-03-18"

input_message_accountability_data · string

The input message accountability data consists of a 8 character cycle date (CCYYMMDD) an 8 character source and a 6 character sequence number.

Example:

"10220318BANK0001123456"

network · string

The network used to process the wire

Example:

"fedwire"

originating_account_number · string<string>

The account number representing the sender account. If the incoming wire is a return, it refers to the sender of the initial wire not the sender of the return.

Example:

1961234745

receiving_account_id · string<uuid>

The internal Synctera account uuid representing the recipient of the wire.

Example:

"b01db9c7-78f2-4a99-8aca-1231d32f9b96"

recipient_message · string

Information from the originator to the beneficiary (recipient).

return_data · object

Data associated with a returned wire

Show child attributes

return_reason · string

The reason we are returning this wire.

settlement_date · string<date>

The settlement date of the transaction once it gets posted

Example:

"2022-03-18"

transaction_id · string<uuid>

ID of the resulting transaction resource

type_subtype · enum<string>

The fedwire label associated with the subtype code

Available options:

BASIC_FUNDS_TRANSFER,

PRIOR_DAY_TRANSFER_REVERSAL,

SAME_DAY_TRANSFER_REVERSAL

Example:

"BASIC_FUNDS_TRANSFER"