Onramp

This event stays documented so integrations can reconcile earlier standalone on-ramp activity. Creating new standalone on-ramps is temporarily unavailable.

Payload schema

Webhook payload

Use this schema when validating, storing, or transforming the incoming onramp webhook payload.

idstring<uuid>required

Unique identifier for this webhook delivery.

webhookIdstring<uuid>required

Identifier of the webhook configuration that produced this delivery.

eventTypestringrequired

Discriminator for the event. Always the value shown here for this event.

Allowedonramp

eventDataobjectrequired

Event-specific payload. The key matches eventType.

onrampOnrampDatarequired

onrampIdstring<uuid>required

statusOnrampStatusrequired

AllowedAwaitingFundsFundsReceivedPaymentSubmittedCompleteCancelled

receiptOnrampReceiptnullable

finalAmountstringnullable

exchangeRatestringnullable

txHashstringnullable

radomDataRadomEventData

Context for the Radom object that triggered the event.

paymentLinkPaymentLinkDatarequired

paymentLinkIdstring<uuid>required

paymentLinkOrderIdstring<uuid>nullable

inputDataInputData[]nullable

labelstringrequired

valuestringnullable

checkoutSessionCheckoutSessionDatarequired

checkoutSessionIdstring<uuid>required

metadataMetadata[]nullable

keystringrequired

valuestringrequired

invoiceInvoiceDatarequired

invoiceIdstring<uuid>required

invoicePaymentIdstring<uuid>nullable

paymentSessionPaymentSessionDatarequired

paymentSessionIdstring<uuid>required

metadataMetadata[]nullable

keystringrequired

valuestringrequired

subscriptionSubscriptionIdDatarequired

subscriptionIdstring<uuid>required

donationLinkDonationLinkDatarequired

donationLinkIdstring<uuid>required

donationLinkOrderIdstring<uuid>required