Simulation

Simulate Incoming Wire V2

Changed on Nov 3, 2026

Simulates an incoming wire against a creditor account in sandbox. Automatically advances to posted on creation; no call to advance required.

post/v2/simulate/wires/incoming

Request

Base URL
https://api.sandbox.lead.bank
URL
https://api.sandbox.lead.bank/v2/simulate/wires/incoming
Auth
HTTP bearer

Headers

Idempotency-Keystring required

Idempotency key

Request body

amountinteger required

The amount of the wire transaction in cents.

creditor_account_number_idstring required

The ID of the Lead Bank Account Number object.

Example request

{
  "amount": 5000,
  "creditor_account_number_id": "account_number_xyz123",
  "debtor": {
    "name": "Alex Smith",
    "account_identifier": {
      "type": "account_number",
      "value": "1032345678"
    },
    "address": {
      "line_one": "123 Main St",
      "line_two": "Suite 100",
      "town_name": "Kansas City",
      "country_sub_division": "MO",
      "post_code": "64105",
      "country": "US"
    }
  },
  "debtor_agent": {
    "local_routing_identifier": {
      "value": "123456"
    },
    "business_identifier_code": "DEUTDEDB"
  },
  "instructing_agent": {
    "local_routing_identifier": {
      "value": "123456"
    }
  },
  "remittance_details": {
    "message_to_creditor": "Payment for invoice 12345"
  },
  "payment_identifiers": {
    "end_to_end_identification": "EndtoEnd12345"
  }
}

Response

Incoming wire object created. The response body is empty.

SimulateResponse required

Changes

Nov 3, 20262c659854496e Revision changes
- breaking
  the // request property's minLength was increased from 0 to 1
- warning
  changed the pattern of the request property // from ^[ \w/\-\?:\.,'\+!@#$%^&\*=\{\|\}~";<>\[\\\]]*[\w/\-\?:\.,'\+!@#$%^&\*=\{\|\}~";<>\[\\\]][ \w/\-\?:\.,'\+!@#$%^&\*=\{\|\}~";<>\[\\\]]*$ to ^[0-9a-zA-Z/\-\?:\.,'\+ !@#$%^&\*=_\{\|\}~";<>\[\\\]]*[0-9a-zA-Z/\-\?:\.,'\+!@#$%^&\*=_\{\|\}~";<>\[\\\]][0-9a-zA-Z/\-\?:\.,'\+ !@#$%^&\*=_\{\|\}~";<>\[\\\]]*$
- warning
  changed the pattern of the request property // from ^[ \w/\-\?:\.,'\+!@#$%^&\*=\{\|\}~";<>\[\\\]]*[\w/\-\?:\.,'\+!@#$%^&\*=\{\|\}~";<>\[\\\]][ \w/\-\?:\.,'\+!@#$%^&\*=\{\|\}~";<>\[\\\]]*$ to ^[0-9a-zA-Z/\-\?:\.,'\+ !@#$%^&\*=_\{\|\}~";<>\[\\\]]*[0-9a-zA-Z/\-\?:\.,'\+!@#$%^&\*=_\{\|\}~";<>\[\\\]][0-9a-zA-Z/\-\?:\.,'\+ !@#$%^&\*=_\{\|\}~";<>\[\\\]]*$
- warning
  changed the pattern of the request property // from ^[ \w/\-\?:\.,'\+!@#$%^&\*=\{\|\}~";<>\[\\\]]*[\w/\-\?:\.,'\+!@#$%^&\*=\{\|\}~";<>\[\\\]][ \w/\-\?:\.,'\+!@#$%^&\*=\{\|\}~";<>\[\\\]]*$ to ^[0-9a-zA-Z/\-\?:\.,'\+ !@#$%^&\*=_\{\|\}~";<>\[\\\]]*[0-9a-zA-Z/\-\?:\.,'\+!@#$%^&\*=_\{\|\}~";<>\[\\\]][0-9a-zA-Z/\-\?:\.,'\+ !@#$%^&\*=_\{\|\}~";<>\[\\\]]*$
- warning
  changed the pattern of the request property // from ^[ \w/\-\?:\.,'\+!@#$%^&\*=\{\|\}~";<>\[\\\]]*[\w/\-\?:\.,'\+!@#$%^&\*=\{\|\}~";<>\[\\\]][ \w/\-\?:\.,'\+!@#$%^&\*=\{\|\}~";<>\[\\\]]*$ to ^[0-9a-zA-Z/\-\?:\.,'\+ !@#$%^&\*=_\{\|\}~";<>\[\\\]]*[0-9a-zA-Z/\-\?:\.,'\+!@#$%^&\*=_\{\|\}~";<>\[\\\]][0-9a-zA-Z/\-\?:\.,'\+ !@#$%^&\*=_\{\|\}~";<>\[\\\]]*$
