Get a payer engagement

get

https://api.wingspan.app/v3/payments/payers/{payerId}/engagements/{payerEngagementId}

Retrieve one engagement on this Payer relationship, whether the payee or the payer created it. Changes on this route apply to engagements the payee created, including the linked payer's own funding authorization on them; a change to a payer-created engagement returns 403.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

payerId

string

required

^[A-Za-z0-9_.]{22,80}$

payerEngagementId

string

required

Payer engagement ID (payer-owned engagement record)

Query Params

expand

array of strings

Optional resource expansions. workDefinitions populates the WorkDefinitions attached to the underlying Engagement inline on the response. Any other value returns 422.

expand

Allowed:

Headers

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

200Payer engagement detail

401Unauthenticated

403Forbidden

404Resource not found