Execute Simulator Withdrawal

post/api/simulator/execute-withdrawal

This endpoint can be used to simulate a withdrawal on a simulated funding source

Request

Body application/json

amountstring
Withdrawal amount in minor units.
fundingSourceIdstring
ID of the funding source to simulate a deposit to.
idstring
ID of the withdrawal interaction
expiresAtstring
The withdrawal intent expiration date

Response

Successful operation.

Body application/json

idstring
ID of the Funding Source Interaction.
fundingSourceIdstring
The ID of the Funding Source that this Interaction relates to.
accountIdstring
The ID of the account that this Interaction relates to.
typestring
The type of Funding Source Interaction.
statusstring
The current status of the interaction.
amountstring
The minor units amount of the transaction.
tokenstring
The token used in the transaction.
createdAtstring
Date time on which the interaction was created.
modifiedAtstring
Last modified date of this interaction.
descriptionstring
A description of the interaction.
creditOrDebitIndicatorstring
The credit or debit indicator of the interaction.

Request fields are invalid.

Body application/json

statusCodeintegerrequired
statusNamestringrequired
errorCodestringrequired
errorsobject[]
Items
- messagestring
- pathstring
  The location of the invalid path param, query param or payload attribute.

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

Body application/json

statusCodeintegerrequired
statusNamestringrequired
errorCodestringrequired
reasonstring

Example

Example Request

ServerAuthentication

curl https://test.immersve.com/api/simulator/execute-withdrawal \
  --request POST \
  --header 'Authorization: Bearer <access-token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "amount": "300000000",
  "fundingSourceId": "91ad6fea3b52ca58d60d7fd310f789ec",
  "id": "057aa15913a57f50577234c8426534c0",
  "expiresAt": "88ad6fea3b52ca58d69f7fd310f789ab"
}'

curl https://test.immersve.com/api/simulator/execute-withdrawal \
  --request POST \
  --header 'Authorization: Bearer <access-token>' \
  --header 'X-Account-Id: <target-account>' \
  --header 'Content-Type: application/json' \
  --data '{
  "amount": "300000000",
  "fundingSourceId": "91ad6fea3b52ca58d60d7fd310f789ec",
  "id": "057aa15913a57f50577234c8426534c0",
  "expiresAt": "88ad6fea3b52ca58d69f7fd310f789ab"
}'

curl https://test.immersve.com/api/simulator/execute-withdrawal \
  --request POST \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'Content-Type: application/json' \
  --data '{
  "amount": "300000000",
  "fundingSourceId": "91ad6fea3b52ca58d60d7fd310f789ec",
  "id": "057aa15913a57f50577234c8426534c0",
  "expiresAt": "88ad6fea3b52ca58d69f7fd310f789ab"
}'

curl https://test.immersve.com/api/simulator/execute-withdrawal \
  --request POST \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'X-Account-Id: <target-account>' \
  --header 'Content-Type: application/json' \
  --data '{
  "amount": "300000000",
  "fundingSourceId": "91ad6fea3b52ca58d60d7fd310f789ec",
  "id": "057aa15913a57f50577234c8426534c0",
  "expiresAt": "88ad6fea3b52ca58d69f7fd310f789ab"
}'

Example Response

{
  "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"
}

{
  "statusCode": 400,
  "statusName": "Bad Request",
  "errorCode": "INVALID_REQUEST_INPUT",
  "errors": [
    {
      "message": "Invalid type",
      "path": "items[1].attributes.invalidField"
    }
  ]
}

{
  "statusCode": 403,
  "statusName": "Forbidden",
  "errorCode": "FORBIDDEN",
  "reason": "Unauthorized"
}