XRPL.to
POST /xaman/payload
POST

/v1/xaman/payload

Create a Xaman sign request — returns { uuid, next.always (open in Xaman), refs.qr_png, refs.websocket_status }. xrpl.to surfaces only (platform key); user_token is refused

Authxrpl.to platform key (our own surfaces only; 403 otherwise)

Request

POSThttps://api.xrpl.to/v1/xaman/payload
Body
Body fieldsas documented
{
  txjson: { TransactionType, ... },
  options?: {
    submit?,
    expire? (min,
    1-60),
    return_url?: { web?, app? },
    multisign?,
    pathfinding?
  },
  custom_meta?: { identifier?, instruction? }
}
curl -X POST 'https://api.xrpl.to/v1/xaman/payload'
Needs xrpl.to platform key (our own surfaces only; 403 otherwise) — copy the code and run it with your key.

Response

No public sample for this endpoint — run the code on the right with your own values and your key to see the response.

What it does

Create a Xaman sign request — returns { uuid, next.always (open in Xaman), refs.qr_png, refs.websocket_status }. xrpl.to surfaces only (platform key); user_token is refused

OpenAPI
NextGET/xaman/payload/{uuid}