<!-- ZenPays documentation · https://docs.zenpayz.com/docs/reference/objects/ramp-order -->

# The RampOrder object

Represents a fiat-to-crypto on-ramp order. Ramp orders track the conversion of fiat currency to cryptocurrency through a third-party on-ramp provider.

## Fields

<ParamTable
  label="Field"
  rows={[
    { name: "id", type: "string", required: true, desc: "Unique identifier for the ramp order" },
    { name: "checkoutSessionId", type: "string", required: true, desc: "Associated checkout session ID" },
    { name: "paymentIntentId", type: "string", required: true, desc: "Associated payment intent ID" },
    { name: "provider", type: "string", required: true, desc: "On-ramp provider handling the order" },
    { name: "fiatAmount", type: "number", required: true, desc: "Fiat amount being converted" },
    { name: "fiatCurrency", type: "string", required: true, desc: "Fiat currency code" },
    { name: "cryptoAmount", type: "number", required: true, desc: "Cryptocurrency amount to be received" },
    { name: "cryptoCurrency", type: "string", required: true, desc: "Cryptocurrency code" },
    { name: "kycStatus", type: "KycStatus", required: true, desc: "KYC verification status for this order [KycStatus](/docs/reference/enums/compliance)" },
    { name: "paymentMethod", type: "'card' | 'bank' | 'local'", required: true, desc: "Payment method used" },
    { name: "status", type: "'pending' | 'pending_provider' | 'pending_funds' | 'confirmed' | 'matched' | 'cleared' | 'failed'", required: true, desc: "Current status of the ramp order" },
    { name: "creditSplit", type: "{\n    /** Amount immediately available */\n    available: number\n    /** Amount pending confirmation */\n    pending: number\n  }", required: false, desc: "Split of credited amounts between available and pending" },
    { name: "reserveAmount", type: "number", required: false, desc: "Amount reserved for this order" },
    { name: "metadata", type: "Record<string, unknown>", required: false, desc: "Custom key-value data attached to the order" },
    { name: "createdAt", type: "string", required: true, desc: "ISO 8601 timestamp when the order was created" },
    { name: "updatedAt", type: "string", required: true, desc: "ISO 8601 timestamp when the order was last updated" },
  ]}
/>

## Example

```json
{
  "id": "obj_1a2b3c",
  "checkoutSessionId": "checkoutsession_1a2b3c",
  "paymentIntentId": "paymentintent_1a2b3c",
  "provider": "string",
  "fiatAmount": 5000,
  "fiatCurrency": "USD",
  "cryptoAmount": 5000,
  "cryptoCurrency": "USD",
  "kycStatus": "pending",
  "paymentMethod": "card",
  "status": "pending",
  "createdAt": "2026-01-15T09:30:00Z",
  "updatedAt": "2026-01-15T09:30:00Z"
}
```