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

fundingSourceId stringrequired
ID for the Funding Source.
Example: 2be03cd65da12fe29b8910af7b4b85e7

application/json

Body

required

amount numberrequired

Withdrawal amount in minor units.

Responses

200

Successful operation

application/json

Schema

Schema

amount number

Withdrawal amount in minor units.

id string

ID of the Withdrawal Intent.

createdAt string

Creation date of the Withdrawal Intent.

expiresAt string

Expiration date of the Withdrawal Intent.

walletAddress string

The wallet address to which the funds will be sent.

execution

object

oneOf

EVM Smart Contract Write

contractAddress string

The address of the smart contract

abi

object[]

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)

Array [

type string

Possible values: [function]

name string

The name of the function

inputs

object[]

Array [

name string

The name of the parameter

type string

The type of the parameter

]

]

method string

Smart contract method

params object

Smart contract call params. Keys are matching names and order defined in ABI

Algorand Contract Call

appId number

Application ID

method string

Smart contract method

abi

object

The JSON ABI of the smart contract (contains only required details)

name string

The name of the method

desc string

The description of the method

args

object[]

An array of argument objects

Array [

name string

Name of the argument

type string

Data type of the argument

desc string

Description of the argument

]

returns

object

The return value of the method

type string

Type of the return value

args

object[]

Smart contract call params. Contents are matching names and order defined in ABI args array

Array [

type string

Data type of the argument

value string

Value of the argument

]

Simulator Call

url string

The payload instructions should be send to this URL using an HTTP POST.

payload

object

The payload with the instructions for the deposit.

amount string

The simulated deposit amount in minor units of the funding source token.

fundingSourceId string

The funding source to deposit funds to.

Example (from schema)

{
  "amount": 300000000,
  "id": "91ad6fea3b52ca58d60d7fd310f789ec",
  "createdAt": "2023-08-14T12:32:54",
  "expiresAt": "2023-08-14T12:32:54",
  "walletAddress": "0xA3058369d6A481B1ff08F62B352409c3D709De9b",
  "execution": {}
}

403

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.

application/json

Schema

Schema

statusCode integerrequired
statusName stringrequired
errorCode stringrequired
reason string

Example (from schema)

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

Loading...