API Reference

Create a recurring deduction

post
https://api.wingspan.app/v3/payments/recurring-deductions

Create a recurring deduction. Rules generate PrePayment commercial adjustments or PostPayment payroll deductions. Only the creator may change the rule. Duplicate externalId returns 409 ResourceConflict; create is not an upsert.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum
required
Defaults to PostPayment

PrePayment creates bilateral document adjustments. PostPayment creates payer-only payroll payout deductions.

Allowed:
deductionTemplate
object
required

Template selected by applicationType: PrePayment requires commercial reason and Gross percentage basis; PostPayment requires payroll type and taxTreatment and permits Gross, Net or DisposableEarnings.

string
string
required
length ≥ 1

Permanent relationship id, including legacy ids.

string
integer
string
required
targets
array of arrays of objects
targets
disbursement
object

Where a post-payment deduction's withheld funds are remitted.

metadata
object

Free-form key-value pairs. Max 50 keys; key length at most 40 characters; value length at most 500 characters. Where a list endpoint declares metadata filtering, it uses the QueryQL namespace via filter[metadata.{key}][eq]=value or filter[metadata.{key}][in][]=value. Endpoints that do not declare the dynamic Metadata filter do not support Metadata filtering.

string
enum
deprecated

Legacy payroll attribution. Does not change the caller perspective determined by the route.

Allowed:
Headers
string
length between 1 and 255
^[\x21-\x7e]{1,255}$

Optional idempotency token for authenticated POST and PATCH requests. Reusing the same key and body returns the cached response for 24 hours, except credential operations that explicitly document a 409 because one-time secret material is never cached; reusing it with a different body returns 409 IdempotencyKeyConflict. Use 1-255 printable ASCII characters.

string
^(?:[A-Za-z0-9_.]{22}|[a-f0-9]{24})$

Select the Account for an Account-scoped operation. A direct ServiceAccount API key MUST supply this header, and the target must be within the ServiceAccount owner's or Authorization grant's Account boundary. A Person bearer may select an Account on which it has an active Stakeholder, and an Account session may select its bound Account (or a descendant only when the session explicitly includes descendants).

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 4 months ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json

Updated 4 months ago

Did this page help you?