Skip to main content
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"
  }
}
'
{}

Authorizations

​
Authorization
string
header
required

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

Headers

​
Idempotency-Key
string
required

Idempotency key

Maximum string length: 255

Body

application/json

Request body to simulate an incoming wire.

​
amount
integer<int64>
required

The amount of the wire transaction in cents.

Required range: 1 <= x <= 990000000000
Example:

5000

​
creditor_account_number_id
string
required

The ID of the creditor account number associated with the wire.

Pattern: ^account_number_\w+$
Example:

"account_number_xyz123"

​
debtor
object
required

Details of the debtor sending funds.

​
debtor_agent
object
required

Debtor Agent financial institution details.

​
remittance_details
object

Details of the remittance information for the wire.

​
payment_identifiers
object

Payment identifiers for the wire.

Response

Incoming Wire object created.

The response is of type object.