API Integration

Integration Flow:

Fetch available assets (fiat, crypto, and payment methods).
Use those to fetch real-time quotes. Include the destination wallet when requesting a Binance BUY quote.
Create a transaction using the selected provider. Binance BUY transactions require the destination wallet again at this step.
Redirect users to the checkout URL.
Handle transaction updates through webhooks or via long polling our transaction endpoints.

Authenticate API requests with your partner API key in the X-ORKI-API-KEY header.

Base URLs

Environment	Base URL
Production	`https://api.money.orki.io`
Sandbox	`https://sandbox.money.orki.io`

All endpoints in this guide use the /api/v1/partner base path. Use the same paths with the base URL for your intended environment.

Use TEST API keys with the sandbox base URL. The sandbox supports the partner endpoints documented in this guide, including Transak staging quotes, checkout-session creation, and sandbox transaction retrieval. Creating a sandbox transaction does not initiate payment. Provider completion, status callbacks, and webhook delivery are not simulated end to end.

API request logs

Authenticated requests to /api/v1/partner endpoints are recorded in the API Logs view in the Terminal after the API key and account’s Partner API access have been validated. Each entry contains the request path, HTTP method, response status code, success or failure state, and timestamp. Request parameters, request bodies, response bodies, and API key values are not included in these log entries. Logs are environment-specific: sandbox requests appear only in the sandbox account data, while production requests appear only in production. API logging does not change an endpoint’s request or response structure.

Destination wallets for BUY transactions

Orki does not configure a partner-level destination wallet for ramp purchases. The destination wallet and network are determined separately for each transaction.

For most providers, the buyer enters or confirms the destination wallet and network during the provider’s hosted or embedded checkout.
You may supply wallet_address with quote and transaction requests. Providers that support a prefilled wallet receive it as part of their checkout configuration.
For Binance BUY transactions, wallet_address is required during both quote discovery and transaction creation. Without it, the Binance quote is marked unsupported and cannot be selected.
The selected ramp provider sends the purchased crypto directly to the transaction’s specified or confirmed wallet. Orki does not custody or redirect it.

Creating an Orki transaction only creates a tracking record and checkout link. No purchase or crypto delivery occurs until the buyer completes the provider’s payment and KYC flow.

1. Get Supported Crypto Currencies

Endpoint: GET /api/v1/partner/crypto-currencies Description: Returns a list of all supported cryptocurrencies and their networks. Response Example:

{
  "msg": "Success",
  "data": [
    {
        "code": "eth",
        "network": "ethereum",
        "name": "Ethereum",
        "crypto_icon": "https://asset-url.com"
    },
    {
        "code": "btc",
        "network": "mainnet",
        "name": "Bitcoin",
        "crypto_icon": "https://asset-url.com"
    }
  ],
  "success": true,
  "code": 200
}

2. Get Supported Fiat Currencies

Endpoint: GET /api/v1/partner/fiat-currencies Description: Lists our supported fiat currencies for transactions. Response Example:

{
  "msg": "Success",
  "data": [
     {
        "code": "EUR",
        "name": "Euro",
        "logoSymbol": "EU",
        "fiatIcon": "<svg>…</svg>",
        "minAmount": 1
    },
    {
        "code": "GBP",
        "name": "British pound",
        "logoSymbol": "GB",
        "fiatIcon": "<svg>…</svg>",
        "minAmount": 8
    }
  ],
  "success": true,
  "code": 200
}

3. Get Payment Methods

Endpoint: GET /api/v1/partner/payment-methods Description: Returns all supported payment methods for buying or selling crypto. Required Query Parameters:

Parameter	Type	Example	Description
`fiat`	string	`"USD"`	Fiat currency used to determine available payment methods.
`type`	string	`"BUY"`	Transaction type: `BUY` or `SELL`.

Response Example:

{
  "msg": "Success",
  "data": {
    "payment_methods": [
      {
          "orki_id": "sepa_bank_transfer",
          "logo": "https://d31sk3i6y53c7h.cloudfront.net/assets/payment-methods/sepa_instant.svg",
          "name": "SEPA Bank Transfer",
          "tagline": "European Bank Transfers"
      },
      {
          "orki_id": "credit_debit_card",
          "logo": "https://d31sk3i6y53c7h.cloudfront.net/assets/payment-methods/card.svg",
          "name": "Card Payment",
          "tagline": "Visa, MasterCard, etc."
      }
    ],
    "recommended": "credit_debit_card"
  },
  "success": true,
  "code": 200
}

4. Get Quotes

Endpoint: GET /api/v1/partner/quotes Description: Fetches exchange rate quotes from all supported providers. Required Query Parameters:

Parameter	Type	Example	Description
`fiat_currency`	string	`"USD"`	The fiat currency to use.
`crypto_currency`	string	`"BTC"`	The crypto currency to buy/sell.
`payment_method`	string	`"credit_debit_card"`	Chosen payment method.
`network`	string	`"mainnet"`	Blockchain network for crypto.
`amount`	number	`900`	Fiat amount for the transaction.
`type`	string	`"BUY"`	Transaction type — `BUY` or `SELL`.

Optional Query Parameters:

Parameter	Type	Example	Description
`wallet_address`	string	`"YOUR_BTC_WALLET_ADDRESS"`	Destination wallet for a BUY transaction. Required for Binance BUY quote eligibility; optional for other providers.

Example Request:

