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": []
}
}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.
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": []
}
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
unique identifier for the request (recommend using uuid v4)
offramp source
Show child attributes
offramp destination
Show child attributes
The type of supporting document, required for swift payment.
billing_document, order_document, shipment_document, regulatory_document, transport_document, other_document The URL of the supporting document, required for swift payment.
Memo code or description for usd offramp.
custom offramp fees, omit if no fees are charged
Show child attributes