Sign in

v1

latestOpenAPI 3.0.12026-07-26106359429.8 KB
Simulation

Simulate Incoming ACH

Simulate an incoming ACH.

post/v1/simulate/ach/incoming_ach

Request body

amountinteger required

The amount of the transaction in cents.

currency_code'USD' required

A three-letter currency code as defined in ISO 4217.

transaction_type'credit' | 'debit' required

ACH transaction type.

account_number_idstring required

The ID of the Lead Bank Account Number object.

sec_code'CCD' | 'PPD' | 'TEL' | 'WEB' | 'CIE' required

The Standard Entry Class, SEC, to code the outgoing ACH. Lead currently supports:

  • CCD: Corporate payment
  • PPD: Written authorization to initiate payment
  • TEL: Telephone initiated payment
  • WEB: Web initiated payment
  • CIE: Customer initiated entry
statement_descriptorstring required

The description you would like to appear on your customers’ statement. Maximum number of characters is 10.

sender_namestring required

The name of the sender. Maximum number of characters is 16.

sender_company_idstring required

The company id of the sender. Maximum number of characters is 10.

sender_routing_numberinteger required

The 9 digit routing number of the sender.

Example request

{
  "amount": 5000,
  "currency_code": "USD",
  "transaction_type": "credit",
  "account_number_id": "account_number_xyz123",
  "sec_code": "WEB",
  "statement_descriptor": "P2P Credit",
  "sender_name": "Lorum Inc.",
  "sender_routing_number": 111122222
}

Response

Incoming ACH object created.

SimulateResponse required