Onramp transaction succeeded
Triggered when the onramp.transaction.success webhook event is emitted. Your API will receive a POST request at the webhook URL you configured.
Authorizations
HMAC-SHA256 signature supplied on every webhook delivery. The signature is computed from the raw request body using the webhook secret supplied during creation of the webhook subscription.
Webhook receivers can cryptographically verify this header before processing the event to ensure the authenticity of the webhook delivery.
Refer to the verify signatures documentation to learn details about the full payload and the exact verification algorithm.
X-Hook0-Signature is deprecated and will eventually be removed. Use X-Webhook-Signature going forward. Both headers are sent with identical values and use the same verification algorithm and webhook secret.
This scheme applies to webhook delivery (outbound POSTs from CDP to your endpoint), not to inbound CDP API requests.
Headers
HMAC-SHA256 signature supplied on every webhook delivery. The signature is computed from the raw request body using the webhook secret supplied during creation of the webhook subscription.
Webhook receivers can cryptographically verify this header before processing the event to ensure the authenticity of the webhook delivery.
Refer to the verify signatures documentation to learn details about the full payload and the exact verification algorithm.
X-Hook0-Signature is deprecated and will eventually be removed. Use X-Webhook-Signature going forward. Both headers are sent with identical values and use the same verification algorithm and webhook secret.
This scheme applies to webhook delivery (outbound POSTs from CDP to your endpoint), not to inbound CDP API requests.
HMAC-SHA256 signature supplied on every webhook delivery. The signature is computed from the raw request body using the webhook secret supplied during creation of the webhook subscription.
Webhook receivers can cryptographically verify this header before processing the event to ensure the authenticity of the webhook delivery.
Refer to the verify signatures documentation to learn details about the full payload and the exact verification algorithm.
X-Hook0-Signature is deprecated and will eventually be removed. Use X-Webhook-Signature going forward. Both headers are sent with identical values and use the same verification algorithm and webhook secret.
This scheme applies to webhook delivery (outbound POSTs from CDP to your endpoint), not to inbound CDP API requests.
Body
The onramp.transaction.success webhook event payload.
- Option 1
- Option 2
Webhook payload for all onramp transaction events (created, updated, success, failed). Shape depends on transaction type — standard flow (guest checkout / authorized) uses OnrampTransactionPayload, Headless API (Apple Pay / Google Pay) uses OnrampOrderPayload. Distinguish by presence of orderId (Headless) vs transactionId (standard).
Current status of the transaction.
ONRAMP_TRANSACTION_STATUS_UNSPECIFIED, ONRAMP_TRANSACTION_STATUS_CREATED, ONRAMP_TRANSACTION_STATUS_IN_PROGRESS, ONRAMP_TRANSACTION_STATUS_SUCCESS, ONRAMP_TRANSACTION_STATUS_FAILED, ONRAMP_TRANSACTION_STATUS_AWAITING_AUTH, ONRAMP_TRANSACTION_STATUS_AWAITING_PAYMENT "ONRAMP_TRANSACTION_STATUS_IN_PROGRESS"
The Onramp-issued identifier of the end partner this transaction was scoped to via the X-Onramp-Partner-Id header on the session that initiated it. Only present for transactions created by an aggregator on behalf of a registered end partner.
"1f1c19e8-d0e9-6443-b706-92a4d033d043"
Response
Webhook received and processed successfully.