Skip to main content
POST
/
api
/
v1
/
treasury
/
payouts
Initiate a payout from an end-user wallet
curl --request POST \
  --url http://localhost:3001/api/v1/treasury/payouts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "partnerEndUserId": "<string>",
  "partnerWalletId": "<string>",
  "amount": "100.00",
  "destinationType": "bank_account",
  "destination": {},
  "idempotencyKey": "<string>",
  "metadata": {}
}
'
{
  "success": true,
  "data": {
    "id": "<string>",
    "partnerId": "<string>",
    "partnerEndUserId": "<string>",
    "amount": "100.00",
    "currency": "USDC",
    "destinationType": "<string>",
    "destinationDetails": {},
    "status": "PENDING",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "partnerWalletId": {},
    "failureReason": {}
  }
}

Documentation Index

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

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

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
partnerEndUserId
string
required

Partner end-user id (cuid)

​
partnerWalletId
string
required

Source PartnerWallet id

​
amount
string
required

Principal amount to send (wallet currency)

Example:

"100.00"

​
destinationType
enum<string>
required
Available options:
bank_account,
crypto,
mobile_money
​
destination
object
required

Destination details (validated in service by destinationType)

​
idempotencyKey
string

Optional idempotency key (logged in metadata only in v1)

​
metadata
object

Test mode metadata (sandbox partners). Supported keys: test_outcome

Response

Payout created

​
success
boolean
required
Example:

true

​
data
object
required