Skip to main content
POST
/
v1
/
simulate
/
ach
/
{ach_id}
/
incoming_return
Simulate Incoming Return
curl --request POST \
  --url https://api.sandbox.lead.bank/v1/simulate/ach/{ach_id}/incoming_return \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "return_code": "R02",
  "return_additional_information": "<string>"
}
'
{}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
ach_id
string
required

ID of the ACH object you want to return.

Pattern: ^ach_\w+$

Body

application/json
​
return_code
enum<string>
required

NACHA Return codes.

Available options:
R01,
R02,
R03,
R04,
R05,
R06,
R07,
R08,
R09,
R10,
R11,
R12,
R13,
R14,
R15,
R16,
R17,
R18,
R19,
R20,
R21,
R22,
R23,
R24,
R25,
R26,
R27,
R28,
R29,
R30,
R31,
R32,
R33,
R34,
R35,
R36,
R37,
R38,
R39,
R40,
R41,
R42,
R43,
R44,
R45,
R46,
R47,
R50,
R51,
R52,
R53,
R61,
R62,
R67,
R68,
R69,
R70,
R71,
R72,
R73,
R74,
R75,
R76,
R77,
R80,
R81,
R82,
R83,
R84,
R85
Example:

"R02"

​
return_additional_information
string

Additional information to be added to the return.

Response

ACH return created.

The response is of type object.