> ## Documentation Index > Fetch the complete documentation index at: https://docs.rampnow.io/llms.txt > Use this file to discover all available pages before exploring further. # Get order config ## OpenAPI ````yaml /api-reference/partner_external.yaml get /api/partner/v1/ext/ramp_order/config openapi: 3.1.0 info: description: API for partner_external service title: partner service version: 0.0.1 servers: - description: Base URL for Production Rampnow APIs url: https://api.rampnow.io - description: Base URL for Sandbox Rampnow APIs url: https://api.sandbox.rampnow.io security: - apiKeyAuth: [] paths: /api/partner/v1/ext/ramp_order/config: get: tags: - Configuration summary: Get order config operationId: GetRampOrderConfig responses: '200': content: application/json: schema: properties: code: type: integer data: $ref: '#/components/schemas/GetRampOrderConfigResponse' displayError: description: For client display type: string message: type: string traceId: type: string required: - code - message - traceId - data type: object description: OK components: schemas: GetRampOrderConfigResponse: description: >- GetRampOrderConfigResponse is the bulk support matrix: every configured asset, payment mode and order type in a single call, split by direction (buy = onramp, sell = offramp). Per-country currency blocking is not applied here — see the blocked-currencies endpoint for that. properties: assetConfigs: additionalProperties: $ref: '#/components/schemas/RampOrderAssetConfig' description: >- Per-asset config (payin/payout modes, limits) keyed by crypto asset code type: object kycLimits: description: Transaction / velocity limits by KYC level items: $ref: '#/components/schemas/KycLimit' type: array orderConfigMap: additionalProperties: $ref: '#/components/schemas/OrderTypeConfig' description: Per-order-type config keyed by order type type: object paymentModeConfigs: additionalProperties: $ref: '#/components/schemas/PaymentModeConfig' description: Per-payment-mode config keyed by payment mode type: object required: - assetConfigs - paymentModeConfigs - orderConfigMap - kycLimits type: object RampOrderAssetConfig: description: >- RampOrderAssetConfig is the per-asset config surfaced on the bulk ramp-order config endpoint. properties: asset: description: >- Crypto asset code Supported Crypto Currencies like ETH:ethereum, BTC:bitcoin etc. For additional options, see the [full list](/quickstart/resources/supported-assets). externalDocs: description: Supported Crypto Currencies like ETH:ethereum, BTC:bitcoin etc. url: https://docs.rampnow.io/quickstart/resources/supported-assets type: string exchangeRate: description: >- Indicative exchange rate from this asset to the base reporting currency type: string orderTypeConfigs: additionalProperties: $ref: '#/components/schemas/OrderTypeConfig' description: Per-order-type overrides for this asset type: object payinModes: description: >- Payment modes accepted when BUYING (onramp into) this asset Payment Methods & Limits like sepa, card, wire etc. For additional options, see the [full list](/quickstart/resources/payment-methods#payment-methods). items: description: >- Payment Methods & Limits like sepa, card, wire etc. For additional options, see the [full list](/quickstart/resources/payment-methods#payment-methods). externalDocs: description: Payment Methods & Limits like sepa, card, wire etc. url: >- https://docs.rampnow.io/quickstart/resources/payment-methods#payment-methods type: string type: array payoutModes: description: >- Payment modes accepted when SELLING (offramp from) this asset Payment Methods & Limits like sepa, card, wire etc. For additional options, see the [full list](/quickstart/resources/payment-methods#payment-methods). items: description: >- Payment Methods & Limits like sepa, card, wire etc. For additional options, see the [full list](/quickstart/resources/payment-methods#payment-methods). externalDocs: description: Payment Methods & Limits like sepa, card, wire etc. url: >- https://docs.rampnow.io/quickstart/resources/payment-methods#payment-methods type: string type: array status: $ref: '#/components/schemas/SettingStatus' description: Whether this asset is currently enabled for the account required: - asset - status - payinModes - payoutModes - exchangeRate - orderTypeConfigs type: object KycLimit: description: >- KycLimit is the transaction / velocity limit for a KYC level, exposed on the config API so a partner (or the docs) can render the per-level caps dynamically. properties: currency: description: >- Currency the limit amounts are denominated in Supported Crypto Currencies like EUR, USDT etc. For additional options, see the [full list](/quickstart/resources/supported-assets). externalDocs: description: Supported Crypto Currencies like EUR, USDT etc. url: https://docs.rampnow.io/quickstart/resources/supported-assets type: string kycLevel: description: KYC tier (0 = unverified; higher = more verified) type: integer perDayLimit: description: Max cumulative amount per rolling day, in `currency` type: string perOrderLimit: description: Max amount for a single order, in `currency` type: string totalOrderLimit: description: Max cumulative amount overall, in `currency` (-1 = unlimited) type: string required: - kycLevel - perOrderLimit - perDayLimit - totalOrderLimit - currency type: object OrderTypeConfig: description: >- OrderTypeConfig describes an order type's availability for the partner account. Returned as part of the bulk config endpoint. properties: maxAmount: description: >- Optional upper bound on order amount, in the account's base currency (USD by default); absent = no ceiling type: string minAmount: description: >- Optional lower bound on order amount, in the account's base currency (USD by default); absent = no floor type: string order: description: Display / preference ordering (lower first) type: integer orderSide: description: >- Internal side flag — bitmask combining source / destination legs; partners can ignore type: integer routeTypes: description: Route types supported (`regular`, `dapp`) items: $ref: '#/components/schemas/RouteType' type: array status: $ref: '#/components/schemas/SettingStatus' description: Whether this order type is active for the account required: - order - status - routeTypes - orderSide type: object PaymentModeConfig: description: >- PaymentModeConfig is a payment method's config for the partner account: activation, amount bounds, and per-direction (payin / payout) provider matrix. properties: maxAmount: description: >- Maximum order amount for this payment mode, in the account's base currency (USD by default) type: string minAmount: description: >- Minimum order amount for this payment mode, in the account's base currency (USD by default) type: string name: description: Display name of the payment mode type: string order: description: Display / preference ordering (lower first) type: integer payinConfig: $ref: '#/components/schemas/PaymentConfig' description: Config used when this mode is on the PAYIN side (customer paying) paymentMode: description: >- Payment mode identifier (`card`, `sepa`, `upi`, …) Payment Methods & Limits like sepa, card, wire etc. For additional options, see the [full list](/quickstart/resources/payment-methods#payment-methods). externalDocs: description: Payment Methods & Limits like sepa, card, wire etc. url: >- https://docs.rampnow.io/quickstart/resources/payment-methods#payment-methods type: string payoutConfig: $ref: '#/components/schemas/PaymentConfig' description: >- Config used when this mode is on the PAYOUT side (customer being paid out) status: $ref: '#/components/schemas/SettingStatus' description: Whether this payment mode is currently enabled required: - name - paymentMode - order - status - minAmount - maxAmount type: object SettingStatus: enum: - unknown - active - inactive - suspended type: string RouteType: enum: - regular - dapp type: string PaymentConfig: description: >- PaymentConfig is one direction (payin or payout) of a payment-mode config: activation state and the set of underlying providers Rampnow can route through for that direction. properties: maxAmount: description: >- Optional upper bound on order amount, in the account's base currency (USD by default); absent = no ceiling type: string minAmount: description: >- Optional lower bound on order amount, in the account's base currency (USD by default); absent = no floor type: string order: description: Preference ordering within its parent (lower first) type: integer orderTypes: description: Order types this direction supports items: $ref: '#/components/schemas/OrderType' type: array providerConfigs: additionalProperties: $ref: '#/components/schemas/PaymentProviderConfig' description: Underlying providers Rampnow may route through, keyed by provider type: object routeTypes: description: Route types supported (`regular`, `dapp`) items: $ref: '#/components/schemas/RouteType' type: array status: $ref: '#/components/schemas/SettingStatus' description: Whether this direction is currently enabled required: - order - status - routeTypes - orderTypes - providerConfigs type: object OrderType: enum: - unknown - buy - sell - swap - payment - refill - payout - cross_border - payroll - sendout - escrow type: string PaymentProviderConfig: description: >- PaymentProviderConfig is the underlying-provider slice of a payment-mode config: which processor Rampnow routes to, and its capability window. properties: assets: description: >- Crypto assets this provider supports Supported Crypto Currencies like ETH:ethereum, BTC:bitcoin etc. For additional options, see the [full list](/quickstart/resources/supported-assets). items: description: >- Supported Crypto Currencies like ETH:ethereum, BTC:bitcoin etc. For additional options, see the [full list](/quickstart/resources/supported-assets). externalDocs: description: Supported Crypto Currencies like ETH:ethereum, BTC:bitcoin etc. url: https://docs.rampnow.io/quickstart/resources/supported-assets type: string type: array maxAmount: description: >- Maximum order amount this provider accepts, in the account's base currency (USD by default) type: string minAmount: description: >- Minimum order amount this provider accepts, in the account's base currency (USD by default) type: string order: description: Provider preference ordering (lower first) type: integer orderTypes: description: Order types this provider supports items: $ref: '#/components/schemas/OrderType' type: array processingFee: $ref: '#/components/schemas/FeeConfig' description: Provider processing fee (fixed + percentage) provider: $ref: '#/components/schemas/EntityProvider' description: Underlying provider identifier status: $ref: '#/components/schemas/SettingStatus' description: Whether this provider is currently enabled tags: description: >- Provider capability tags (`provider_kyc`, `high_risk_supported`, `dapp_flow`) items: $ref: '#/components/schemas/PaymentProviderTag' type: array required: - provider - order - status - orderTypes - tags - minAmount - maxAmount - assets type: object FeeConfig: description: >- FeeConfig is a simple fixed + percentage fee schedule. Amount fields are denominated in the account's base currency (USD by default) unless the surrounding context says otherwise. properties: fixedFee: description: Flat fee component, in the account's base currency (USD by default) type: number percentageFee: description: Percentage fee component (0–100), applied to the base amount type: number required: - fixedFee - percentageFee type: object EntityProvider: enum: - unknown - rampnow - zen - januar - coinbase_exchange - coinbase_prime - okx - kraken - binance - fireblocks - bybit - volt - paysafe - crypto - customer - sumsub - dummy - find_ip - trustfull - scorechain - veriff - gate_io - mexc - now_nodes - ivy - banxa - onramp - thirdweb - wert - banxa_dapp - leopay - emerchant_pay - nuvei - bridge - chain_up - stripe - zoho - drpc - near_intents - hypermid - flashnet - link - meld - signoz minimum: 0 type: string PaymentProviderTag: enum: - provider_kyc - high_risk_supported - dapp_flow type: string securitySchemes: apiKeyAuth: description: >- Partner API key sent in the X-RAMPNOW-API-KEY header. Every request must ALSO send X-RAMPNOW-TIMESTAMP (unix seconds) and X-RAMPNOW-SIGN (hex HMAC-SHA256 of `timestamp + METHOD + requestURI + rawBody`, keyed with your API secret). See the Authentication guide. in: header name: X-RAMPNOW-API-KEY type: apiKey ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.