Skip to main content
WEBHOOK

Body

application/json

Snapshot of a crypto purchase that a buyer started through a partner's Ramp widget checkout.

type
string
required

Webhook event identifier.

Allowed value: "ramp.transaction_updated"
notification_id
string
required

Identifier of this purchase update. Retries and repeated deliveries of the same update carry the same value.

transaction_id
string
required

Kraken identifier of the purchase, shared by every update for it.

external_transaction_id
string
required

Checkout session identifier that the partner supplied when the purchase started.

status
enum<string>
required

Partner-facing purchase status. completed, failed and canceled are final. state gives the specific step.

Available options:
new,
paid,
pending,
completed,
failed,
canceled
state
enum<string>
required

Purchase step that produced this update.

  • transaction_started: the purchase started (new).
  • awaiting_payment: the purchase waits for the buyer's payment (pending).
  • deposit_held: the payment is held for review (pending).
  • deposit_credited: the payment was received (paid).
  • deposit_failed: the payment failed (canceled).
  • payment_failed: the payment failed after it was initiated (failed).
  • quote_executed: the crypto was bought (pending).
  • quote_execution_failed: the crypto could not be bought (failed).
  • travel_rule_blocked: Travel Rule checks blocked the purchase (failed).
  • withdrawal_started: the crypto is being sent to destination_address (pending).
  • withdrawal_completed: the crypto was delivered (completed).
  • withdrawal_failed: the crypto could not be delivered (failed).
Available options:
transaction_started,
awaiting_payment,
deposit_held,
deposit_credited,
deposit_failed,
payment_failed,
quote_executed,
quote_execution_failed,
travel_rule_blocked,
withdrawal_started,
withdrawal_completed,
withdrawal_failed
timestamp
string<date-time>
required

Time at which the purchase reached state.

in_asset
string
required

Currency the buyer pays with.

in_amount
string
required

Total amount the buyer pays, in in_asset.

Pattern: ^[0-9]+(\.[0-9]+)?$
out_asset
string
required

Crypto asset the buyer receives.

out_amount
string
required

Amount of out_asset for the purchase. It is the quoted amount until withdrawal_completed and the delivered amount after it.

Pattern: ^[0-9]+(\.[0-9]+)?$
expected_out_amount
string
required

Quoted amount of out_asset, including the withdrawal fee. It does not change when the purchase completes.

Pattern: ^[0-9]+(\.[0-9]+)?$
trader_id
string
required

Kraken account identifier of the buyer. It is the same for every purchase by that buyer.

trader_country
string
required

Buyer's country from Kraken's identity verification, as an ISO 3166-1 alpha-2 code.

Pattern: ^[A-Z]{2}$
network
string
required

Kraken name of the blockchain on which the crypto is delivered.

provider_asset_id
string
required

Identifier of out_asset on network in the checkout partner's naming.

provider_network
string
required

Name of network in the checkout partner's naming.

destination_address
string
required

Address to which the crypto is delivered.

in_method
enum<string>

Payment method the buyer used. Omitted when the method has no name in the checkout partner's naming.

Available options:
card,
applepay,
googlepay,
sepa,
fasterpayments
delivered_out_amount
string

Amount of out_asset delivered to destination_address, after the withdrawal fee. Included only in withdrawal_completed.

Pattern: ^[0-9]+(\.[0-9]+)?$
withdrawal_fee
string

Fee for sending the crypto to destination_address. Omitted while it is not known; 0 when no fee applies.

Pattern: ^[0-9]+(\.[0-9]+)?$
withdrawal_fee_currency
string

Currency of withdrawal_fee, included together with it.

destination_memo
string

Destination tag or memo that the checkout supplied for destination_address, for blockchains that need one. Omitted when there is none.

transaction_hash
string

On-chain transaction hash of the delivery. Included only in withdrawal_completed.

target_contract_address
string

Contract address of out_asset on network. Omitted for a blockchain's native coin.

affiliate_fee
string

Referral fee for this purchase, in affiliate_fee_currency. Omitted until the fee is recorded.

Pattern: ^[0-9]+(\.[0-9]+)?$
affiliate_fee_currency
string

Currency of affiliate_fee, included together with it.

Response

2XX

Delivery endpoint accepted the webhook.