POST/api/partner/v1/billing/payment-setup-link

Integration payment page

The hosted payment page for your integration's own payment method.

The payment method charged for every owner whose fees your integration pays. Body { instrument: card | bank, returnUrl? }.

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

instrumentstring

Allowed values:cardbankDefault: card

returnUrlstring <uri>

Response

200 · application/json

successbooleanrequired

dataobject

ownerIdstring

Pass as X-Owner-Id on owner-level calls.

externalIdstring

emailstring

companyNamestring

feePayerstring

Allowed values:ownerintegration

payerAccountIdstring

paymentMethodstring

Allowed values:cardbank

paymentMethodReadyboolean

paymentSetupUrlstring

Hosted Stripe page; present only while no payment method is on file.

inviteSentboolean

errorstringnullable

Status codes

200The link (paymentSetupUrl).

400Validation error.

412Your integration has no billing account yet; contact MyEZToll.