Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.orafi.app/llms.txt

Use this file to discover all available pages before exploring further.

​
The crypto account object

A crypto settlement account is a saved on-chain wallet address linked to your business profile. Once added, it can be used as a trusted payout destination without re-signing each time.
​
id
string
Unique identifier for the settlement account.
​
walletAddress
string
On-chain wallet address saved for payouts.
​
network
string
Saved network for wallet address.
​
profileId
string
Business profile that owns this settlement account.
{
  "id": "854da716-03bf-4bcf-9eba-3302208f8f36",
  "walletAddress": "0x711e00869390d0b5...52de4",
  "profileId": "84a9f045-8a21-4ce4-a7a0-828265c0021b"
}

​
Add a crypto account

POST /settlement/crypto
Links a new wallet address to your profile. Requires a signed message to prove wallet ownership.

​
Request body

​
walletAddress
string
required
Destination wallet address to save.
​
bytes
string
required
Serialized message bytes that were signed by the wallet owner.
​
signature
string
required
Cryptographic signature proving ownership of the wallet.
curl -X POST https://api.orafi.app/settlement/crypto \
  -H "Content-Type: application/json" \
  -H "x-api-key: ora_test_your_api_key" \
  -d '{
    "walletAddress": "0x871cf48ff1847e7a796ed69a04250323df16a66d43b25fee5e1619d82f55c2d3",
    "bytes": "QWRkIGNyeXB0byBhY2NvdW50IGFzIGEgc2V0dGxlbWVudCBhY2NvdW50",
    "signature": "AEQCjzWKVlM5Ht4Qbwk/ZpPeWbL4YRFFY..."
  }'

​
List crypto accounts

GET /settlement/crypto
Returns all saved crypto settlement accounts for the authenticated profile. 
curl -X GET https://api.orafi.app/settlement/crypto \
  -H "x-api-key: ora_test_your_api_key"

​
Delete a crypto account

DELETE /settlement/crypto/{accountId}
Permanently removes a saved wallet address from your settlement accounts.

​
Path parameters

​
accountId
string
required
ID of the settlement account to delete.
curl -X DELETE https://api.orafi.app/settlement/crypto/854da716-03bf-4bcf-9eba-3302208f8f36 \
  -H "x-api-key: ora_test_your_api_key"