Kado Documentation

https://docs.kado.money
Admin
Kado is a web3 payments infrastructure provider that enables seamless fiat-to-crypto,...
Tokens:34,624
Snippets:50
Trust Score:8.3
Update:1 year ago
Show doc for...
Tokens:
Raw
### Kado Widget - Insufficient Funds Example

Source: https://docs.kado.money/integrations/best-practices

Demonstrates how to call the Kado Ramp widget when a user has insufficient funds for an action, pre-filling the amount and currency needed.

```APIDOC
Widget Call Example (Insufficient Funds):

Scenario: User wants to swap 1 ETH for 1500 USDC, but only has 1300 USDC.

When the user clicks 'Swap' and insufficient funds are detected, call the Kado Ramp widget with the following parameters:

Parameters:
  _amount = 200
    - Description: The difference in amount the user is missing (1500 - 1300).
    - Type: number
  _onRevCurrency = USDC
    - Description: The asset that the user is missing.
    - Type: string
  _wallet = [their connected user wallet]
    - Description: The user's connected wallet address, passed directly.
    - Type: string
```

--------------------------------

### Get Configurations API

Source: https://docs.kado.money/integrations/integrate-kado/the-hybrid-api/get-quote

Retrieves Kado's general configurations, including available countries, languages, and payment methods. This endpoint helps tailor the user experience based on regional availability.

```APIDOC
GET /v2/public/config

Description:
Other Kado configurations, such as available countries, languages, and payment methods.
```

--------------------------------

### Kado Hybrid API Endpoints

Source: https://docs.kado.money/kado-products/kado-off-ramp

Provides access to Kado's core functionalities for integrating crypto payments and transfers directly into your application. Supports getting quotes, initiating payments, and checking order status.

```APIDOC
Kado Hybrid API:

This API allows for programmatic integration of Kado's fiat-to-crypto and crypto-to-fiat services.

1. Get Quote:
   - Endpoint: POST /quote
   - Description: Retrieves a quote for a crypto transaction based on specified parameters.
   - Parameters:
     - `amount`: (number) The amount of fiat currency.
     - `fiat`: (string) The fiat currency code (e.g., 'USD').
     - `crypto`: (string) The crypto currency code (e.g., 'ETH').
     - `network`: (string) The blockchain network (e.g., 'ethereum').
     - `country`: (string) The user's country code (e.g., 'US').
   - Returns: Quote details including estimated crypto amount, fees, and exchange rate.

2. Pay via Kado Widget:
   - Endpoint: POST /pay
   - Description: Initiates a payment flow using the Kado Widget.
   - Parameters:
     - `quoteId`: (string) The ID obtained from the Get Quote endpoint.
     - `redirectUrl`: (string) The URL to redirect the user to after payment completion.
     - `userId`: (string, optional) Your internal user identifier.
     - `metadata`: (object, optional) Additional data to pass along.
   - Returns: A URL to launch the Kado Widget for the user to complete the transaction.

3. Get Order Status:
   - Endpoint: GET /order/{orderId}
   - Description: Retrieves the status of a previously initiated transaction.
   - Parameters:
     - `orderId`: (string) The unique identifier for the order.
   - Returns: The current status of the order (e.g., 'pending', 'completed', 'failed').

Related Endpoints:
- The Widget integration for frontend embedding.
- Advanced configurations for specific payment methods or network integrations.
```

--------------------------------

### Get Supported Assets API

Source: https://docs.kado.money/integrations/integrate-kado/the-hybrid-api/get-quote

Fetches a list of all active cryptocurrencies and digital assets supported by Kado. This is essential for users to know which assets can be traded via the platform.

```APIDOC
GET /v1/ramp/supported-assets

Description:
The list of active assets available on Kado.
```

--------------------------------

### Kado Hybrid API: Get Quote Functionality

Source: https://docs.kado.money/integrations/integrate-kado/the-hybrid-api/get-quote

This API documentation covers the necessary steps to retrieve supported assets, blockchains, and configurations from Kado's Hybrid API. These calls are crucial for building custom frontends that allow users to buy or sell cryptocurrencies, enabling the generation of accurate quotes.

