Create a link request

post

https://api.wingspan.app/v3/payments/link-requests

Create a link request for one side of a payer–payee record. An explicit create is a re-invite that replaces a terminal predecessor. Supply payerPayeeId, the targetType (which side of the record links), and exactly one destination (targetEmail or targetWingspanAccountId). Returns 404 when the record does not exist or the caller owns neither side, 422 unless exactly one destination is supplied, and 409 when a non-terminal request already exists for the record.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

override

boolean

Proceed after the invited Person's existing-relationship conflict warning. Does not merge relationships or bypass acceptance account-pair conflicts.

payerPayeeId

string

required

The PayerPayee record the request belongs to. Accepts canonical Wingspan ids and legacy composite relationship ids returned by V3 payer/payee read/list endpoints.

targetType

string

enum

required

Which side of the record the request links.

Allowed:

targetEmail

string

required

Email destination for an invite request.

targetWingspanAccountId

string

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

Existing Account destination hint.

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

201Link request created

400Malformed request syntax

401Unauthenticated

403Forbidden

404Resource not found

409Conflict

422Validation error

503A downstream dependency is temporarily unavailable; retryable. Body carries code: ServiceUnavailable and may include extensions.retryAfter.