Onramp

Offramp transaction updated

Triggered when the offramp.transaction.updated webhook event is emitted. Your API will receive a POST request at the webhook URL you configured.

postWebhookofframpTransactionUpdated

Payload

eventTypestring required

The webhook event type.

transactionIdstring required

Unique transaction identifier.

status'TRANSACTION_STATUS_UNSPECIFIED' | 'TRANSACTION_STATUS_CREATED' | 'TRANSACTION_STATUS_EXPIRED' | 'TRANSACTION_STATUS_STARTED' | 'TRANSACTION_STATUS_SUCCESS' | 'TRANSACTION_STATUS_FAILED' required

Current status of the offramp transaction.

assetstring

The crypto currency being sold (e.g., "ETH", "USDC").

networkstring

The blockchain network (e.g., "ethereum", "base").

fromAddressstring

The address crypto was received from.

toAddressstring

The address crypto was sent to (Coinbase deposit address).

createdAtstring date-time

When the transaction was created.

updatedAtstring date-time

When the transaction was last updated.

txHashstring

The onchain transaction hash of the crypto send.

redirectUrlstring

The URL the user was redirected to after confirming the offramp.

paymentMethod'UNSPECIFIED' | 'CARD' | 'ACH_BANK_ACCOUNT' | 'APPLE_PAY' | 'FIAT_WALLET' | 'CRYPTO_ACCOUNT' | 'GUEST_CHECKOUT_CARD' | 'PAYPAL' | 'RTP' | 'GUEST_CHECKOUT_APPLE_PAY' | 'GUEST_CHECKOUT_GOOGLE_PAY'

The payment method type used for cashout.

partnerUserRefstring

The partnerUserId provided when initializing the offramp session.

Example payload

{
  "eventType": "offramp.transaction.updated",
  "transactionId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "status": "TRANSACTION_STATUS_STARTED",
  "asset": "ETH",
  "network": "ethereum",
  "sellAmount": {
    "currency": "USD",
    "value": "5.00"
  },
  "total": {
    "currency": "USD",
    "value": "5.00"
  },
  "minimumTotal": {
    "currency": "USD",
    "value": "5.00"
  },
  "subtotal": {
    "currency": "USD",
    "value": "5.00"
  },
  "coinbaseFee": {
    "currency": "USD",
    "value": "5.00"
  },
  "exchangeRate": {
    "currency": "USD",
    "value": "5.00"
  },
  "unitPrice": {
    "currency": "USD",
    "value": "5.00"
  },
  "fromAddress": "0x742d35Cc6634C0532925a3b844Bc454e4438f44e",
  "toAddress": "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913",
  "createdAt": "2025-09-02T02:34:13Z",
  "updatedAt": "2025-09-02T02:40:00Z",
  "txHash": "0xabcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890",
  "redirectUrl": "https://partner.com/offramp/complete",
  "paymentMethod": "ACH_BANK_ACCOUNT",
  "partnerUserRef": "example_user_ref"
}

Response

Webhook received and processed successfully.

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.