- warning
  changed the pattern of the request property // from ^[ \w/\-\?:\.,'\+!@#$%^&\*=\{\|\}~";<>\[\\\]]*[\w/\-\?:\.,'\+!@#$%^&\*=\{\|\}~";<>\[\\\]][ \w/\-\?:\.,'\+!@#$%^&\*=\{\|\}~";<>\[\\\]]*$ to ^[0-9a-zA-Z/\-\?:\.,'\+ !@#$%^&\*=_\{\|\}~";<>\[\\\]]*[0-9a-zA-Z/\-\?:\.,'\+!@#$%^&\*=_\{\|\}~";<>\[\\\]][0-9a-zA-Z/\-\?:\.,'\+ !@#$%^&\*=_\{\|\}~";<>\[\\\]]*$
- warning
  changed the pattern of the request property / from ^[ \w/\-\?:\.,'\+!@#$%^&\*=\{\|\}~";<>\[\\\]]*[\w/\-\?:\.,'\+!@#$%^&\*=\{\|\}~";<>\[\\\]][ \w/\-\?:\.,'\+!@#$%^&\*=\{\|\}~";<>\[\\\]]*$ to ^[0-9a-zA-Z/\-\?:\.,'\+ !@#$%^&\*=_\{\|\}~";<>\[\\\]]*[0-9a-zA-Z/\-\?:\.,'\+!@#$%^&\*=_\{\|\}~";<>\[\\\]][0-9a-zA-Z/\-\?:\.,'\+ !@#$%^&\*=_\{\|\}~";<>\[\\\]]*$
- warning
  changed the pattern of the request property / from ^[ \w/\-\?:\.,'\+!@#$%^&\*=\{\|\}~";<>\[\\\]\n]*$ to ^[0-9a-zA-Z/\-\?:\.,'\+ !@#$%^&\*=_\{\|\}~";<>\[\\\]]*[0-9a-zA-Z/\-\?:\.,'\+!@#$%^&\*=_\{\|\}~";<>\[\\\]][0-9a-zA-Z/\-\?:\.,'\+ !@#$%^&\*=_\{\|\}~";<>\[\\\]]*$
- warning
  removed the request property
- warning
  removed the request property /
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  added the new authentication_missing enum value to the response property for the response status
- warning
  added the new content_too_large enum value to the response property for the response status
- warning
  added the new endpoint_disabled enum value to the response property for the response status
- warning
  added the new error_unclassified enum value to the response property for the response status
- warning
  added the new gateway_timeout enum value to the response property for the response status
- warning
  added the new headers_invalid enum value to the response property for the response status
- warning
  added the new idempotency_key_in_use enum value to the response property for the response status
- warning
  added the new idempotency_request_mismatched enum value to the response property for the response status
- warning
  added the new internal_server_error enum value to the response property for the response status
- warning
  added the new lead_control_restricted enum value to the response property for the response status
- warning
  added the new limit_exceeded enum value to the response property for the response status
- warning
  added the new method_not_allowed enum value to the response property for the response status
- warning
  added the new object_modified_concurrently enum value to the response property for the response status
- warning
  added the new object_not_found enum value to the response property for the response status
- warning
  added the new object_state_mismatched enum value to the response property for the response status
- warning
  added the new operation_invalid enum value to the response property for the response status
- warning
  added the new parameters_invalid enum value to the response property for the response status
- warning
  added the new partner_control_restricted enum value to the response property for the response status
- warning
  added the new rate_limit_exceeded enum value to the response property for the response status
- warning
  added the new related_object_incompatible enum value to the response property for the response status
- warning
  added the new related_object_invalid enum value to the response property for the response status
- warning
  added the new related_object_not_ready enum value to the response property for the response status
- warning
  added the new request_malformed enum value to the response property for the response status
- warning
  added the new service_unavailable enum value to the response property for the response status
- warning
  added the new source_ip_not_permitted enum value to the response property for the response status
- warning
  added the new token_invalid enum value to the response property for the response status
- warning
  added the new unsupported_media_type enum value to the response property for the response status
- warning
  added the new url_invalid enum value to the response property for the response status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the optional property to the response with the status
- info
  the response property became required for the status
- info
  added the required property to the response with the status

Operation history