API reference

Payouts

NQD API Payouts reference. List payouts; Retrieve payout; Create payouts

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

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.