curl --request POST \
  --url https://production.hifi.com/v3/offramps \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "requestId": "8f3a2b1c-4d5e-6f70-8192-a3b4c5d6e7f8",
  "source": {
    "currency": "USDC",
    "amount": 100,
    "walletId": "wlt_1aLcs3Kf9dQ2mNpXwZ7bV"
  },
  "destination": {
    "currency": "USD",
    "externalAccountId": "extacct_9aB0xY4mNpXwZ7bV1aLdt"
  },
  "achMessage": "Invoice 1024",
  "purposeOfPayment": "Supplier payment",
  "description": "July settlement"
}
'

{
  "id": "offramp_9dQ2mNpXwZ7bV1aLcs3Kf",
  "requestId": "8f3a2b1c-4d5e-6f70-8192-a3b4c5d6e7f8",
  "status": "OPEN_QUOTE",
  "failedReason": null,
  "error": null,
  "errorDetails": null,
  "source": {
    "chain": "POLYGON",
    "amount": 100,
    "currency": "USDC",
    "userId": "usr_3Kf9dQ2mNpXwZ7bV1aLcs",
    "walletId": "wlt_1aLcs3Kf9dQ2mNpXwZ7bV",
    "externalWalletId": null,
    "walletAddress": "0x1234567890abcdef1234567890abcdef12345678"
  },
  "destination": {
    "amount": 99.5,
    "currency": "USD",
    "userId": "usr_7dLpR2mNpXwZ7bV1aQz3x",
    "externalAccountId": "extacct_9aB0xY4mNpXwZ7bV1aLdt",
    "externalCardId": null
  },
  "receipt": {
    "transactionHash": "0xabc123def4567890abc123def4567890abc123def4567890abc123def4567890",
    "paymentTracking": null
  },
  "quote": {
    "sourceCurrency": "USDC",
    "destinationCurrency": "USD",
    "rate": "0.9985"
  },
  "depositInfo": [],
  "sameDayAch": false,
  "achMessage": null,
  "sepaMessage": null,
  "wireMessage": null,
  "swiftMessage": null,
  "purposeOfPayment": "Supplier payment",
  "returnAddress": "0x1234567890abcdef1234567890abcdef12345678",
  "developerFee": {
    "id": "fee_9dQ2mNpXwZ7bV1aLcs3Kf",
    "transactionHash": "0xdef4567890abc123def4567890abc123def4567890abc123def4567890abc123",
    "fees": "0.5"
  },
  "description": "July settlement",
  "createdAt": "2026-07-01T10:30:00.000Z",
  "updatedAt": "2026-07-01T10:30:00.000Z"
}

{
  "type": "VALIDATION_ERROR",
  "message": "One or more fields are invalid or missing.",
  "fields": [
    {
      "code": "invalid_value",
      "message": "Must be a valid email address",
      "field": "email"
    }
  ]
}

{
  "type": "UNAUTHORIZED",
  "message": "Authentication required"
}

{
  "type": "RESOURCE_CONFLICT",
  "message": "Resource already exists or conflicts with current state"
}

{
  "type": "INTERNAL_SERVER_ERROR",
  "message": "An internal server error occurred"
}

Offramps

Create an offramp

Create an offramp transaction that converts stablecoins into fiat and pays out to a beneficiary bank account or card.

The source must reference exactly one of walletId (a custodial HIFI wallet) or externalWalletId. The destination must reference exactly one of externalAccountId or externalCardId. Exactly one of source.amount or destination.amount must be provided; the other side is computed from the conversion rate.

Provide a unique requestId per offramp to guarantee idempotency; reusing a requestId returns a conflict.

POST

offramps

curl --request POST \
  --url https://production.hifi.com/v3/offramps \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "requestId": "8f3a2b1c-4d5e-6f70-8192-a3b4c5d6e7f8",
  "source": {
    "currency": "USDC",
    "amount": 100,
    "walletId": "wlt_1aLcs3Kf9dQ2mNpXwZ7bV"
  },
  "destination": {
    "currency": "USD",
    "externalAccountId": "extacct_9aB0xY4mNpXwZ7bV1aLdt"
  },
  "achMessage": "Invoice 1024",
  "purposeOfPayment": "Supplier payment",
  "description": "July settlement"
}
'

{
  "id": "offramp_9dQ2mNpXwZ7bV1aLcs3Kf",
  "requestId": "8f3a2b1c-4d5e-6f70-8192-a3b4c5d6e7f8",
  "status": "OPEN_QUOTE",
  "failedReason": null,
  "error": null,
  "errorDetails": null,
  "source": {
    "chain": "POLYGON",
    "amount": 100,
    "currency": "USDC",
    "userId": "usr_3Kf9dQ2mNpXwZ7bV1aLcs",
    "walletId": "wlt_1aLcs3Kf9dQ2mNpXwZ7bV",
    "externalWalletId": null,
    "walletAddress": "0x1234567890abcdef1234567890abcdef12345678"
  },
  "destination": {
    "amount": 99.5,
    "currency": "USD",
    "userId": "usr_7dLpR2mNpXwZ7bV1aQz3x",
    "externalAccountId": "extacct_9aB0xY4mNpXwZ7bV1aLdt",
    "externalCardId": null
  },
  "receipt": {
    "transactionHash": "0xabc123def4567890abc123def4567890abc123def4567890abc123def4567890",
    "paymentTracking": null
  },
  "quote": {
    "sourceCurrency": "USDC",
    "destinationCurrency": "USD",
    "rate": "0.9985"
  },
  "depositInfo": [],
  "sameDayAch": false,
  "achMessage": null,
  "sepaMessage": null,
  "wireMessage": null,
  "swiftMessage": null,
  "purposeOfPayment": "Supplier payment",
  "returnAddress": "0x1234567890abcdef1234567890abcdef12345678",
  "developerFee": {
    "id": "fee_9dQ2mNpXwZ7bV1aLcs3Kf",
    "transactionHash": "0xdef4567890abc123def4567890abc123def4567890abc123def4567890abc123",
    "fees": "0.5"
  },
  "description": "July settlement",
  "createdAt": "2026-07-01T10:30:00.000Z",
  "updatedAt": "2026-07-01T10:30:00.000Z"
}