```APIDOC
Kado Hybrid API: Get Quote Flow

This section outlines the API endpoints and data required to enable quote generation for crypto transactions using the Kado Hybrid API.

1.  **Get Supported Assets**
    *   **Endpoint**: `/v1/ramp/supported-assets`
    *   **Description**: Retrieves a list of all assets currently supported by Kado for purchase or sale. This is essential for populating frontend dropdowns or lists of available cryptocurrencies.
    *   **Parameters**: None explicitly mentioned for this call, but it returns a list of assets.
    *   **Returns**: A list of supported assets, each with a unique `symbol` and other relevant details.
    *   **Usage**: Call this endpoint to ensure assets displayed to the user are actively available for transactions.

2.  **Get Blockchains**
    *   **Endpoint**: `/v1/ramp/blockchains`
    *   **Description**: Fetches a list of supported blockchains that Kado can interact with. This data is needed to specify the origin or destination network for transactions.
    *   **Parameters**: None explicitly mentioned for this call.
    *   **Returns**: A list of supported blockchains, each with an `origin` identifier.
    *   **Usage**: Use the `origin` identifier from this response when requesting quotes.

3.  **Get Configurations**
    *   **Endpoint**: `/v1/ramp/configs`
    *   **Description**: Retrieves general configuration settings relevant to Kado's ramp services. This might include network fees, processing times, or other operational parameters.
    *   **Parameters**: None explicitly mentioned for this call.
    *   **Returns**: Configuration details for Kado services.

4.  **Get Quote**
    *   **Endpoint**: `/v1/ramp/quote` (Implied by context)
    *   **Description**: Calculates a real-time quote for a specific crypto transaction based on the selected asset, blockchain, and transaction amount. This is the core step before initiating a purchase or sale.
    *   **Parameters**: Requires `assetSymbol` (from `/v1/ramp/supported-assets`), `origin` (from `/v1/ramp/blockchains`), and transaction details (e.g., amount, fiat currency).
    *   **Returns**: A quote object containing the exchange rate, fees, and estimated transaction details.
    *   **Usage**: Use the `symbol` and `origin` obtained from the previous calls to request a quote for a user's desired transaction.

**Related Functionality**: 
*   **Kado Widget**: For embedding Kado's UI directly into your application.
*   **Customization**: Parameters and options for tailoring the integration experience.
```

--------------------------------

### Get Order Status API Endpoint and Off-Ramp Workflow

Source: https://docs.kado.money/integrations/integrate-kado/the-hybrid-api/get-order-status

This section describes how to retrieve the status of an order using the Kado Hybrid API and outlines the steps for wallet integrators to initiate off-ramps based on this status. It includes details on path parameters and the post-confirmation workflow.

```APIDOC
GET /orders/{orderId}

Description:
Retrieves the status and details of a specific Kado order.

Path Parameters:
- orderId (String, required): The unique identifier for the order. This can be the Kado-generated Order ID or a custom sessionId provided by the integrator.

Workflow for Initiating Off-Ramps:
1. Initiate the off-ramp flow in your application by setting the `product=SELL` URL parameter when directing users to the Kado Widget.
2. After a user confirms their order within the Kado Widget, Kado will send a `window.postMessage` event containing the `orderId`.
3. Use the received `orderId` to call the Get Order Status API endpoint (`GET /orders/{orderId}`).
4. The API response will contain details such as `payAmount.amount` and `depositAddress`.
5. Initiate a cryptocurrency send of `payAmount.amount` from your user's wallet to the `depositAddress`.
6. Optionally, if the Kado Widget was closed, it can be reopened to display the status of that specific order by navigating to `https://app.kado.money/ramp/order/{orderId}`.

Related Concepts:
- Pay via Kado Widget: For initiating the initial payment flow.
- Session ID: For custom order tracking.
```

--------------------------------

### Get Blockchains API

Source: https://docs.kado.money/integrations/integrate-kado/the-hybrid-api/get-quote

Retrieves a list of all active blockchains supported by Kado. This endpoint is crucial for understanding the network environments available for transactions.

```APIDOC
GET /v1/ramp/blockchains

Description:
The list of active blockchains available on Kado.

Response Example (200 OK):
{
  "success": boolean,
  "message": string,
  "data": {
    "blockchains": [
      {
        "_id": string,
        "supportedEnvironment": string,
        "network": string,
        "origin": string,
        "label": string,
        "associatedAssets": {
            "_id": string,
            "name": string,
            "description": string,
            "label": string,
            "supportedProviders": string[],
            "stablecoin": boolean,
            "liveOnRamp": boolean,
            "createdAt": string,
            "updatedAt": string,
            "__v": number,
            "priority": number
        },
        "avgTransactionTimeSeconds": number,
        "usesAvaxRouter": boolean,
        "liveOnRamp": boolean,
        "createdAt": string,
        "updatedAt": string,
        "__v": number,
        "priority": number
      }
    ]
  }
}
```

--------------------------------

### Kado Integration Configuration Parameters

Source: https://docs.kado.money/integrations/customizing-your-integration/parameters

Defines the parameters used to configure the Kado integration, controlling default selections for currencies, amounts, addresses, and product types. Query parameters are case-sensitive.

```APIDOC
apiKey - Required
  Description: Kado integrator key. This is a public key used for identifier purposes.
  Type: String
  Example: fa47115e-35e3-11ed-a261-0242ac120002

onPayCurrency
  Description: The fiat currency that will be selected by default for the user to pay in. Users can select any other that is available for selection.
  Values: USD, EUR, CAD, GBP, MXN, COP, INR, CHF, AUD, ARS, BRL, CLP, JPY, KRW, PEN, PHP, SGD, TRY, UYU, TWD, VND, CRC, SEK, PLN, DKK, NOK, NZD
  Type: String
  Default Value: USD

