Execute Simulator Deposit

POST 
/api/simulator/execute-deposit

This endpoint can be used to simulate a deposit and use it as a source of funds.

Request

application/json

Body

required

amount string

Deposit amount in minor units.

fundingSourceId string

ID of the funding source to simulate a deposit to.

Responses

200

Successful operation

application/json

Schema

Schema

id string

ID of the Funding Source Interaction.

fundingSourceId string

The ID of the Funding Source that this Interaction relates to.

accountId string

The ID of the account that this Interaction relates to.

type string

The type of Funding Source Interaction.

status string

The current status of the interaction.

amount string

The minor units amount of the transaction.

token string

The token used in the transaction.

createdAt string

Date time on which the interaction was created.

modifiedAt string

Last modified date of this interaction.

description string

A description of the interaction.

creditOrDebitIndicator string

The credit or debit indicator of the interaction.

Example (from schema)

{
  "id": "f0220f084a182e3f4b4d605cda1d3340",
  "fundingSourceId": "2be03cd65da12fe29b8910af7b4b85e7",
  "accountId": "979254377d0e05002242d038926a5691",
  "type": "Deposit",
  "status": "confirmed",
  "amount": 20000,
  "token": "USDC",
  "createdAt": "2023-11-15T00:48:48.902Z",
  "modifiedAt": "2023-11-15T00:49:59.261Z",
  "description": "1 Queen Street Auckland NZ",
  "creditOrDebitIndicator": "credit"
}

400

Request fields are invalid

application/json

Schema

Schema

statusCode integerrequired
statusName stringrequired
errorCode stringrequired

errors

object[]

Array [

message string

path string

The location of the invalid path param, query param or payload attribute.

]

Example (from schema)

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

403

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

Schema

statusCode integerrequired
statusName stringrequired
errorCode stringrequired
reason string

Example (from schema)

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

Loading...