Get Checkout URL

Generate a hosted Ramp checkout URL for the provided transaction configuration. The response echoes the request parameters so the Ramp partner can confirm what was submitted.

GET /b2b/ramp/checkout

Get Checkout URL

cURL

curl --request GET \
  --url https://nexus.kraken.com/b2b/ramp/checkout \
  --header 'API-Key: <api-key>' \
  --header 'API-Sign: <api-key>'

200

{
  "result": {
    "checkout_url": "<string>",
    "request_data": {
      "in_asset": "<string>",
      "in_method": "<string>",
      "in_amount": "1.23",
      "out_asset": "<string>",
      "out_method": "<string>",
      "country": "<string>",
      "network": "<string>",
      "wallet_address": "<string>",
      "memo": "<string>",
      "affiliate_fee_bps": "250",
      "subdivision": "<string>",
      "redirect_url": "<string>",
      "failure_url": "<string>",
      "external_user_id": "<string>",
      "external_partner_id": "<string>",
      "external_transaction_id": "<string>",
      "external_metadata": "<string>"
    }
  }
}

Authorizations

API-Key · string · header · required

The "API-Key" header should contain your API key.

API-Sign · string · header · required

Authenticated requests should be signed with the "API-Sign" header, using a signature generated with your private key, nonce, encoded payload, and URI path.

Headers

Payward-Version · enum<string> · default: 2025-04-15

The target version of the Payward Ramp API to use. The API version name is based on the date when the API version was released. For example, the API version 2025-04-15 was released on April 15, 2025.

Available options: 2025-04-15

Query Parameters

in_asset · string · required

Fiat asset code the user will deposit (input asset). Use GET /b2b/ramp/fiat-currencies to discover supported fiat currencies.

Maximum string length: 16

in_method · string · required

Funding method for the deposit. Use GET /b2b/ramp/payment-methods to discover supported payment methods.

in_amount · string<decimal128> · required

Amount to deposit (input amount). Decimal number represented as a string to preserve precision.

Required string length: 1 - 64

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

Example:

"1.23"

out_asset · string · required

Crypto asset the user receives (output asset). Use GET /b2b/ramp/buy/crypto to discover supported crypto assets.

Maximum string length: 16

out_method · string · required

Withdrawal method identifier. Use GET /b2b/ramp/buy/crypto to discover available withdrawal methods for each crypto asset.

network · string

Optional withdrawal network identifier. Use GET /b2b/ramp/buy/crypto to discover available networks for each crypto asset.

wallet_address · string

Optional destination wallet address for the crypto withdrawal.

memo · string

Optional memo/tag/note for the crypto withdrawal (used for certain assets).

affiliate_fee_bps · string<bps>

Affiliate fee in basis points to attribute to the partner (0-10000 where 100 = 1%). This fee is additive to the platform fee, increasing the total fee charged to the user. The affiliate_fee in webhook payloads reflects the partner's portion of the total fee for transactions originating from this checkout. Basis points represented as a string. Range 0-10000 where 100 = 1%.

Pattern: ^\d{1,5}$

Example:

"250"

country · string · required

ISO 3166-1 alpha-2 country code. Use GET /b2b/ramp/countries to discover supported values.

Maximum string length: 2

subdivision · string

ISO 3166-2 subdivision code suffix (e.g., CA for California when country is US). Use GET /b2b/ramp/countries to discover supported values.

redirect_url · string<uri>

URL to redirect the user after completing checkout successfully.

failure_url · string<uri>

URL to redirect the user after a failed checkout.

external_user_id · string

Optional partner-supplied user identifier.

Maximum string length: 64

external_partner_id · string

Optional partner-supplied partner identifier.

Maximum string length: 64

external_transaction_id · string

Optional partner transaction identifier.

Maximum string length: 64

external_metadata · string

Optional metadata to store alongside the checkout.

Maximum string length: 1000

Response

200

application/json

Response

result · object · required

Show child attributes