onRevCurrency
  Description: The cryptocurrency that will be selected by default for the user to buy. Users can select any other that is available for selection. Note: requires network to be set.
  Values: USDT, USDC, SOL, ETH, AVAX, DAI, OSMO, ATOM, BTC, XLM, STARS, SCRT, INJ, CMDX, wETH, wBTC, USDC.e, POL, XRP, REGEN, WHALE, BLD, IST, XKI, XPLA, HUAHUA, FLIX, ARCH, LTC, NTRN, SEI, TIA, COREUM, BONK, JUP, KUJI, QCK, IXO, FRXUSD, KYVE, SGE, SUI, DYM, XION
  Type: String

offPayCurrency
  Description: The cryptocurrency that will be selected by default for the user to sell. Users can select any other that is available for selection. Note: Off Ramp currently not available for Arbitrum, Optimism, Polygon
  Values: USDT, USDC, SOL, ETH, AVAX, ATOM, BTC, XLM, XRP, LTC, NTRN, SEI, TIA, BONK, JUP, KUJI, QCK, SUI, DYM, XION
  Type: String

offRevCurrency
  Description: The fiat currency that will be selected by default for the user to be paid in. Users can select any other that is available for selection.
  Values: USD
  Type: String

product
  Description: The option that will be selected by default (on-ramp or off-ramp). Users can change the selection.
  Values: BUY, SELL, SWAP
  Type: String

onPayAmount
  Description: The amount that will be selected by default for the user to buy. Users can enter any other amount.
  Constraints: Any positive number, rounded to the nearest cent. Min/max will be validated upon widget load. Min >= 10
  Type: String

offPayAmount
  Description: The amount that will be entered by default for the user to sell. Users can enter any other amount.
  Constraints: Any positive number. Min/max will be validated upon widget load.
  Type: String

onToAddress
  Description: Blockchain address of the wallet where the purchased cryptocurrency will be sent to.
  Constraints: Valid wallet address matching the network.
  Example: 0x3ACfa4b5320550199C322A9B33e85c70d0F90D1b
  Type: String

onToAddressMulti
  Description: Key-value pairs to set multiple wallet addresses, associated to a specific blockchain.
  Constraints: Valid chain:address key-value pairs.
  Example: ETHEREUM:0x1234,OSMOSIS:osmo1234,COSMOS HUB:cosmos1234
  Type: Array[string]

offFromAddress
  Description: Blockchain address of the wallet that cryptocurrency will be sent from, for an off-ramp.
  Constraints: Valid wallet address matching the network.
  Example: 0x3ACfa4b5320550199C322A9B33e85c70d0F90D1b
  Type: String

network
  Description: The crypto network that will be selected by default for buy or sell. Users can select any other networks that are available for selection. Note: Requires onRevCurrency to be set. Note: Off Ramp currently not available for Arbitrum, Optimism, Polygon
  Values: BITCOIN, TERRA, OSMOSIS, SOLANA, ETHEREUM, JUNO, AVALANCHE, KUJIRA, INJECTIVE, ARBITRUM, OPTIMISM, POLYGON, COSMOS HUB, STELLAR, STARGAZE, SECRET, BASE, COMDEX, RIPPLE, BASE, REGEN, AGORIC, MIGALOO, KI, XPLA, NOBLE, CHIHUAHUA, OMNIFLIX, ARCHWAY, LITECOIN, NEUTRON, SEI, CELESTIA, COREUM, QUICKSILVER, IMPACTS HUB, FRAXTAL, KYVE, SGE NETWORK, SUI, DYMENSION, XION
  Type: String

cryptoList
  Description: A comma-separated list of crypto currencies that users can buy or sell. Only these will show on the widget.
  Values: USDT, USDC, SOL, ETH, AVAX, DAI, OSMO, ATOM, BTC, XLM, STARS, SCRT, INJ, CMDX, wETH, wBTC, USDC.e, POL, XRP, REGEN, WHALE, BLD, IST, XKI, XPLA, HUAHUA, FLIX, ARCH, LTC, NTRN, SEI, TIA, COREUM, BONK, JUP, KUJI, QCK, IXO, FRXUSD, KYVE, SGE, SUI, DYM, XION
  Type: Array[string]

fiatList
  Description: A comma-separated list of fiat currencies that users can buy or sell. Only these will show on the widget.
  Values: USD, CAD, GBP, EUR, MXN, COP, INR, CHF, AUD, ARS, BRL, CLP, JPY, KRW, PEN, PHP, SGD, TRY, UYU, TWD, VND, CRC, SEK, PLN, DKK, NOK, NZD
  Type: Array[string]

networkList
  Description: A comma-separated list of crypto networks that users can buy or sell. Only these will show on the widget. Note: Requires onRevCurrency to be set.
  Values: BITCOIN, TERRA, OSMOSIS, SOLANA, ETHEREUM, JUNO, AVALANCHE, KUJIRA, INJECTIVE, ARBITRUM, OPTIMISM, POLYGON, COSMOS HUB, STELLAR, STARGAZE, SECRET, BASE, COMDEX, RIPPLE, BASE, REGEN, AGORIC, MIGALOO, KI, XPLA, NOBLE, CHIHUAHUA, OMNIFLIX, ARCHWAY, LITECOIN, NEUTRON, SEI, CELESTIA, COREUM, QUICKSILVER, IMPACTS HUB, FRAXTAL, KYVE, SGE NETWORK, SUI, DYMENSION, XION
  Type: Array[string]
