To create multiple disbursements at once, use the bulk creation mutation. This mutation processes all disbursements synchronously and returns the results immediately.
Each disbursement created will trigger a disbursement.created webhook event.
Create Multiple Disbursements
Use the following mutation to create multiple disbursements:
Example variables:
Example response:
You can provide a client-generated id for each disbursement in the
createInputs. If you provide an id, it must be a valid UUID v4. This id will
become the disbursement.id, allowing you to associate results with records in
your own system for better traceability.
Response Fields
The mutation returns a DisbursementsCreateBulkResult object containing:
- disbursements: An array of
DisbursementsCreateBulkResultItem objects, each containing:
- id: The disbursement ID
- amount: The disbursement amount
- expiresAt: When the disbursement expires (nullable)
- publicKey: The public key for the disbursement (nullable)
- status: The current status of the disbursement
- url: The URL where the disbursement can be accessed (nullable)
Additional notes
- Each successful disbursement will emit a
disbursement.created webhook event.
- The mutation processes all disbursements synchronously and returns immediately with the results.
