Search payers

post

https://api.wingspan.app/v3/payments/payers/search

Returns the first page of the caller's Activated Payers, sized by limit. query, filters and sort are not supported yet and return 422. The response has no continuation token; use the list endpoint to page through all Payers.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

filter

object

Body Params

query

string

filters

object

Structured filters. Billing-document search accepts eq, in, and != operators, for example { "status": { "in": ["Opened", "Paid"] }, "id": { "in": ["inv_1", "inv_2"] }, "metadata": { "invoiceType": { "!=": "approvedInvoicesPayment" } } }.

sort

string

Comma-separated fields; prefix with - for descending.

limit

integer

1 to 100

Defaults to 25

Headers

Idempotency-Key

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.

X-Wingspan-Account

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

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

200Search results

400Malformed request syntax

401Unauthenticated

403Forbidden

422Validation error