Create Withdrawal Intent

post/api/funding-sources/{fundingSourceId}/withdraw

Create a Withdrawal Intent for a given Funding Source.

For more information on Withdrawal Intents see the Card Funding guide

Request

Path Parameters

fundingSourceIdstringrequired
ID for the Funding Source.

Body application/json

amountnumberrequired
Withdrawal amount in minor units.

Response

Successful operation.

Body application/json

amountnumber
Withdrawal amount in minor units.
idstring
ID of the Withdrawal Intent.
createdAtstring
Creation date of the Withdrawal Intent.
expiresAtstring
Expiration date of the Withdrawal Intent.
walletAddressstring
The wallet address to which the funds will be sent.
executionobject
One of
contractAddressstring
The address of the smart contract
abiobject[]
The JSON ABI of the smart contract (contains only required details. more details here https://docs.soliditylang.org/en/v0.8.19/abi-spec.html#json)
Items
typestring
Allowed values:function
namestring
The name of the function
inputsobject[]
Items
namestring
The name of the parameter
typestring
The type of the parameter
methodstring
Smart contract method
paramsobject
Smart contract call params. Keys are matching names and order defined in ABI

FORBIDDEN Insufficient permissions to perform the action.

INSUFFICIENT_BALANCE Withdrawal amount exceeds funding source balance.

TOO_MANY_PENDING_WITHDRAWALS Maximum amount of intents exceeded (10).

FUNDING_STRATEGY_NOT_SUPPORTED Funding strategy is not supported.

Body application/json

statusCodeintegerrequired
statusNamestringrequired
errorCodestringrequired
reasonstring

Example

Example Request

ServerAuthentication

curl 'https://api.immersve.com/api/funding-sources/{fundingSourceId}/withdraw' \
  --request POST \
  --header 'Authorization: Bearer <access-token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "amount": 300000000
}'

curl 'https://api.immersve.com/api/funding-sources/{fundingSourceId}/withdraw' \
  --request POST \
  --header 'Authorization: Bearer <access-token>' \
  --header 'X-Account-Id: <target-account>' \
  --header 'Content-Type: application/json' \
  --data '{
  "amount": 300000000
}'

curl 'https://api.immersve.com/api/funding-sources/{fundingSourceId}/withdraw' \
  --request POST \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'Content-Type: application/json' \
  --data '{
  "amount": 300000000
}'

curl 'https://api.immersve.com/api/funding-sources/{fundingSourceId}/withdraw' \
  --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
}'

curl 'https://test.immersve.com/api/funding-sources/{fundingSourceId}/withdraw' \
  --request POST \
  --header 'Authorization: Bearer <access-token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "amount": 300000000
}'

curl 'https://test.immersve.com/api/funding-sources/{fundingSourceId}/withdraw' \
  --request POST \
  --header 'Authorization: Bearer <access-token>' \
  --header 'X-Account-Id: <target-account>' \
  --header 'Content-Type: application/json' \
  --data '{
  "amount": 300000000
}'

curl 'https://test.immersve.com/api/funding-sources/{fundingSourceId}/withdraw' \
  --request POST \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'Content-Type: application/json' \
  --data '{
  "amount": 300000000
}'

curl 'https://test.immersve.com/api/funding-sources/{fundingSourceId}/withdraw' \
  --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
}'

Example Response

{
  "amount": 300000000,
  "id": "91ad6fea3b52ca58d60d7fd310f789ec",
  "createdAt": "2023-08-14T12:32:54",
  "expiresAt": "2023-08-14T12:32:54",
  "walletAddress": "0xA3058369d6A481B1ff08F62B352409c3D709De9b",
  "execution": {
    "contractAddress": "string",
    "abi": [
      {
        "type": "function",
        "name": "approve",
        "inputs": [
          {
            "name": "_spender",
            "type": "address"
          }
        ]
      }
    ],
    "method": "string",
    "params": {}
  }
}

{
  "amount": 300000000,
  "id": "91ad6fea3b52ca58d60d7fd310f789ec",
  "createdAt": "2023-08-14T12:32:54",
  "expiresAt": "2023-08-14T12:32:54",
  "walletAddress": "0xA3058369d6A481B1ff08F62B352409c3D709De9b",
  "execution": {
    "appId": 702773164,
    "method": "cardFundExecuteApprovedWithdrawal",
    "abi": {
      "name": "cardFundExecuteApprovedWithdrawal",
      "desc": "Withdraws funds before the withdrawal timestamp has lapsed, by using the early withdrawal signature provided by Immersve.",
      "args": [
        {
          "name": "cardFund",
          "type": "address",
          "desc": "The address of the card."
        }
      ],
      "returns": {
        "type": "void"
      }
    },
    "args": [
      {
        "type": "address",
        "value": "EY434UKQU4EX2M63RXFIKZUUKZG4GY5GWV"
      }
    ],
    "x-ref-name": "algorand-contract-call-example"
  }
}

{
  "amount": 300000000,
  "id": "91ad6fea3b52ca58d60d7fd310f789ec",
  "createdAt": "2023-08-14T12:32:54",
  "expiresAt": "2023-08-14T12:32:54",
  "walletAddress": "0xA3058369d6A481B1ff08F62B352409c3D709De9b",
  "execution": {
    "url": "https://test.immersve.com/api/simulator/execute-deposit",
    "payload": {
      "amount": 1000000,
      "fundingSourceId": "91ad6fea3b52ca58d60d7fd310f789ec"
    }
  }
}

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