APIs
  1. Alfred API
  2. Payouts

Pay out from your own balance

post
https://api.sandbox.alfredpay.io/v1/payouts/fiat

Pays a recipient on your own account from your own balance. The rail is derived from the recipient.

Attach a quoteId when the payout converts, for example from USDC to ARS, and send the quote's toAmount as amount.value. Leave quoteId out to pay from a balance already held in the payout currency.

Read it back with GET /v1/payouts/fiat/{payoutId}. Success is transaction_status: COMPLETE with settlement_status: SETTLED. FAILED is terminal, and funds never leave on a failure.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

A recipient on your own account.

amount
object
required

What the recipient receives. With a quote, the quote's toAmount.

string

Optional. The quote this payout settles.

string
length ≤ 140

Optional. Shown on the transfer.

metadata
object

Client-supplied key–value pairs, echoed on the object and every event about it.

Headers
uuid
required

Required on every state-changing POST, simulators included; the only exempt POST is …/verifications/preflight.
Replay (same key, same body) returns the original response with Idempotent-Replayed: true; same key with a
different body → 409 idempotency_conflict. Keys are UUIDs, scoped to the API key, retained for 24 hours.

Responses

Updated about 4 hours ago

Did this page help you?
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 4 hours ago

Did this page help you?