Create an offramp

curl --request POST \
  --url https://production.hifibridge.com/v2/offramps \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "requestId": "<string>",
  "source": {
    "currency": "usdc",
    "chain": "POLYGON",
    "amount": 1,
    "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "externalWalletId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "destination": {
    "currency": "usd",
    "accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "amount": 1,
    "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "sameDayAch": false,
    "achReference": "<string>",
    "sepaReference": "<string>",
    "wireMessage": "<string>",
    "paymentReference": "<string>",
    "swiftReference": "<string>",
    "swiftCharges": "sha"
  },
  "purposeOfPayment": "gift",
  "supportingDocumentType": "billing_document",
  "supportingDocumentUrl": "<string>",
  "description": "<string>",
  "developerFee": [
    {
      "fees": [
        {
          "type": "PERCENTAGE",
          "value": "<string>",
          "walletAddress": "<string>"
        }
      ]
    }
  ]
}
'

{
  "transferType": "OFFRAMP",
  "transferDetails": {
    "id": "173c1e89-7bbd-4352-9e5d-73807681510d",
    "requestId": "201ca31d-700f-4c76-ac4b-961623acbb79",
    "createdAt": "2025-02-03T16:12:04.331652+00:00",
    "updatedAt": "2025-02-03T16:12:08.732+00:00",
    "status": "OPEN_QUOTE",
    "failedReason": null,
    "source": {
      "userId": "7d54a7a7-dac3-4313-8b09-27fa4b7fd1ee",
      "chain": "POLYGON",
      "currency": "usdc",
      "amount": 10,
      "walletAddress": "0x366B759bAA089Fa57a08edd3F2E028E86b97f8D6",
      "user": {
        "email": "[email protected]",
        "firstName": "John",
        "lastName": "Doe",
        "businessName": null
      }
    },
    "destination": {
      "userId": "7d54a7a7-dac3-4313-8b09-27fa4b7fd1ee",
      "amount": 0,
      "currency": "usd",
      "wireMessage": "Wire message",
      "achReference": "ACH reference",
      "paymentReference": "Payment reference",
      "user": {
        "email": "[email protected]",
        "firstName": "John",
        "lastName": "Doe",
        "businessName": null
      },
      "accountId": "12c1c496-8f57-41a1-8292-dbe6547791ce"
    },
    "receipt": {
      "transactionHash": null,
      "paymentTracking": null
    },
    "developerFee": {
      "id": "1c3d24c1-6136-574c-a647-e7eb6a9fb6ed",
      "transactionHash": null,
      "fees": [
        {
          "type": "PERCENTAGE",
          "value": "0.0005",
          "amount": "0.000515",
          "walletAddress": "0x366B759bAA089Fa57a08edd3F2E028E86b97f8D7"
        },
        {
          "type": "FLAT",
          "value": "0.01",
          "amount": "0.010000",
          "walletAddress": "0x366B759bAA089Fa57a08edd3F2E028E86b97f8D7"
        }
      ]
    },
    "quoteInformation": {
      "sendGross": {
        "amount": "10",
        "currency": "usdc"
      },
      "sendNet": {
        "amount": "10",
        "currency": "usdc"
      },
      "receiveGross": {
        "amount": "10",
        "currency": "usd"
      },
      "receiveNet": {
        "amount": "10",
        "currency": "usd"
      },
      "rate": "1"
    },
    "depositInformation": []
  }
}

Offramps

Create an offramp

An offramp facilitates the conversion of crypto to fiat. Once the crypto transfer is confirmed, HIFI will deposit the converted fiat into the receiving user’s bank account.

There are two types of offramp:

Quote-based offramp: This type of offramp first returns the conversion rate quote based on the best market rate, which you can accept through the Accept an offramp quote endpoint to initiate the offramp.
To learn more about quote-based offramps, click here.
Non-quote-based offramp: This type of offramp will be initiated immediately upon creating an offramp.

POST

offramps

Create an offramp

