Payouts

{
  "id": "cmjpayout001",
  "amount": 5.00,
  "status": "COMPLETED",
  "walletAddress": "0x871cf48ff1847e7a...55c2d3",
  "txDigest": "5kRmC7nV...",
  "method": "CRYPTO",
  "transactionId": "cmjfu1cjv0002v8vsabc12345",
  "cryptoAccountId": "854da716-03bf-4bcf-9eba-3302208f8f36",
  "fiatAccountId": null
}

The payout object

A payout represents a withdrawal of settled funds from your Orafi account to an external wallet address. Payouts are processed on-chain in USDC.

string

Unique identifier for the payout.

number

Payout amount in the base unit.

string

default:"INITIALIZED"

Current payout status. One of INITIALIZED, COMPLETED, or FAILED.

string

Destination wallet address the funds are sent to.

string

On-chain transaction digest, available after the payout is processed.

string

Payout method. One of CRYPTO or FIAT.

string

ID of the parent transaction record.

string

ID of the crypto settlement account used, if applicable.

string

ID of the fiat settlement account used, if applicable.

{
  "id": "cmjpayout001",
  "amount": 5.00,
  "status": "COMPLETED",
  "walletAddress": "0x871cf48ff1847e7a...55c2d3",
  "txDigest": "5kRmC7nV...",
  "method": "CRYPTO",
  "transactionId": "cmjfu1cjv0002v8vsabc12345",
  "cryptoAccountId": "854da716-03bf-4bcf-9eba-3302208f8f36",
  "fiatAccountId": null
}

Transaction sub-object

When retrieving a Transaction with type: "PAYOUT", the payout appears as a nested payout sub-object with these fields:

string

Unique identifier for the payout.

string

Payout method. One of CRYPTO or FIAT.

string

Destination wallet address. Present for crypto payouts.

string

On-chain transaction digest. Available after payout is processed.

string

ID of the crypto settlement account used, if applicable.

string

ID of the fiat settlement account used, if applicable.

{
  "id": "cmjpayout001",
  "method": "CRYPTO",
  "walletAddress": "0x871cf48ff1847e7a...55c2d3",
  "txDigest": "5kRmC7nV...",
  "cryptoAccountId": "854da716-03bf-4bcf-9eba-3302208f8f36",
  "fiatAccountId": null
}

Check available balances

GET /transactions/payout/balances

Returns your available payout balances by token. Use this to check how much you can withdraw before initiating a payout.

curl -X GET https://api.orafi.app/transactions/payout/balances \
  -H "x-api-key: ora_test_your_api_key"

const response = await fetch("https://api.orafi.app/transactions/payout/balances", {
  headers: { "x-api-key": "ora_test_your_api_key" }
});

import requests

response = requests.get(
    "https://api.orafi.app/transactions/payout/balances",
    headers={"x-api-key": "ora_test_your_api_key"}
)

{
  "success": true,
  "message": "Balances retrieved successfully",
  "data": [
    {
      "coinType": "USDC",
      "balance": 35192
    }
  ]
}

Create a crypto payout

POST /transactions/payout/crypto

Initiates a crypto payout. There are two supported methods:

Settlement account
Direct wallet

Use a previously saved crypto settlement account. No wallet signing required.Required fields: amount, cryptoSettlementAccountId

Send funds to any wallet address.Required fields: amount, walletAddress, network Get supported networks See Supported Networks

Request body

number

required

Amount to withdraw.

string

ID of a saved crypto settlement account. Use this or provide a direct wallet address --- not both.

string

Destination wallet address for the payout. Required when not using a settlement account.

string

Serialized message bytes signed by the wallet owner. Required with walletAddress.

string

Cryptographic signature generated by signing bytes with the wallet’s private key. Required with walletAddress.

boolean

default:"false"

When true, saves the wallet address as a settlement account for future payouts.

curl -X POST https://api.orafi.app/transactions/payout/crypto \
  -H "Content-Type: application/json" \
  -H "x-api-key: ora_test_your_api_key" \
  -d '{
    "amount": 5000,
    "cryptoSettlementAccountId": "854da716-03bf-4bcf-9eba-3302208f8f36"
  }'

curl -X POST https://api.orafi.app/transactions/payout/crypto \
  -H "Content-Type: application/json" \
  -H "x-api-key: ora_test_your_api_key" \
  -d '{
    "amount": 5000,
    "walletAddress": "0x742d35Cc6634C0532925a3b844Bc454e4438f44e",
    "bytes": "QWRkIGNyeXB0byBhY2NvdW50...",
    "signature": "AEQCjzWKVlM5Ht4Qbwk/ZpPe..."
  }'

const response = await fetch("https://api.orafi.app/transactions/payout/crypto", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "x-api-key": "ora_test_your_api_key"
  },
  body: JSON.stringify({
    amount: 5000,
    cryptoSettlementAccountId: "854da716-03bf-4bcf-9eba-3302208f8f36"
  })
});

import requests

response = requests.post(
    "https://api.orafi.app/transactions/payout/crypto",
    headers={
        "Content-Type": "application/json",
        "x-api-key": "ora_test_your_api_key"
    },
    json={
        "amount": 5000,
        "cryptoSettlementAccountId": "854da716-03bf-4bcf-9eba-3302208f8f36"
    }
)

{
  "success": true,
  "message": "Payout created successfully",
  "data": {
    "id": "payout_abc123",
    "amount": 5000,
    "status": "INITIALIZED",
    "walletAddress": "0x742d35Cc6634C0532925a3b844Bc454e4438f44e"
  }
}

{
  "success": false,
  "message": "Insufficient balance"
}

Create a fiat payout

POST /transactions/payout/fiat

Initiates a fiat payout to a saved bank account or a new bank account. See Fiat Settlements to manage your saved accounts. You can use a saved fiat settlement account or provide bank details directly.

Retry a failed payout

POST /transactions/payout/crypto/retry

Retries a payout that previously failed. The payout must be in FAILED status.

Request body

string

required

The ID of the failed payout to retry.

curl -X POST https://api.orafi.app/transactions/payout/crypto/retry \
  -H "Content-Type: application/json" \
  -H "x-api-key: ora_test_your_api_key" \
  -d '{
    "payoutId": "payout_abc123"
  }'

const response = await fetch("https://api.orafi.app/transactions/payout/crypto/retry", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "x-api-key": "ora_test_your_api_key"
  },
  body: JSON.stringify({ payoutId: "payout_abc123" })
});

import requests

response = requests.post(
    "https://api.orafi.app/transactions/payout/crypto/retry",
    headers={
        "Content-Type": "application/json",
        "x-api-key": "ora_test_your_api_key"
    },
    json={"payoutId": "payout_abc123"}
)

{
  "success": true,
  "message": "Payout retried successfully",
  "data": {
    "id": "payout_abc123",
    "amount": 5000,
    "status": "INITIALIZED",
    "walletAddress": "0x742d35Cc6634C0532925a3b844Bc454e4438f44e"
  }
}

Overview

Transactions

Payments

Refunds

Paylinks

Customers

Subscriptions

Webhooks

Webhook Deliveries

Crypto Settlements

Fiat Settlements

Profile

Mode

Notifications

Extras

Payouts

The payout object

Transaction sub-object

Check available balances

Create a crypto payout

Request body

Create a fiat payout

Retry a failed payout

Request body

​The payout object

​Transaction sub-object

​Check available balances

​Create a crypto payout

​Request body

​Create a fiat payout

​Retry a failed payout

​Request body

The payout object

Transaction sub-object

Check available balances

Create a crypto payout

Request body

Create a fiat payout

Retry a failed payout

Request body