```

--------------------------------

### Link to Kado Widget (HTML)

Source: https://docs.kado.money/integrations/integrate-kado/the-widget/new-window-tab

Provides a simple HTML anchor (`<a>`) tag that links to the Kado widget. Clicking this link will open the Kado widget in a new browser tab, allowing users to complete the on-ramp process. This is a straightforward method for directing users to the Kado platform.

```html
<a href="https://app.kado.money/?apiKey=API_KEY">On-ramp</a>
```

--------------------------------

### Kado Widget Integration - New Window/Tab

Source: https://docs.kado.money/kado-products/kado-on-ramp

Details on integrating the Kado Widget by opening it in a new browser window or tab. This approach separates the Kado flow from your main application interface.

```APIDOC
Kado Widget - New Window/Tab:

**Description**: Integrate the Kado Widget by directing users to a Kado-hosted URL in a new browser tab or window. This is a simpler integration method that requires less client-side management.

**Usage**: 
Construct a Kado Widget URL with the necessary parameters and open it in a new tab.

**URL Parameters**: 
These parameters are appended to the base Kado Widget URL:

*   `apiKey`: Your Kado API key.
*   `amount`: The amount of fiat currency.
*   `fiatCurrency`: The fiat currency code (e.g., 'USD').
*   `cryptoCurrency`: The cryptocurrency to be purchased (e.g., 'USDC').
*   `network`: The blockchain network (e.g., 'ethereum', 'solana').
*   `userId`: A unique identifier for the user.
*   `redirectUrl`: The URL to redirect the user to after the transaction.
*   `metadata`: Optional data to pass along.

**Example (Constructing URL and Opening)**:

```javascript
const baseUrl = 'https://widget.kado.money/';
const params = new URLSearchParams({
  apiKey: 'YOUR_KADO_API_KEY',
  amount: '50',
  fiatCurrency: 'EUR',
  cryptoCurrency: 'ETH',
  network: 'avalanche',
  userId: 'user_98765',
  redirectUrl: 'https://your-app.com/kado-callback'
});

const widgetUrl = `${baseUrl}?${params.toString()}`;

window.open(widgetUrl, '_blank');
```

**Callback Handling**: 
Your `redirectUrl` should be configured to receive callbacks from Kado, allowing you to update your application's state based on the transaction outcome.
```

--------------------------------

### Configure Kado Webhook Endpoint

Source: https://docs.kado.money/integrations/integrate-kado/the-hybrid-api/advanced

Update your integration's webhook URL or secret by sending a POST request to the Kado API. This requires prior setup of API Authentication.

```APIDOC
POST https://api.kado.money/v1/partner/configure-webhook

Payload:
{
  "webhookUrl": "String (Webhook URL for Kado to POST updates to)",
  "webhookSecret": "String (Webhook secret used to calculate the x-signature header)"
}

This endpoint allows you to manage where Kado sends event notifications and the secret used for signature generation.
```

--------------------------------

### Kado Widget Integration - New Window/Tab

Source: https://docs.kado.money/kado-products

Details on integrating the Kado Widget by opening it in a new browser window or tab. This approach separates the Kado flow from your main application interface.

```APIDOC
Kado Widget - New Window/Tab:

**Description**: Integrate the Kado Widget by directing users to a Kado-hosted URL in a new browser tab or window. This is a simpler integration method that requires less client-side management.

**Usage**: 
Construct a Kado Widget URL with the necessary parameters and open it in a new tab.

**URL Parameters**: 
These parameters are appended to the base Kado Widget URL:

*   `apiKey`: Your Kado API key.
*   `amount`: The amount of fiat currency.
*   `fiatCurrency`: The fiat currency code (e.g., 'USD').
*   `cryptoCurrency`: The cryptocurrency to be purchased (e.g., 'USDC').
*   `network`: The blockchain network (e.g., 'ethereum', 'solana').
*   `userId`: A unique identifier for the user.
*   `redirectUrl`: The URL to redirect the user to after the transaction.
*   `metadata`: Optional data to pass along.

**Example (Constructing URL and Opening)**:

```javascript
const baseUrl = 'https://widget.kado.money/';
const params = new URLSearchParams({
  apiKey: 'YOUR_KADO_API_KEY',
  amount: '50',
  fiatCurrency: 'EUR',
  cryptoCurrency: 'ETH',
  network: 'avalanche',
  userId: 'user_98765',
  redirectUrl: 'https://your-app.com/kado-callback'
});

const widgetUrl = `${baseUrl}?${params.toString()}`;

window.open(widgetUrl, '_blank');
```

