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

Field	Type	Description
id REQUIRED	string	Unique identifier for the ramp order
checkoutSessionId REQUIRED	string	Associated checkout session ID
paymentIntentId REQUIRED	string	Associated payment intent ID
provider REQUIRED	string	On-ramp provider handling the order
fiatAmount REQUIRED	number	Fiat amount being converted
fiatCurrency REQUIRED	string	Fiat currency code
cryptoAmount REQUIRED	number	Cryptocurrency amount to be received
cryptoCurrency REQUIRED	string	Cryptocurrency code
kycStatus REQUIRED	KycStatus	KYC verification status for this order KycStatus
paymentMethod REQUIRED	'card'| 'bank'| 'local'	Payment method used
status REQUIRED	'pending'| 'pending_provider'| 'pending_funds'| 'confirmed'| 'matched'| 'cleared'| 'failed'	Current status of the ramp order
creditSplit OPTIONAL	{ /** Amount immediately available */ available: number /** Amount pending confirmation */ pending: number }	Split of credited amounts between available and pending
reserveAmount OPTIONAL	number	Amount reserved for this order
metadata OPTIONAL	Record<string, unknown>	Custom key-value data attached to the order
createdAt REQUIRED	string	ISO 8601 timestamp when the order was created
updatedAt REQUIRED	string	ISO 8601 timestamp when the order was last updated

Example

{
  "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"
}