POST/api/partner/v1/owners

Create an owner

Create one of your rental companies as an owner (booking platforms).

Integration credential only; no X-Owner-Id. The owner gets your integration's defaults: we do not charge renters for tolls and violations (you do), no payout account is opened, your integration becomes the owner's partner, and our fees go to the payer you choose (feePayer: owner or integration). Idempotent on externalId. 409 = the email already has an account (the owner connects you from the owner portal); 412 = your integration is not set up to create owners yet. Payment method for an owner who pays: stripePaymentMethodId (a card created with MyEZToll's publishable key) or the returned paymentSetupUrl. sendInvite emails the owner how to sign in, in language.

Authorization

X-Api-Key header

Send your partner key on every request. An owner key acts for its one owner; an integration token also needs the owner's id in the X-Owner-Id header.

Body

application/json

externalIdstringrequired

Your id for this rental company; the idempotency key.

emailstring <email>required

firstNamestringrequired

lastNamestringrequired

companyNamestring

phoneNumberstring

addressstring

address2string

citystring

statestring

zipCodestring

countrystring

feePayerstring

Who our fees are invoiced to; omitted = your integration's default.

Allowed values:ownerintegration

stripePaymentMethodIdstring

Card PaymentMethod created with the MyEZToll publishable key (owner payer only).

returnUrlstring <uri>

https URL the hosted payment page returns to.

sendInviteboolean

Email the owner how to sign in to the owner portal.

Default: false

languagestring

The owner's language (en, es, fr, de, pt, ru, uk, tr, fa, ur, hy, ka, uz, zh-Hans, zh-Hant): the invite is written in it. Unknown or empty = English.

Response

200 · application/json

successbooleanrequired

dataobject

ownerobject

createdboolean

warningstring

errorstringnullable

Status codes

200This externalId was already created; the existing owner.

201Created. warning is set when the owner was created but the payment method could not be attached.

400Validation error.

401Missing, unknown or revoked API key.

403Not an integration credential.

409An account with this email already exists.

412Your integration is not set up to create owners yet; contact MyEZToll.