curl --request GET \
--url https://api.gigstack.io/v2/platform-payouts/{id} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.gigstack.io/v2/platform-payouts/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.gigstack.io/v2/platform-payouts/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)Get a platform payouts run
Returns the run: its status, plan totals and, once confirmed, the worker’s progress. Poll it after
confirming until status is completed or failed; the worker runs every minute. Then read
result, not status, to know how the run went: status: completed only means the worker has
nothing left to try, while result tells completed (everything issued) from
partially_completed (some documents failed) and failed (nothing issued).
A run of another team, or of the other mode (a live run with a test key), answers 404
run_not_found, never 403.
curl --request GET \
--url https://api.gigstack.io/v2/platform-payouts/{id} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.gigstack.io/v2/platform-payouts/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.gigstack.io/v2/platform-payouts/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)Authorizations
Authentication Method: HTTP Bearer token.
The runtime requires the literal Bearer prefix — a bare token in the
Authorization header is rejected with 401 unauthorized.
Header Format: Authorization: Bearer YOUR_API_KEY
Your API key is a JWT. Live keys operate on live data (livemode: true);
test keys operate on isolated test data (livemode: false).
Get your key at: app.gigstack.pro/settings?tab=api
Errors: credential failures are answered by the authentication layer with a raw
{ "message": … } body, not the standardized envelope — 401 for a missing, malformed or
expired token, 403 for a revoked key or a plan without API access. See the Unauthorized
and AuthForbidden responses.
Path Parameters
Run id, as returned by POST /platform-payouts.
^batchrun_[A-Za-z0-9]{6,40}$Response
The run. Once it is finished, result says how it went: completed, partially_completed
or failed.
Standardized success envelope emitted by sendSuccessResponse.
true true
A platform payouts run: the files it was planned from, the plan totals, and the stamping progress. Amounts are MXN in pesos (not cents). Timestamps are epoch milliseconds.
Show child attributes
Show child attributes
Server time in epoch milliseconds (Luxon.now().toMillis()).
1767225600000
Human-readable summary. Present only when the handler supplies one.
"Operation completed successfully"