Generates a secure binary payload for the nano in order to authorize the transaction.

  • For swap with floating trade method, we send on swap endpoint the amount. This exact value should be used to generate the swap order and the binary payload, but the amount to might be updated.
  • The final source of Truth for the user is the binary payload you generate.
post/swap/float

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/swap/float
  • Auth: none declared

Request body

amountstring required

Amount requested by the user to be swap (or amountFrom).

refundAddressstring required

User's refund address, typically the fromAddress.

payoutAddressstring required

User's payout transaction address.

refundAddressExtraIdstring

Field used for blockchains that require a memo (e.g., XRP, XLM).

payoutAddressExtraIdstring

Field used for blockchains that require a memo (e.g., XRP, XLM).

currencyFromstring required

From currency ID, using the provider's identifiers.

currencyTostring required

To currency ID, using the provider's identifiers.

payloadCurrencyFromstring required

From currency ID, using Ledger's referential. (representing currency_from in the protobuf payload)

payloadCurrencyTostring required

To currency ID, using Ledger's referential. (representing currency_to in the protobuf payload)

noncestring required

Value for the device_transaction_id_ng field in the protobuf payload, in hex format of the byte array nonce received by the user.

slippagestring

Value between 0 to 1 (0.1 => 10%). Maximum difference between the quoted amount and the final amount received, as a ratio. If exceeded, user consent is required or a refund is made.

Response

Swap ID with flattened JWS. https://www.rfc-editor.org/rfc/rfc7515#section-7.2.2

swapIdstring required

provider's id of the ongoing swap transaction. This will be used by Ledger's backend to retrieve the status of user swap transaction. A unique id must be generated each time this endpoint is called, even if called with a same quoteId : quoteId != swapId. This is a swap attempt id and several retries sharing the same quote id might be performed by a user.

payinAddressstring required

Provider's payin address.

createdAtstring required

Creation date of the swap payload in ISO-8601 format.

providerFeesstring required

Fees paid to the provider, converted to currencyTo.

referralFeesstring required

Fees paid to Ledger, as a referral fee, converted to currencyTo.

payoutNetworkFeesstring required

estimated gas fees that will be used for the payout transaction (as an output coin floating amount).

Changes

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