Submitting a batch of transfers (idempotently)

Submitting a batch of transfers (idempotently)

cURL

curl --request PUT \
  --url https://waitlist-api.prod.blast.io/v1/contracts/{contractAddress}/batches/{batchId} \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "pointType": "<string>",
  "transfers": [
    {
      "toAddress": "<string>",
      "points": "<string>"
    }
  ],
  "secondsToFinalize": 123
}
'

200

{
  "success": true,
  "batchId": "<string>"
}

The points API accepts transfers in batches. For efficiency, try to completely fill your batches. This API expects you to provide a client generated batchId to uniquely identify this batch of transfers.

Authentication

Authorization · string · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Params

contractAddress · string · required

Contract address distributing the points.

batchId · string · required

batchId is a client provided string (max length 64). If a request fails, the request can be retried with the same batchId. If the batchId already exists, we return a 409.

We recommend using a UUID as batchId.

Request

pointType · string · required

Point type to distribute, can be PHASE2_POINTS or PHASE2_GOLD

transfers · Transfer[] · required

List of transfers to submitted as part of the batch.

Show child attributes

toAddress · string · required

Points receiver

points · string · required

Amount of points to distribute to toAddress.

Must be >= MINIMUM_{pointType}_TRANSFER_SIZE and must have decimal places <= MAX_TRANSFER_DECIMALS

secondsToFinalize · number

Number of seconds to wait before finalizing this batch, must be between MINIMUM_FINALIZE_SECONDS and DEFAULT_FINALIZE_SECONDS.

If not present uses DEFAULT_FINALIZE_SECONDS

Response

success · boolean

Response status

batchId · string

Transfer batch batchId which was provided as a param.