Fiat To Crypto

Operations for fiat to crypto conversions (on-ramp)

Request on-ramp quote

post

Generate a quote for converting fiat currency to cryptocurrency.

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.

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:

• fromAmount: Specify exact fiat amount to spend

• toAmount: Specify exact crypto amount to receive

• usd: Specify USD value for conversion

Important Notes:

• Currently supports BRL to BRZ conversions

• Provide EITHER recipientId OR settlementDetails (not both)

• If using recipientId, recipient must have crypto settlement details configured

• If using settlementDetails, provide destination chain, token, and address inline

• Quote includes PIX payment instructions for BRL

• Quotes expire after 5-10 minutes (check expiresAt field)

• Exchange rates include all fees

Authorizations

ClientId & Signature & Timestamp

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

application/json

fromCurrencystring · enumRequired

Source fiat currency code (currently only "BRL" supported)

Example: BRLPossible values:

recipientIdstringOptional

UUID of the recipient to receive cryptocurrency (provide either this OR settlementDetails)

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

Responses

200

On-ramp quote generated successfully

application/json

messagestringOptionalExample: Fiat-to-Crypto Quote requested

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

400

Bad Request - Invalid parameters

application/json

401

Unauthorized - Invalid authentication

application/json

404

Not Found - Recipient not found

application/json

429

Too Many Requests

application/json

500

Internal Server Error

application/json

502

Bad Gateway - External service error

application/json

post

/onramp/quote

HTTPcURLJavaScriptPython

POST /v1/onramp/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: 122

{
  "fromCurrency": "BRL",
  "intent": {
    "method": "fromAmount",
    "value": "500"
  },
  "recipientId": "123e4567-e89b-12d3-a456-426614174000"
}

Specify fiat amountSpecify crypto amountSpecify USD valueInline crypto settlement details

{
  "message": "Fiat-to-Crypto Quote requested",
  "transactionId": "550e8400-e29b-41d4-a716-446655440000",
  "depositInstructions": {
    "method": "PIX",
    "amount": "527.50",
    "currency": "BRL",
    "pixQrCode": "data:image/png;base64,iVBORw0KGgoAAAANS...",
    "pixKey": "00020126580014br.gov.bcb.pix...",
    "expiresAt": "2024-01-15T10:30:00Z",
    "referenceId": "REF123456789"
  },
  "quote": {
    "provider": "Transfero",
    "fromCurrency": "BRL",
    "toCrypto": "0x4b2a3c...",
    "fromAmount": "527.50",
    "toAmount": "100",
    "toAddress": "0xabc123...",
    "exchangeRate": 5.275,
    "estimatedDuration": 60
  }
}

Get on-ramp status

get

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

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 (use "{}" for GET requests), using your Client Secret as the key.

Required Headers

Header	Description
x-client-id	Your project's client ID
x-signature	HMAC-SHA256 signature derived from your client secret

---

Status Values:

• In_progress: Payment pending or being processed

• Completed: Cryptocurrency successfully delivered

• Failed: Payment failed or was rejected

Deposit Status Values:

• awaiting: Waiting for fiat deposit

• received: Deposit received, processing

• confirmed: Deposit confirmed, converting to crypto

• completed: Crypto sent to wallet

Authorizations

ClientId & Signature & Timestamp

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

transactionIdstringRequired

UUID of the transaction to check

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

transactionIdstringOptional

Unique transaction identifier

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

statusstring · enumOptional

Current transaction status

Example: CompletedPossible values:

typestringOptional

Transaction type (always "FIAT_TO_CRYPTO")

Example: FIAT_TO_CRYPTO

fromCurrencystringOptional

Source fiat currency

Example: BRL

toCryptostringOptional

Target cryptocurrency token address

Example: 0x4b2a3c...

toChainstringOptional

Destination blockchain ID

Example: 8453

fiatAmountstringOptional

Amount of fiat currency deposited

Example: 527.50

cryptoAmountstringOptional

Amount of cryptocurrency to receive

Example: 100.00

settlementAddressstringOptional

Recipient's wallet address

Example: 0xabc123...

depositMethodstringOptional

Payment method used (e.g., "PIX")

Example: PIX

depositStatusstring · enumOptional

Status of fiat deposit

Example: confirmedPossible values:

transferoOrderIdstringOptional

Provider's order identifier

Example: ORD-123456

transferoReferenceIdstringOptional

Provider's reference ID

Example: REF-789012

createdAtstring · date-timeOptional

ISO 8601 timestamp of transaction creation

Example: 2024-01-15T10:00:00Z

updatedAtstring · date-timeOptional

ISO 8601 timestamp of last update

Example: 2024-01-15T10:05:00Z

400

Bad Request - Invalid parameters

application/json

401

Unauthorized - Invalid authentication

application/json

404

Not Found - Transaction not found

application/json

429

Too Many Requests

application/json

500

Internal Server Error

application/json

get

/onramp/status

HTTPcURLJavaScriptPython

GET /v1/onramp/status?transactionId=text HTTP/1.1
Host: api.orda.network
x-client-id: prj_abc123def456ghi789
x-signature: a1b2c3d4e5f6789abc123def456ghi789abc123def456
x-timestamp: YOUR_API_KEY
Accept: */*

{
  "transactionId": "550e8400-e29b-41d4-a716-446655440000",
  "status": "Completed",
  "type": "FIAT_TO_CRYPTO",
  "fromCurrency": "BRL",
  "toCrypto": "0x4b2a3c...",
  "toChain": "8453",
  "fiatAmount": "527.50",
  "cryptoAmount": "100.00",
  "settlementAddress": "0xabc123...",
  "depositMethod": "PIX",
  "depositStatus": "confirmed",
  "transferoOrderId": "ORD-123456",
  "transferoReferenceId": "REF-789012",
  "createdAt": "2024-01-15T10:00:00Z",
  "updatedAt": "2024-01-15T10:05:00Z"
}