HIFI Developer Docs

Create a crypto transfer

curl --request POST \
  --url https://production.hifibridge.com/v2/wallets/transfers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "requestId": "<string>",
  "source": {
    "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "destination": {
    "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "walletAddress": "<string>"
  },
  "currency": "usdc",
  "amount": 1,
  "chain": "POLYGON",
  "fee": {
    "type": "FIX",
    "value": 1
  },
  "requireApproval": false
}
'

{
  "transferType": "WALLET.TRANSFER",
  "transferDetails": {
    "id": "006737ca-42d5-4780-b3c2-aeb63279c591",
    "requestId": "d0d62bec-2623-4f61-afda-148d6a8e1009",
    "createdAt": "2025-02-03T16:11:36.654998+00:00",
    "updatedAt": "2025-02-03T16:12:41.503+00:00",
    "chain": "POLYGON_MAINNET",
    "currency": "usdc",
    "contractAddress": "0x3c499c542cEF5E3811e1192ce70d8cC03d5c3359",
    "status": "CREATED",
    "failedReason": "",
    "source": {
      "userId": "aec66b02-4f3f-471c-839a-94820b36abb2",
      "walletAddress": "0xA25641cB6056C371CB65F28aC02450c9206e0fAA",
      "walletType": "INDIVIDUAL",
      "user": {
        "email": "[email protected]",
        "lastName": "Yoon",
        "firstName": "Samuel",
        "businessName": null
      }
    },
    "destination": {
      "userId": "aec66b02-4f3f-471c-839a-94820b36abb2",
      "walletType": "INDIVIDUAL",
      "walletAddress": "0xA25641cB6056C371CB65F28aC02450c9206e0fAA",
      "user": {
        "email": "[email protected]",
        "lastName": "Yoon",
        "firstName": "Samuel",
        "businessName": null
      }
    },
    "amount": 0.01,
    "amountIncludeDeveloperFee": 0.01,
    "receipt": {
      "transactionHash": "0x5784890f9efd0160e9401439a5cf2aa5350580ecf48f9ca2af617338ae089e53",
      "userOpHash": "0xef7bdb071b1fcfb5df629bd4d27ffa6dc32d0a5df676f26fb8c25311df1185ac"
    },
    "developerFee": {
      "feeId": "9b354c37-d20d-4d94-bcd8-c852353ca406",
      "feeType": "FIX",
      "feeAmount": 0.5,
      "feePercent": 0,
      "status": "CREATED",
      "transactionHash": null,
      "failedReason": null
    }
  }
}

POST

wallets

transfers

Create a crypto transfer

curl --request POST \
  --url https://production.hifibridge.com/v2/wallets/transfers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "requestId": "<string>",
  "source": {
    "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "destination": {
    "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "walletAddress": "<string>"
  },
  "currency": "usdc",
  "amount": 1,
  "chain": "POLYGON",
  "fee": {
    "type": "FIX",
    "value": 1
  },
  "requireApproval": false
}
'

{
  "transferType": "WALLET.TRANSFER",
  "transferDetails": {
    "id": "006737ca-42d5-4780-b3c2-aeb63279c591",
    "requestId": "d0d62bec-2623-4f61-afda-148d6a8e1009",
    "createdAt": "2025-02-03T16:11:36.654998+00:00",
    "updatedAt": "2025-02-03T16:12:41.503+00:00",
    "chain": "POLYGON_MAINNET",
    "currency": "usdc",
    "contractAddress": "0x3c499c542cEF5E3811e1192ce70d8cC03d5c3359",
    "status": "CREATED",
    "failedReason": "",
    "source": {
      "userId": "aec66b02-4f3f-471c-839a-94820b36abb2",
      "walletAddress": "0xA25641cB6056C371CB65F28aC02450c9206e0fAA",
      "walletType": "INDIVIDUAL",
      "user": {
        "email": "[email protected]",
        "lastName": "Yoon",
        "firstName": "Samuel",
        "businessName": null
      }
    },
    "destination": {
      "userId": "aec66b02-4f3f-471c-839a-94820b36abb2",
      "walletType": "INDIVIDUAL",
      "walletAddress": "0xA25641cB6056C371CB65F28aC02450c9206e0fAA",
      "user": {
        "email": "[email protected]",
        "lastName": "Yoon",
        "firstName": "Samuel",
        "businessName": null
      }
    },
    "amount": 0.01,
    "amountIncludeDeveloperFee": 0.01,
    "receipt": {
      "transactionHash": "0x5784890f9efd0160e9401439a5cf2aa5350580ecf48f9ca2af617338ae089e53",
      "userOpHash": "0xef7bdb071b1fcfb5df629bd4d27ffa6dc32d0a5df676f26fb8c25311df1185ac"
    },
    "developerFee": {
      "feeId": "9b354c37-d20d-4d94-bcd8-c852353ca406",
      "feeType": "FIX",
      "feeAmount": 0.5,
      "feePercent": 0,
      "status": "CREATED",
      "transactionHash": null,
      "failedReason": null
    }
  }
}

Authorizations

Authorization

string

header

required

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

Body

application/json

requestId

string

required

unique identifier for the transfer request (recommend using uuid v4)

source

object

required

crypto transfer source

Show child attributes

source.userId

string<uuid>

required

user who is sending the crypto

destination

object

required

crypto transfer destination

Show child attributes

destination.userId

string<uuid>

required

user who is receiving the crypto (should provide either userId or walletAddress)

destination.walletAddress

string

wallet address that is receiving the crypto (should provide either userId or walletAddress)

currency

enum<string>

crypto currency (note: usdHifi is only available in sandbox to simulate token movement)

Available options:

usdc,

usdt,

usdHifi

amount

number<float>

