Retrieve a redirect URL

Returns the URL of the on-ramp widget, including the specified buy parameters, to which the user will be redirected.

get/buy-redirect

Request

  • Base URL: https://developers.ledger.com (the document declares no server; this is the origin it was published from)
  • URL: https://developers.ledger.com/buy-redirect
  • Auth: API key in header X-API-KEY

Query parameters

fromstring required

Fiat currency at the ISO-4217 standard.

tostring required

Crypto currency ID using the LedgerId format.

payment-methodstring required

Payment method, valid values: card, googlepay, applepay, paypal, cryptocom, sepa, ach, instantach, fasterpayments, easybank, bank, cashapp, venmo, pix, mobikwik, easypay, astropay, upibanktransfer, sofort, bancontact, giropay, eps, ideal, other, revolut, p2p, interac, payid, spei, imps, gcash, ovo, shopeepay, grabpay, linkaja, maya, pse, dana, qris

amountinteger required

Fiat amount to buy.

countrystring required

Country of the user at the Alpha-2 standard (ISO3166).

deststring required

Destination address of the buy.

ledgerTransactionIdstring required

Ledger Wallet transaction ID. Used by Ledger to track transactions and their completion statuses.

deeplinkUrlstring

Deeplink URL to Ledger Wallet.

accountIdstring

The Ledger Wallet ID of the account the user selected to receive the crypto.

languagestring

The language chosen by the user in Ledger Wallet. Valid values: ar, de, en, es, fr, ja, ko, pt, ru, th, tr, zh.

themestring

The theme chosen by the user in Ledger Wallet. Valid values: light, dark.

Response

OK

rampRedirectUrlstring uri required

The URL of the on-ramp widget, including the specified Buy parameters, to which the user will be redirected.

Example response

{
  "rampRedirectUrl": "https://widget.crypto-partner.com?fiatCurrency=GBP&amount=12345&cryptoCurrency=ETH&walletAddress=0x96e2B7Bf479f84e7A0a94f0620290B7D3E08f5EF&countryCode=GB&partnerId=a01798bc-7f0b-14ed-a12b-0e3fac1209ad&externalOrderId=2d1769bc-7aab-92ed-a10b-0232ac12090d&disableFiatAmount=true&disableCryptoCurrency=true&disableWalletAddress=true&disableCountryCode=true&skipWalletAddress=true&partnerRedirectUrl=https%3A%2F%2Fcrypto.partner.com%2Forder%3ForderId%3D2d1769bc-7aab-92ed-a10b-0232ac12090d&theme=dark"
}

Changes

No recorded changes to this operation across all 1 revision of this API.