Simulate Incoming Wire
curl --request POST \
--url https://api.sandbox.lead.bank/v1/simulate/wires/incoming \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"amount": 5000,
"creditor_account_number_id": "account_number_xyz123",
"debtor": {
"name": "Allan Scott",
"account_identifier": {
"type": "account_number",
"value": "1032345678"
},
"address": {
"line_one": "123 Main St",
"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_two": "Suite 100",
"line_three": "Kansas City, MO 64105"
}
},
"debtor_agent": {
"routing_number": "021000021"
},
"remittance_details": {
"message_to_creditor": "Payment for invoice 12345"
},
"payment_identifiers": {
"end_to_end_identification": "EndtoEnd12345"
}
}
'import requests
url = "https://api.sandbox.lead.bank/v1/simulate/wires/incoming"
payload = {
"amount": 5000,
"creditor_account_number_id": "account_number_xyz123",
"debtor": {
"name": "Allan Scott",
"account_identifier": {
"type": "account_number",
"value": "1032345678"
},
"address": {
"line_one": "123 Main St",
"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_two": "Suite 100",
"line_three": "Kansas City, MO 64105"
}
},
"debtor_agent": { "routing_number": "021000021" },
"remittance_details": { "message_to_creditor": "Payment for invoice 12345" },
"payment_identifiers": { "end_to_end_identification": "EndtoEnd12345" }
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
amount: 5000,
creditor_account_number_id: 'account_number_xyz123',
debtor: {
name: 'Allan Scott',
account_identifier: {type: 'account_number', value: '1032345678'},
address: {
line_one: '123 Main St',
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_two: 'Suite 100',
line_three: 'Kansas City, MO 64105'
}
},
debtor_agent: {routing_number: '021000021'},
remittance_details: {message_to_creditor: 'Payment for invoice 12345'},
payment_identifiers: {end_to_end_identification: 'EndtoEnd12345'}
})
};
fetch('https://api.sandbox.lead.bank/v1/simulate/wires/incoming', 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/incoming",
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,
'creditor_account_number_id' => 'account_number_xyz123',
'debtor' => [
'name' => 'Allan Scott',
'account_identifier' => [
'type' => 'account_number',
'value' => '1032345678'
],
'address' => [
'line_one' => '123 Main St',
'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_two' => 'Suite 100',
'line_three' => 'Kansas City, MO 64105'
]
],
'debtor_agent' => [
'routing_number' => '021000021'
],
'remittance_details' => [
'message_to_creditor' => 'Payment for invoice 12345'
],
'payment_identifiers' => [
'end_to_end_identification' => 'EndtoEnd12345'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>"
],
]);
$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/incoming"
payload := strings.NewReader("{\n \"amount\": 5000,\n \"creditor_account_number_id\": \"account_number_xyz123\",\n \"debtor\": {\n \"name\": \"Allan Scott\",\n \"account_identifier\": {\n \"type\": \"account_number\",\n \"value\": \"1032345678\"\n },\n \"address\": {\n \"line_one\": \"123 Main St\",\n \"department\": \"Procurement Department\",\n \"sub_department\": \"IT Procurement\",\n \"street_name\": \"Main Street\",\n \"building_number\": \"100\",\n \"building_name\": \"City Hall\",\n \"floor\": \"4th Floor\",\n \"post_box\": \"PO Box 12345\",\n \"room\": \"600\",\n \"post_code\": \"12345\",\n \"town_name\": \"Kansas City\",\n \"town_location_name\": \"Westside North\",\n \"district_name\": \"Manhattan\",\n \"country_sub_division\": \"NY\",\n \"country\": \"US\",\n \"line_two\": \"Suite 100\",\n \"line_three\": \"Kansas City, MO 64105\"\n }\n },\n \"debtor_agent\": {\n \"routing_number\": \"021000021\"\n },\n \"remittance_details\": {\n \"message_to_creditor\": \"Payment for invoice 12345\"\n },\n \"payment_identifiers\": {\n \"end_to_end_identification\": \"EndtoEnd12345\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
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/incoming")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 5000,\n \"creditor_account_number_id\": \"account_number_xyz123\",\n \"debtor\": {\n \"name\": \"Allan Scott\",\n \"account_identifier\": {\n \"type\": \"account_number\",\n \"value\": \"1032345678\"\n },\n \"address\": {\n \"line_one\": \"123 Main St\",\n \"department\": \"Procurement Department\",\n \"sub_department\": \"IT Procurement\",\n \"street_name\": \"Main Street\",\n \"building_number\": \"100\",\n \"building_name\": \"City Hall\",\n \"floor\": \"4th Floor\",\n \"post_box\": \"PO Box 12345\",\n \"room\": \"600\",\n \"post_code\": \"12345\",\n \"town_name\": \"Kansas City\",\n \"town_location_name\": \"Westside North\",\n \"district_name\": \"Manhattan\",\n \"country_sub_division\": \"NY\",\n \"country\": \"US\",\n \"line_two\": \"Suite 100\",\n \"line_three\": \"Kansas City, MO 64105\"\n }\n },\n \"debtor_agent\": {\n \"routing_number\": \"021000021\"\n },\n \"remittance_details\": {\n \"message_to_creditor\": \"Payment for invoice 12345\"\n },\n \"payment_identifiers\": {\n \"end_to_end_identification\": \"EndtoEnd12345\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.lead.bank/v1/simulate/wires/incoming")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 5000,\n \"creditor_account_number_id\": \"account_number_xyz123\",\n \"debtor\": {\n \"name\": \"Allan Scott\",\n \"account_identifier\": {\n \"type\": \"account_number\",\n \"value\": \"1032345678\"\n },\n \"address\": {\n \"line_one\": \"123 Main St\",\n \"department\": \"Procurement Department\",\n \"sub_department\": \"IT Procurement\",\n \"street_name\": \"Main Street\",\n \"building_number\": \"100\",\n \"building_name\": \"City Hall\",\n \"floor\": \"4th Floor\",\n \"post_box\": \"PO Box 12345\",\n \"room\": \"600\",\n \"post_code\": \"12345\",\n \"town_name\": \"Kansas City\",\n \"town_location_name\": \"Westside North\",\n \"district_name\": \"Manhattan\",\n \"country_sub_division\": \"NY\",\n \"country\": \"US\",\n \"line_two\": \"Suite 100\",\n \"line_three\": \"Kansas City, MO 64105\"\n }\n },\n \"debtor_agent\": {\n \"routing_number\": \"021000021\"\n },\n \"remittance_details\": {\n \"message_to_creditor\": \"Payment for invoice 12345\"\n },\n \"payment_identifiers\": {\n \"end_to_end_identification\": \"EndtoEnd12345\"\n }\n}"
response = http.request(request)
puts response.read_body{}{
"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 Wire
Simulate an incoming Wire.
POST
/
v1
/
simulate
/
wires
/
incoming
Simulate Incoming Wire
curl --request POST \
--url https://api.sandbox.lead.bank/v1/simulate/wires/incoming \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"amount": 5000,
"creditor_account_number_id": "account_number_xyz123",
"debtor": {
"name": "Allan Scott",
"account_identifier": {
"type": "account_number",
"value": "1032345678"
},
"address": {
"line_one": "123 Main St",
"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_two": "Suite 100",
"line_three": "Kansas City, MO 64105"
}
},
"debtor_agent": {
"routing_number": "021000021"
},
"remittance_details": {
"message_to_creditor": "Payment for invoice 12345"
},
"payment_identifiers": {
"end_to_end_identification": "EndtoEnd12345"
}
}
'import requests
url = "https://api.sandbox.lead.bank/v1/simulate/wires/incoming"
payload = {
"amount": 5000,
"creditor_account_number_id": "account_number_xyz123",
"debtor": {
"name": "Allan Scott",
"account_identifier": {
"type": "account_number",
"value": "1032345678"
},
"address": {
"line_one": "123 Main St",
"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_two": "Suite 100",
"line_three": "Kansas City, MO 64105"
}
},
"debtor_agent": { "routing_number": "021000021" },
"remittance_details": { "message_to_creditor": "Payment for invoice 12345" },
"payment_identifiers": { "end_to_end_identification": "EndtoEnd12345" }
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
amount: 5000,
creditor_account_number_id: 'account_number_xyz123',
debtor: {
name: 'Allan Scott',
account_identifier: {type: 'account_number', value: '1032345678'},
address: {
line_one: '123 Main St',
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_two: 'Suite 100',
line_three: 'Kansas City, MO 64105'
}
},
debtor_agent: {routing_number: '021000021'},
remittance_details: {message_to_creditor: 'Payment for invoice 12345'},
payment_identifiers: {end_to_end_identification: 'EndtoEnd12345'}
})
};
fetch('https://api.sandbox.lead.bank/v1/simulate/wires/incoming', 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/incoming",
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,
'creditor_account_number_id' => 'account_number_xyz123',
'debtor' => [
'name' => 'Allan Scott',
'account_identifier' => [
'type' => 'account_number',
'value' => '1032345678'
],
'address' => [
'line_one' => '123 Main St',
'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_two' => 'Suite 100',
'line_three' => 'Kansas City, MO 64105'
]
],
'debtor_agent' => [
'routing_number' => '021000021'
],
'remittance_details' => [
'message_to_creditor' => 'Payment for invoice 12345'
],
'payment_identifiers' => [
'end_to_end_identification' => 'EndtoEnd12345'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>"
],
]);
$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/incoming"
payload := strings.NewReader("{\n \"amount\": 5000,\n \"creditor_account_number_id\": \"account_number_xyz123\",\n \"debtor\": {\n \"name\": \"Allan Scott\",\n \"account_identifier\": {\n \"type\": \"account_number\",\n \"value\": \"1032345678\"\n },\n \"address\": {\n \"line_one\": \"123 Main St\",\n \"department\": \"Procurement Department\",\n \"sub_department\": \"IT Procurement\",\n \"street_name\": \"Main Street\",\n \"building_number\": \"100\",\n \"building_name\": \"City Hall\",\n \"floor\": \"4th Floor\",\n \"post_box\": \"PO Box 12345\",\n \"room\": \"600\",\n \"post_code\": \"12345\",\n \"town_name\": \"Kansas City\",\n \"town_location_name\": \"Westside North\",\n \"district_name\": \"Manhattan\",\n \"country_sub_division\": \"NY\",\n \"country\": \"US\",\n \"line_two\": \"Suite 100\",\n \"line_three\": \"Kansas City, MO 64105\"\n }\n },\n \"debtor_agent\": {\n \"routing_number\": \"021000021\"\n },\n \"remittance_details\": {\n \"message_to_creditor\": \"Payment for invoice 12345\"\n },\n \"payment_identifiers\": {\n \"end_to_end_identification\": \"EndtoEnd12345\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
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/incoming")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 5000,\n \"creditor_account_number_id\": \"account_number_xyz123\",\n \"debtor\": {\n \"name\": \"Allan Scott\",\n \"account_identifier\": {\n \"type\": \"account_number\",\n \"value\": \"1032345678\"\n },\n \"address\": {\n \"line_one\": \"123 Main St\",\n \"department\": \"Procurement Department\",\n \"sub_department\": \"IT Procurement\",\n \"street_name\": \"Main Street\",\n \"building_number\": \"100\",\n \"building_name\": \"City Hall\",\n \"floor\": \"4th Floor\",\n \"post_box\": \"PO Box 12345\",\n \"room\": \"600\",\n \"post_code\": \"12345\",\n \"town_name\": \"Kansas City\",\n \"town_location_name\": \"Westside North\",\n \"district_name\": \"Manhattan\",\n \"country_sub_division\": \"NY\",\n \"country\": \"US\",\n \"line_two\": \"Suite 100\",\n \"line_three\": \"Kansas City, MO 64105\"\n }\n },\n \"debtor_agent\": {\n \"routing_number\": \"021000021\"\n },\n \"remittance_details\": {\n \"message_to_creditor\": \"Payment for invoice 12345\"\n },\n \"payment_identifiers\": {\n \"end_to_end_identification\": \"EndtoEnd12345\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.lead.bank/v1/simulate/wires/incoming")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 5000,\n \"creditor_account_number_id\": \"account_number_xyz123\",\n \"debtor\": {\n \"name\": \"Allan Scott\",\n \"account_identifier\": {\n \"type\": \"account_number\",\n \"value\": \"1032345678\"\n },\n \"address\": {\n \"line_one\": \"123 Main St\",\n \"department\": \"Procurement Department\",\n \"sub_department\": \"IT Procurement\",\n \"street_name\": \"Main Street\",\n \"building_number\": \"100\",\n \"building_name\": \"City Hall\",\n \"floor\": \"4th Floor\",\n \"post_box\": \"PO Box 12345\",\n \"room\": \"600\",\n \"post_code\": \"12345\",\n \"town_name\": \"Kansas City\",\n \"town_location_name\": \"Westside North\",\n \"district_name\": \"Manhattan\",\n \"country_sub_division\": \"NY\",\n \"country\": \"US\",\n \"line_two\": \"Suite 100\",\n \"line_three\": \"Kansas City, MO 64105\"\n }\n },\n \"debtor_agent\": {\n \"routing_number\": \"021000021\"\n },\n \"remittance_details\": {\n \"message_to_creditor\": \"Payment for invoice 12345\"\n },\n \"payment_identifiers\": {\n \"end_to_end_identification\": \"EndtoEnd12345\"\n }\n}"
response = http.request(request)
puts response.read_body{}{
"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.
Headers
Idempotency key
Maximum string length:
255Body
application/json
Request body to simulate an incoming wire.
The amount of the wire transaction in cents.
Required range:
1 <= x <= 990000000000Example:
5000
The ID of the creditor account number associated with the wire.
Pattern:
^account_number_\w+$Example:
"account_number_xyz123"
Details of the debtor sending funds.
Show child attributes
Show child attributes
Debtor Agent financial institution details.
Show child attributes
Show child attributes
Details of the remittance information for the wire.
Show child attributes
Show child attributes
Payment identifiers for the wire.
Show child attributes
Show child attributes
Response
Incoming Wire object created.
The response is of type object.
Was this page helpful?
⌘I