cURL
curl --request POST \ --url 'https://share-ddn.formless.xyz/v1#payouts_query_batch' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "jsonrpc": "2.0", "id": "1", "method": "payouts", "params": { "batch_id": "89de4f6d-a8e5-4808-9c29-ebac29dec4cb" } } '
{ "jsonrpc": "2.0", "id": "<string>", "result": { "payout_batch_id": "<string>", "status": "pending", "submitter": "<string>", "timestamp": {}, "details": {}, "activity_details": {}, "successful_txns": 123, "incomplete_txns": 123, "completion_percentage": 123, "total_amount_paid_usd": 123, "message": "<string>", "failure": "<string>" } }
Query the status of a payout batch by batch ID
JWT token with Unique ID identification
2.0
payouts
Show child attributes
Batch ID to query status for
Successful response
The batch ID
Current status of the batch
pending
complete
failed
Unique ID of the user who submitted the batch
When the batch was created
Batch details object containing contract_address, network_id, amount_usd, etc.
Activity information for the payout (isrc_code, upc_code, month, year, day, etc.)
Number of successful transactions (present when status is complete)
Number of incomplete transactions (present when status is complete)
Completion percentage (present when status is complete)
Total amount paid in USD (present when status is complete)
Status message (present when status is complete or failed)
Failure reason (present when status is failed)