**Callback Handling**: 
Your `redirectUrl` should be configured to receive callbacks from Kado, allowing you to update your application's state based on the transaction outcome.
```

--------------------------------

### Kado Order Completion Event Data

Source: https://docs.kado.money/integrations/integrate-kado/the-hybrid-api/advanced

An example JSON payload representing an `order_completed` event from Kado. It details transaction information, amounts, fees, asset details, and status.

```json
{
 "id": "7c1b3e32-d1ee-44de-859f-69bbfcd90b18",
 "resource": "order",
 "type": "order_completed",
 "data": {
  "buyAmount": {
   "amount": 5,
   "unit": "USD"
  },
  "receiveAmount": {
   "amount": 3.0017109752558957,
   "unit": "USDC"
  },
  "to": "manual_input",
  "from": "debit_card",
  "fundsTransferMethod": "My card 1/2025",
  "exchangeRate": 1,
  "currencyType": "USD",
  "walletAddress": "GBKTITXSISPWPZSUZKI6WSYHLKVJDK3KBVJEHNI6ZUTLIE37TCF4YHSO",
  "totalFeeUsd": 1.99,
  "processingFee": {
   "amount": 1.99,
   "unit": "USD",
   "name": "processingFee",
   "originalAmount": 1.99,
   "promotionModifier": 1,
   "amountInUSD": 1.99,
   "originalAmountInUSD": 1.99
  },
  "bridgeFee": [
   {
    "amount": 0,
    "name": "bridgeFee",
    "unit": "USD",
    "discount": null,
    "originalAmount": 0,
    "promotionModifier": 1,
    "createdAt": "2024-05-22T06:38:55.110Z",
    "updatedAt": "2024-05-22T06:38:55.110Z"
   }
  ],
  "smartContractFees": [],
  "gasFee": {
   "amount": 0,
   "unit": "USD",
   "name": "networkFee",
   "originalAmount": 0,
   "promotionModifier": 1
  },
  "asset": "USDC_STELLAR",
  "assetSymbol": "USDC",
  "blockchain": "stellar",
  "txHash": "f2c8ee0f81be16108ae30c6aadf5b4220602120b2b1a7ade4b15ec170713e66f",
  "humanStatusField": "Settled",
  "machineStatusField": "SETTLED",
  "providerDisbursementStatus": "settled",
  "manualDepositWalletAddress": null,
  "manualDepositMemo": null,
  "createdAt": "2024-05-22T06:38:55.111Z",
  "paymentStatus": "success",
  "transferStatus": "settled",
  "transferStatusUpdatedAt": "2024-05-22T06:39:19.310Z",
  "allPossibleTxHashes": {
   "originalTxHashFromProvider": {
    "txHash": "f2c8ee0f81be16108ae30c6aadf5b4220602120b2b1a7ade4b15ec170713e66f",
    "scannerName": "Stellar.expert",
    "txLink": "https://stellar.expert/explorer/testnet/tx/f2c8ee0f81be16108ae30c6aadf5b4220602120b2b1a7ade4b15ec170713e66f"
   }
  },
  "method": "buy",
  "id": "664d92fd680697c24a844d9b",
  "pricePerUnit": 0.99943,
  "orderType": "onRamp",
  "sendFrom": "Debit Card",
  "sendTo": "GBKTITXSISPWPZSUZKI6WSYHLKVJDK3KBVJEHNI6ZUTLIE37TCF4YHSO",
  "originOfOrder": "Kado Test",
  "userRef": "64a7f203ec433fc4b5cc0be2",
  "usdAmount": 5,
  "appliedPromotion": null,
  "wireInformation": null,
  "anchorTransactionId": "",
  "txSettledAt": "2024-05-22T06:39:19.328Z",
  "quote": {
   "amount": 1,
   "price": 0.99943,
   "symbol": "USDC",
   "unit": "USD"
  },
  "paymentFailureMessage": "",
  "desiredPayAmount": "5"
 },
 "message": "The order has been processed successfully."
}
```

--------------------------------

### Get Quote API

Source: https://docs.kado.money/integrations/integrate-kado/the-hybrid-api/get-quote

Calculates the expected amount of digital assets a user will receive for a given fiat currency amount. It considers transaction type, payment method, asset, and blockchain.

```APIDOC
GET /v2/ramp/quote

Description:
The amount of digital assets (BTC, ETH, USDC, etc.) that a user can expect to receive for an input amount of fiat currency (USD, CAD, MXN, etc.).

Query Parameters:
- transactionType (String): Specifies the transaction type, e.g., "buy" or "sell".
- fiatMethod (String): The payment method for the transaction (e.g., "ach", "debit_card", "credit_card", "wire").
- partner (String): Identifier for the partner making the request (e.g., "fortress").
- amount (Number): The amount of fiat or crypto to quote. Defaults to 100.
- asset (String): The cryptocurrency name (e.g., "BTC"). Must match the `symbol` field from the GET Assets response. Defaults to "BTC".
- blockchain (String): The blockchain name (e.g., "bitcoin"). Must match the `origin` field from the GET Blockchains response. Defaults to "bitcoin".
- currency (String): The fiat currency code (e.g., "USD", "CAD"). Supported currencies include USD, CAD, GBP, EUR, MXN, COP, INR, CHF, AUD, ARS, BRL, CLP, JPY, KRW, PEN, PHP, SGD, TRY, UYU, TWD, VND, CRC, SEK, PLN, DKK, NOK, NZD.