curl --request POST \
  --url https://production.hifibridge.com/v2/offramps \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "requestId": "<string>",
  "source": {
    "currency": "usdc",
    "chain": "POLYGON",
    "amount": 1,
    "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "externalWalletId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "destination": {
    "currency": "usd",
    "accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "amount": 1,
    "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "sameDayAch": false,
    "achReference": "<string>",
    "sepaReference": "<string>",
    "wireMessage": "<string>",
    "paymentReference": "<string>",
    "swiftReference": "<string>",
    "swiftCharges": "sha"
  },
  "purposeOfPayment": "gift",
  "supportingDocumentType": "billing_document",
  "supportingDocumentUrl": "<string>",
  "description": "<string>",
  "developerFee": [
    {
      "fees": [
        {
          "type": "PERCENTAGE",
          "value": "<string>",
          "walletAddress": "<string>"
        }
      ]
    }
  ]
}
'

{
  "transferType": "OFFRAMP",
  "transferDetails": {
    "id": "173c1e89-7bbd-4352-9e5d-73807681510d",
    "requestId": "201ca31d-700f-4c76-ac4b-961623acbb79",
    "createdAt": "2025-02-03T16:12:04.331652+00:00",
    "updatedAt": "2025-02-03T16:12:08.732+00:00",
    "status": "OPEN_QUOTE",
    "failedReason": null,
    "source": {
      "userId": "7d54a7a7-dac3-4313-8b09-27fa4b7fd1ee",
      "chain": "POLYGON",
      "currency": "usdc",
      "amount": 10,
      "walletAddress": "0x366B759bAA089Fa57a08edd3F2E028E86b97f8D6",
      "user": {
        "email": "[email protected]",
        "firstName": "John",
        "lastName": "Doe",
        "businessName": null
      }
    },
    "destination": {
      "userId": "7d54a7a7-dac3-4313-8b09-27fa4b7fd1ee",
      "amount": 0,
      "currency": "usd",
      "wireMessage": "Wire message",
      "achReference": "ACH reference",
      "paymentReference": "Payment reference",
      "user": {
        "email": "[email protected]",
        "firstName": "John",
        "lastName": "Doe",
        "businessName": null
      },
      "accountId": "12c1c496-8f57-41a1-8292-dbe6547791ce"
    },
    "receipt": {
      "transactionHash": null,
      "paymentTracking": null
    },
    "developerFee": {
      "id": "1c3d24c1-6136-574c-a647-e7eb6a9fb6ed",
      "transactionHash": null,
      "fees": [
        {
          "type": "PERCENTAGE",
          "value": "0.0005",
          "amount": "0.000515",
          "walletAddress": "0x366B759bAA089Fa57a08edd3F2E028E86b97f8D7"
        },
        {
          "type": "FLAT",
          "value": "0.01",
          "amount": "0.010000",
          "walletAddress": "0x366B759bAA089Fa57a08edd3F2E028E86b97f8D7"
        }
      ]
    },
    "quoteInformation": {
      "sendGross": {
        "amount": "10",
        "currency": "usdc"
      },
      "sendNet": {
        "amount": "10",
        "currency": "usdc"
      },
      "receiveGross": {
        "amount": "10",
        "currency": "usd"
      },
      "receiveNet": {
        "amount": "10",
        "currency": "usd"
      },
      "rate": "1"
    },
    "depositInformation": []
  }
}

Authorizations

Authorization

string

header

required

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

Body

application/json

Offramp
Offramp (USD)
Offramp (BRL)
Offramp (COP)
Offramp (MXN)
Offramp (ARS)
Offramp (Africa)
Offramp Global Network (BRL)
Offramp Global Network (MXN)
Offramp Global Network (NGN)
Offramp Global Network (HKD)
Offramp Global Network (CHN)

requestId

string

required

unique identifier for the request (recommend using uuid v4)

source

object

required

offramp source

Show child attributes

source.currency

enum<string>

required

crypto currency (note: usdHifi is only available in sandbox to simulate token movement)

Available options:

usdc,

usdt,

usdHifi

source.chain

enum<string>

required

Available options:

POLYGON,

ETHEREUM,

SOLANA,

BASE

source.amount

number<float>

amount of crypto currency to send

Required range: x >= 0

source.userId

string<uuid>

