Skip to main content
POST
/
transfers
Create transfer
curl --request POST \
  --url https://api.onbeam.io/transfers \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "fromWalletId": "<string>",
  "toAddress": "<string>",
  "fromChainId": 123,
  "toChainId": 123,
  "token": "<string>",
  "amount": "<string>"
}
'
{
  "transferId": "<string>",
  "status": "<string>"
}

Authorizations

x-api-key
string
header
required

Body

application/json
fromWalletId
string
required
toAddress
string
required
fromChainId
integer
required
toChainId
integer
required
token
string
required
amount
string
required

Response

200 - application/json

Transfer created

transferId
string
required
status
string
required
Example:

"pending"