Headers:
- X-Widget-Id (String): Your frontend integrator API key.
```

--------------------------------

### Kado Webhook: Order Pending Event

Source: https://docs.kado.money/integrations/integrate-kado/the-hybrid-api/advanced

Example JSON payload representing an order status update where the order is pending fulfillment. This payload details the initial order parameters and status.

```JSON
{
   "id": "c46ebe64-7ccc-493e-a640-6457673ed2bf",
   "resource": "order",
   "type": "order_pending",
   "data": {
       "buyAmount": {
           "amount": 5,
           "unit": "USD"
       },
       "receiveAmount": {
           "unit": "USDC"
       },
       "to": "manual_input",
       "from": "debit_card",
       "fundsTransferMethod": "My card 1/2025",
       "exchangeRate": 1,
       "currencyType": "USD",
       "walletAddress": "GBKTITXSISPWPZSUZKI6WSYHLKVJDK3KBVJEHNI6ZUTLIE37TCF4YHSO",
       "totalFeeUsd": 1.99,
       "processingFee": {
           "amount": 1.99,
           "unit": "USD",
           "name": "processingFee",
           "originalAmount": 1.99,
           "promotionModifier": 1,
           "amountInUSD": 1.99,
           "originalAmountInUSD": 1.99
       },
       "bridgeFee": [
           {
               "amount": 0,
               "name": "bridgeFee",
               "unit": "USD",
               "discount": null,
               "originalAmount": 0,
               "promotionModifier": 1,
               "createdAt": "2024-05-22T06:38:55.110Z",
               "updatedAt": "2024-05-22T06:38:55.110Z"
           }
       ],
       "smartContractFees": [],
       "gasFee": {
           "amount": 0,
           "unit": "USD",
           "name": "networkFee",
           "originalAmount": 0,
           "promotionModifier": 1
       },
       "asset": "USDC_STELLAR",
       "assetSymbol": "USDC",
       "blockchain": "stellar",
       "txHash": "",
       "humanStatusField": "Pending Fulfillment",
       "machineStatusField": "PENDING_FULFILLMENT",
       "manualDepositWalletAddress": null,
       "manualDepositMemo": null,
       "createdAt": "2024-05-22T06:38:55.111Z",
       "paymentStatus": "success",
       "transferStatus": "uninitiated",
       "allPossibleTxHashes": {},
       "method": "buy",
       "id": "664d92fd680697c24a844d9b",
       "pricePerUnit": 1,
       "orderType": "onRamp",
       "sendFrom": "Debit Card",
       "sendTo": "GBKTITXSISPWPZSUZKI6WSYHLKVJDK3KBVJEHNI6ZUTLIE37TCF4YHSO",
       "originOfOrder": "Kado Test",
       "userRef": "64a7f203ec433fc4b5cc0be2",
       "usdAmount": 5,
       "appliedPromotion": null,
       "wireInformation": null,
       "anchorTransactionId": "",
       "quote": {
           "amount": 1,
           "price": 0.99943,
           "symbol": "USDC",
           "unit": "USD"
       },
       "paymentFailureMessage": "",
       "desiredPayAmount": "5"
   },
   "message": "The order is pending."
}
```

--------------------------------

### Kado Hybrid API Endpoints

Source: https://docs.kado.money/kado-products

Documentation for the Kado Hybrid API, detailing key endpoints for managing crypto transactions. This includes retrieving quotes, initiating payments via the Kado Widget, and checking order statuses.

```APIDOC
Kado Hybrid API Reference:

This API allows for programmatic interaction with Kado's services, enabling features like obtaining quotes, processing payments, and tracking transaction status.

Endpoints:

1.  **Get Quote**
    *   **Description**: Retrieves a quote for a crypto transaction based on specified parameters.
    *   **Method**: POST (or GET, depending on implementation)
    *   **Parameters**: 
        *   `amount`: The amount of fiat currency.
        *   `fiat_currency`: The fiat currency code (e.g., USD, EUR).
        *   `crypto_currency`: The cryptocurrency code (e.g., BTC, ETH, USDC).
        *   `network`: The blockchain network for the cryptocurrency.
        *   `country`: The user's country code.
    *   **Returns**: Quote details including crypto amount, exchange rate, fees, and validity period.
    *   **Example**: 
        ```json
        {
          "amount": 100,
          "fiat_currency": "USD",
          "crypto_currency": "USDC",
          "network": "ethereum",
          "country": "US"
        }
        ```

2.  **Pay via Kado Widget**
    *   **Description**: Initiates a payment flow by redirecting the user to the Kado Widget.
    *   **Method**: POST
    *   **Parameters**: 
        *   `quote_id`: The ID obtained from the 'Get Quote' endpoint.
        *   `user_id`: Identifier for the user initiating the transaction.
        *   `redirect_url`: URL to redirect the user to after the transaction.
        *   `metadata`: Optional data to associate with the transaction.
    *   **Returns**: A URL to the Kado Widget for payment processing or a transaction ID.
    *   **Example**: 
        ```json
        {
          "quote_id": "quote_abc123",
          "user_id": "user_xyz789",
          "redirect_url": "https://your-app.com/payment-success",
          "metadata": {"order_id": "ORD-5678"}
        }
        ```

