Get Widget Payout Details

GET
/v1/widget/payout-details

The cash payouts of the participant that the Widget token names, in the Project of the token's Program. The token needs the widget:read scope. Only USD cash Rewards that RefRef pays out count: a participant without one is not eligible, and so is a participant that the Project does not have yet; the route creates no participant. canSave tells whether the token can save the details (widget:payout).

Authorization

WidgetJWT
AuthorizationBearer <token>

HS256 with typ refref-widget+jwt, aud refref-widget, programId the referral Program of the Widget, sub the external ID of the participant, participantKind its kind (individual or group), optional email the contact email of the participant, mandatory iat and exp, lifetime at most 900 seconds. scope lists one or more Widget scopes separated by one space; widget:read gives Widget init, the referral and Reward reads, and the payout details read, and widget:payout gives the payout details save, for example "widget:read widget:payout". A token without the scope of an operation gets 403. Signed by the backend of the Program's Project with the Project secret. A Widget request names no Project and no Program; the token's Program gives both.

In: header

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/v1/widget/payout-details"
{  "eligible": true,  "contactEmail": "string",  "recipient": {    "status": "active",    "country": "string",    "method": {      "type": "paypal",      "maskedDestination": "string"    },    "termsVersion": "string",    "termsAcceptedAt": "string",    "taxStatus": "not_required"  },  "offeredMethods": [    "paypal"  ],  "termsVersion": "string",  "taxFormRequired": true,  "canSave": true,  "amounts": {    "currency": "string",    "heldMinor": "string",    "payableMinor": "string",    "inProgressMinor": "string",    "paidMinor": "string",    "correctionsMinor": "string"  }}

Get Root Health GET

Previous Page

Identify Handle POST

Says to whom the handle of a browser belongs. The body has one of three forms. `{ handle, participant }`: this browser belongs to the participant. Send it once, at the identity moment (the creation of the account or the group), when the fact that counts comes later, for example a signup at email verification. A signup sent at account creation can send the handle in `identify` instead. Do not identify at sign-in, verification, or account linking. The call creates the participant when the Project does not have it, and enrolls it at sign-up: in each active referral Program whose `enrollAtSignup` is not false, where it was never enrolled, with its referral code. While the participant limit of the Workspace pauses new enrollments, it enrolls nothing. `{ handle, reference }`: this browser belongs to the person of a flow that starts before the account exists and can end on another device or in a hosted login, such as a magic link or a one-time code. `reference.key` is your key of the flow, unique in the Project and bound to its challenge (for example a digest of the magic-link token); a key is never used again. The call that names an unknown key creates its reference, which expires at `reference.expiresAt`: after the receipt and at most 90 days after it; the default is 24 hours after it. An expired reference gets 409. `{ reference, participant }`: the account of the flow exists. The reference resolves once to the participant, and the handles identified to it then belong to the participant. The same participant again returns the first result; another participant, or a reference that expired before it resolved, gets 409. A key that no handle named yet is created resolved, so the two calls can come in either order. It enrolls the participant at sign-up, as the first form does. A handle is identified once: the same target again returns the first identification, and another target gets 409. An unknown handle, or a handle of another Project, gets 404. `observedAt` is the time of the identity moment; the default is the receipt. A caller clock can run ahead: an `observedAt` up to 5 minutes after the receipt records the receipt, and a later one gets 400. The click window of a handle ends at its identification, also when its reference resolves later. A fact uses only the identifications and resolves that RefRef received at or before the fact; a fact never waits for one.