Sign in

v1

latestOpenAPI 3.0.12026-07-26106359429.8 KB
Simulation

Simulate Incoming Wire V2

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

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.

metadataMetadata

A set of key-value pairs that can be used to store additional information related to this 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": {
    "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"
    }
  },
  "payment_identifiers": {
    "message_identification": "20241215MMQFMP2L017736",
    "end_to_end_identification": "EndtoEnd12345",
    "uetr": "dae7d83c-1624-4a79-a8ef-3794de115c13",
    "instruction_identification": "Instruction12345",
    "return_identification": "ReturnInstruction12345"
  }
}

Response

Incoming wire object created. The response body is empty.

SimulateResponse required