Create Transfer Request

Create a money transfer request from a specific wallet.

Create a Withdrawal

Initiate a mutation to create an assets transfer request to send for approval from one of your organization's wallets.

Important Note - Naming convention for this process is slightly different than what's presented in our interface. In our platform "withdrawals" are described as "Money Transfers" while in our API, the mutation is called createWithdrawal.

mutation CreateWithdrawal($data: WithdrawalCreateInput!) {
  createWithdrawal(data: $data) {
    id
  }
}

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Body (WithdrawalCreateInput) object

Name	Type	Description
id*	String	Wallet ID
id* (financialAsset)	String	Asset ID
address*	String	Destination Address (To)
amount*	Integer	Transfer amount
id* (blockchain)	String	Blockchain ID
note	String	Transaction Note
priority	String	Transaction Priority (Slow, medium, fast, etc.)

Example body:

{
	"data": {
		"wallet": {
			"id": "clol7o576002oaz011mmtnvru"
		},
		"financialAsset": {
			"id": "clefn78gv011olc6rcwtt0wel"
		},
		"address": "0x7582f3483116105e0b7845ac1a0df5eb0c8cd062",
		"amount": 5,
		"blockchain": {
			"id": "clefn78em00mslc6r3lzf3h5a"
		},
		"note": "",
		"priority": "Medium"
	}
}

Response

Return values:

Name	Type	Description
id	String	Withdrawal ID

🟢 Success

{
	"data": {
		"createWithdrawal": {
			"id": "clpgvrjb700136g01lr3o0tgu",
		}
	}
}

🔴 Failure

{
}

Try it out!

Apollo Studio