Skip to main content
POST
/
v2
/
onramps
Create an onramp
curl --request POST \
  --url https://production.hifibridge.com/v2/onramps \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "requestId": "<string>",
  "purposeOfPayment": "gift",
  "isInstant": false,
  "source": {
    "amount": 1,
    "currency": "usd",
    "transferType": "ach",
    "accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "destination": {
    "amount": 1,
    "currency": "usdc",
    "chain": "POLYGON",
    "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "externalWalletId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "virtualAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "fee": {
    "type": "FIX",
    "value": 1
  }
}'
{
  "transferType": "ONRAMP",
  "transferDetails": {
    "id": "b26927e6-2771-423c-af44-a3c7a3e815c5",
    "requestId": "e1047def-6942-4fd7-be04-e62eb41813b6",
    "createdAt": "2025-02-03T17:15:31.927121+00:00",
    "updatedAt": "2025-02-03T17:15:35.882+00:00",
    "status": "OPEN_QUOTE",
    "failedReason": null,
    "source": {
      "userId": "c15c0adf-3e45-4a62-b334-73aeec127649",
      "currency": "usd",
      "amount": 10,
      "accountId": null,
      "user": {
        "email": "example@hifibridge.com",
        "lastName": "Wu",
        "firstName": "Henry",
        "businessName": null
      },
      "bankInfo": null
    },
    "destination": {
      "userId": "c15c0adf-3e45-4a62-b334-73aeec127649",
      "currency": "usdc",
      "chain": "POLYGON",
      "walletAddress": "0x848732f6c834E05b17C56fa01E83EE095f72C3c3",
      "externalWalletId": null,
      "amount": null,
      "user": {
        "email": "example@hifibridge.com",
        "lastName": "Wu",
        "firstName": "Henry",
        "businessName": null
      }
    },
    "receipt": {
      "transactionHash": null
    },
    "developerFee": null,
    "virtualAccountId": null,
    "quoteInformation": {
      "sendGross": {
        "amount": "10.00",
        "currency": "usd"
      },
      "sendNet": {
        "amount": "10.00",
        "currency": "usd"
      },
      "railFee": {
        "amount": "0.00",
        "currency": "usdc"
      },
      "receiveGross": {
        "amount": "10.00",
        "currency": "usdc"
      },
      "receiveNet": {
        "amount": "10.00",
        "currency": "usdc"
      },
      "rate": "1.00",
      "expiresAt": "N/A"
    },
    "depositInfo": null
  }
}

Authorizations

Authorization
string
header
required

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

Body

application/json
  • Onramp
  • Onramp (USD)
  • Onramp (BRL)
  • Onramp (MXN)
  • Onramp (Africa)
requestId
string
required

unique identifier for the request (recommend using uuid v4)

source
object
required

onramp source

destination
object
required

onramp destination

purposeOfPayment
enum<string>
Available options:
gift,
bills,
groceries,
travel,
health,
entertainment,
housing,
school-fees,
other
isInstant
boolean
default:false

instant onramp. coming soon ...

fee
object

custom onramp fee, omit if no fee is charged

Response

Success

transferType
string
transferDetails
object
I