ALalfredpay
Conversions

Convert your own balance and deliver to a recipient

Changed on

Executes a quote against your own stablecoin balance and delivers the fiat to a recipient on your own account. Funds are drawn from your balance, and no inbound deposit is needed. The result is a PAY_OUT with subtype OFF_RAMP, which settles asynchronously.

POST /v1/payouts/fiat with a quoteId produces the same result. Read it back with GET /v1/conversions/{conversionId} until transaction_status is COMPLETE or FAILED.

post/v1/conversions

Request

  • Base URL
    https://api.sandbox.alfredpay.io
  • URL
    https://api.sandbox.alfredpay.io/v1/conversions
  • Auth
    • HTTP bearer
    • or API key in header api-key and API key in header api-secret

Headers

Idempotency-Keystring 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.

Request body

quoteIdstring required

An active quote.

linkedAccountIdstring required

A recipient on your own account, for the fiat side.

Response

Created

idstring

txn_...

transaction_type'PAY_OUT'
transaction_subtype'OFF_RAMP'
transaction_status'CREATED' | 'PENDING_VALIDATION' | 'PENDING_FUNDS' | 'PENDING_COMPLIANCE' | 'PENDING_RFI' | 'APPROVED_FOR_EXECUTION' | 'PROCESSING' | 'COMPLETE' | 'FAILED' | 'CANCELLED' | 'BLOCKED'

Business lifecycle, customer-facing. Terminal values are COMPLETE, FAILED, CANCELLED, BLOCKED.

settlement_status'NOT_STARTED' | 'FUNDS_EXPECTED' | 'FUNDS_RECEIVED' | 'FUNDS_HELD' | 'FUNDS_RELEASED' | 'SETTLED' | 'PARTIALLY_SETTLED' | 'FAILED' | 'RETURNED'

Leg-level and financial. "Delayed settlement" is a settlement value with the parent still PROCESSING, never a business status.

quoteIdstring
executionRatestring
created_atstring date-time

Changes