Sign in

v45

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-2684278289.5 KB
Recipient Invites

Create a recipient invite

Create an invite for a recipient to submit their payment details. Supply a recipientId to invite an existing recipient; omit it to invite someone new, in which case the recipient is created when the invitee completes onboarding.

post/recipients/invites

Request body

contactEmailstring required

Contact email the invite is sent to. When 'recipientId' is present, updates the recipient's contact email to this value.

namestring nullable

Name the invite is created for. This field is required when 'recipientId' is absent. When 'recipientId' is present, this field is optional and updates the recipient's name to this value.

notesstring nullable

Optional notes shown to the recipient.

organizationNameOnRequeststring nullable

Optional organization name to display on the request.

paymentMethodsPaymentMethod[] required

Payment methods the recipient may submit details for.

recipientIdstring uuid nullable

The recipient to send the invite to.

requireTaxDocumentboolean required

Whether the recipient must upload a tax document.

sendEmailboolean required

When true, sends an Email to the invitee. When false, does not send an email to the invitee.

Response

contactEmailstring required

Recipient contact email the invite was created for.

createdAtstring yyyy-mm-ddThh:MM:ssZ required

When the invite was created.

expiresAtstring yyyy-mm-ddThh:MM:ssZ nullable

When the invite expires, if it has an expiry.

idstring required

The invite's id, also embedded in 'onboardingUrl'.

namestring required

Recipient name the invite was created for.

notesstring nullable

Notes shown to the recipient, if any.

onboardingUrlstring required

URL where the recipient submits their payment details.

paymentMethodsPaymentMethod[] required

Payment methods the recipient may submit details for.

recipientIdstring uuid nullable

The existing recipient this invite is for, if any.

requireTaxDocumentboolean required

Whether the recipient must upload a tax document.

status'created' | 'completed' | 'expired' required

Status of the invite.

Example response

{
  "createdAt": "2016-07-22T00:00:00Z",
  "expiresAt": "2016-07-22T00:00:00Z"
}