Market

GetDexQuote returns a cross-chain route quote from the configured DEX provider

post

https://backend.pay.kiichain.iohttps://backend.pay.staging.kiichain.io

/market/v1/dex/quote

Quote-only. Does not execute the swap. Response includes the raw route data needed by the client (or a follow-up call) to actually execute it

Body

application/json

allowMultiTxbooleanOptional

senderAddressstringOptional

sender_address is the wallet address of the user initiating the swap.

Responses

200

A successful response.

application/json

affiliateAddressstringOptional

affiliate_address is the address that receives the affiliate fee for this route.

affiliateFeeBpsinteger · int32Optional

affiliate_fee_bps is the affiliate fee in basis points applied to this route (e.g. 100 = 1.00%).

approvalAddressstringOptional

approval_address is the spender (LiFi router) that needs ERC-20 allowance.

approvalAmountstringOptional

approval_amount is the minimum token amount (base units) that must be approved.

approvalTokenstringOptional

approval_token is the ERC-20 contract address that must grant allowance before the swap. Empty for native-token swaps (no approval needed).

doesSwapbooleanOptional

estimatedAmountOutstringOptional

evmTxstringOptional

evm_tx is the RLP-serialized unsigned EIP-1559 transaction (hex, 0x-prefixed). Only present when provider is "lifi". Parse with viem's parseTransaction, then pass the extracted fields to sendTransaction (nonce is a placeholder — omit it).

providerstringOptional

provider identifies which DEX routing provider fulfilled this quote ("skip" or "lifi").

routeDataobjectOptional

route_data is the full Skip route object required for swap execution. Contains the complete route including operations, required chain addresses, and all fields needed to call Skip's executeRoute without a separate route() call.

swapPriceImpactPercentstringOptional

txsRequiredinteger · int32Optional

usdAmountInstringOptional

usdAmountOutstringOptional

default

An unexpected error response. details[0] is always an AppError, see #/components/schemas/AppError

application/json

post/market/v1/dex/quote

HTTPcURLJavaScriptPython

