Skip to main content
POST
/
transactions
/
payout
/
crypto
Create crypto payout
curl --request POST \
  --url https://api.orafi.app/v1/transactions/payout/crypto \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "amount": 10.5,
  "network": "SUI",
  "walletAddress": "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb",
  "alias": "<string>",
  "cryptoSettlementAccountId": "<string>",
  "save": false
}
'
{
  "success": true,
  "message": "Crypto payout initiated successfully",
  "data": {
    "id": "payout_abc123",
    "walletAddress": "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb",
    "network": "SUI",
    "amount": "10.50",
    "status": "CONFIRMED",
    "txDigest": "<string>",
    "createdAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
x-api-key
string
header
required

API key for merchant authentication required for most endpoints

Body

application/json
​
amount
number
required

Payout amount

Example:

10.5

​
network
enum<string>
required

Blockchain network

Available options:
SUI
Example:

"SUI"

​
walletAddress
string

Wallet address to send crypto to

Example:

"0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb"

​
alias
string

Alias for wallet address

​
cryptoSettlementAccountId
string

ID of saved settlement account

​
save
boolean

Save this wallet for future use

Example:

false

Response

Crypto payout created successfully

​
success
boolean
Example:

true

​
message
string
Example:

"Crypto payout initiated successfully"

​
data
object