Simulated Testing
Overview
The Simulations module of the Customer API is a component designed to simulate events. This module is only available in our sandbox environment and features one primary API endpoint at this time:
Simulate Deposit
This endpoint enables an API user to simulate a deposit to a specified customer account under the API's control.
Endpoint:
/api/v1/customer/simulations/payins
Method:
POST
JSON Request Body Parameters:
Parameter Name | Type | Description |
---|---|---|
DestinationAccountId | Integer | Account ID to simulate deposit to |
TransferType | String | Possible Values: (US Domestic Account) ACH WIRE (International Account) SWIFT |
Amount | Decimal | Amount to deposit |
Request Body Example (JSON)
Success Response Example (JSON)
Last updated