On/Off-Ramps

On-ramps convert fiat to crypto; off-ramps convert crypto to fiat. When you place these orders through a connected account with a provider such as Alfred Pay, Yellow Card, or Scrypt, the provider may require information about the originator and beneficiary, which you include in the order’s participantsIdentification object. It does not go through a Travel Rule provider or your Travel Rule policy; the provider applies its own requirements, which depend on the provider, the payment rail, and who the funds belong to.

What you can do through the API

Task	Console	API
Read a provider’s requirements	No	`GET /trading/providers`
Create an order with participant information	No	`POST /trading/orders` (`fireblocks.tradingBeta.createOrder`)
Track an order	No	`GET /trading/orders/{orderId}` (`fireblocks.tradingBeta.getOrder`)
Connect the provider account	Yes	No

Step 1: Before you start

Trading API access. On/off-ramp orders use the Trading API, which is in Beta. Contact your Customer Success Manager for access.
A connected account with the provider, set up in the Console. See Connected accounts and balances on the Help Center.

Step 2: Build participantsIdentification

Set the relationship separately for the originator and the beneficiary. For example, you can fund an on-ramp yourself (FirstParty originator) and pay out to a customer (ThirdParty beneficiary).

Relationship	Meaning	Data required
`FirstParty`	You’re acting for yourself; the provider already holds your KYC.	Minimal: the relationship type and entity type.
`ThirdParty`	You’re acting for someone else.	The provider may require full PII, such as name, address, and date of birth.

Field	Description
`originator`, `beneficiary`	One object per party.
`participantRelationshipType`	`FirstParty` or `ThirdParty`.
`entityType`	`INDIVIDUAL` or `BUSINESS`.
`fullName`	`firstName` and `lastName`, for individuals.
`businessName`	The business’s legal name, for businesses.
`registrationNumber`	The business’s registration number, for businesses.
`dateOfBirth`	ISO date, for example `1985-03-15`.
`postalAddress`	`streetName`, `buildingNumber`, `postalCode`, `city`, `subdivision`, `district`, and `country` (ISO alpha-2).
`externalReferenceId`	Your own reference for the party.

Acting for yourself:

{
  "participantsIdentification": {
    "originator": { "entityType": "INDIVIDUAL", "participantRelationshipType": "FirstParty" },
    "beneficiary": { "entityType": "INDIVIDUAL", "participantRelationshipType": "FirstParty" }
  }
}

Paying out to a third party:

{
  "participantsIdentification": {
    "originator": { "entityType": "BUSINESS", "participantRelationshipType": "FirstParty" },
    "beneficiary": {
      "entityType": "INDIVIDUAL",
      "participantRelationshipType": "ThirdParty",
      "fullName": { "firstName": "Alexander", "lastName": "Johnson" },
      "dateOfBirth": "1985-03-15",
      "postalAddress": {
        "streetName": "Fifth Avenue",
        "buildingNumber": "350",
        "postalCode": "10118",
        "city": "New York",
        "subdivision": "NY",
        "district": "Manhattan",
        "country": "US"
      },
      "externalReferenceId": "person_ref_7f3e2d1c4b8a5e9f"
    }
  }
}

Step 3: Create the order

const { data: order } = await fireblocks.tradingBeta.createOrder({
  createOrderRequest: {
    via: { type: "PROVIDER_ACCOUNT", providerId: "YELLOWCARD", accountId },
    executionRequestDetails: {
      type: "MARKET",
      side: "BUY",
      baseAmount: "250",
      baseAssetId: "XOF",
      baseAssetRail: "LBT",
      quoteAssetId: "USDT_ERC20",
      quoteAssetRail: "BLOCKCHAIN",
    },
    settlement: {
      type: "DVP",
      sourceAccount: { type: "VAULT_ACCOUNT", accountId: vaultAccountId },
      destinationAccount: { type: "UNMANAGED_WALLET", accountId: whitelistedBankAccountId },
    },
    participantsIdentification: {
      originator: { entityType: "INDIVIDUAL", participantRelationshipType: "FirstParty" },
      beneficiary: { entityType: "INDIVIDUAL", participantRelationshipType: "FirstParty" },
    },
  },
  idempotencyKey: `order-${Date.now()}`,
});

When the source is a vault account, Fireblocks creates a transfer to the provider, approved and signed under your workspace’s Policies like any other transfer, before the order executes. When tracking the order, PENDING_USER_ACTION means it needs action from you, such as an approval; COMPLETED, FAILED, and CANCELED are terminal. For quotes, settlement types, and the full order flow, see On/Off-Ramp, and cross-chain Swap via CeFi.

Whitelisted destinations

Register external bank accounts and crypto addresses as whitelisted destinations, and use them as the order’s destinationAccount with type UNMANAGED_WALLET. They are verified once and reused for future orders.

Provider-specific requirements

Some providers publish their requirements in their provider manifest. Providers can also ask for more information after you create an order, through the order’s requirements (RFI) flow; Circle Payments Network (CPN) supports this. See Off-ramp with Circle Payment Network (CPN).

Limitations

Placing orders is API only, through the Trading API in Beta.
Required fields vary by provider and rail; there is no single field set that works for every provider.

On the Help Center

For an overview of on/off-ramps and connected accounts, see On/Off-Ramps Travel Rule Overview.

Get Started

Transactions

API Co-Signers

Webhooks

Workspace & Security

Identity & Compliance

Manage Wallets

Smart Contracts & Tokenization

Treasury & Trading

Gas Management

Payments

Embedded Wallets

Offchain Signing

Direct Custody Wallets

Integrations

Assets & NFTs

Canton

Key Link

What you can do through the API

Step 1: Before you start

Step 2: Build participantsIdentification

Step 3: Create the order

Whitelisted destinations

Provider-specific requirements

Limitations

On the Help Center

​What you can do through the API

​Step 1: Before you start

​Step 2: Build participantsIdentification

​Step 3: Create the order

​Whitelisted destinations

​Provider-specific requirements

​Limitations

​On the Help Center

What you can do through the API

Step 1: Before you start

Step 2: Build participantsIdentification

Step 3: Create the order

Whitelisted destinations

Provider-specific requirements

Limitations

On the Help Center