{
  "type": "VALIDATION_ERROR",
  "message": "One or more fields are invalid or missing.",
  "fields": [
    {
      "code": "invalid_value",
      "message": "Must be a valid email address",
      "field": "email"
    }
  ]
}

{
  "type": "UNAUTHORIZED",
  "message": "Authentication required"
}

{
  "type": "RESOURCE_CONFLICT",
  "message": "Resource already exists or conflicts with current state"
}

{
  "type": "INTERNAL_SERVER_ERROR",
  "message": "An internal server error occurred"
}

Authorizations

Authorization

string

header

required

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

Body

application/json

Offramp parameters. Exactly one of source.walletId / source.externalWalletId, exactly one of destination.externalAccountId / destination.externalCardId, and exactly one of source.amount / destination.amount must be provided.

Parameters for creating an offramp transaction.

requestId

string<uuid>

required

Client-supplied idempotency key. Must be a UUID and unique per offramp.

Example:

"8f3a2b1c-4d5e-6f70-8192-a3b4c5d6e7f8"

source

object

required

Source of the stablecoins. Provide exactly one of walletId or externalWalletId. Provide amount here only if it is omitted from destination.

Show child attributes

destination

object

required

Fiat payout destination. Provide exactly one of externalAccountId or externalCardId. Provide amount here only if it is omitted from source.

Show child attributes

sameDayAch

boolean

Request same-day ACH settlement (applicable to ACH payouts only).

Example:

false

achMessage

string

Reference message included with ACH payouts.

Example:

"Invoice 1024"

sepaMessage

string

Reference message included with SEPA payouts.

Example:

"Invoice 1024"

wireMessage

string

Reference message included with wire payouts.

Example:

"Invoice 1024"

swiftMessage

string

Reference message included with SWIFT payouts.

Example:

"Invoice 1024"

purposeOfPayment

string

Purpose of the payment.

Example:

"Supplier payment"

description

string

Free-text description of the offramp.

Example:

"July settlement"

Response

Offramp created successfully.

An offramp transaction.

string

Public ID of the offramp (prefixed with offramp_).

Example:

"offramp_9dQ2mNpXwZ7bV1aLcs3Kf"

requestId

string<uuid>

Client-supplied idempotency key.

Example:

"8f3a2b1c-4d5e-6f70-8192-a3b4c5d6e7f8"

status

enum<string>

Available options:

NOT_INITIATED,

CREATED,

PENDING_APPROVAL,

OPEN_QUOTE,

CRYPTO_INITIATED,

AWAITING_FUNDS,

CRYPTO_PENDING,

CRYPTO_PROCESSED,

FIAT_INITIATED,

FIAT_PENDING,

COMPLETED,

FIAT_FAILED,

FIAT_RETURNED,

CRYPTO_RETURNED,

CRYPTO_FAILED,

QUOTE_FAILED,

IN_REVIEW,

REJECTED,

EXPIRED,

CANCELLED

Example:

"OPEN_QUOTE"

failedReason

string | null

Machine-readable failure reason. Null unless the offramp failed.

Example:

null

error

string | null

User-facing error summary. Null unless the offramp failed.

Example:

null

errorDetails

string | null

User-facing error details. Null unless the offramp failed.

Example:

null

source

object

Resolved source of the offramp.

Show child attributes

destination

object

Resolved fiat payout destination.

Show child attributes

receipt

object

On-chain and payout tracking references.

Show child attributes

quote

object | null

Conversion quote for this offramp.

Example:

{
  "sourceCurrency": "USDC",
  "destinationCurrency": "USD",
  "rate": "0.9985"
}

depositInfo

object[]

Deposit instructions, when applicable.

Example:

[]

sameDayAch

boolean

Example:

false

achMessage

string | null

Example:

null

sepaMessage

string | null

Example:

null

wireMessage

string | null

Example:

null

swiftMessage

string | null

Example:

null

purposeOfPayment

string | null

Example:

"Supplier payment"

returnAddress

string | null

Address to which source stablecoins are returned if the offramp fails.

Example:

"0x1234567890abcdef1234567890abcdef12345678"

developerFee

object | null

Developer fee charged on the offramp, if any.

Show child attributes

description

string | null

Example:

"July settlement"

createdAt

string<date-time>

Example:

"2026-07-01T10:30:00.000Z"

updatedAt

string<date-time>

Example:

"2026-07-01T10:30:00.000Z"

⌘I

Overview

Endpoints

Create an offramp

Authorizations

Body

Response