POST /market/v1/dex/quote HTTP/1.1
Host: backend.pay.kiichain.io
Content-Type: application/json
Accept: */*
Content-Length: 149

{
  "allowMultiTx": true,
  "assetIn": {
    "amount": "text",
    "chainId": "text",
    "denom": "text"
  },
  "assetOut": {
    "chainId": "text",
    "denom": "text"
  },
  "senderAddress": "text"
}

{
  "affiliateAddress": "text",
  "affiliateFeeBps": 1,
  "approvalAddress": "text",
  "approvalAmount": "text",
  "approvalToken": "text",
  "assetIn": {
    "amount": "text",
    "chainId": "text",
    "denom": "text"
  },
  "assetOut": {
    "amount": "text",
    "chainId": "text",
    "denom": "text"
  },
  "doesSwap": true,
  "estimatedAmountOut": "text",
  "evmTx": "text",
  "provider": "text",
  "routeData": {},
  "swapPriceImpactPercent": "text",
  "txsRequired": 1,
  "usdAmountIn": "text",
  "usdAmountOut": "text"
}

GetFiatAssets returns a list of fiat assets

get

https://backend.pay.kiichain.iohttps://backend.pay.staging.kiichain.io

/market/v1/fiat-assets

Static reference list of fiat currencies (ISO codes) supported across on-ramp/off-ramp products

Required scopes

This endpoint requires the following scopes:

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

Send 'Authorization: APIKey ' to authenticate with a API key.

Responses

200

A successful response.

application/json

default

An unexpected error response. details[0] is always an AppError, see #/components/schemas/AppError

application/json

get/market/v1/fiat-assets

HTTPcURLJavaScriptPython

GET /market/v1/fiat-assets HTTP/1.1
Host: backend.pay.kiichain.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "fiatAssets": [
    {
      "code": "text",
      "name": "text",
      "symbol": "text"
    }
  ]
}

GetFiatAsset returns a fiat asset by id

get

https://backend.pay.kiichain.iohttps://backend.pay.staging.kiichain.io

/market/v1/fiat-assets/{code}

code is the 3-letter ISO fiat currency code (e.g. "USD", "BRL")

Required scopes

This endpoint requires the following scopes:

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

Send 'Authorization: APIKey ' to authenticate with a API key.

Path parameters

codestringRequired

code represents the fiat asset identifier

Responses

200

A successful response.

application/json

default

An unexpected error response. details[0] is always an AppError, see #/components/schemas/AppError

application/json

get/market/v1/fiat-assets/{code}

HTTPcURLJavaScriptPython

GET /market/v1/fiat-assets/{code} HTTP/1.1
Host: backend.pay.kiichain.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "fiatAsset": {
    "code": "text",
    "name": "text",
    "symbol": "text"
  }
}

ListInstruments lists all the instruments for the users

get

https://backend.pay.kiichain.iohttps://backend.pay.staging.kiichain.io

/market/v1/instruments

Scoped to the instruments account_id has access to, not a global list

Required scopes

This endpoint requires the following scopes:

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

Send 'Authorization: APIKey ' to authenticate with a API key.

Query parameters

accountIdstringRequired

account_id is the account identifier used to validate if the user has access to the provider

Responses

200

A successful response.

application/json

default

An unexpected error response. details[0] is always an AppError, see #/components/schemas/AppError

application/json

get/market/v1/instruments

HTTPcURLJavaScriptPython

GET /market/v1/instruments?accountId=text HTTP/1.1
Host: backend.pay.kiichain.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "instruments": [
    {
      "createdAt": "2026-08-10T23:09:15.669Z",
      "description": "text",
      "enabled": true,
      "id": "text",
      "name": "text",
      "productBase": {
        "applyAmlCheck": true,
        "chainToken": {
          "chain": {
            "chainId": "text",
            "confirmationDepth": 1,
            "contracts": {
              "ANY_ADDITIONAL_PROPERTY": {
                "address": "text",
                "version": "text"
              }
            },
            "enabled": true,
            "feeAddress": "text",
            "feeBps": 1,
            "id": 1,
            "logo": "text",
            "name": "text",
            "testnet": true,
            "type": "text"
          },
          "chainTokenEnabled": true,
          "contractAddress": "text",
          "enabledDex": true,
          "id": 1,
          "native": true,
          "token": {
            "decimals": 1,
            "enabled": true,
            "id": 1,
            "logo": "text",
            "name": "text",
            "stable": true,
            "symbol": "text"
          }
        },
        "enabled": true,
        "feeSpec": {
          "bpsValue": "text",
          "flatValue": "text",
          "type": "text"
        },
        "fiatAsset": {
          "code": "text",
          "name": "text",
          "symbol": "text"
        },
        "id": "text",
        "name": "text",
        "type": "text"
      },
      "productQuote": {
        "applyAmlCheck": true,
        "chainToken": {
          "chain": {
            "chainId": "text",
            "confirmationDepth": 1,
            "contracts": {
              "ANY_ADDITIONAL_PROPERTY": {
                "address": "text",
                "version": "text"
              }
            },
            "enabled": true,
            "feeAddress": "text",
            "feeBps": 1,
            "id": 1,
            "logo": "text",
            "name": "text",
            "testnet": true,
            "type": "text"
          },
          "chainTokenEnabled": true,
          "contractAddress": "text",
          "enabledDex": true,
          "id": 1,
          "native": true,
          "token": {
            "decimals": 1,
            "enabled": true,
            "id": 1,
            "logo": "text",
            "name": "text",
            "stable": true,
            "symbol": "text"
          }
        },
        "enabled": true,
        "feeSpec": {
          "bpsValue": "text",
          "flatValue": "text",
          "type": "text"
        },
        "fiatAsset": {
          "code": "text",
          "name": "text",
          "symbol": "text"
        },
        "id": "text",
        "name": "text",
        "type": "text"
      },
      "provider": {
        "additionalTemplate": {
          "fields": [
            {
              "name": "text",
              "optional": true,
              "options": [
                "text"
              ],
              "pattern": "text",
              "type": "text"
            }
          ],
          "title": "text"
        },
        "autoConfirm": true,
        "enabled": true,
        "id": "text",
        "identifier": "text",
        "isUserAllowed": true,
        "kycStatus": "text",
        "name": "text"
      },
      "spread": {
        "bps": {
          "askBps": "text",
          "bidBps": "text"
        }
      },
      "updatedAt": "2026-08-10T23:09:15.669Z"
    }
  ]
}

GetInstrument retrieves a single instrument by its id

get

https://backend.pay.kiichain.iohttps://backend.pay.staging.kiichain.io

/market/v1/instruments/{id}

account_id is checked to confirm the caller has access to this instrument before returning it

Required scopes

This endpoint requires the following scopes:

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

Send 'Authorization: APIKey ' to authenticate with a API key.

Path parameters

idstringRequired

id is the id of the instrument

Query parameters

accountIdstringRequired

account_id is the account identifier used to validate if the user has access to the instrument

Responses

200

A successful response.

application/json

default

An unexpected error response. details[0] is always an AppError, see #/components/schemas/AppError

application/json

get/market/v1/instruments/{id}

HTTPcURLJavaScriptPython

GET /market/v1/instruments/{id}?accountId=text HTTP/1.1
Host: backend.pay.kiichain.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "instrument": {
    "createdAt": "2026-08-10T23:09:15.669Z",
    "description": "text",
    "enabled": true,
    "id": "text",
    "name": "text",
    "productBase": {
      "applyAmlCheck": true,
      "chainToken": {
        "chain": {
          "chainId": "text",
          "confirmationDepth": 1,
          "contracts": {
            "ANY_ADDITIONAL_PROPERTY": {
              "address": "text",
              "version": "text"
            }
          },
          "enabled": true,
          "feeAddress": "text",
          "feeBps": 1,
          "id": 1,
          "logo": "text",
          "name": "text",
          "testnet": true,
          "type": "text"
        },
        "chainTokenEnabled": true,
        "contractAddress": "text",
        "enabledDex": true,
        "id": 1,
        "native": true,
        "token": {
          "decimals": 1,
          "enabled": true,
          "id": 1,
          "logo": "text",
          "name": "text",
          "stable": true,
          "symbol": "text"
        }
      },
      "enabled": true,
      "feeSpec": {
        "bpsValue": "text",
        "flatValue": "text",
        "type": "text"
      },
      "fiatAsset": {
        "code": "text",
        "name": "text",
        "symbol": "text"
      },
      "id": "text",
      "name": "text",
      "type": "text"
    },
    "productQuote": {
      "applyAmlCheck": true,
      "chainToken": {
        "chain": {
          "chainId": "text",
          "confirmationDepth": 1,
          "contracts": {
            "ANY_ADDITIONAL_PROPERTY": {
              "address": "text",
              "version": "text"
            }
          },
          "enabled": true,
          "feeAddress": "text",
          "feeBps": 1,
          "id": 1,
          "logo": "text",
          "name": "text",
          "testnet": true,
          "type": "text"
        },
        "chainTokenEnabled": true,
        "contractAddress": "text",
        "enabledDex": true,
        "id": 1,
        "native": true,
        "token": {
          "decimals": 1,
          "enabled": true,
          "id": 1,
          "logo": "text",
          "name": "text",
          "stable": true,
          "symbol": "text"
        }
      },
      "enabled": true,
      "feeSpec": {
        "bpsValue": "text",
        "flatValue": "text",
        "type": "text"
      },
      "fiatAsset": {
        "code": "text",
        "name": "text",
        "symbol": "text"
      },
      "id": "text",
      "name": "text",
      "type": "text"
    },
    "provider": {
      "additionalTemplate": {
        "fields": [
          {
            "name": "text",
            "optional": true,
            "options": [
              "text"
            ],
            "pattern": "text",
            "type": "text"
          }
        ],
        "title": "text"
      },
      "autoConfirm": true,
      "enabled": true,
      "id": "text",
      "identifier": "text",
      "isUserAllowed": true,
      "kycStatus": "text",
      "name": "text"
    },
    "spread": {
      "bps": {
        "askBps": "text",
        "bidBps": "text"
      }
    },
    "updatedAt": "2026-08-10T23:09:15.669Z"
  }
}

GetInstrumentLimits retrieves the limits from the provided instrument

get

https://backend.pay.kiichain.iohttps://backend.pay.staging.kiichain.io

/market/v1/instruments/{id}/limits

Returns the min/max tradeable amount for the given side (buy or sell)

Required scopes

This endpoint requires the following scopes:

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

Send 'Authorization: APIKey ' to authenticate with a API key.

Path parameters

idstringRequired

id is the id of the instrument

Query parameters

sidestringRequired

side is the side of the quote (buy or sell)

Responses

200

A successful response.

application/json

default

An unexpected error response. details[0] is always an AppError, see #/components/schemas/AppError

application/json

get/market/v1/instruments/{id}/limits

HTTPcURLJavaScriptPython

GET /market/v1/instruments/{id}/limits?side=text HTTP/1.1
Host: backend.pay.kiichain.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "limits": {
    "maxBaseAmount": "text",
    "maxQuoteAmount": "text",
    "minBaseAmount": "text",
    "minQuoteAmount": "text"
  }
}

GetInstrumentQuote retrieves the quote from the provided instrument

get

https://backend.pay.kiichain.iohttps://backend.pay.staging.kiichain.io

/market/v1/instruments/{id}/quote

Applies the instrument's configured spread on top of the underlying provider price for the given side (buy or sell) and amount

Required scopes

This endpoint requires the following scopes:

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

Send 'Authorization: APIKey ' to authenticate with a API key.

Path parameters

idstringRequired

id is the id of the instrument

Query parameters

amountstringRequired

amount contains the amount to transfer (must be atoms)

accountIdstringRequired

account_id is the ID of the account used to sign the quote

sidestringRequired

side is the side of the quote (buy or sell)

Responses

200

A successful response.

application/json

default

An unexpected error response. details[0] is always an AppError, see #/components/schemas/AppError

application/json

get/market/v1/instruments/{id}/quote

HTTPcURLJavaScriptPython

GET /market/v1/instruments/{id}/quote?amount=text&accountId=text&side=text HTTP/1.1
Host: backend.pay.kiichain.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "quote": {
    "quotePayload": {
      "accountId": "text",
      "assetIn": {
        "amount": "text",
        "code": "text",
        "type": "text"
      },
      "assetOut": {
        "amount": "text",
        "code": "text",
        "type": "text"
      },
      "exp": "text",
      "expirationDate": "2026-08-10T23:09:15.669Z",
      "externalId": "text",
      "id": "text",
      "meta": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "price": "text",
      "productFee": {
        "amount": "text",
        "code": "text",
        "type": "text"
      },
      "providerFee": {
        "amount": "text",
        "code": "text",
        "type": "text"
      },
      "targetId": "text",
      "targetType": "text"
    },
    "signature": "text"
  }
}

ListProducts lists all products with optional filtering

get

https://backend.pay.kiichain.iohttps://backend.pay.staging.kiichain.io

/market/v1/products

Returns every product regardless of enabled status. Filter client-side if only enabled ones are needed

Required scopes

This endpoint requires the following scopes:

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

Send 'Authorization: APIKey ' to authenticate with a API key.

Responses

200

A successful response.

application/json

default

An unexpected error response. details[0] is always an AppError, see #/components/schemas/AppError

application/json

get/market/v1/products

HTTPcURLJavaScriptPython

GET /market/v1/products HTTP/1.1
Host: backend.pay.kiichain.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "products": [
    {
      "applyAmlCheck": true,
      "chainToken": {
        "chain": {
          "chainId": "text",
          "confirmationDepth": 1,
          "contracts": {
            "ANY_ADDITIONAL_PROPERTY": {
              "address": "text",
              "version": "text"
            }
          },
          "enabled": true,
          "feeAddress": "text",
          "feeBps": 1,
          "id": 1,
          "logo": "text",
          "name": "text",
          "testnet": true,
          "type": "text"
        },
        "chainTokenEnabled": true,
        "contractAddress": "text",
        "enabledDex": true,
        "id": 1,
        "native": true,
        "token": {
          "decimals": 1,
          "enabled": true,
          "id": 1,
          "logo": "text",
          "name": "text",
          "stable": true,
          "symbol": "text"
        }
      },
      "enabled": true,
      "feeSpec": {
        "bpsValue": "text",
        "flatValue": "text",
        "type": "text"
      },
      "fiatAsset": {
        "code": "text",
        "name": "text",
        "symbol": "text"
      },
      "id": "text",
      "name": "text",
      "type": "text"
    }
  ]
}

ListProductsProviders returns the store relations products providers

get

https://backend.pay.kiichain.iohttps://backend.pay.staging.kiichain.io

/market/v1/products-providers

account_id scopes the list to relations that account is allowed to use

Required scopes

This endpoint requires the following scopes:

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

Send 'Authorization: APIKey ' to authenticate with a API key.

Query parameters

accountIdstringRequired

account_id is the ID of the account to verify if it's allowed to use the provider

Responses

200

A successful response.

application/json

default

An unexpected error response. details[0] is always an AppError, see #/components/schemas/AppError

application/json

get/market/v1/products-providers

HTTPcURLJavaScriptPython

GET /market/v1/products-providers?accountId=text HTTP/1.1
Host: backend.pay.kiichain.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "productsProviders": [
    {
      "createdAt": "2026-08-10T23:09:15.669Z",
      "enabled": true,
      "fiatAsset": {
        "code": "text",
        "name": "text",
        "symbol": "text"
      },
      "id": "text",
      "product": {
        "applyAmlCheck": true,
        "chainToken": {
          "chain": {
            "chainId": "text",
            "confirmationDepth": 1,
            "contracts": {
              "ANY_ADDITIONAL_PROPERTY": {
                "address": "text",
                "version": "text"
              }
            },
            "enabled": true,
            "feeAddress": "text",
            "feeBps": 1,
            "id": 1,
            "logo": "text",
            "name": "text",
            "testnet": true,
            "type": "text"
          },
          "chainTokenEnabled": true,
          "contractAddress": "text",
          "enabledDex": true,
          "id": 1,
          "native": true,
          "token": {
            "decimals": 1,
            "enabled": true,
            "id": 1,
            "logo": "text",
            "name": "text",
            "stable": true,
            "symbol": "text"
          }
        },
        "enabled": true,
        "feeSpec": {
          "bpsValue": "text",
          "flatValue": "text",
          "type": "text"
        },
        "fiatAsset": {
          "code": "text",
          "name": "text",
          "symbol": "text"
        },
        "id": "text",
        "name": "text",
        "type": "text"
      },
      "provider": {
        "additionalTemplate": {
          "fields": [
            {
              "name": "text",
              "optional": true,
              "options": [
                "text"
              ],
              "pattern": "text",
              "type": "text"
            }
          ],
          "title": "text"
        },
        "autoConfirm": true,
        "enabled": true,
        "id": "text",
        "identifier": "text",
        "isUserAllowed": true,
        "kycStatus": "text",
        "name": "text"
      },
      "type": "text",
      "updatedAt": "2026-08-10T23:09:15.669Z"
    }
  ]
}

GetProductsProvider returns a single products provider relation by ID

get

https://backend.pay.kiichain.iohttps://backend.pay.staging.kiichain.io

/market/v1/products-providers/{id}

account_id is checked to confirm the caller can use this relation

Required scopes

This endpoint requires the following scopes:

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

Send 'Authorization: APIKey ' to authenticate with a API key.

Path parameters

idstringRequired

id is the id of the relation products providers to retrieve

Query parameters

accountIdstringRequired

account_id is the ID of the account to verify if it's allowed to use the provider

Responses

200

A successful response.

application/json

default

An unexpected error response. details[0] is always an AppError, see #/components/schemas/AppError

application/json

get/market/v1/products-providers/{id}

HTTPcURLJavaScriptPython

GET /market/v1/products-providers/{id}?accountId=text HTTP/1.1
Host: backend.pay.kiichain.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "productsProvider": {
    "createdAt": "2026-08-10T23:09:15.669Z",
    "enabled": true,
    "fiatAsset": {
      "code": "text",
      "name": "text",
      "symbol": "text"
    },
    "id": "text",
    "product": {
      "applyAmlCheck": true,
      "chainToken": {
        "chain": {
          "chainId": "text",
          "confirmationDepth": 1,
          "contracts": {
            "ANY_ADDITIONAL_PROPERTY": {
              "address": "text",
              "version": "text"
            }
          },
          "enabled": true,
          "feeAddress": "text",
          "feeBps": 1,
          "id": 1,
          "logo": "text",
          "name": "text",
          "testnet": true,
          "type": "text"
        },
        "chainTokenEnabled": true,
        "contractAddress": "text",
        "enabledDex": true,
        "id": 1,
        "native": true,
        "token": {
          "decimals": 1,
          "enabled": true,
          "id": 1,
          "logo": "text",
          "name": "text",
          "stable": true,
          "symbol": "text"
        }
      },
      "enabled": true,
      "feeSpec": {
        "bpsValue": "text",
        "flatValue": "text",
        "type": "text"
      },
      "fiatAsset": {
        "code": "text",
        "name": "text",
        "symbol": "text"
      },
      "id": "text",
      "name": "text",
      "type": "text"
    },
    "provider": {
      "additionalTemplate": {
        "fields": [
          {
            "name": "text",
            "optional": true,
            "options": [
              "text"
            ],
            "pattern": "text",
            "type": "text"
          }
        ],
        "title": "text"
      },
      "autoConfirm": true,
      "enabled": true,
      "id": "text",
      "identifier": "text",
      "isUserAllowed": true,
      "kycStatus": "text",
      "name": "text"
    },
    "type": "text",
    "updatedAt": "2026-08-10T23:09:15.669Z"
  }
}

GetProductProviderLimits retrieves the limits for a provider based on the product, fiat and amount

get

https://backend.pay.kiichain.iohttps://backend.pay.staging.kiichain.io

/market/v1/products-providers/{id}/limits

Returns the min/max tradeable amount for on-ramp/off-ramp through this relation

Required scopes

This endpoint requires the following scopes:

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

Send 'Authorization: APIKey ' to authenticate with a API key.

Path parameters

idstringRequired

id is the id of the relation products providers

Responses

200

A successful response.

application/json

default

An unexpected error response. details[0] is always an AppError, see #/components/schemas/AppError

application/json

get/market/v1/products-providers/{id}/limits

HTTPcURLJavaScriptPython

GET /market/v1/products-providers/{id}/limits HTTP/1.1
Host: backend.pay.kiichain.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "limits": {
    "maxFiatAmount": "text",
    "maxTokenAmount": "text",
    "minFiatAmount": "text",
    "minTokenAmount": "text"
  }
}

ProcessOnRamp initializes the on-ramp process with the given information

post

https://backend.pay.kiichain.iohttps://backend.pay.staging.kiichain.io

/market/v1/products-providers/{id}/onramp

Creates the on-ramp ticket and returns a provider-specific payload Either a redirect URL (e.g. MoonPay widget) or PIX payment details (e.g. Avenia PIX), depending on the provider

Required scopes

This endpoint requires the following scopes:

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

Send 'Authorization: APIKey ' to authenticate with a API key.

Path parameters

idstringRequired

id is the id of the relation products providers

Body

application/json

accountIdstringRequired

destinationIdstringRequired

Responses

200

A successful response.

application/json

ProcessOnRampResponse is the response message for the ProcessOnRamp method. Exactly one of url_payload or deposit_payload is set, depending on the on-ramp type.

ticketIdstringRequired

default

An unexpected error response. details[0] is always an AppError, see #/components/schemas/AppError

application/json

post/market/v1/products-providers/{id}/onramp

HTTPcURLJavaScriptPython

POST /market/v1/products-providers/{id}/onramp HTTP/1.1
Host: backend.pay.kiichain.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 524

{
  "accountId": "text",
  "destinationId": "text",
  "quote": {
    "quotePayload": {
      "accountId": "text",
      "assetIn": {
        "amount": "text",
        "code": "text",
        "type": "text"
      },
      "assetOut": {
        "amount": "text",
        "code": "text",
        "type": "text"
      },
      "exp": "text",
      "expirationDate": "2026-08-10T23:09:15.669Z",
      "externalId": "text",
      "id": "text",
      "meta": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "price": "text",
      "productFee": {
        "amount": "text",
        "code": "text",
        "type": "text"
      },
      "providerFee": {
        "amount": "text",
        "code": "text",
        "type": "text"
      },
      "targetId": "text",
      "targetType": "text"
    },
    "signature": "text"
  }
}

{
  "depositPayload": {
    "depositCode": "text",
    "depositKey": "text"
  },
  "ticketId": "text",
  "urlPayload": {
    "expiresAt": "text",
    "url": "text"
  }
}

GetProductProviderQuote retrieves the quote for a product based on the provider, fiat and amount

get

https://backend.pay.kiichain.iohttps://backend.pay.staging.kiichain.io

/market/v1/products-providers/{id}/quote

Quote-only. Use ProcessOnRamp separately to act on it. amount can be crypto (atoms) or fiat (decimal) depending on the relation's direction

Required scopes

This endpoint requires the following scopes:

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

Send 'Authorization: APIKey ' to authenticate with a API key.

Path parameters

idstringRequired

id is the id of the relation products providers

Query parameters

amountstringRequired

amount contains the amount to transfer (can be crypto in atoms or fiat in decimals)

accountIdstringRequired

account_id is the ID of the account used to sign the quote

Responses

200

A successful response.

application/json

default

An unexpected error response. details[0] is always an AppError, see #/components/schemas/AppError

application/json

get/market/v1/products-providers/{id}/quote

HTTPcURLJavaScriptPython

GET /market/v1/products-providers/{id}/quote?amount=text&accountId=text HTTP/1.1
Host: backend.pay.kiichain.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "quote": {
    "quotePayload": {
      "accountId": "text",
      "assetIn": {
        "amount": "text",
        "code": "text",
        "type": "text"
      },
      "assetOut": {
        "amount": "text",
        "code": "text",
        "type": "text"
      },
      "exp": "text",
      "expirationDate": "2026-08-10T23:09:15.669Z",
      "externalId": "text",
      "id": "text",
      "meta": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "price": "text",
      "productFee": {
        "amount": "text",
        "code": "text",
        "type": "text"
      },
      "providerFee": {
        "amount": "text",
        "code": "text",
        "type": "text"
      },
      "targetId": "text",
      "targetType": "text"
    },
    "signature": "text"
  }
}

GetProduct retrieves a product by its ID

get

https://backend.pay.kiichain.iohttps://backend.pay.staging.kiichain.io

/market/v1/products/{productId}

Includes the product's chain/token, fee spec and AML check flag

Required scopes

This endpoint requires the following scopes:

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

Send 'Authorization: APIKey ' to authenticate with a API key.

Path parameters

productIdstringRequired

product_id is the ID of the product to retrieve

Responses

200

A successful response.

application/json

default

An unexpected error response. details[0] is always an AppError, see #/components/schemas/AppError

application/json

get/market/v1/products/{productId}

HTTPcURLJavaScriptPython

GET /market/v1/products/{productId} HTTP/1.1
Host: backend.pay.kiichain.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "product": {
    "applyAmlCheck": true,
    "chainToken": {
      "chain": {
        "chainId": "text",
        "confirmationDepth": 1,
        "contracts": {
          "ANY_ADDITIONAL_PROPERTY": {
            "address": "text",
            "version": "text"
          }
        },
        "enabled": true,
        "feeAddress": "text",
        "feeBps": 1,
        "id": 1,
        "logo": "text",
        "name": "text",
        "testnet": true,
        "type": "text"
      },
      "chainTokenEnabled": true,
      "contractAddress": "text",
      "enabledDex": true,
      "id": 1,
      "native": true,
      "token": {
        "decimals": 1,
        "enabled": true,
        "id": 1,
        "logo": "text",
        "name": "text",
        "stable": true,
        "symbol": "text"
      }
    },
    "enabled": true,
    "feeSpec": {
      "bpsValue": "text",
      "flatValue": "text",
      "type": "text"
    },
    "fiatAsset": {
      "code": "text",
      "name": "text",
      "symbol": "text"
    },
    "id": "text",
    "name": "text",
    "type": "text"
  }
}

ListProviders returns all registered providers

get

https://backend.pay.kiichain.iohttps://backend.pay.staging.kiichain.io

/market/v1/providers

DB-registered providers only. Use ListRegistryProviders to see providers implemented in code but not yet registered

Required scopes

This endpoint requires the following scopes:

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

Send 'Authorization: APIKey ' to authenticate with a API key.

Query parameters

accountIdstringRequired

account_id is the ID of the account to verify if it's allowed to use the provider

Responses

200

A successful response.

application/json

default

An unexpected error response. details[0] is always an AppError, see #/components/schemas/AppError

application/json

get/market/v1/providers

HTTPcURLJavaScriptPython

GET /market/v1/providers?accountId=text HTTP/1.1
Host: backend.pay.kiichain.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "providers": [
    {
      "additionalTemplate": {
        "fields": [
          {
            "name": "text",
            "optional": true,
            "options": [
              "text"
            ],
            "pattern": "text",
            "type": "text"
          }
        ],
        "title": "text"
      },
      "autoConfirm": true,
      "enabled": true,
      "id": "text",
      "identifier": "text",
      "isUserAllowed": true,
      "kycStatus": "text",
      "name": "text"
    }
  ]
}

GetProvider returns the provided information from the Id

get

https://backend.pay.kiichain.iohttps://backend.pay.staging.kiichain.io

/market/v1/providers/{providerId}

account_id is used to resolve is_user_allowed and kyc_status for that specific account on this provider

Required scopes

This endpoint requires the following scopes:

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

Send 'Authorization: APIKey ' to authenticate with a API key.

Path parameters

providerIdstringRequired

provider_id is the ID of the provider to retrieve

Query parameters

accountIdstringRequired

account_id is the ID of the account associated to the provider

Responses

200

A successful response.

application/json

default

An unexpected error response. details[0] is always an AppError, see #/components/schemas/AppError

application/json

get/market/v1/providers/{providerId}

HTTPcURLJavaScriptPython

GET /market/v1/providers/{providerId}?accountId=text HTTP/1.1
Host: backend.pay.kiichain.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "provider": {
    "additionalTemplate": {
      "fields": [
        {
          "name": "text",
          "optional": true,
          "options": [
            "text"
          ],
          "pattern": "text",
          "type": "text"
        }
      ],
      "title": "text"
    },
    "autoConfirm": true,
    "enabled": true,
    "id": "text",
    "identifier": "text",
    "isUserAllowed": true,
    "kycStatus": "text",
    "name": "text"
  }
}

GetProviderKyc returns the KYC data for the user on the given provider

post

https://backend.pay.kiichain.iohttps://backend.pay.staging.kiichain.io

/market/v1/providers/{providerId}/kyc/{accountId}

Always fetches a fresh status from the provider and persists a history record. It doesn't just read the last known status from the DB

Required scopes

This endpoint requires the following scopes:

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

Send 'Authorization: APIKey ' to authenticate with a API key.

Path parameters

providerIdstringRequired

provider_id is the DB ID of the provider

accountIdstringRequired

account_id is the ID of the account to retrieve KYC data for

Body

application/json

object · GetProviderKycRequest is the request message for the GetProviderKyc methodOptional

Responses

200

A successful response.

application/json

basicCompanyDataUrlstringOptional

basic_company_data_url is the second URL for KYB (company) accounts only. Present when the sub-account is a company; absent for individual KYC.

metadataobject · metadata contains provider-specific KYC metadataOptional

nextUrlstringOptional

next_url is the redirect URL to continue the KYC process (when applicable). For KYB (company) accounts this is the authorized representative URL.

providerAccountIdstringOptional

reasonstringOptional

statusstringRequired

status is the current KYC status for the account on this provider. Possible values: "pending", "processing", "verified", "rejected".

default

An unexpected error response. details[0] is always an AppError, see #/components/schemas/AppError

application/json

post/market/v1/providers/{providerId}/kyc/{accountId}

HTTPcURLJavaScriptPython

POST /market/v1/providers/{providerId}/kyc/{accountId} HTTP/1.1
Host: backend.pay.kiichain.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

{
  "basicCompanyDataUrl": "text",
  "history": [
    {
      "createdAt": "2026-08-10T23:09:15.669Z",
      "reason": "text",
      "status": "text"
    }
  ],
  "metadata": {},
  "nextUrl": "text",
  "providerAccountId": "text",
  "reason": "text",
  "status": "text"
}

StartProviderKyc initiates the KYC process for the user on the given provider

post

https://backend.pay.kiichain.iohttps://backend.pay.staging.kiichain.io

/market/v1/providers/{providerId}/kyc/{accountId}/start

Creates the provider sub-account and returns the KYC redirect URL. Must be called explicitly by the user. GetProviderKyc no longer auto-triggers this

Required scopes

This endpoint requires the following scopes:

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

Send 'Authorization: APIKey ' to authenticate with a API key.

Path parameters

providerIdstringRequired

provider_id is the DB ID of the provider

accountIdstringRequired

account_id is the ID of the account to initiate KYC for

Body

application/json

object · StartProviderKycRequest is the request message for the StartProviderKyc methodOptional

Responses

200

A successful response.

application/json

basicCompanyDataUrlstringOptional

basic_company_data_url is the second URL for KYB (company) accounts only. Present when the sub-account is a company; absent for individual KYC.

nextUrlstringOptional

next_url is the redirect URL the user must follow to complete the KYC process. For KYB (company) accounts this is the authorized representative URL.

statusstringRequired

status is the current KYC status after initiating the flow. Possible values: "pending", "processing", "verified", "rejected".

default

An unexpected error response. details[0] is always an AppError, see #/components/schemas/AppError

application/json

post/market/v1/providers/{providerId}/kyc/{accountId}/start

HTTPcURLJavaScriptPython

POST /market/v1/providers/{providerId}/kyc/{accountId}/start HTTP/1.1
Host: backend.pay.kiichain.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

{
  "basicCompanyDataUrl": "text",
  "nextUrl": "text",
  "status": "text"
}

ListTradeInstruments lists the trade instruments available to the account

get

https://backend.pay.kiichain.iohttps://backend.pay.staging.kiichain.io

/market/v1/trade-instruments

Each instrument carries its hydrated products so the caller can render the pair picker that GetTradeInstrumentQuote expects

Required scopes

This endpoint requires the following scopes:

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

Send 'Authorization: APIKey ' to authenticate with a API key.

Query parameters

accountIdstringRequired

account_id is the identifier of the account listing the instruments

Responses

200

A successful response.

application/json

default

An unexpected error response. details[0] is always an AppError, see #/components/schemas/AppError

application/json

get/market/v1/trade-instruments

HTTPcURLJavaScriptPython

GET /market/v1/trade-instruments?accountId=text HTTP/1.1
Host: backend.pay.kiichain.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "tradeInstruments": [
    {
      "createdAt": "2026-08-10T23:09:15.669Z",
      "description": "text",
      "enabled": true,
      "id": "text",
      "name": "text",
      "products": [
        {
          "product": {
            "applyAmlCheck": true,
            "chainToken": {
              "chain": {
                "chainId": "text",
                "confirmationDepth": 1,
                "contracts": {
                  "ANY_ADDITIONAL_PROPERTY": {
                    "address": "text",
                    "version": "text"
                  }
                },
                "enabled": true,
                "feeAddress": "text",
                "feeBps": 1,
                "id": 1,
                "logo": "text",
                "name": "text",
                "testnet": true,
                "type": "text"
              },
              "chainTokenEnabled": true,
              "contractAddress": "text",
              "enabledDex": true,
              "id": 1,
              "native": true,
              "token": {
                "decimals": 1,
                "enabled": true,
                "id": 1,
                "logo": "text",
                "name": "text",
                "stable": true,
                "symbol": "text"
              }
            },
            "enabled": true,
            "feeSpec": {
              "bpsValue": "text",
              "flatValue": "text",
              "type": "text"
            },
            "fiatAsset": {
              "code": "text",
              "name": "text",
              "symbol": "text"
            },
            "id": "text",
            "name": "text",
            "type": "text"
          },
          "role": "text"
        }
      ],
      "provider": {
        "additionalTemplate": {
          "fields": [
            {
              "name": "text",
              "optional": true,
              "options": [
                "text"
              ],
              "pattern": "text",
              "type": "text"
            }
          ],
          "title": "text"
        },
        "autoConfirm": true,
        "enabled": true,
        "id": "text",
        "identifier": "text",
        "isUserAllowed": true,
        "kycStatus": "text",
        "name": "text"
      },
      "spread": {
        "bps": {
          "askBps": "text",
          "bidBps": "text"
        }
      },
      "updatedAt": "2026-08-10T23:09:15.669Z"
    }
  ]
}

GetTradeInstrumentQuote returns a quote for a pair inside a trade instrument

get

https://backend.pay.kiichain.iohttps://backend.pay.staging.kiichain.io

/market/v1/trade-instruments/{id}/quote

Both legs are named explicitly. Exactly one of them must be the instrument's quote product, which is what determines the side of the trade

Required scopes

This endpoint requires the following scopes:

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

Send 'Authorization: APIKey ' to authenticate with a API key.

Path parameters

idstringRequired

id contains the identifier of the trade instrument

Query parameters

accountIdstringRequired

account_id is the identifier of the account requesting the quote

productInIdstringRequired

product_in_id is the product the user gives up

productOutIdstringRequired

product_out_id is the product the user receives

amountstringRequired

amount contains the amount of product_in in atoms

Responses

200

A successful response.

application/json

default

An unexpected error response. details[0] is always an AppError, see #/components/schemas/AppError

application/json

get/market/v1/trade-instruments/{id}/quote

HTTPcURLJavaScriptPython

GET /market/v1/trade-instruments/{id}/quote?accountId=text&productInId=text&productOutId=text&amount=text HTTP/1.1
Host: backend.pay.kiichain.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "quote": {
    "quotePayload": {
      "accountId": "text",
      "assetIn": {
        "amount": "text",
        "code": "text",
        "type": "text"
      },
      "assetOut": {
        "amount": "text",
        "code": "text",
        "type": "text"
      },
      "exp": "text",
      "expirationDate": "2026-08-10T23:09:15.669Z",
      "externalId": "text",
      "id": "text",
      "meta": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "price": "text",
      "productFee": {
        "amount": "text",
        "code": "text",
        "type": "text"
      },
      "providerFee": {
        "amount": "text",
        "code": "text",
        "type": "text"
      },
      "targetId": "text",
      "targetType": "text"
    },
    "signature": "text"
  }
}