Skip to main content
GET
/
v1
/
payouts
/
{payoutId}
cURL
curl --request GET \
  --url https://api.example.com/v1/payouts/{payoutId}
{
  "payoutId": "<string>",
  "object": "payout",
  "accountId": "<string>",
  "sourceAmount": "<string>",
  "sourceAssetCode": "<string>",
  "destinationAmount": "<string>",
  "destinationAssetCode": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "cryptoDetails": {
    "toAddress": "<string>",
    "transactionSignature": "<string>",
    "confirmations": 123,
    "networkFee": "<string>",
    "networkFeeAsset": "<string>"
  },
  "description": "<string>",
  "initiatedAt": "<string>",
  "completedAt": "<string>",
  "metadata": {}
}

Documentation Index

Fetch the complete documentation index at: https://docs.bluerails.com/llms.txt

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

Path Parameters

​
payoutId
string
required

Response

200 - application/json

The request has succeeded.

​
payoutId
string
required
​
object
enum<string>
default:payout
required
Available options:
payout
​
accountId
string
required
​
method
enum<string>
required
Available options:
crypto,
fiat
​
status
enum<string>
required
Available options:
INITIATED,
PROCESSING,
COMPLETED,
FAILED,
CANCELLED
​
sourceAmount
string
required
​
sourceAssetCode
string
required
​
destinationAmount
string
required
​
destinationAssetCode
string
required
​
createdAt
string
required
​
updatedAt
string
required
​
cryptoDetails
object
​
description
string
​
initiatedAt
string
​
completedAt
string
​
metadata
object