Skip to main content
POST
/
v1
/
simulate
/
ach
/
incoming_ach
Simulate Incoming ACH
curl --request POST \
  --url https://api.sandbox.lead.bank/v1/simulate/ach/incoming_ach \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "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_company_id": 1234567890,
  "sender_routing_number": 111122222
}
'
{}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
amount
integer<int64>
required

The amount of the transaction in cents.

Required range: 0 <= x <= 9900000000
Example:

5000

​
currency_code
enum<string>
required

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

Available options:
USD
Example:

"USD"

​
transaction_type
enum<string>
required

ACH transaction type.

Available options:
credit,
debit
Example:

"credit"

​
account_number_id
string
required

The ID of the Lead Bank Account Number object.

Pattern: ^account_number_\w+$
Example:

"account_number_xyz123"

​
sec_code
enum<string>
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
Available options:
CCD,
PPD,
TEL,
WEB,
CIE
Example:

"WEB"

​
statement_descriptor
string
required

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

Required string length: 1 - 10
Pattern: ^(?!0+$)(?! +$)[\x20-\x7E]*$
Example:

"P2P Credit"

​
sender_name
string
required

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

Example:

"Lorum Inc."

​
sender_company_id
string
required

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

Example:

1234567890

​
sender_routing_number
integer<int32>
required

The 9 digit routing number of the sender.

Example:

111122222

Response

Incoming ACH object created.

The response is of type object.