Simulate Incoming Return Request Acceptance
curl --request POST \
--url https://api.sandbox.lead.bank/v1/simulate/wires/{wire_id}/incoming_return_request_acceptance \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"amount": 5000,
"currency_code": "USD"
}
'import requests
url = "https://api.sandbox.lead.bank/v1/simulate/wires/{wire_id}/incoming_return_request_acceptance"
payload = {
"amount": 5000,
"currency_code": "USD"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({amount: 5000, currency_code: 'USD'})
};
fetch('https://api.sandbox.lead.bank/v1/simulate/wires/{wire_id}/incoming_return_request_acceptance', 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/simulate/wires/{wire_id}/incoming_return_request_acceptance",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'amount' => 5000,
'currency_code' => 'USD'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.lead.bank/v1/simulate/wires/{wire_id}/incoming_return_request_acceptance"
payload := strings.NewReader("{\n \"amount\": 5000,\n \"currency_code\": \"USD\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.sandbox.lead.bank/v1/simulate/wires/{wire_id}/incoming_return_request_acceptance")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 5000,\n \"currency_code\": \"USD\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.lead.bank/v1/simulate/wires/{wire_id}/incoming_return_request_acceptance")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 5000,\n \"currency_code\": \"USD\"\n}"
response = http.request(request)
puts response.read_body{
"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": {}
}{
"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>"
}{
"code": "<string>",
"title": "<string>",
"detail": "<string>",
"status": "<string>",
"invalid_parameters": [
{
"parameter": "transaction_type",
"reason": "<string>"
}
],
"instance": "<string>"
}Simulation
Simulate Incoming Return Request Acceptance
Simulate a counterparty financial institution accepting a return request you initiated. Acceptance arrives as a monetary return (pacs.004) crediting funds back to the original sender. Builds the incoming return wire and pushes it through the ingress path. Transitions the matching outgoing return request to accepted, populates the resolution, and fires the wires.return_request_status_updated webhook.
Requires an active outgoing return request (status = pending) on the wire. The amount must not exceed the original wire amount.
POST
/
v1
/
simulate
/
wires
/
{wire_id}
/
incoming_return_request_acceptance
Simulate Incoming Return Request Acceptance
curl --request POST \
--url https://api.sandbox.lead.bank/v1/simulate/wires/{wire_id}/incoming_return_request_acceptance \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"amount": 5000,
"currency_code": "USD"
}
'import requests
url = "https://api.sandbox.lead.bank/v1/simulate/wires/{wire_id}/incoming_return_request_acceptance"
payload = {
"amount": 5000,
"currency_code": "USD"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({amount: 5000, currency_code: 'USD'})
};
fetch('https://api.sandbox.lead.bank/v1/simulate/wires/{wire_id}/incoming_return_request_acceptance', 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/simulate/wires/{wire_id}/incoming_return_request_acceptance",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'amount' => 5000,
'currency_code' => 'USD'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.lead.bank/v1/simulate/wires/{wire_id}/incoming_return_request_acceptance"
payload := strings.NewReader("{\n \"amount\": 5000,\n \"currency_code\": \"USD\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.sandbox.lead.bank/v1/simulate/wires/{wire_id}/incoming_return_request_acceptance")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 5000,\n \"currency_code\": \"USD\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.lead.bank/v1/simulate/wires/{wire_id}/incoming_return_request_acceptance")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 5000,\n \"currency_code\": \"USD\"\n}"
response = http.request(request)
puts response.read_body{
"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": {}
}{
"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>"
}{
"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.
Path Parameters
ID of the wire whose outgoing return request you want to simulate an acceptance of.
Pattern:
^wire_\w+$Body
application/json
Amount to be returned, in the currency's minor units. Must be greater than zero and not exceed the original wire amount.
Required range:
1 <= x <= 990000000000Example:
5000
A three-letter currency code as defined in ISO 4217.
Available options:
USD Example:
"USD"
Response
The updated wire object, with the outgoing return request now in accepted status and a return wire credited.
Unique identifier of the wire object.
Pattern:
^wire_\w+$Example:
"wire_xyz123"
The ID of the Account object.
Pattern:
^account_\w+$Example:
"account_xyz123"
The ID of the Lead Bank Account Number object.
Pattern:
^account_number_\w+$Example:
"account_number_xyz123"
ISO 8601 format timestamp representing when the wire object was created.
Example:
"2024-06-27T11:22:33Z"
ISO 8601 format timestamp representing when the wire object was last updated.
Example:
"2024-06-27T11:22:33Z"
The ISO-8601 Datestamp indicating the wire settlement date based on the Fedwire's business day definition.
Example:
"2024-06-27"
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"
Indicates the type of wire message that the object represents.
Available options:
transfer, return Example:
"transfer"
The current status of the wire object.
Available options:
created, scheduled, processing, posted, under_review, rejected, canceled, cancel_pending Example:
"created"
Show child attributes
Show child attributes
Details of the debtor sending funds.
Show child attributes
Show child attributes
Details of the financial institution where the debtor (payer) holds their account. This object may be absent if the instructing agent does not provide this information.
Show child attributes
Show child attributes
The financial institution that transmitted the payment through Fedwire. In some cases, this may differ from the bank where the account is held. This object will always be populated.
Show child attributes
Show child attributes
The financial institution that received the payment through Fedwire. This may not always be the bank where the recipient's account is held. This object will always be populated.
Show child attributes
Show child attributes
Details of the financial institution where the creditor (payee) holds their account. This object may be absent if the instructing agent does not provide this information.
Show child attributes
Show child attributes
Details of the creditor receiving funds.
Show child attributes
Show child attributes
The ultimate party on whose behalf the payment is made, if different from the debtor.
Show child attributes
Show child attributes
The ultimate party to which the payment is intended, if different from the creditor.
Show child attributes
Show child attributes
Details of any other agents involved in the wire transfer.
Show child attributes
Show child attributes
Wire payment identifiers.
Show child attributes
Show child attributes
Wire remittance details.
Show child attributes
Show child attributes
Information about any charges assessed during wire transfer processing.
Show child attributes
Show child attributes
Related wire objects.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Return requests associated with this wire.
Show child attributes
Show child attributes
A set of key-value pairs that can be used to store additional information related to this object.
Show child attributes
Show child attributes
Was this page helpful?
⌘I