curl -X GET "https://api.money.orki.io/api/v1/partner/quotes?fiat_currency=USD&crypto_currency=BTC&payment_method=credit_debit_card&network=mainnet&amount=900&type=BUY&wallet_address=YOUR_BTC_WALLET_ADDRESS" \
  -H "X-ORKI-API-KEY: YOUR_API_KEY"

Example Response:

{
  "msg": "Success",
  "data": [
    {
      "provider": {
        "name": "Moon Pay",
        "identifier": "moonpay",
        "icon": "https://.../moonpay.svg"
      },
      "exchange_rate": 2256201.94,
      "is_best": true,
      "crypto_amount": 0.0004,
      "fiat_amount": 900,
      "quote_amount": 0.0004,
      "percentage_diff": 0
    },
    {
      "provider": {
        "name": "Transak",
        "identifier": "transak",
        "icon": "https://.../transak.svg"
      },
      "exchange_rate": 2124319.04,
      "is_best": false,
      "crypto_amount": 0.00038746,
      "fiat_amount": 900,
      "quote_amount": 0.00038746,
      "percentage_diff": 3.14
    }
  ],
  "success": true,
  "code": 200
}

5. Create Transaction

Endpoint: POST /api/v1/partner/transactions Description: Creates a new transaction and returns a checkout URL for the user to complete payment. JSON Body:

Parameter	Type	Required	Example	Description
`fiat_currency`	string	Yes	`"USD"`	Fiat currency code.
`crypto_currency`	string	Yes	`"BTC"`	Crypto currency code.
`payment_method`	string	Yes	`"credit_debit_card"`	Payment method identifier.
`network`	string	Yes	`"mainnet"`	Crypto network.
`amount`	number	Yes	`900`	Fiat amount.
`type`	string	Yes	`"BUY"`	Transaction type (`BUY` or `SELL`).
`provider`	string	Yes	`"guardarian"`	Provider selected from the quote response.
`wallet_address`	string	Binance BUY only	`"YOUR_BTC_WALLET_ADDRESS"`	Per-transaction destination wallet. Optional for other providers.
`partner_context`	string	No	`"abcd"`	Your reconciliation identifier, returned in transaction webhooks.
`redirect_url`	string	No	`"https://website.com/success"`	URL used after the provider checkout.

Example Request:

curl -X POST "https://api.money.orki.io/api/v1/partner/transactions" \
  -H "X-ORKI-API-KEY: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "fiat_currency": "USD",
    "crypto_currency": "BTC",
    "payment_method": "credit_debit_card",
    "network": "mainnet",
    "amount": 900,
    "type": "BUY",
    "provider": "guardarian",
    "wallet_address": "YOUR_BTC_WALLET_ADDRESS",
    "partner_context": "abcd",
    "redirect_url": "https://website.com/success"
  }'

Example Response:

{
  "msg": "Success",
  "data": {
    "transaction_id": "01k8qrw1j0f2mvd99x33ep160s",
    "provider": {
      "name": "Guardarian",
      "identifier": "guardarian",
      "icon": "https://d31sk3i6y53c7h.cloudfront.net/assets/providers/guardarian.svg"
    },
    "exchange_rate": 93023.26,
    "is_best": true,
    "fiat_amount": 350,
    "crypto_amount": 0.0037606,
    "quote_amount": 0.0037606,
    "link": "https://provider.example/checkout"
  },
  "success": true,
  "code": 200
}

6. Handle Webhooks

Description: Receive updates for transaction status changes. Sample Payload:

{
  "meta": {
    "version": "1.0",
    "server_time": 1735303290,
    "event": "transaction.success"
  },
  "data": {
    "id": "12345",
    "provider_transaction_id": "abc-789",
    "partner_context": "abcd",
    "type": "buy",
    "sender_address": "0x123...",
    "recipient_address": "0x456...",
    "exchange_rate": "1.05",
    "transaction_hash": "0xdeadbeef...",
    "provider_fee": "2.50",
    "orki_fee": "0.50",
    "network_fee": "0.20",
    "fiat_amount": "100.00",
    "crypto_amount": "0.0023",
    "fiat_currency": "USD",
    "crypto_currency": "ETH",
    "network": "ethereum",
    "transaction_method": "card",
    "status": "success",
    "provider": "stripe",
    "created_at": "2025-08-26T10:00:00Z"
  }
}

Events:

transaction.success
transaction.failed

✅ When to Use

You want full control of UX and transaction logic.
You’re integrating crypto buy/sell within your product flow.
You need flexibility in pricing, routing, or KYC handling.

🚀 Next Steps

Obtain your API key from the Partner Dashboard.
Review the OpenAPI Reference for detailed request/response models.
Set up Webhooks to monitor transaction lifecycle.

Getting started

Authentication

Integration Guide

Widget Integration

Ramp Providers

Supported Assets

Webhooks

API Integration

Integration Flow:

Base URLs

API request logs

Destination wallets for BUY transactions

1. Get Supported Crypto Currencies

2. Get Supported Fiat Currencies

3. Get Payment Methods

4. Get Quotes

5. Create Transaction

6. Handle Webhooks

​Integration Flow:

​Base URLs

​API request logs

​Destination wallets for BUY transactions

​1. Get Supported Crypto Currencies

​2. Get Supported Fiat Currencies

​3. Get Payment Methods

​4. Get Quotes

​5. Create Transaction

​6. Handle Webhooks

Integration Flow:

Base URLs

API request logs

Destination wallets for BUY transactions

1. Get Supported Crypto Currencies

2. Get Supported Fiat Currencies

3. Get Payment Methods

4. Get Quotes

5. Create Transaction

6. Handle Webhooks