user who is sending the crypto, required if externalWalletId is not provided

source.externalWalletId

string<uuid>

external wallet id who is sending the crypto, required if userId is not provided

destination

object

required

offramp destination

Show child attributes

destination.currency

enum<string>

required

fiat currency

Available options:

usd,

eur,

brl,

hkd,

mxn,

cop,

ars,

ngn,

ugx,

kes,

zmw,

mwk,

rwf,

tzs,

xaf,

xof,

bwp,

xaf,

cdf,

ghs,

zar

destination.accountId

string<uuid>

required

account that is receiving the fiat currency

destination.amount

number<float>

amount of fiat currency to receive

Required range: x >= 0

destination.userId

string<uuid>

user who is receiving the fiat

destination.sameDayAch

boolean

default:false

same day ACH offramp for a $1 additional fee

destination.achReference

string

a reference message to include when offramping through ACH transfer.

it can be at most 10 characters, A-Z, a-z, 0-9, and spaces. Note that as of 2024-08-06, setting this field is only supported for certain developers while we work on rolling out general support for everyone.

destination.sepaReference

string

a reference message to include when offramping through SEPA transfer.

it must be between 6 to 140 characters. The allowed characters are a-z, A-Z, 0-9, spaces, ampersand (&), hyphen (-), full stop (.), and solidus (/).

destination.wireMessage

string

a message to include when offramping through WIRE transfer.

it can be at most 4 lines, each with a max length of 35 char according to the Fedwire standard.

destination.paymentReference

string

a reference message to include when offramping.

Please utilize wireMessage for wire transfer and achReference for ACH transfer instead of this field.

destination.swiftReference

string

a reference message or remittance information to include when offramping through SWIFT transfer.

