Substy Developers
Billing

Request creator payouts

Request payouts for the selected creator balances. This moves funds through the platform's payout process; inspect per-creator results and payout history before assuming completion.

POST/v1/agencies/{agencyId}/payout-batches

Request payouts for the selected creator balances. This moves funds through the platform's payout process; inspect per-creator results and payout history before assuming completion.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

agencyId*string
Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/agencies/string/payout-batches" \  -H "Authorization: Bearer YOUR_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "requests": [      {        "creatorId": "688ebf54-d343-4104-8711-82c2feac534a",        "withdrawalAmount": 20      }    ]  }'
{  "data": {    "results": [      {        "creatorId": "string",        "creatorName": "string",        "success": true,        "data": null,        "error": null      }    ],    "successCount": 0,    "errorCount": 0  },  "meta": {    "requestId": "string",    "operationId": "3051932a-fdd2-48fa-b330-7e7d41535969",    "status": "COMPLETED"  }}

List agency payout transactions GET

List creator payout transactions using the supported limit and marker pagination.

Get wallet payment status GET

Check a wallet payment using its transactionId. Returns the current transaction status, amount and update time. Use after checkout to confirm processing; a checkout link alone does not confirm payment.