SolutionsPricingDocsStart Free
Api

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 (decision 0048). 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, iss and projectId equal to Project ID, aud refref-widget, sub the external ID of the participant, participantKind its kind (individual or group), 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 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 Project backend with its secret.

In: header

Query Parameters

projectId*string
Match\S
Length1 <= length <= 512

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/widget/payout-details?projectId=string"
{  "eligible": true,  "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"  }}