Fetching a single batch

You can inspect the status of a batch of transfers using this detailed API, which returns all of the transfers in the batch.

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 which submitted the batch.

batchId

string

required

Transfer batch batchId to fetch the status for.

Response

success

boolean

Response status.

batch

BatchWithTransfers

Batch details along with transfer details.

Show child attributes

id

string

Batch ID.

contractAddress

string

Contract address that requested the transfer of points.

pointType

PointType

Point type requested to be transferred. Can be PHASE2_POINTS or PHASE2_GOLD.

createdAt

string

Timestamp when the batch was created.

finalizeAt

string

Timestamp when the batch was finalized.

updatedAt

string

Timestamp when the batch was updated. If not updated then it will null.

status

Status

Status of the batch. Can be PENDING or CANCELLED or FINALIZING or FINALIZED.

points

string

Total points being transferred in the batch.

transferCount

number

Number of transfer that are part of the batch.

transfers

Transfer[]

Transfer that are part of the batch.

Show child attributes

toAddress

string

Points receiver

points

string

Amount of points distributed to toAddress in the transfer.

Will be >= MINIMUM_{pointType}_TRANSFER_SIZE and will have decimal places <= MAX_TRANSFER_DECIMALS