---
title: "Create a payout onboarding link"
method: POST
path: "/payouts/onboarding-link"
tags: ["Payouts"]
---

# Create a payout onboarding link

`POST /payouts/onboarding-link`

## Request

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

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.

## Request body

- object
  - `country` string: Payout-bank country. Unsupported values use the US default.
  - `email` string, email: Required when creating a payout account.
  - `return_url` string, uri, required: An absolute HTTPS URL. Plain HTTP is accepted only for loopback development.
  - `refresh_url` string, uri, required: An absolute HTTPS URL. Plain HTTP is accepted only for loopback development.

## Response `200`

Success.

- object
  - `data` PayoutLink, required
    - `url` string, uri, required
    - `type` 'onboarding' | 'dashboard', required

## Other responses

- `400`: The request itself could not be read, such as a body that is not a JSON object. A field we refuse is validation_failed instead.
- `401`: The API key is missing, malformed, or no longer valid.
- `402`: The operation requires an active Aisle membership for this wedding.
- `403`: The key is valid but not permitted to do this.
- `404`: No such resource inside the key's wedding.
- `405`: That HTTP method is not supported here. See the Allow header.
- `409`: The request collided with the current state of the resource.
- `415`: A request body must be sent as application/json.
- `422`: The request was well-formed but a field was not acceptable. Every field at fault is named in error.details.
- `429`: Too many requests. Retry after the time given in Retry-After.
- `500`: Something went wrong on our side.

---

[API](https://skmtc.dev/aisle/apis/aisle-api.md) · [All operations](https://skmtc.dev/aisle/apis/aisle-api/llms.txt) · [OpenAPI document](https://skmtc.dev/aisle/apis/aisle-api/revisions/689a2f2420cc?raw)