amount of crypto currency to send

Required range: x >= 0

chain

enum<string>

Available options:

POLYGON,

ETHEREUM,

BASE,

SOLANA

fee

object

crypto transfer fee

Show child attributes

fee.type

enum<string>

required

Available options:

FIX,

PERCENT

fee.value

number<float>

required

custom transaction fee (0.01 represents 1% when type is set to PERCENT, checkout https://docs.hifibridge.com/v2/docs/fee-collection for more information)

Required range: x >= 0

requireApproval

boolean

default:false

Whether this transfer requires approval before processing.

true: Transfer will enter approval workflow
false or omitted: Transfer proceeds immediately

Example:

false

Response

Success

transferType

string

Example:

"WALLET.TRANSFER"

transferDetails

object

Show child attributes

transferDetails.id

string<uuid>

Example:

"006737ca-42d5-4780-b3c2-aeb63279c591"

transferDetails.requestId

string<uuid>

Example:

"d0d62bec-2623-4f61-afda-148d6a8e1009"

transferDetails.createdAt

string<date-time>

Example:

"2025-02-03T16:11:36.654998+00:00"

transferDetails.updatedAt

string<date-time>

Example:

"2025-02-03T16:12:41.503+00:00"

transferDetails.chain

string

Example:

"POLYGON_MAINNET"

transferDetails.currency

string

Example:

"usdc"

transferDetails.contractAddress

string

Example:

"0x3c499c542cEF5E3811e1192ce70d8cC03d5c3359"

transferDetails.status

string

Example:

"CREATED"

transferDetails.failedReason

string

Example:

""

transferDetails.source

object

Show child attributes

transferDetails.source.userId

string<uuid>

Example:

"aec66b02-4f3f-471c-839a-94820b36abb2"

transferDetails.source.walletAddress

string

Example:

"0xA25641cB6056C371CB65F28aC02450c9206e0fAA"

transferDetails.source.walletType

string

Example:

"INDIVIDUAL"

transferDetails.source.user

object

Show child attributes

transferDetails.source.user.email

string

Example:

"[email protected]"

transferDetails.source.user.lastName

string

Example:

"Yoon"

transferDetails.source.user.firstName

string

Example:

"Samuel"

transferDetails.source.user.businessName

string

Example:

null

transferDetails.destination

object

Show child attributes

transferDetails.destination.userId

string<uuid>

Example:

"aec66b02-4f3f-471c-839a-94820b36abb2"

transferDetails.destination.walletAddress

string

Example:

"0xA25641cB6056C371CB65F28aC02450c9206e0fAA"

transferDetails.destination.walletType

string

Example:

"INDIVIDUAL"

transferDetails.destination.user

object

Show child attributes

transferDetails.destination.user.email

string

Example:

"[email protected]"

transferDetails.destination.user.lastName

string

Example:

"Yoon"

transferDetails.destination.user.firstName

string

Example:

"Samuel"

transferDetails.destination.user.businessName

string

Example:

null

transferDetails.amount

number<float>

Example:

0.01

transferDetails.amountIncludeDeveloperFee

number<float>

Example:

0.01

transferDetails.receipt

object

Show child attributes

transferDetails.receipt.transactionHash

string

Example:

"0x5784890f9efd0160e9401439a5cf2aa5350580ecf48f9ca2af617338ae089e53"

transferDetails.receipt.userOpHash

string

Example:

"0xef7bdb071b1fcfb5df629bd4d27ffa6dc32d0a5df676f26fb8c25311df1185ac"

transferDetails.developerFee

object

Show child attributes

transferDetails.developerFee.feeId

string<uuid>

Example:

"9b354c37-d20d-4d94-bcd8-c852353ca406"

transferDetails.developerFee.feeType

string

Example:

"FIX"

transferDetails.developerFee.feeAmount

number<float>

Example:

0.5

transferDetails.developerFee.feePercent

number<float>

Example:

0

transferDetails.developerFee.status

string

Example:

"CREATED"

transferDetails.developerFee.transactionHash

string

Example:

null

transferDetails.developerFee.failedReason

string

Example:

null

transferDetails.approval

object

Show child attributes

transferDetails.approval.id

string<uuid>

Example:

"006737ca-42d5-4780-b3c2-aeb63279c591"

transferDetails.approval.status

string

Example:

"PENDING"

transferDetails.approval.createdAt

string<date-time>

Example:

"2025-02-03T16:11:36.654998+00:00"

transferDetails.approval.updatedAt

string<date-time>

Example:

"2025-02-03T16:12:41.503+00:00"

transferDetails.approval.transferId

string<uuid>

Example:

"006737ca-42d5-4780-b3c2-aeb63279c591"

transferDetails.approval.transferType

string

Example:

"WALLET.TRANSFER"

transferDetails.approval.fromDashboard

boolean

Example:

true

transferDetails.approval.initiatorProfileId

string<uuid>

Example:

"aec66b02-4f3f-471c-839a-94820b36abb2"

transferDetails.approval.votes

object[]

Array of approval votes (only present when status is PENDING_APPROVAL or REJECTED)

Show child attributes

transferDetails.approval.votes.approverId

string<uuid>

Example:

"aec66b02-4f3f-471c-839a-94820b36abb2"

transferDetails.approval.votes.vote

enum<string>

Available options:

APPROVE,

REJECT

Example:

"REJECT"

transferDetails.approval.votes.comment

string

Example:

"Transfer amount exceeds daily limit"

transferDetails.approval.votes.createdAt

string<date-time>

Example:

"2025-02-03T16:12:41.503+00:00"

Retrieve a batch crypto transfer

Create a batch crypto transfer

⌘I

Overview

Endpoints

Create a crypto transfer

Authorizations

Body

Response