LElead
Simulation

Simulate Incoming Wire

Changed on

Simulate an incoming Wire.

post/v1/simulate/wires/incoming

Request

  • Base URL
    https://api.sandbox.lead.bank
  • URL
    https://api.sandbox.lead.bank/v1/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": "Allan Scott",
    "account_identifier": {
      "type": "account_number",
      "value": "1032345678"
    },
    "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"
    }
  },
  "remittance_details": {
    "message_to_creditor": "Payment for invoice 12345"
  },
  "payment_identifiers": {
    "end_to_end_identification": "EndtoEnd12345"
  },
  "debtor_agent": {
    "routing_number": "021000021"
  }
}

Response

Incoming Wire object created.

SimulateResponse required

Changes

  • 2c659854496eRevision changes
    • 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/\-\?:\(\)\.,'\+ !@#$%^&\*=_\{\|\}~";<>\[\\\]]*$

    • info

      the // request property's maxLength was increased from 35 to 70

    • info

      the // request property's maxLength was increased from 35 to 70

    • info

      the // request property's minLength was decreased from 1 to 0