3.  **Get Order Status**
    *   **Description**: Retrieves the current status of a Kado transaction.
    *   **Method**: GET
    *   **Parameters**: 
        *   `transaction_id`: The unique identifier for the transaction.
    *   **Returns**: The status of the transaction (e.g., PENDING, COMPLETED, FAILED).
    *   **Example**: 
        ```json
        {
          "transaction_id": "txn_def456"
        }
        ```

Related Endpoints:
*   Advanced configurations might involve separate endpoints for managing payment methods or user profiles.
```

--------------------------------

### Kado Webhook: Order Processing Event

Source: https://docs.kado.money/integrations/integrate-kado/the-hybrid-api/advanced

Example JSON payload representing an order status update where the order is processing. This payload includes the calculated receive amount and updated status details.

```JSON
{
 "id": "db5e30fd-52c1-4328-82fa-340159056375",
 "resource": "order",
 "type": "order_processing",
 "data": {
   "buyAmount": {
     "amount": 5,
     "unit": "USD"
   },
   "receiveAmount": {
     "amount": 3.0017109752558957,
     "unit": "USDC"
   },
   "to": "manual_input",
   "from": "debit_card",
   "fundsTransferMethod": "My card 1/2025",
   "exchangeRate": 1,
   "currencyType": "USD",
   "walletAddress": "GBKTITXSISPWPZSUZKI6WSYHLKVJDK3KBVJEHNI6ZUTLIE37TCF4YHSO",
   "totalFeeUsd": 1.99,
   "processingFee": {
     "amount": 1.99,
     "unit": "USD",
     "name": "processingFee",
     "originalAmount": 1.99,
     "promotionModifier": 1,
     "amountInUSD": 1.99,
     "originalAmountInUSD": 1.99
   },
   "bridgeFee": [
     {
       "amount": 0,
       "name": "bridgeFee",
       "unit": "USD",
       "discount": null,
       "originalAmount": 0,
       "promotionModifier": 1,
       "createdAt": "2024-05-22T06:38:55.110Z",
       "updatedAt": "2024-05-22T06:38:55.110Z"
     }
   ],
   "smartContractFees": [],
   "gasFee": {
     "amount": 0,
     "unit": "USD",
     "name": "networkFee",
     "originalAmount": 0,
     "promotionModifier": 1
   },
   "asset": "USDC_STELLAR",
   "assetSymbol": "USDC",
   "blockchain": "stellar",
   "txHash": "",
   "humanStatusField": "Pending Fulfillment",
   "machineStatusField": "PENDING_FULFILLMENT",
   "manualDepositWalletAddress": null,
   "manualDepositMemo": null,
   "createdAt": "2024-05-22T06:38:55.111Z",
   "paymentStatus": "success",
   "transferStatus": "uninitiated",
   "allPossibleTxHashes": {},
   "method": "buy",
   "id": "664d92fd680697c24a844d9b",
   "pricePerUnit": 0.99943,
   "orderType": "onRamp",
   "sendFrom": "Debit Card",
   "sendTo": "GBKTITXSISPWPZSUZKI6WSYHLKVJDK3KBVJEHNI6ZUTLIE37TCF4YHSO",
   "originOfOrder": "Kado Test",
   "userRef": "64a7f203ec433fc4b5cc0be2",
   "usdAmount": 5,
   "appliedPromotion": null,
   "wireInformation": null,
   "anchorTransactionId": "",
   "quote": {
     "amount": 1,
     "price": 0.99943,
     "symbol": "USDC",
     "unit": "USD"
   },
   "paymentFailureMessage": "",
   "desiredPayAmount": "5"
 }
}
```

--------------------------------

### Kado Widget - New Window/Tab Integration

Source: https://docs.kado.money/integrations/integrate-kado/the-widget/new-window-tab

Integrate Kado by directing users to a new tab or window at app.kado.money, which houses the Kado Ramp widget. This method allows users to buy/sell without modifying your existing user experience directly.

```APIDOC
Integration Method: New Window/Tab

Description: Opens the Kado Ramp widget in a new browser tab or window.

URL: https://app.kado.money/

Key Feature: Seamless user experience as the Kado interface is separate from the integrating application.

Related Concepts:
- API Key: A unique public identifier used for tracking usage and attribution. Obtain your API key from your Kado point of contact.
```

--------------------------------

### Kado Hybrid API Endpoints

Source: https://docs.kado.money/kado-products/kado-on-ramp

Documentation for the Kado Hybrid API, detailing key endpoints for managing crypto transactions. This includes retrieving quotes, initiating payments via the Kado Widget, and checking order statuses.

```APIDOC
Kado Hybrid API Reference:

This API allows for programmatic interaction with Kado's services, enabling features like obtaining quotes, processing payments, and tracking transaction status.

Endpoints:

