Crypto To Fiat

Operations for crypto to fiat conversions (off-ramp)

Request off-ramp quote

post

Generate a quote for converting cryptocurrency to fiat currency.

You can provide either an existing recipientId or create a new recipient by providing kycInformation and fiatSettlementDetails.

Authentication

All API requests to orda require HMAC signatures using your project's client ID and client secret. The signature is a HMAC-SHA256 hash of the request body, using your Client Secret as the key. For GET or endpoints with no request body, use the string "{}" (canonical empty object) for the signature.

Required Headers

Header

Description

x-client-id

Your project's client ID

x-signature

HMAC-SHA256 signature derived from your client secret

Content-Type

application/json for this request

Intent Specification: The quote request uses an intent object to specify the amount calculation method:

usd: Calculate based on USD amount
fromAmount: Calculate based on source token amount
toAmount: Calculate based on destination token amount

Important Notes:

Provide EITHER recipientId OR both kycInformation and fiatSettlementDetails (not both options)
If a recipientId is provided, the system will use the recipient's pre-configured settlement details
If you provide kycInformation and fiatSettlementDetails, settlement details are provided inline
KYC information is required for compliance with financial regulations
Quotes have a limited validity period

Authorizations

x-client-idstringRequired

Your project client ID from orda dashboard

x-signaturestringRequired

HMAC-SHA256 signature of canonical request body using your client secret

x-timestampstringRequired

Unix timestamp in milliseconds for replay protection (recommended)

Header parameters

x-client-idstringRequired

Your project client ID from orda dashboard

Default: prj_abc123def456ghi789Example: prj_abc123def456ghi789

x-signaturestringRequired

HMAC-SHA256 signature of canonical request body using your client secret

Default: a1b2c3d4e5f6789abc123def456ghi789abc123def456Example: a1b2c3d4e5f6789abc123def456ghi789abc123def456

x-timestampstringOptional

Unix timestamp in milliseconds for replay protection (recommended)

Default: 1704067200000Example: 1704067200000

Body

fromChainstringRequired

Source blockchain chain ID

Example: 42161

fromTokenstringRequired

Source token contract address

Example: 0xaf88d065e77c8cC2239327C5EDb3A432268e5831

fromAddressstringRequired

Source wallet address

Example: 0x742d35Cc6634C0532925a3b844Bc45426438f000

recipientIdstringOptional

The ID of the recipient to send funds to (provide either this OR kycInformation+fiatSettlementDetails)

Example: 123e4567-e89b-12d3-a456-426614174000

Responses

200

Off-ramp quote generated successfully

application/json

messagestringOptionalExample: Crypto-to-Fiat Quote requested

transactionIdstring · uuidOptionalExample: 550e8400-e29b-41d4-a716-446655440000

400

Bad Request - Invalid parameters

application/json

401

Unauthorized - Invalid authentication

application/json

404

Not Found - Business not found

application/json

429

Too Many Requests

application/json

500

Internal Server Error

application/json

post/offramp/quote

POST /v1/offramp/quote HTTP/1.1
Host: api.orda.network
x-client-id: prj_abc123def456ghi789
x-signature: a1b2c3d4e5f6789abc123def456ghi789abc123def456
x-timestamp: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 230

{
  "fromChain": "42161",
  "fromToken": "0xaf88d065e77c8cC2239327C5EDb3A432268e5831",
  "fromAddress": "0x742d35Cc6634C0532925a3b844Bc45426438f000",
  "intent": {
    "method": "usd",
    "value": "100"
  },
  "recipientId": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "message": "Crypto-to-Fiat Quote requested",
  "transactionId": "550e8400-e29b-41d4-a716-446655440000",
  "quote": {
    "provider": "Transfero",
    "providerRequestId": "0x006b09055cff301034ed164c81c56f8302a350d51210b8686f8d43a1fa13fc06",
    "fromToken": {
      "chainId": 8453,
      "address": "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913",
      "symbol": "USDC",
      "decimals": 6,
      "price": 0.999788
    },
    "toCurrency": "BRL",
    "fromAmount": "100",
    "toAmount": "590",
    "exchangeRate": "5.90",
    "fromAddress": "0x65dC5d3Dab013af752832a5B03De7Ae902aCF048",
    "estimatedDuration": 60,
    "fees": {
      "bridge": {
        "amount": "2000000000000000",
        "token": "ETH"
      },
      "gas": {
        "amount": "1000000000000000",
        "token": "ETH"
      },
      "integrator": 0,
      "maxSlippage": null
    }
  },
  "approvalTxParams": {
    "from": "0x65dC5d3Dab013af752832a5B03De7Ae902aCF048",
    "to": "0xaf88d065e77c8cC2239327C5EDb3A432268e5831",
    "gas": "0xe7db",
    "data": "0x095ea7b3000000000000000000000000af88d065e77c8cc2239327c5edb3a432268e583100000000000000000000000000000000000000000000000000000000000f4371",
    "value": "0x0",
    "nonce": 41
  },
  "transactionRequest": {
    "from": "0x65dC5d3Dab013af752832a5B03De7Ae902aCF048",
    "to": "0xaf88d065e77c8cC2239327C5EDb3A432268e5831",
    "data": "0xa9059cbb000000000000000000000000f70da97812cb96acdf810712aa562db8dfa3dbef00000000000000000000000000000000000000000000000000000000000f4371006b09055cff301034ed164c81c56f8302a350d51210b8686f8d43a1fa13fc06",
    "value": "0",
    "chainId": 42161,
    "requestId": "0x006b09055cff301034ed164c81c56f8302a350d51210b8686f8d43a1fa13fc06",
    "maxFeePerGas": "0x2d8f0fc",
    "maxPriorityFeePerGas": "0x0"
  }
}

