> ## 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 an order by external ID ## OpenAPI ````yaml /api-reference/partner_external.yaml get /api/partner/v1/ext/ramp_order/{uid} 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/{uid}: get: tags: - Onramp & Offramp Intent summary: Get an order by external ID operationId: GetRampOrderByExternalUid parameters: - in: path name: uid required: true schema: type: string responses: '200': content: application/json: schema: properties: code: type: integer data: $ref: '#/components/schemas/GetRampOrderByExternalUidResponse' displayError: description: For client display type: string message: type: string traceId: type: string required: - code - message - traceId - data type: object description: OK components: schemas: GetRampOrderByExternalUidResponse: properties: orderList: description: >- Orders matching the supplied `externalOrderUid` (typically 0 or 1; may be >1 across retries) items: $ref: '#/components/schemas/OrderSummary' type: array required: - orderList type: object OrderSummary: description: OrderSummary is one order row in list / lookup responses. properties: baseAmount: description: Order amount expressed in `baseCurrency` type: string baseCurrency: description: >- Currency the order is converted into for consolidated reporting 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 createdAt: description: When the order was created (UTC) format: date-time type: string customer: $ref: '#/components/schemas/UserSummary' description: Summary of the customer that placed the order dstAmount: description: Quoted destination amount type: string dstChain: description: >- Destination-leg chain (`fiat` for fiat legs) Supported Blockchains like ethereum, bitcoin etc. For additional options, see the [full list](/quickstart/resources/blockchain-list). externalDocs: description: Supported Blockchains like ethereum, bitcoin etc. url: https://docs.rampnow.io/quickstart/resources/blockchain-list type: string dstCurrency: description: >- Destination-leg currency 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 dstFillAmount: description: >- Actual delivered destination amount (populated on completion; use for reconciliation) type: string feeDetails: description: Fee breakdown — see FeeDetail items: $ref: '#/components/schemas/FeeDetail' type: array orderMode: $ref: '#/components/schemas/OrderMode' description: Order mode (`checkout`, `server`, `dapp`) orderType: $ref: '#/components/schemas/OrderType' description: Order direction (`buy`, `sell`, …) partnerCurrency: description: >- Currency `partnerFee` is denominated in (currently always USDC) 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 partnerFee: description: Partner fee / markup earned on this order, in `partnerCurrency` type: string paymentMode: description: >- Payment method used 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 paymentStatus: $ref: '#/components/schemas/PaymentStatus' description: Payment lifecycle status srcAmount: description: Source-leg amount type: string srcChain: description: >- Source-leg chain (`fiat` for fiat legs) Supported Blockchains like ethereum, bitcoin etc. For additional options, see the [full list](/quickstart/resources/blockchain-list). externalDocs: description: Supported Blockchains like ethereum, bitcoin etc. url: https://docs.rampnow.io/quickstart/resources/blockchain-list type: string srcCurrency: description: >- Source-leg currency 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 status: $ref: '#/components/schemas/OrderStatus' description: Order lifecycle status transactionHash: description: >- On-chain settlement transaction hash(es); populated when the destination leg is on-chain items: type: string type: array uid: description: Rampnow order UID type: string updatedAt: description: When the order was last updated (UTC) format: date-time type: string walletAddress: description: Beneficiary wallet the destination was delivered to type: string required: - createdAt - updatedAt - uid - status - paymentStatus - paymentMode - orderType - orderMode - srcChain - srcCurrency - srcAmount - dstChain - dstCurrency - dstAmount - dstFillAmount - baseCurrency - baseAmount - partnerCurrency - partnerFee - feeDetails - transactionHash - walletAddress type: object UserSummary: description: >- UserSummary is the compact customer profile embedded in list responses (orders, webhooks, etc.). Use the customer detail endpoint if you need the full record. properties: country: description: >- Country of residence (ISO 3166-1 alpha-2) Supported Countries like DE, US etc. For additional options, see the [full list](/quickstart/resources/supported-countries). externalDocs: description: Supported Countries like DE, US etc. url: https://docs.rampnow.io/quickstart/resources/supported-countries type: string createdAt: description: When the customer was created in Rampnow format: date-time type: string email: description: Customer email type: string firstName: description: Given name type: string gender: $ref: '#/components/schemas/GenderType' description: Customer gender lastName: description: Family name type: string phone: description: Customer phone (E.164) type: string status: $ref: '#/components/schemas/UserStatus' description: Customer account status uid: description: Rampnow customer UID type: string required: - createdAt - uid - status - firstName - lastName - email - phone - gender - country type: object FeeDetail: description: >- FeeDetail describes one line item in an order's fee breakdown. Fees are already reflected in the order's `srcAmount` / `dstAmount`; this struct is exposed purely so partners can render an itemised breakdown. properties: currency: description: >- Currency the `fee` amount is 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 discount: $ref: '#/components/schemas/Discount' description: Discount rule applied to this fee, if any discountValue: description: Absolute amount subtracted by `discount`, in `currency` type: string fee: description: Fee amount in `currency`, already net of any discount type: string isInclusive: description: >- IsInclusive is informational only. When true, this fee is already netted inside the order's srcAmount / dstAmount and is not billed again; when false, it was added on top of the base amount. Partners generally do not need to act on this flag — it is exposed for accurate fee-breakdown display and reconciliation. type: boolean slippage: description: >- Slippage tolerance for provider-side conversion, as a fraction (e.g. 0.01 = 1%) type: number type: description: >- Fee category (e.g. `rampnow`, `partner`, `network`, `platform`, exchange fees) type: string required: - type - fee - currency - isInclusive type: object OrderMode: enum: - regular - checkout - server type: string OrderType: enum: - unknown - buy - sell - swap - payment - refill - payout - cross_border - payroll - sendout - escrow type: string PaymentStatus: enum: - unknown - created - pending - authorized - accepted - received - rejected - expired - canceled - failed - refunded - chargebacked - review - processing_failed type: string OrderStatus: enum: - unknown - created - processing - completed - partially_failed - failed - expired - canceled - payment_failed - payment_processing - blocked type: string GenderType: enum: - unknown - male - female type: string UserStatus: enum: - unknown - active - inactive - blocked type: string Discount: properties: type: description: 'Discount kind: `percentage` or `flat`' type: string value: description: >- Discount magnitude (percent 0-100 when `type=percentage`, or a flat amount in the parent fee's currency) type: string required: - type - value type: object 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.