v1
latestOpenAPI 3.0.12026-07-26106359429.8 KBWire
List all wires V2
List all wire objects.
get/v2/wires
Query parameters
account_number_idstring
Returns wires associated with this account_number_id.
direction'outgoing' | 'incoming'
Who is initiating the transaction.
outgoing: You are sending a wire transaction to a counterparty. incoming: You are receiving an wire transaction from a counterparty.
Example:incoming
Returns wires with this direction.
status'created' | 'scheduled' | 'processing' | 'posted' | 'under_review' | 'rejected' | 'canceled' | 'cancel_pending'
The current status of the wire object.
Example:created
Returns wires with this status.
corridor_type'domestic' | 'international'
Indicates whether the wire is domestic or international.
Example:domestic
Returns wires with this corridor_type.
return_request_status'response_needed' | 'pending' | 'accepted' | 'rejected'
Current status of the return request.
- For incoming return requests: response_needed, accepted, rejected.
- For outgoing return requests: pending, accepted, rejected.
accepted and rejected are terminal.
Returns wires that have a return request in this status.
A set of filters on the list using the object’s field created_at.
limitinteger
Maximum number of objects to be returned.
starting_afterstring
A cursor for use in pagination; this is an ID that defines your place in the list.
ending_beforestring
A cursor for use in pagination; this is an ID that defines your place in the list.
Response
A list of wire objects.
Example response
{
"objects": [
{
"id": "wire_xyz123",
"account_number_id": "account_number_xyz123",
"core_transaction_ids": [
"core_transaction_xyz123"
],
"created_at": "2024-06-27T11:22:33Z",
"updated_at": "2024-06-27T11:22:33Z",
"settlement_date": "2024-06-27",
"direction": "incoming",
"type": "transfer",
"corridor_type": "domestic",
"status": "created",
"amounts": {
"settlement_amount": 5000,
"settlement_currency_code": "USD",
"instructed_amount": 5000
},
"debtor": {
"name": "Alan Scott",
"account_identifier": {
"type": "other"
},
"address": {
"department": "Procurement Department",
"sub_department": "IT Procurement",
"street_name": "Main Street",
"building_number": "100",
"building_name": "City Hall",
"floor": "4th Floor",
"post_box": "PO Box 12345",
"room": "600",
"post_code": "12345",
"town_name": "Kansas City",
"town_location_name": "Westside North",
"district_name": "Manhattan",
"country_sub_division": "NY",
"country": "US",
"line_one": "123 Main St",
"line_two": "Suite 100",
"line_three": "Kansas City, MO 64105"
}
},
"debtor_agent": {
"business_identifier_code": "BOFAUS3NXXX",
"name": "Bank of America",
"local_routing_identifier": {
"scheme": "GBDSC",
"value": "123456"
},
"address": {
"department": "Procurement Department",
"sub_department": "IT Procurement",
"street_name": "Main Street",
"building_number": "100",
"building_name": "City Hall",
"floor": "4th Floor",
"post_box": "PO Box 12345",
"room": "600",
"post_code": "12345",
"town_name": "Kansas City",
"town_location_name": "Westside North",
"district_name": "Manhattan",
"country_sub_division": "NY",
"country": "US",
"line_one": "123 Main St",
"line_two": "Suite 100",
"line_three": "Kansas City, MO 64105"
}
},
"instructing_agent": {
"name": "Bank of America",
"business_identifier_code": "CHASUS33",
"local_routing_identifier": {
"scheme": "GBDSC",
"value": "123456"
}
},
"instructed_agent": {
"name": "Bank of America",
"business_identifier_code": "CHASUS33",
"local_routing_identifier": {
"scheme": "GBDSC",
"value": "123456"
}
},
"creditor_agent": {
"business_identifier_code": "BOFAUS3NXXX",
"name": "Bank of America",
"local_routing_identifier": {
"scheme": "GBDSC",
"value": "123456"
},
"address": {
"department": "Procurement Department",
"sub_department": "IT Procurement",
"street_name": "Main Street",
"building_number": "100",
"building_name": "City Hall",
"floor": "4th Floor",
"post_box": "PO Box 12345",
"room": "600",
"post_code": "12345",
"town_name": "Kansas City",
"town_location_name": "Westside North",
"district_name": "Manhattan",
"country_sub_division": "NY",
"country": "US",
"line_one": "123 Main St",
"line_two": "Suite 100",
"line_three": "Kansas City, MO 64105"
}
},
"creditor": {
"name": "Alan Scott",
"account_identifier": {
"type": "other"
},
"address": {
"department": "Procurement Department",
"sub_department": "IT Procurement",
"street_name": "Main Street",
"building_number": "100",
"building_name": "City Hall",
"floor": "4th Floor",
"post_box": "PO Box 12345",
"room": "600",
"post_code": "12345",
"town_name": "Kansas City",
"town_location_name": "Westside North",
"district_name": "Manhattan",
"country_sub_division": "NY",
"country": "US",
"line_one": "123 Main St",
"line_two": "Suite 100",
"line_three": "Kansas City, MO 64105"
}
},
"initiating_party": {
"name": "Alan Scott",
"account_identifier": {
"type": "other"
},
"address": {
"department": "Procurement Department",
"sub_department": "IT Procurement",
"street_name": "Main Street",
"building_number": "100",
"building_name": "City Hall",
"floor": "4th Floor",
"post_box": "PO Box 12345",
"room": "600",
"post_code": "12345",
"town_name": "Kansas City",
"town_location_name": "Westside North",
"district_name": "Manhattan",
"country_sub_division": "NY",
"country": "US",
"line_one": "123 Main St",
"line_two": "Suite 100",
"line_three": "Kansas City, MO 64105"
}
},
"ultimate_debtor": {
"name": "Alan Scott",
"account_identifier": {
"type": "other"
},
"address": {
"department": "Procurement Department",
"sub_department": "IT Procurement",
"street_name": "Main Street",
"building_number": "100",
"building_name": "City Hall",
"floor": "4th Floor",
"post_box": "PO Box 12345",
"room": "600",
"post_code": "12345",
"town_name": "Kansas City",
"town_location_name": "Westside North",
"district_name": "Manhattan",
"country_sub_division": "NY",
"country": "US",
"line_one": "123 Main St",
"line_two": "Suite 100",
"line_three": "Kansas City, MO 64105"
}
},
"ultimate_creditor": {
"name": "Alan Scott",
"account_identifier": {
"type": "other"
},
"address": {
"department": "Procurement Department",
"sub_department": "IT Procurement",
"street_name": "Main Street",
"building_number": "100",
"building_name": "City Hall",
"floor": "4th Floor",
"post_box": "PO Box 12345",
"room": "600",
"post_code": "12345",
"town_name": "Kansas City",
"town_location_name": "Westside North",
"district_name": "Manhattan",
"country_sub_division": "NY",
"country": "US",
"line_one": "123 Main St",
"line_two": "Suite 100",
"line_three": "Kansas City, MO 64105"
}
},
"other_agents": {
"previous_instructing_agent_one": {
"business_identifier_code": "BOFAUS3NXXX",
"name": "Bank of America",
"local_routing_identifier": {
"scheme": "GBDSC",
"value": "123456"
},
"address": {
"department": "Procurement Department",
"sub_department": "IT Procurement",
"street_name": "Main Street",
"building_number": "100",
"building_name": "City Hall",
"floor": "4th Floor",
"post_box": "PO Box 12345",
"room": "600",
"post_code": "12345",
"town_name": "Kansas City",
"town_location_name": "Westside North",
"district_name": "Manhattan",
"country_sub_division": "NY",
"country": "US",
"line_one": "123 Main St",
"line_two": "Suite 100",
"line_three": "Kansas City, MO 64105"
}
},
"previous_instructing_agent_two": {
"business_identifier_code": "BOFAUS3NXXX",
"name": "Bank of America",
"local_routing_identifier": {
"scheme": "GBDSC",
"value": "123456"
},
"address": {
"department": "Procurement Department",
"sub_department": "IT Procurement",
"street_name": "Main Street",
"building_number": "100",
"building_name": "City Hall",
"floor": "4th Floor",
"post_box": "PO Box 12345",
"room": "600",
"post_code": "12345",
"town_name": "Kansas City",
"town_location_name": "Westside North",
"district_name": "Manhattan",
"country_sub_division": "NY",
"country": "US",
"line_one": "123 Main St",
"line_two": "Suite 100",
"line_three": "Kansas City, MO 64105"
}
},
"previous_instructing_agent_three": {
"business_identifier_code": "BOFAUS3NXXX",
"name": "Bank of America",
"local_routing_identifier": {
"scheme": "GBDSC",
"value": "123456"
},
"address": {
"department": "Procurement Department",
"sub_department": "IT Procurement",
"street_name": "Main Street",
"building_number": "100",
"building_name": "City Hall",
"floor": "4th Floor",
"post_box": "PO Box 12345",
"room": "600",
"post_code": "12345",
"town_name": "Kansas City",
"town_location_name": "Westside North",
"district_name": "Manhattan",
"country_sub_division": "NY",
"country": "US",
"line_one": "123 Main St",
"line_two": "Suite 100",
"line_three": "Kansas City, MO 64105"
}
},
"intermediary_agent_one": {
"business_identifier_code": "BOFAUS3NXXX",
"name": "Bank of America",
"local_routing_identifier": {
"scheme": "GBDSC",
"value": "123456"
},
"address": {
"department": "Procurement Department",
"sub_department": "IT Procurement",
"street_name": "Main Street",
"building_number": "100",
"building_name": "City Hall",
"floor": "4th Floor",
"post_box": "PO Box 12345",
"room": "600",
"post_code": "12345",
"town_name": "Kansas City",
"town_location_name": "Westside North",
"district_name": "Manhattan",
"country_sub_division": "NY",
"country": "US",
"line_one": "123 Main St",
"line_two": "Suite 100",
"line_three": "Kansas City, MO 64105"
}
},
"intermediary_agent_two": {
"business_identifier_code": "BOFAUS3NXXX",
"name": "Bank of America",
"local_routing_identifier": {
"scheme": "GBDSC",
"value": "123456"
},
"address": {
"department": "Procurement Department",
"sub_department": "IT Procurement",
"street_name": "Main Street",
"building_number": "100",
"building_name": "City Hall",
"floor": "4th Floor",
"post_box": "PO Box 12345",
"room": "600",
"post_code": "12345",
"town_name": "Kansas City",
"town_location_name": "Westside North",
"district_name": "Manhattan",
"country_sub_division": "NY",
"country": "US",
"line_one": "123 Main St",
"line_two": "Suite 100",
"line_three": "Kansas City, MO 64105"
}
},
"intermediary_agent_three": {
"business_identifier_code": "BOFAUS3NXXX",
"name": "Bank of America",
"local_routing_identifier": {
"scheme": "GBDSC",
"value": "123456"
},
"address": {
"department": "Procurement Department",
"sub_department": "IT Procurement",
"street_name": "Main Street",
"building_number": "100",
"building_name": "City Hall",
"floor": "4th Floor",
"post_box": "PO Box 12345",
"room": "600",
"post_code": "12345",
"town_name": "Kansas City",
"town_location_name": "Westside North",
"district_name": "Manhattan",
"country_sub_division": "NY",
"country": "US",
"line_one": "123 Main St",
"line_two": "Suite 100",
"line_three": "Kansas City, MO 64105"
}
}
},
"payment_identifiers": {
"message_identification": "20241215MMQFMP2L017736",
"end_to_end_identification": "EndtoEnd12345",
"uetr": "dae7d83c-1624-4a79-a8ef-3794de115c13",
"instruction_identification": "Instruction12345",
"return_identification": "ReturnInstruction12345"
},
"remittance_details": {
"payment_notification": "ba77ae30-efb8-4139-8e51-37e3fd905b2b",
"message_to_creditor": "Payment for invoice 12345",
"message_to_receiving_fi": "message for receiving financial institution",
"fi_to_fi_message": "message from financial institution to financial institution",
"transfer_purpose": {
"type": "invoice_payment",
"other_details": "Payment for consulting services"
}
},
"charges": {
"charge_bearer": "shared",
"breakdown": [
{
"amount": "12.50",
"currency_code": "USD",
"charging_agent": {
"business_identifier_code": "BOFAUS3NXXX",
"name": "Bank of America",
"local_routing_identifier": {
"scheme": "GBDSC",
"value": "123456"
},
"address": {
"department": "Procurement Department",
"sub_department": "IT Procurement",
"street_name": "Main Street",
"building_number": "100",
"building_name": "City Hall",
"floor": "4th Floor",
"post_box": "PO Box 12345",
"room": "600",
"post_code": "12345",
"town_name": "Kansas City",
"town_location_name": "Westside North",
"district_name": "Manhattan",
"country_sub_division": "NY",
"country": "US",
"line_one": "123 Main St",
"line_two": "Suite 100",
"line_three": "Kansas City, MO 64105"
}
}
}
]
},
"related_wires": {
"original_wire_id": "wire_xyz001",
"return_wire_ids": [
"wire_xyz002"
]
},
"return_requests": [
{
"created_at": "2024-06-27T12:15:00Z",
"details": "suspected unauthorized activity",
"deadline": "2024-07-08T23:30:00Z"
}
],
"return": {
"reason": "honor_return_request"
},
"rejection": {
"reason": "honor_return_request",
"message_identification": "20241215MMQFMP2L017736"
}
}
]
}