Create Payees

Creates payees and invites them to onboard. Send up to 100 payees in one request.

Use it to add payees before you pay them, so they can set up a payment method and tax details in advance. You can also skip
it: Create Payment and Get Widget URL create the payee if it does not exist.

Requires the Administrator, Expert User or User role.

Each row is matched against your payees by referenceId and email, as described in
Payee Reference IDs:

  • No payee has the referenceId or the email: Payment Labs creates the payee and may send them an invitation email.
  • A payee has the referenceId but another email: that payee's email changes to email.
  • A payee has the email but another reference ID: that payee's reference ID changes to referenceId.
  • A payee has both: nothing changes, and no email is sent.

In every matched case, taxJurisdiction is added to the payee if it does not have it yet.

Rows are processed independently. The response is 200 with one result per row, in the same order as the request, even when
some rows fail. Check result on each item. A failed row saves nothing; fix it and send it again. Sending a row again after it
succeeded is safe: it matches the payee it created.

Errors (the whole request is rejected)

  • 400 VALIDATION_ERROR with details.body code INVALID_PAYLOAD: the body is not a non-empty JSON array.
  • 400 VALIDATION_ERROR with details.body code PAYLOAD_TOO_LARGE: the array has more than 100 rows.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The payees to create, between 1 and 100. Each email and each referenceId can appear only once per request.

CreatePayeesRequest

One payee to create or update.

string
required

Email address of the payee. Payment Labs checks that it is well formed and that its domain accepts email.

string

Your own ID for the payee, unique within your payor account. If you omit it, the payee's email is used as its reference ID.
See Payee Reference IDs.

string
enum

Tax jurisdiction to add to the payee, which makes the payee fill in that jurisdiction's tax form during onboarding. It must
be one of the tax jurisdictions enabled on your payor account (see Get Payor). Omit it, or send none, to add none.

Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json