it can have at most 4 lines (separated by "\n"), each line with a max length of 35 chars. The allowed characters are a-z, A-Z, 0-9, special characters (/ - ? : ( ) . , ' +), and spaces.

destination.swiftCharges

enum<string>

Available options:

sha,

our

purposeOfPayment

enum<string>

Available options:

gift,

bills,

groceries,

travel,

health,

entertainment,

housing,

school-fees,

other

supportingDocumentType

enum<string>

The type of supporting document, required for swift payment.

Available options:

billing_document,

order_document,

shipment_document,

regulatory_document,

transport_document,

other_document

supportingDocumentUrl

string

The URL of the supporting document, required for swift payment.

description

string

Memo code or description for usd offramp.

developerFee

object[] | null

custom offramp fees, omit if no fees are charged

Show child attributes

developerFee.fees

object[]

required

Show child attributes

developerFee.fees.type

enum<string>

required

Available options:

PERCENTAGE,

FLAT

developerFee.fees.value

string

required

Fee amount as a string. For PERCENTAGE type, "0.0005" represents 0.05%. For FLAT type, represents absolute amount. For PERCENTAGE type, the value must be between 0 and 1 with max 4 decimal places.

developerFee.fees.walletAddress

string

required

Wallet address to receive the fee

Response

Success

transferType

string

transferDetails

object

Show child attributes

transferDetails.id

string<uuid>

unique identifier for the offramp

transferDetails.requestId

string<uuid>

transferDetails.createdAt

string<date-time>

transferDetails.updatedAt

string<date-time>

transferDetails.status

enum<string>

Refer to here for more details on each offramp status.

Available options:

NOT_INITIATED,

CREATED,

OPEN_QUOTE,

CRYPTO_INITIATED,

AWAITING_FUNDS,

CRYPTO_PENDING,

CRYPTO_PROCESSED,

FIAT_INITIATED,

FIAT_PENDING,

COMPLETED,

FIAT_FAILED,

CRYPTO_RETURNED,

CRYPTO_FAILED,

QUOTE_FAILED,

IN_REVIEW

transferDetails.failedReason

string

transferDetails.source

object

Show child attributes

transferDetails.source.userId

string<uuid>

transferDetails.source.chain

string

transferDetails.source.currency

string

transferDetails.source.amount

number

transferDetails.source.walletAddress

string

transferDetails.source.user

object

Show child attributes

transferDetails.source.user.email

string

transferDetails.source.user.lastName

string | null

transferDetails.source.user.firstName

string | null

transferDetails.source.user.businessName

string | null

transferDetails.destination

object

Show child attributes

transferDetails.destination.userId

string<uuid>

transferDetails.destination.amount

number

transferDetails.destination.currency

string

transferDetails.destination.user

object

Show child attributes

transferDetails.destination.user.email

string

transferDetails.destination.user.lastName

string | null

transferDetails.destination.user.firstName

string | null

transferDetails.destination.user.businessName

string | null

transferDetails.destination.accountId

string<uuid>

destination offramp account ID

transferDetails.destination.sameDayAch

boolean

default:false

same day ACH offramp for a $1 additional fee

transferDetails.receipt

object

Show child attributes

transferDetails.receipt.transactionHash

string | null

transferDetails.receipt.paymentTracking

object

Show child attributes

transferDetails.receipt.paymentTracking.fedBatchId

string

Fedwire or ACH batch ID used for settlement tracking

transferDetails.receipt.paymentTracking.imad

string

Input Messaging Accountability Data. A combination of a date, source identifier, and sequence number assigned to a Fedwire message when it is processed by the Federal Reserve Bank Funds Transfer application. Unique to the payment.

transferDetails.receipt.paymentTracking.omad

string

Output Messaging Accountability Data. A combination of a date, destination identifier, and sequence number assigned to a Fedwire message when it is processed by the Federal Reserve Bank Funds Transfer application.

transferDetails.receipt.paymentTracking.traceNumber

string

Unique ACH trace number for the transaction

transferDetails.receipt.paymentTracking.paymentRail

enum<string>

Available options:

wire,

ach,

rtp,

swift

transferDetails.developerFee

object

Show child attributes

transferDetails.developerFee.id

string<uuid>

unique identifier for the developer fee record

transferDetails.developerFee.transactionHash

string | null

transaction hash of the fee transfer

transferDetails.developerFee.fees

object[]

Show child attributes

transferDetails.developerFee.fees.type

enum<string>

required

Available options:

PERCENTAGE,

FLAT

transferDetails.developerFee.fees.value

string

required

fee amount as string, for percentage represents decimal (e.g. "0.0005" = 0.05%)

transferDetails.developerFee.fees.amount

string

required

actual fee amount charged

transferDetails.developerFee.fees.walletAddress

string

required

wallet address receiving the fee

transferDetails.quoteInformation

object

Show child attributes

transferDetails.quoteInformation.sendGross

object

Show child attributes

transferDetails.quoteInformation.sendGross.amount

string

transferDetails.quoteInformation.sendGross.currency

string

transferDetails.quoteInformation.sendNet

object

Show child attributes

transferDetails.quoteInformation.sendNet.amount

string

transferDetails.quoteInformation.sendNet.currency

string

transferDetails.quoteInformation.receiveGross

object

Show child attributes

transferDetails.quoteInformation.receiveGross.amount

string

transferDetails.quoteInformation.receiveGross.currency

string

transferDetails.quoteInformation.receiveNet

object

Show child attributes

transferDetails.quoteInformation.receiveNet.amount

string

transferDetails.quoteInformation.receiveNet.currency

string

transferDetails.quoteInformation.rate

string

transferDetails.quoteInformation.expiresAt

string<date-time>

transferDetails.depositInformation

object[]

Show child attributes

transferDetails.depositInformation.id

string<uuid>

transferDetails.depositInformation.fromAddress

string

transferDetails.depositInformation.toAddress

string

transferDetails.depositInformation.currency

string

transferDetails.depositInformation.contractAddress

string

transferDetails.depositInformation.rawAmount

string

transferDetails.depositInformation.amount

number

transferDetails.depositInformation.chain

string

transferDetails.depositInformation.collected

boolean

transferDetails.depositInformation.collectable

boolean

transferDetails.depositInformation.expiresAt

string<date-time>

transferDetails.depositInformation.transactionHash

string | null

Retrieve an offramp rate

Accept an offramp quote

⌘I

Overview

Endpoints

Create an offramp

Authorizations

Body

Response