Skip to main content
POST
/
craft-send
craft-send
curl --request POST \
  --url https://api.jup.ag/send/v1/craft-send \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "inviteSigner": "<string>",
  "sender": "<string>",
  "amount": "<string>",
  "mint": "<string>"
}
'
{
  "tx": "<string>",
  "expiry": "<string>",
  "totalFeeLamports": "<string>"
}

Authorizations

​
x-api-key
string
header
required

Get API key via https://portal.jup.ag

Body

application/json
​
inviteSigner
string
required
  • Public key address generated from the hash of the invite code
  • Do note that, the invite code requires to be generated client side, refer to docs
  • Please handle invite code and secret key with highest security as user funds are involved
​
sender
string
required
  • Public key address of the sender
  • This address will be funding the amount to be sent and the token accounts involved
​
amount
string
required
  • Amount in atomic value (before decimals)
  • E.g. to send 1 USDC is equivalent of amount='1000000'
  • Do note that there will be additional SOL amount being used in the transaction for transaction fees and token accounts
​
mint
string
  • Defaults to WSOL mint
  • Only pass in this parameter with other mint when required

Response

Successful response

​
tx
string
required
  • Base64-encoded unsigned Send transaction
​
expiry
string
required
  • Unix timestamp of when the invite will expire
  • Expired invites will automatically clawback to sender
​
totalFeeLamports
string
required
  • Amount of fees required for network's transaction fee and token accounts