payload

POST https://xumm.app/api/v1/platform/payload

Submit a payload containing a sign request to the XUMM platform.

Only the txjson field is mandatory

👍

The txjson field

Compose the transaction you would like to sign in JSON format, as per XRPL transaction format specification at xrpl.org. All common fields can be part of your transaction template as well.

Therefore, any JSON value you'd use to sign and send to rippled can be sent to the xumm
API, with the (signing) account fields being added/filled being the only major difference.

Exception on the default XRPL transaction format (JSON):

If maxLedgerSequence is entered with a value < 32570, xumm will handle and replace the value. It will be considered a relative value from the current ledger index at the moment the user taps the Accept (sign) button in xumm.

📘

Return URL

The following strings will be replaced:

• {id} will be replaced with the xumm payload UUID.
• {cid} will be replaced with the optional custom payload identifier
• {txid} will be replaced with the signed transaction hash
• {txblob} will be replaced with the signed transaction HEX blob

🚧

Return URL origin logic

If both the app and web return URL values are present, and if they are identical, the XUMM platform will execute logic to see if the user is coming from a browser tab (local device or remote, e.g. desktop browser). If so, and if the origin browser window is still active, only the origin browser window will redirect, and the app won't. Else (if the browser window is not active anymore) XUMM will redirect to the return URL.

This behaviour prevents a double redirect (both on mobile and on desktop / browser window).

After sending a payload, there are three ways to get payload status updates / response. Please check the "Payload status updates"-guide for further information.

📘

Obtaining the user_token

To deliver a payload to a known user, a user_token has to be sent when POSTing the payload. Your application receives the user_token after the user decides to sign one of your payloads for the first time. The user_token will be delivered to your application in the Webhook and when fetching the Payload results from the xumm API.

Read more about the Payload workflow, or read more about the Webhook & user token in the "Payload status updates" guide.