Get off-ramp status

get

Authentication

All API requests to orda require HMAC signatures using your project's client ID and client secret:

Required Headers

Header

Description

x-client-id

Your project's client ID

x-signature

HMAC-SHA256 signature derived from your client secret

The signature is an HMAC-SHA256 hash of the request body, using your Client Secret as the key.

Check the status of a crypto-to-fiat transaction.

Status Values:

Processing: The crypto has been received and fiat conversion is in process
Completed: The fiat has been successfully sent to the recipient's bank account
Failed: The transaction failed
Refunded: The transaction was refunded

Authorizations

x-client-idstringRequired

Your project client ID from orda dashboard

x-signaturestringRequired

HMAC-SHA256 signature of canonical request body using your client secret

x-timestampstringRequired

Unix timestamp in milliseconds for replay protection (recommended)

Query parameters

transactionIdstring · uuidRequired

UUID of the off-ramp transaction

Example: 550e8400-e29b-41d4-a716-446655440000

Header parameters

x-client-idstringRequired

Your project client ID from orda dashboard

Default: prj_abc123def456ghi789Example: prj_abc123def456ghi789

x-signaturestringRequired

HMAC-SHA256 signature of canonical request body using your client secret

Default: a1b2c3d4e5f6789abc123def456ghi789abc123def456Example: a1b2c3d4e5f6789abc123def456ghi789abc123def456

x-timestampstringOptional

Unix timestamp in milliseconds for replay protection (recommended)

Default: 1704067200000Example: 1704067200000

Responses

200

Transaction status retrieved successfully

application/json

idstring · uuidOptionalExample: 550e8400-e29b-41d4-a716-446655440000

statusstring · enumOptionalExample: ProcessingPossible values:

createdAtstring · date-timeOptionalExample: 2025-01-15T12:34:56.789Z

updatedAtstring · date-timeOptionalExample: 2025-01-15T12:35:56.789Z

depositAddressstringOptionalExample: 0x1234567890123456789012345678901234567890

depositAmountstringOptionalExample: 100.0

depositTxHashstringOptionalExample: 0x29623029145bffe2479c2d466bd95a01762ce3e852d826bb67975fa2d7bfc580

withdrawalAmountstringOptionalExample: 99.5

withdrawalDetailsobjectOptional

Details of the fiat withdrawal

Example: {"bankAccountNumber":"****7890","currency":"BRL","status":"Processing"}

400

Bad Request - Invalid or missing transactionId

application/json

401

Unauthorized - Missing or invalid API key

application/json

404

Not Found - Transaction not found

application/json

429

Too Many Requests

application/json

500

Internal Server Error

application/json

get/offramp/status

GET /v1/offramp/status?transactionId=123e4567-e89b-12d3-a456-426614174000 HTTP/1.1
Host: api.orda.network
x-client-id: prj_abc123def456ghi789
x-signature: a1b2c3d4e5f6789abc123def456ghi789abc123def456
x-timestamp: YOUR_API_KEY
Accept: */*

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "Processing",
  "createdAt": "2025-01-15T12:34:56.789Z",
  "updatedAt": "2025-01-15T12:35:56.789Z",
  "depositAddress": "0x1234567890123456789012345678901234567890",
  "depositAmount": "100.0",
  "depositTxHash": "0x29623029145bffe2479c2d466bd95a01762ce3e852d826bb67975fa2d7bfc580",
  "withdrawalAmount": "99.5",
  "withdrawalDetails": {
    "bankAccountNumber": "****7890",
    "currency": "BRL",
    "status": "Processing"
  }
}

PreviousCrypto To Crypto

NextFiat To Crypto

Last updated 2 months ago