Payouts

Create a payout onboarding link

Requires an API key with the payments scope and full access. Call it from your server and redirect the couple to the returned short-lived Stripe URL. This POST uses a stable internal account-creation key, but exposes no general client idempotency-key contract.

post/payouts/onboarding-link

Request

  • Base URL: https://api.aisle.wedding/v1
  • URL: https://api.aisle.wedding/v1/payouts/onboarding-link
  • Auth: HTTP bearer

Request body

countrystring

Payout-bank country. Unsupported values use the US default.

emailstring email

Required when creating a payout account.

return_urlstring uri required

An absolute HTTPS URL. Plain HTTP is accepted only for loopback development.

refresh_urlstring uri required

An absolute HTTPS URL. Plain HTTP is accepted only for loopback development.

Response

Success.

Changes

No recorded changes to this operation across all 1 revision of this API.