Execute simulator withdrawal
POST/api/simulator/execute-withdrawal
This endpoint can be used to simulate a withdrawal on a simulated funding source
Request
- application/json
Body
required
Withdrawal amount in minor units.
ID of the funding source to simulate a deposit to.
ID of the withdrawal interaction
The withdrawal intent expiration date
Responses
- 200
- 400
- 403
Successful operation
- application/json
- Schema
- Example (from schema)
Schema
ID of the Funding Source Interaction.
The ID of the Funding Source that this Interaction relates to.
The ID of the account that this Interaction relates to.
The type of Funding Source Interaction.
The current status of the interaction.
The minor units amount of the transaction.
The token used in the transaction.
Date time on which the interaction was created.
Last modified date of this interaction.
A description of the interaction.
The credit or debit indicator of the interaction.
{
"id": "f0220f084a182e3f4b4d605cda1d3340",
"fundingSourceId": "2be03cd65da12fe29b8910af7b4b85e7",
"accountId": "979254377d0e05002242d038926a5691",
"type": "Withdrawal",
"status": "confirmed",
"amount": 20000,
"token": "USDC",
"createdAt": "2023-11-15T00:48:48.902Z",
"modifiedAt": "2023-11-15T00:49:59.261Z",
"description": "User withdrawal",
"creditOrDebitIndicator": "debit"
}
Request fields are invalid
- application/json
- Schema
- Example (from schema)
Schema
{
"statusCode": 400,
"statusName": "Bad Request",
"errorCode": "BAD_REQUEST",
"errors": [
"Expected string, received number"
]
}
User is not allowed to perform the action with the reason stated in the errorCode
FORBIDDEN Insufficient permissions to perform the action.
INVALID_FUNDING_SOURCE_TYPE Funding source type is invalid. Only funding types using the Simulator strategies are valid
- application/json
- Schema
- Example (from schema)
Schema
{
"statusCode": 403,
"statusName": "Forbidden",
"errorCode": "FORBIDDEN",
"reason": "Unauthorized"
}