Retrieve a redirect URL

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

get/sell-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/sell-redirect
  • Auth: API key in header x-api-key

Query parameters

accountIdstring required

User’s selected account id, where the crypto he wants to sell is stored.

cryptoCurrencystring required

The crypto currency that the user wants to sell. It will contain the LedgerID value to identify the crypto.

fiatCurrencystring required

The FIAT currency that the user wants to be paid with.

cryptoAmountstring required

The crypto amount that the user wants to sell.

paymentMethodstring required

The payment method selected by the user.

modestring required

In this case always sell.

bankResidencystring required

User's Country Code (ALPHA-2).

customParametersstring

Used to include additional URL-encoded key-value parameters in the widget URL.

ledgerTransactionIdstring

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

deeplinkUrlstring

Deeplink URL to Ledger Wallet.

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 off-ramp widget, including the specified Sell parameters, to which the user will be redirected.

Example response

{
  "rampRedirectUrl": "https://widget.crypto-partner.com/?product=SELL&cryptoAmount=20&fiatCurrency=EUR&network=polygon&paymentMethod=credit_debit_card&cryptoCurrencyCode=USDC&countryCode=GB&partnerOrderId=test-order-id&partnerCustomerId=12342&theme=dark"
}

Changes

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