contractor-onboarding-public

Payout Requirements

What Wise needs to pay somebody in country, asked of Wise right now.

⛔THE FORM IS DRAWN FROM THIS, NOT FROM ANYTHING WE HOLD. Frederick, 2026-09-15: "the system should be designed to ask for information based off the country in real time. When they're filling out the form, versus trying to think through all the different countries at once."

Public and token-scoped like the rest of onboarding: the contractor has no login, and the link IS the credential. The Wise token never leaves the server -- this is why the browser cannot simply call Wise itself.

Answers payable: false with a sentence rather than an error when Wise will not pay into that country: a contractor reading "500" learns nothing, and it is a real state, not a fault.

⛔ADDED 2026-10-01 (fix/the-bank-form-is-never-rate-limited-mid-entry): details is a JSON object of this country's fields the contractor has already answered ({"legalType": "BUSINESS"}), sent by the page ONLY for a field Wise's own response marked refreshRequirementsOnChange (wise.RequiredField.refresh_requirements_on_change) -- choosing "Business" over "Person" changes what Wise asks for next, and this is how the page re-asks for the UPDATED list without ever touching the submit route. A malformed or empty details degrades to the plain country-only ask, never a 400 -- a refresh is advisory, not a submission, and nothing about it should be able to fail the form.

get/api/onboard/{token}/payout-requirements

Request

  • Base URL: https://api.pigeonly.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.pigeonly.com/api/onboard/{token}/payout-requirements
  • Auth: none declared

Path parameters

tokenstring required

Query parameters

countrystring required
detailsstring nullable

Response

Successful Response

object required

Changes

No recorded changes to this operation across all 1 revision of this API.