List all wires V1
curl --request GET \
--url https://api.sandbox.lead.bank/v1/wires \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.sandbox.lead.bank/v1/wires"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.sandbox.lead.bank/v1/wires', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.lead.bank/v1/wires",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.lead.bank/v1/wires"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.sandbox.lead.bank/v1/wires")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.lead.bank/v1/wires")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"objects": [
{
"id": "wire_xyz123",
"account_id": "account_xyz123",
"account_number_id": "account_number_xyz123",
"created_at": "2024-06-27T11:22:33Z",
"updated_at": "2024-06-27T11:22:33Z",
"settlement_date": "2024-06-27",
"direction": "incoming",
"type": "transfer",
"status": "created",
"amounts": {
"settlement_amount": 5000,
"settlement_currency_code": "USD",
"instructed_amount": 5000,
"instructed_currency_code": "<string>",
"instructed_to_settlement_exchange_rate": 1
},
"debtor": {
"name": "Alan Scott",
"account_identifier": {
"type": "other",
"value": 1234567890
},
"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",
"routing_number": "<string>",
"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"
},
"local_routing_identifier": {
"scheme": "GBDSC",
"value": "123456"
}
},
"instructing_agent": {
"name": "Bank of America",
"routing_number": "021000021",
"business_identifier_code": "CHASUS33"
},
"instructed_agent": {
"name": "Bank of America",
"routing_number": "021000021",
"business_identifier_code": "CHASUS33"
},
"creditor_agent": {
"business_identifier_code": "BOFAUS3NXXX",
"name": "Bank of America",
"routing_number": "<string>",
"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"
},
"local_routing_identifier": {
"scheme": "GBDSC",
"value": "123456"
}
},
"creditor": {
"name": "Alan Scott",
"account_identifier": {
"type": "other",
"value": 1234567890
},
"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",
"value": 1234567890
},
"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",
"value": 1234567890
},
"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",
"routing_number": "<string>",
"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"
},
"local_routing_identifier": {
"scheme": "GBDSC",
"value": "123456"
}
},
"previous_instructing_agent_two": {
"business_identifier_code": "BOFAUS3NXXX",
"name": "Bank of America",
"routing_number": "<string>",
"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"
},
"local_routing_identifier": {
"scheme": "GBDSC",
"value": "123456"
}
},
"previous_instructing_agent_three": {
"business_identifier_code": "BOFAUS3NXXX",
"name": "Bank of America",
"routing_number": "<string>",
"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"
},
"local_routing_identifier": {
"scheme": "GBDSC",
"value": "123456"
}
},
"intermediary_agent_one": {
"business_identifier_code": "BOFAUS3NXXX",
"name": "Bank of America",
"routing_number": "<string>",
"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"
},
"local_routing_identifier": {
"scheme": "GBDSC",
"value": "123456"
}
},
"intermediary_agent_two": {
"business_identifier_code": "BOFAUS3NXXX",
"name": "Bank of America",
"routing_number": "<string>",
"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"
},
"local_routing_identifier": {
"scheme": "GBDSC",
"value": "123456"
}
},
"intermediary_agent_three": {
"business_identifier_code": "BOFAUS3NXXX",
"name": "Bank of America",
"routing_number": "<string>",
"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"
},
"local_routing_identifier": {
"scheme": "GBDSC",
"value": "123456"
}
}
},
"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",
"routing_number": "<string>",
"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"
},
"local_routing_identifier": {
"scheme": "GBDSC",
"value": "123456"
}
}
}
]
},
"related_wires": {
"original_wire_id": "wire_xyz001",
"return_wire_ids": [
"wire_xyz002"
]
},
"return": {
"reason": "honor_return_request",
"code": "<string>",
"additional_information": "<string>"
},
"rejection": {
"reason": "honor_return_request",
"additional_information": "<string>",
"message_identification": "20241215MMQFMP2L017736"
},
"return_requests": [
{
"created_at": "2024-06-27T12:15:00Z",
"details": "suspected unauthorized activity",
"deadline": "2024-07-08T23:30:00Z",
"resolution": {
"resolved_at": "2023-11-07T05:31:56Z",
"rejection_details": "<string>"
}
}
],
"metadata": {}
}
],
"has_more": true
}{
"code": "<string>",
"title": "<string>",
"detail": "<string>",
"status": "<string>",
"invalid_parameters": [
{
"parameter": "transaction_type",
"reason": "<string>"
}
],
"instance": "<string>"
}{
"code": "<string>",
"title": "<string>",
"detail": "<string>",
"status": "<string>",
"invalid_parameters": [
{
"parameter": "transaction_type",
"reason": "<string>"
}
],
"instance": "<string>"
}Wire
List all Wires
List all wire objects.
GET
/
v1
/
wires
List all wires V1
curl --request GET \
--url https://api.sandbox.lead.bank/v1/wires \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.sandbox.lead.bank/v1/wires"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.sandbox.lead.bank/v1/wires', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.lead.bank/v1/wires",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.lead.bank/v1/wires"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.sandbox.lead.bank/v1/wires")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.lead.bank/v1/wires")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"objects": [
{
"id": "wire_xyz123",
"account_id": "account_xyz123",
"account_number_id": "account_number_xyz123",
"created_at": "2024-06-27T11:22:33Z",
"updated_at": "2024-06-27T11:22:33Z",
"settlement_date": "2024-06-27",
"direction": "incoming",
"type": "transfer",
"status": "created",
"amounts": {
"settlement_amount": 5000,
"settlement_currency_code": "USD",
"instructed_amount": 5000,
"instructed_currency_code": "<string>",
"instructed_to_settlement_exchange_rate": 1
},
"debtor": {
"name": "Alan Scott",
"account_identifier": {
"type": "other",
"value": 1234567890
},
"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",
"routing_number": "<string>",
"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"
},
"local_routing_identifier": {
"scheme": "GBDSC",
"value": "123456"
}
},
"instructing_agent": {
"name": "Bank of America",
"routing_number": "021000021",
"business_identifier_code": "CHASUS33"
},
"instructed_agent": {
"name": "Bank of America",
"routing_number": "021000021",
"business_identifier_code": "CHASUS33"
},
"creditor_agent": {
"business_identifier_code": "BOFAUS3NXXX",
"name": "Bank of America",
"routing_number": "<string>",
"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"
},
"local_routing_identifier": {
"scheme": "GBDSC",
"value": "123456"
}
},
"creditor": {
"name": "Alan Scott",
"account_identifier": {
"type": "other",
"value": 1234567890
},
"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",
"value": 1234567890
},
"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",
"value": 1234567890
},
"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",
"routing_number": "<string>",
"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"
},
"local_routing_identifier": {
"scheme": "GBDSC",
"value": "123456"
}
},
"previous_instructing_agent_two": {
"business_identifier_code": "BOFAUS3NXXX",
"name": "Bank of America",
"routing_number": "<string>",
"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"
},
"local_routing_identifier": {
"scheme": "GBDSC",
"value": "123456"
}
},
"previous_instructing_agent_three": {
"business_identifier_code": "BOFAUS3NXXX",
"name": "Bank of America",
"routing_number": "<string>",
"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"
},
"local_routing_identifier": {
"scheme": "GBDSC",
"value": "123456"
}
},
"intermediary_agent_one": {
"business_identifier_code": "BOFAUS3NXXX",
"name": "Bank of America",
"routing_number": "<string>",
"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"
},
"local_routing_identifier": {
"scheme": "GBDSC",
"value": "123456"
}
},
"intermediary_agent_two": {
"business_identifier_code": "BOFAUS3NXXX",
"name": "Bank of America",
"routing_number": "<string>",
"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"
},
"local_routing_identifier": {
"scheme": "GBDSC",
"value": "123456"
}
},
"intermediary_agent_three": {
"business_identifier_code": "BOFAUS3NXXX",
"name": "Bank of America",
"routing_number": "<string>",
"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"
},
"local_routing_identifier": {
"scheme": "GBDSC",
"value": "123456"
}
}
},
"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",
"routing_number": "<string>",
"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"
},
"local_routing_identifier": {
"scheme": "GBDSC",
"value": "123456"
}
}
}
]
},
"related_wires": {
"original_wire_id": "wire_xyz001",
"return_wire_ids": [
"wire_xyz002"
]
},
"return": {
"reason": "honor_return_request",
"code": "<string>",
"additional_information": "<string>"
},
"rejection": {
"reason": "honor_return_request",
"additional_information": "<string>",
"message_identification": "20241215MMQFMP2L017736"
},
"return_requests": [
{
"created_at": "2024-06-27T12:15:00Z",
"details": "suspected unauthorized activity",
"deadline": "2024-07-08T23:30:00Z",
"resolution": {
"resolved_at": "2023-11-07T05:31:56Z",
"rejection_details": "<string>"
}
}
],
"metadata": {}
}
],
"has_more": true
}{
"code": "<string>",
"title": "<string>",
"detail": "<string>",
"status": "<string>",
"invalid_parameters": [
{
"parameter": "transaction_type",
"reason": "<string>"
}
],
"instance": "<string>"
}{
"code": "<string>",
"title": "<string>",
"detail": "<string>",
"status": "<string>",
"invalid_parameters": [
{
"parameter": "transaction_type",
"reason": "<string>"
}
],
"instance": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Returns wires associated with this account_id.
Pattern:
^account_\w+$Returns wires associated with this account_number_id.
Pattern:
^account_number_\w+$Returns wires with this direction.
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.
Available options:
outgoing, incoming Example:
"incoming"
Returns wires with this status.
The current status of the wire object.
Available options:
created, scheduled, processing, posted, under_review, rejected, canceled, cancel_pending Example:
"created"
Returns wires that have a return request with this status. Only wires where the matching return request is visible to the client are returned. 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.
Available options:
response_needed, pending, accepted, rejected A set of filters on the list using the object’s field created_at.
Show child attributes
Show child attributes
Maximum number of objects to be returned.
Required range:
1 <= x <= 100A cursor for use in pagination; this is an ID that defines your place in the list.
Pattern:
^wire_\w+$A cursor for use in pagination; this is an ID that defines your place in the list.
Pattern:
^wire_\w+$Was this page helpful?
⌘I