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
referenceIdor theemail: Payment Labs creates the payee and may send them an invitation email. - A payee has the
referenceIdbut another email: that payee's email changes toemail. - A payee has the
emailbut another reference ID: that payee's reference ID changes toreferenceId. - 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_ERRORwithdetails.bodycodeINVALID_PAYLOAD: the body is not a non-empty JSON array.400 VALIDATION_ERRORwithdetails.bodycodePAYLOAD_TOO_LARGE: the array has more than 100 rows.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
