Skip to main content
POST
/
v1#payouts_query_batch
Query Payout Batch Status
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 using the batch ID returned from the execute payout endpoint. The batch status can be pending, complete, or failed.

Authorizations

Authorization
string
header
required

JWT token with Unique ID identification

Body

application/json
jsonrpc
enum<string>
default:2.0
required
Available options:
2.0
id
string
default:1
required
method
enum<string>
default:payouts
required
Available options:
payouts
params
object
required

Response

200 - application/json

Successful response

jsonrpc
enum<string>
required
Available options:
2.0
id
string
required
result
object
required
  • Option 1
  • Option 2
I