PreparedPurchase
transaction objectrequired
Transaction built by a prepare endpoint. The wallet adds only the signature(s). Read nonce back from the signed transaction, because some wallets raise it to the account's current nonce.
MultiversX bech32 address.
Possible values: Value must match regular expression ^erd1[02-9ac-hj-np-z]{58}$
erd1mf4u0jr6786wtz7s7dj6gmpyfafg8e0exh5wvye5cygvvxyyxhpsmj8q0eMultiversX bech32 address.
Possible values: Value must match regular expression ^erd1[02-9ac-hj-np-z]{58}$
erd1mf4u0jr6786wtz7s7dj6gmpyfafg8e0exh5wvye5cygvvxyyxhpsmj8q0ebase64
MultiversX bech32 address.
Possible values: Value must match regular expression ^erd1[02-9ac-hj-np-z]{58}$
erd1mf4u0jr6786wtz7s7dj6gmpyfafg8e0exh5wvye5cygvvxyyxhpsmj8q0eMultiversX bech32 address.
Possible values: Value must match regular expression ^erd1[02-9ac-hj-np-z]{58}$
erd1mf4u0jr6786wtz7s7dj6gmpyfafg8e0exh5wvye5cygvvxyyxhpsmj8q0eassignment object
Absent when gasless=false.
The ID of this assignment, as 24 lowercase hex characters.
Possible values: Value must match regular expression ^[0-9a-f]{24}$
MultiversX bech32 address.
Possible values: Value must match regular expression ^erd1[02-9ac-hj-np-z]{58}$
erd1mf4u0jr6786wtz7s7dj6gmpyfafg8e0exh5wvye5cygvvxyyxhpsmj8q0ePossible values: [0, 1, 2]
Lease token v1, base64url without padding, 192 characters.
Possible values: >= 192 characters and <= 192 characters
Unix time in milliseconds.
Possible values: >= 0
Unix time in milliseconds.
Possible values: >= 0
Advisory; present when a fresh nonce view exists.
Present only on re-sign and cancel leases.
The contract's getRegistryVersion() value this assignment was made from. Use it in the cache key when you verify the relayer on chain.
Human and LLM readable description of what will be signed.
Next steps - sign once, read the nonce back, POST /v1/relay with the lease.
True when the call is on the free list and is relayed free of charge. Show this value to the user instead of working it out yourself.
Relay Units.
Possible values: >= 0
On-chain fee debited from credits (addSenders).
Possible values: Value must match regular expression ^[0-9]+$
contractCall object
Hex-encoded arguments in order.
tokenTransfer object
Non-negative integer as decimal string (pricing document family).
Possible values: Value must match regular expression ^[0-9]+$
quote objectrequired
A price quote, with amounts as decimal strings. Stateless: quoteMac authenticates the canonical
JSON (RFC 8785) of all other members, so any API host can verify a quote it did not issue by
recomputing the MAC. No quote is stored; two prepare calls simply give two valid quotes. The MAC key
differs per environment, so a devnet quote never verifies on mainnet.
At most 12 ASCII bytes, because it becomes the ref of the contract call and data bytes are billed at full gas price. It is q_ followed by the first 10 Crockford base32 characters of an HMAC, keyed with the service's quote key, over corelayer/quote-id/v1 followed by the canonical JSON of every member except quoteId and quoteMac. Any API host can recompute it.
Possible values: Value must match regular expression ^q_[0-9A-Z]{10}$
HMAC-SHA256 with the service's quote key over corelayer/quote/v1 followed by the canonical JSON of every other member, quoteId included. Base64url without padding.
Possible values: Value must match regular expression ^[A-Za-z0-9_-]{43}$
Possible values: >= 0 and <= 12
Non-negative integer as decimal string (pricing document family).
Possible values: Value must match regular expression ^[0-9]+$
Unix time in milliseconds.
Possible values: >= 0
Non-negative integer as decimal string (pricing document family).
Possible values: Value must match regular expression ^[0-9]+$
Non-negative integer as decimal string (pricing document family).
Possible values: Value must match regular expression ^[0-9]+$
Unix time in milliseconds.
Possible values: >= 0
Unix time in milliseconds.
Possible values: >= 0
Non-negative integer as decimal string (pricing document family).
Possible values: Value must match regular expression ^[0-9]+$
Non-negative integer as decimal string (pricing document family).
Possible values: Value must match regular expression ^[0-9]+$
{
"transaction": {
"nonce": 0,
"value": "string",
"receiver": "erd1mf4u0jr6786wtz7s7dj6gmpyfafg8e0exh5wvye5cygvvxyyxhpsmj8q0e",
"sender": "erd1mf4u0jr6786wtz7s7dj6gmpyfafg8e0exh5wvye5cygvvxyyxhpsmj8q0e",
"gasPrice": 0,
"gasLimit": 0,
"data": "string",
"chainID": "string",
"version": 0,
"options": 0,
"guardian": "erd1mf4u0jr6786wtz7s7dj6gmpyfafg8e0exh5wvye5cygvvxyyxhpsmj8q0e",
"relayer": "erd1mf4u0jr6786wtz7s7dj6gmpyfafg8e0exh5wvye5cygvvxyyxhpsmj8q0e"
},
"assignment": {
"assignmentId": "string",
"relayer": "erd1mf4u0jr6786wtz7s7dj6gmpyfafg8e0exh5wvye5cygvvxyyxhpsmj8q0e",
"shard": 0,
"lease": "string",
"leaseExpiresAtMs": 0,
"serverTimeMs": 0,
"chainId": "string",
"minGasPrice": 0,
"maxGasPrice": 0,
"extraGasRelayed": 0,
"extraGasGuarded": 0,
"expectedNonce": 0,
"pinNonce": 0,
"registryVersion": 0
},
"summary": "string",
"instructions": "string",
"free": true,
"ru": 0,
"feeMicroUsdc": "string",
"contractCall": {
"endpoint": "string",
"args": [
"string"
],
"tokenTransfer": {
"token": "string",
"amount": "string"
}
},
"quote": {
"quoteId": "string",
"quoteMac": "string",
"tierId": 0,
"months": 0,
"tariff": "string",
"tariffVersion": 0,
"tariffEffectiveMs": 0,
"priceMicroUsdc": "string",
"maxPrice": "string",
"pendingTariff": "string",
"issuedAtMs": 0,
"expiresAtMs": 0
},
"payMicroUsdc": "string",
"fromCreditsMicroUsdc": "string"
}