XRPL.to
POST /studio/drop/{slug}/batch
POST

/v1/studio/drop/{slug}/batch

Prepare a purchase settled in one Batch (pay, mint, accept)

AuthNone — works without a key

Payload

POSThttps://api.xrpl.to/v1/studio/drop/fuzzybears/batch
Path parameterValueDescription
slugA collection slug, or its identity as issuer:taxon
Body
Body fieldsas documented
{
  wallet,
  quantity (1 to 3),
  referrer?,
  claim_code?
}
curl -X POST 'https://api.xrpl.to/v1/studio/drop/fuzzybears/batch'
No public sample for this one — copy the code and fill in your own values.

Response

No public sample for this endpoint — run the code on the right with your own values to see the response.
Shapeas documented
{
  batch_id,
  batch,
  quantity,
  price_drops,
  total_drops,
  price_value,
  total_value,
  currency,
  issuer,
  phase,
  referral,
  burn,
  fee_drops,
  total_fee_drops,
  copies,
  sign_within_seconds
}

What it does

Prepare a purchase settled in one Batch (pay, mint, accept)

Notes
An edition adds the buyer's payment of its copies' fee to minter_address (total_fee_drops, tagged for the drop) and names the copies' numbers (copies); a Batch holds 8 transactions, so with a price, a sharer's cut and that fee 2 NFTs fit (batch_max on the wallet's offer). A burn-to-mint phase adds the buyer's NFTokenBurn of each NFT it gives up (burn: their NFTokenIDs), at most 2 a Batch. With referrer (the wallet that shared the link, never the buyer or the creator) on a drop that gives a share (referral_bps), the price is two payments: the sharer's cut, rounded down, and the rest to the creator (referral: { referrer, bps, cut }). A purchase settled on the ledger in one all-or-nothing Batch (XLS-56): the buyer's payment of the price to the creator (XRP in drops, or the drop's token: an Amount of its currency, issuer and value), the minter's NFTokenMint of each NFT offered to the buyer for 0, and the buyer's NFTokenAcceptOffer of each offer, which is named before it exists (SHA-512Half of 'q', the minter's AccountID and the mint's Ticket). Same checks as a mint (phase, allowlist, raffle winners, limit, funds); 1 to 3 NFTs a Batch (8 inner transactions at most). Check what it asks you to sign, co-sign it with xrpl.js signMultiBatch(wallet, batch, { batchAccount: wallet }) and send the BatchSigner to /studio/drop/{slug}/batch/{batch_id}/sign within sign_within_seconds, or its NFTs go back on sale. The ledger then applies all of it or none of it: a payment never goes without its NFTs.
No key. Payments on the ledger pay for what costs money; a hidden drop's art stays off IPFS until its reveal. Open the NFT studio →
OpenAPI
PrevGET/studio/drop/{slug}/raffleNextPOST/studio/drop/{slug}/batch/{id}/sign