HIFI Docs

GET

offramps

{offrampId}

Retrieve an offramp

curl --request GET \
  --url https://production.hifi.com/v3/offramps/{offrampId} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://production.hifi.com/v3/offramps/{offrampId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://production.hifi.com/v3/offramps/{offrampId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://production.hifi.com/v3/offramps/{offrampId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://production.hifi.com/v3/offramps/{offrampId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "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_NOT_FOUND",
  "message": "<string>",
  "fields": [
    {
      "code": "<string>",
      "message": "<string>",
      "field": "<string>"
    }
  ]
}

{
  "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.

Path Parameters

offrampId

string

required

Public ID of the offramp transaction (prefixed with offramp_)

Response

Offramp retrieved 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

Retrieve an offramp

curl --request GET \
  --url https://production.hifi.com/v3/offramps/{offrampId} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://production.hifi.com/v3/offramps/{offrampId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://production.hifi.com/v3/offramps/{offrampId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://production.hifi.com/v3/offramps/{offrampId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://production.hifi.com/v3/offramps/{offrampId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "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_NOT_FOUND",
  "message": "<string>",
  "fields": [
    {
      "code": "<string>",
      "message": "<string>",
      "field": "<string>"
    }
  ]
}

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

Overview

Endpoints

Retrieve an offramp

Authorizations

Path Parameters

Response