CoinbaseOnrampOrder

orderId · string · required

Required string length: 36

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Example:

"95b11417-f18f-457f-8804-68e361f9164f"

paymentTotal · string · required

Digits with optional decimal part

Pattern: ^(\d+(\.\d+)?|\.\d+)$

Example:

"100.00"

paymentSubtotal · string · required

Digits with optional decimal part

Pattern: ^(\d+(\.\d+)?|\.\d+)$

Example:

"100.00"

paymentCurrency · string · required

Maximum string length: 50

Pattern: ^(?=\S)[\p{L}\p{N}a-zA-Z _.,:!?&%@\/+\-'|]+(?<=\S)$

Example:

"An example name"

paymentMethod · enum<string> · required

The type of payment method to be used to complete an onramp order.

Available options: GUEST_CHECKOUT_APPLE_PAY

purchaseAmount · string · required

Digits with optional decimal part

Pattern: ^(\d+(\.\d+)?|\.\d+)$

Example:

"100.00"

purchaseCurrency · string · required

Maximum string length: 50

Pattern: ^(?=\S)[\p{L}\p{N}a-zA-Z _.,:!?&%@\/+\-'|]+(?<=\S)$

Example:

"An example name"

fees · object[] · required

The fees associated with the order.

Show child attributes

exchangeRate · string · required

Digits with optional decimal part

Pattern: ^(\d+(\.\d+)?|\.\d+)$

Example:

"100.00"

destinationAddress · string · required

Valid blockchain wallet address, must be an alphanumeric string without any special characters

Maximum string length: 255

Pattern: ^[A-Za-z0-9]{18,100}$

Example:

"0xbF394748301603f18d953C90F0b087CBEC0E1834"

destinationNetwork · string · required

Maximum string length: 50

Pattern: ^(?=\S)[\p{L}\p{N}a-zA-Z _.,:!?&%@\/+\-'|]+(?<=\S)$

Example:

"An example name"

status · enum<string> · required

The status of an onramp order.

Available options: ONRAMP_ORDER_STATUS_PENDING_AUTH, ONRAMP_ORDER_STATUS_PENDING_PAYMENT, ONRAMP_ORDER_STATUS_PROCESSING, ONRAMP_ORDER_STATUS_COMPLETED, ONRAMP_ORDER_STATUS_FAILED

createdAt · string<date-time> · required

The date and time the order was created.

Example:

"2025-04-24T00:00:00.000Z"

updatedAt · string<date-time> · required

The date and time the order was last updated.

Example:

"2025-04-24T00:00:00.000Z"

txHash · string

A string with a max length of 4096 characters

Maximum string length: 4096

partnerUserRef · string

Maximum string length: 255

Pattern: ^(?=\S)[\p{L}\p{N}a-zA-Z _.,:!?&%@\/+\-'|]+(?<=\S)$

Example:

"An example name"