Skip to main content
POST
/
v2
/
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>",
  "purposeOfPayment": "gift",
  "supportingDocumentType": "billing_document",
  "supportingDocumentUrl": "<string>",
  "description": "<string>",
  "source": {
    "amount": 1,
    "currency": "usdc",
    "chain": "POLYGON",
    "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "externalWalletId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "destination": {
    "amount": 1,
    "currency": "usd",
    "accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "sameDayAch": false,
    "achReference": "<string>",
    "sepaReference": "<string>",
    "wireMessage": "<string>",
    "swiftReference": "<string>",
    "swiftCharges": "sha"
  },
  "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": "john.doe@hifibridge.com",
        "firstName": "John",
        "lastName": "Doe",
        "businessName": null
      }
    },
    "destination": {
      "userId": "7d54a7a7-dac3-4313-8b09-27fa4b7fd1ee",
      "amount": 0,
      "currency": "usd",
      "user": {
        "email": "john.doe@hifibridge.com",
        "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

destination
object
required

offramp destination

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

Response

Success

transferType
string
transferDetails
object
I