API Reference

Create an Earned Wage Access advance

post
https://api.wingspan.app/v3/payments/earned-wage-accesses

Payee-only. Requests an advance against one of the payee's W-2 work logs. The engagement must have Earned Wage Access enabled, the work log must be open, and amount must not exceed the work log's earnedWageAccessAmountDetails.availableAmount. The payer's Wingspan Wallet funds the advance, and the payout goes to the payee's payout destination for type, or to the payee's Wingspan Wallet when none is set up. A payout to the payee's Wingspan Wallet has no fee. When one of these conditions is not met, returns 422 with a detailCode that names the reason, for example payments.EarnedWageAccessNotEnabled, payments.EarnedWageAccessAmountExceedsAvailable or payments.EarnedWageAccessPayerFundingUnavailable. Returns 409 with payments.EarnedWageAccessRequestInProgress while another request for the same work log is in progress.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Payee-only. The payer and the available amount come from the work log; amount must not exceed the work log's earnedWageAccessAmountDetails.availableAmount.

string
required

The payee's W-2 work log to draw against.

double
required

Advance amount, with at most 2 decimal places. Must be greater than zero, and greater than the payout fee for Instant unless the payout goes to the payee's Wingspan Wallet.

string
enum
required

Payout rail for the advance. Instant takes a flat fee (feeAmount) out of the amount sent to the payee; Standard has no fee. A payout to the payee's Wingspan Wallet has no fee for either type.

Allowed:
payoutDestination
object

Sends this advance to the given destination instead of the payee's saved payout destination for type. The payee's payout settings are not changed. Omit to use the saved destination, or the payee's Wingspan Wallet when none is saved for type.

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 24 days 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 24 days ago

Did this page help you?