1.  **Get Quote**
    *   **Description**: Retrieves a quote for a crypto transaction based on specified parameters.
    *   **Method**: POST (or GET, depending on implementation)
    *   **Parameters**: 
        *   `amount`: The amount of fiat currency.
        *   `fiat_currency`: The fiat currency code (e.g., USD, EUR).
        *   `crypto_currency`: The cryptocurrency code (e.g., BTC, ETH, USDC).
        *   `network`: The blockchain network for the cryptocurrency.
        *   `country`: The user's country code.
    *   **Returns**: Quote details including crypto amount, exchange rate, fees, and validity period.
    *   **Example**: 
        ```json
        {
          "amount": 100,
          "fiat_currency": "USD",
          "crypto_currency": "USDC",
          "network": "ethereum",
          "country": "US"
        }
        ```

2.  **Pay via Kado Widget**
    *   **Description**: Initiates a payment flow by redirecting the user to the Kado Widget.
    *   **Method**: POST
    *   **Parameters**: 
        *   `quote_id`: The ID obtained from the 'Get Quote' endpoint.
        *   `user_id`: Identifier for the user initiating the transaction.
        *   `redirect_url`: URL to redirect the user to after the transaction.
        *   `metadata`: Optional data to associate with the transaction.
    *   **Returns**: A URL to the Kado Widget for payment processing or a transaction ID.
    *   **Example**: 
        ```json
        {
          "quote_id": "quote_abc123",
          "user_id": "user_xyz789",
          "redirect_url": "https://your-app.com/payment-success",
          "metadata": {"order_id": "ORD-5678"}
        }
        ```

3.  **Get Order Status**
    *   **Description**: Retrieves the current status of a Kado transaction.
    *   **Method**: GET
    *   **Parameters**: 
        *   `transaction_id`: The unique identifier for the transaction.
    *   **Returns**: The status of the transaction (e.g., PENDING, COMPLETED, FAILED).
    *   **Example**: 
        ```json
        {
          "transaction_id": "txn_def456"
        }
        ```

Related Endpoints:
*   Advanced configurations might involve separate endpoints for managing payment methods or user profiles.
```

--------------------------------

### Get KYC Status API Endpoint

Source: https://docs.kado.money/integrations/integrate-kado/the-hybrid-api/advanced

Retrieves the Know Your Customer (KYC) status for a specific user. Requires the user's Kado ID as a path parameter. The response includes the user's status level and whether documents have been uploaded.

```APIDOC
GET /v1/partner/kyc/:userId

Obtain the KYC status of the user.

Path Parameters:
- userId (String, required): The user's Kado ID.

Response Data Fields:
- status: String. 'L0' means initial information has not been submitted, or there was a problem with the initial validation. 'L1' means we are awaiting approval. 'L2' means the user is fully KYC'd.
- docsUploaded: Boolean. 'true'/'false' if KYC documents have not yet been uploaded or if there was an error uploading.

Example Response (200 OK):
```json
{
    "success": true,
    "message": "KYC status fetched successfully.",
    "data": {
        "status": "L2",
        "docsUploaded": true
    }
}
```
```

--------------------------------

### Kado Hybrid API Core Operations

Source: https://docs.kado.money/integrations/integrate-kado/the-hybrid-api/advanced

Core endpoints for the Kado Hybrid API to manage payment flows. Includes getting quotes, initiating payments via the Kado Widget, and checking order status. These operations facilitate seamless cryptocurrency and fiat transactions.

```APIDOC
Kado Hybrid API Endpoints:

Get Quote:
  Endpoint: POST /quote
  Description: Retrieves a quote for a transaction, including estimated rates and fees.
  Parameters:
    - amount: The amount of cryptocurrency or fiat to be transacted.
    - currency: The fiat currency code (e.g., USD, EUR).
    - network: The blockchain network for the transaction (e.g., ETH, SOL).
    - destinationAddress: The address where funds will be sent.
  Returns: Quote details including rate, fees, and validity period.

Pay via Kado Widget:
  Endpoint: POST /pay
  Description: Initiates a payment flow using the Kado Widget. This typically redirects the user to the Kado interface.
  Parameters:
    - quoteId: The ID obtained from a previous Get Quote request.
    - userReferenceId: A unique identifier for the user.
    - redirectUrl: The URL to redirect the user to after the transaction.
  Returns: A URL to launch the Kado Widget or a transaction confirmation.

Get Order Status:
  Endpoint: GET /order/{orderId}
  Description: Retrieves the current status of a previously initiated order.
  Parameters:
    - orderId: The unique identifier for the order.
  Returns: Order status information, including completion, failure, or pending state.
```

--------------------------------

### Kado Sandbox Supported Assets

Source: https://docs.kado.money/integrations/integrate-kado/sandbox

Lists the assets and their corresponding blockchains supported for sandbox disbursements and on-ramp tests in the Kado Money platform.

```APIDOC
Asset | Blockchain
------|-----------
USDC  | Avalanche Fuji C-Chain
AVAX  | Avalanche Fuji C-Chain
USDC  | Stellar Testnet
XLM   | Stellar Testnet
```
Tokens:
Raw