Build a payout batch from everything approved and past its hold
Gather every approved commission whose hold has ended into a draft payout batch, one line per partner. A batch holds one currency: send currency to choose which, otherwise the first currency with something to pay is used, and partners owed in other currencies wait for the next batch. Partners below their programme payout minimum, or with a tax form still outstanding, are left for a later batch. The batch is approved and marked paid in the dashboard. Answers 409 nothing_payable when no commission is ready (the message says how much is approved but still in its hold and the first date it can be paid) and 409 nothing_eligible when nobody has reached the minimum.
https://app.softsolz.uk/api/v1/services/affiliates/affiliates/payoutsRecent Requests
Kept only in this browserHeaders
AuthorizationstringrequiredBearer token: Bearer sk_live_... (or sk_test_... for sandbox). A login token will not work here.
Idempotency-KeystringOptional idempotency key for safe retries.
Body Params
methodstringHow the partners will be paid. Defaults to manual.
currencystringThree-letter currency to pay in this batch, for example GBP.
Response
Response Body
idstringPayout batch id.referencestringHuman-readable payout reference.statusstringA new batch is a draft until it is approved and then paid.methodstringHow the partners will be paid.currencystringPayout currency.total_centsintegerTotal to pay across every partner in the batch, in minor units.commission_countintegerCommissions included in the batch.approved_atstring | nullWhen the batch was approved, or null.paid_atstring | nullWhen the batch was settled, or null.external_referencestring | nullBank or provider reference recorded when the batch was paid, or null.failure_reasonstring | nullWhy the payout failed, or null.created_atstringWhen the batch was built.Request
curl --request POST \ --url https://app.softsolz.uk/api/v1/services/affiliates/affiliates/payouts \ --header 'Authorization: Bearer sk_live_your_key' \ --header 'Content-Type: application/json' \ --data '{ "method": "manual"}'Credentials
Sent as a Bearer token and used in the samples above and in Try it. Kept only in this browser tab until you close it. Use an sk_test_ key to stay in your sandbox.
Response · 201
{ "data": { "id": "4", "reference": "PAY-20261001-K3QZ", "status": "draft", "method": "manual", "currency": "GBP", "total_cents": 37500, "commission_count": 1, "approved_at": null, "paid_at": null, "external_reference": null, "failure_reason": null, "created_at": "2026-10-01T10:30:00.000Z" }}