API reference

Payout Templates

NQD API Payout Templates reference. List payout templates; Create payout templates; Upsert payout template

OpenAPI JSON
GET /v1/payouts/templates
List payout templates
POST /v1/payouts/templates
Create payout templates
PUT /v1/payouts/templates/{templateId}
Upsert payout template
DELETE /v1/payouts/templates/{templateId}
Delete payout template
PUT /v1/payouts/templates
Upsert payout templates in a batch
GET /v1/payouts/templates/{templateId}/entries
List applied entries for a payout template
POST /v1/payouts/templates/{templateId}/entries
Add applied entry to a payout template
PATCH /v1/payouts/templates/{templateId}/entries/{entryId}
Partially update applied entry on a payout template
DELETE /v1/payouts/templates/{templateId}/entries/{entryId}
Remove applied entry from a payout template
PUT /v1/payouts/templates/{templateId}/entries/reorder
Reorder applied entries for a payout template
GET /v1/payouts/templates/{templateId}/modifiers
List applied modifiers for a payout template
POST /v1/payouts/templates/{templateId}/modifiers
Add applied modifier to a payout template
PATCH /v1/payouts/templates/{templateId}/modifiers/{modifierId}
Partially update applied modifier on a payout template
DELETE /v1/payouts/templates/{templateId}/modifiers/{modifierId}
Remove applied modifier from a payout template
PUT /v1/payouts/templates/{templateId}/modifiers/reorder
Reorder applied modifiers for a payout template

Every operation uses the same Core contract as the dashboard. Request and response fields, examples, and code samples are generated from the current API descriptor.