Get Widget URL

put

https://api-sandbox.paymentlabs.io/payors/widget-url

Returns a signed URL that opens the Payment Labs payee widget for one payee, where the payee signs up, enters personal details,
adds a payment method and fills in tax forms.

Call it from your server each time a payee opens the widget, then load the returned url in an iframe or redirect the payee
to it. See Getting Started with the Payee Widget.

Any payout role can call it.

Side effects. Payment Labs finds the payee by payeeReferenceId and payeeEmail, the same way Create Payees does:

If no payee matches either value, Payment Labs creates the payee and may send them an invitation email.
If the payee found by payeeReferenceId has another email, the payee's email changes to payeeEmail.
If the payee found by payeeEmail has another reference ID, the payee's reference ID changes to payeeReferenceId.
taxJurisdiction, if sent, is added to the payee's tax jurisdictions.

Errors

400 EMAIL_ALREADY_IN_USE: payeeReferenceId belongs to one payee and payeeEmail to another. Send the email that payee
already has.
400 VALIDATION_ERROR: a required field is missing, payeeEmail is not a valid email address, taxJurisdiction is not a
known value, or the body has a field not listed here.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Identifies the payee to open the payee widget for.

payeeEmail

string

required

Email address of the payee. If no payee of yours has this email or payeeReferenceId, Payment Labs creates one. If the
payee found by payeeReferenceId has a different email, the payee's email is changed to this one.

payeeReferenceId

string

required

Your own ID for the payee, unique within your payor account. If the payee found by payeeEmail has a different reference ID,
the payee's reference ID is changed to this one. See Payee Reference IDs.

taxJurisdiction

string

enum

Tax jurisdiction to add to the payee. The payee is then asked for the tax form of that jurisdiction during onboarding. Omit it,
or send none, to leave the payee's tax jurisdictions unchanged.

redirectPath

string

Page of the payee widget to open after the payee signs in, as a Base64-encoded path, for example L3BheW1lbnQtbWV0aG9kcw==
for /payment-methods. Omit it to open the default page.

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The signed widget URL.

404The resource does not exist in your account.

422The request body is not valid JSON, or is not a JSON object. Send Content-Type: application/json with a JSON object body.