curl --request GET \
--url https://production.hifibridge.com/v2/offramps \
--header 'Authorization: Bearer <token>'{
"count": 1,
"records": [
{
"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": "COMPLETED",
"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": {
"imad": "20250827SIM14AE0135526",
"omad": "20250827SIM22390135526",
"paymentRail": "wire"
}
},
"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": []
}
}
]
}List all offramps
Returns a list of offramps associated with a user under your organization. The offramps are returned sorted by creation date, with the most recent offramps appearing first.
curl --request GET \
--url https://production.hifibridge.com/v2/offramps \
--header 'Authorization: Bearer <token>'{
"count": 1,
"records": [
{
"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": "COMPLETED",
"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": {
"imad": "20250827SIM14AE0135526",
"omad": "20250827SIM22390135526",
"paymentRail": "wire"
}
},
"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
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
The user ID.
default to 10, maximum to 100
ISO format: YYYY-MM-DD
ISO format: YYYY-MM-DD
Response
Success
Show child attributes
Show child attributes
Show child attributes
Show child attributes
unique identifier for the offramp
Refer to here for more details on each offramp status.
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 Show child attributes
Show child attributes
Show child attributes
Show child attributes
destination offramp account ID
same day ACH offramp for a $1 additional fee
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Fedwire or ACH batch ID used for settlement tracking
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.
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.
Unique ACH trace number for the transaction
wire, ach, rtp, swift Show child attributes
Show child attributes
unique identifier for the developer fee record
transaction hash of the fee transfer
Show child attributes
Show child attributes
PERCENTAGE, FLAT fee amount as string, for percentage represents decimal (e.g. "0.0005" = 0.05%)
actual fee amount charged
wallet address receiving the fee
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The createdAt timestamp of the last record in the current page. Pass this as createdBefore in the next request to retrieve the next page of results.