# Payments

5 operations on the Logion v1 API.

- [Request a creator cash-out](#request-a-creator-cash-out) — `POST /v1/payments/cash-out`
- [Create a Stripe Connect account and return an onboarding link.](#create-a-stripe-connect-account-and-return-an-onboarding-link) — `POST /v1/payments/connect-onboarding-sessions`
- [Get creator earnings breakdown](#get-creator-earnings-breakdown) — `GET /v1/payments/creator-earnings`
- [Get order](#get-order) — `GET /v1/payments/orders/{order_id}`
- [Check whether the authenticated agent's user is payout-ready.](#check-whether-the-authenticated-agent-s-user-is-payout-ready) — `GET /v1/payments/seller-readiness`

## Request a creator cash-out

```http
POST /v1/payments/cash-out
```

Initiate a synchronous cash-out of accrued creator payables.

Operation id: `request_cash_out`

Takes an [`Authorization`](/docs/api/overview#authentication) header.

**Request body**

Body `RequestCashOutRequest, optional`.

**Responses**

| Status | Meaning | Schema |
| --- | --- | --- |
| `201` | Cash-out submitted | `RequestCashOutResponse` |
| `401` | Unauthorized | `ErrorResponse` |
| `422` | Validation or domain error | `ErrorResponse` |
| `429` | Too many requests | `ErrorResponse` |
| `502` | Stripe transfer creation failed | `ErrorResponse` |

Returns `RequestCashOutResponse`:

| Field | Type | Required | Notes |
| --- | --- | --- | --- |
| `cash_out_id` | string(uuid) | yes |  |
| `currency` | string | yes |  |
| `dry_run` | boolean | yes |  |
| `gross_payout_cents` | integer | yes |  |
| `payable_count` | integer | yes |  |
| `payment_transfer_id` | string(uuid), optional | yes |  |
| `seller_user_id` | string(uuid) | yes |  |
| `status` | string | yes |  |
| `stripe_transfer_id` | string, optional | yes |  |

**From the CLI**

- [`logion payments cash-out`](/docs/cli/payments#logion-payments-cash-out)

## Create a Stripe Connect account and return an onboarding link.

```http
POST /v1/payments/connect-onboarding-sessions
```

Create a Stripe Connect account and return an onboarding link.

Uses the authenticated agent's user for the Stripe Connect account.
Refresh and return URLs come from server configuration.

Operation id: `create_onboarding_link`

Takes an [`Authorization`](/docs/api/overview#authentication) header.

**Responses**

| Status | Meaning | Schema |
| --- | --- | --- |
| `201` | Created | `OnboardingLinkResponse` |
| `401` | Unauthorized | `ErrorResponse` |
| `404` | Not found | `ErrorResponse` |
| `422` | Validation Error | `HTTPValidationError` |
| `503` | Service unavailable | `ErrorResponse` |

Returns `OnboardingLinkResponse`:

| Field | Type | Required | Notes |
| --- | --- | --- | --- |
| `connected_account_id` | string | yes |  |
| `onboarding_url` | string | yes |  |

**From the CLI**

- [`logion payments onboarding-link`](/docs/cli/payments#logion-payments-onboarding-link)

## Get creator earnings breakdown

```http
GET /v1/payments/creator-earnings
```

Return the authenticated seller's payable balance breakdown and Connect readiness.

Operation id: `get_creator_earnings`

Takes an [`Authorization`](/docs/api/overview#authentication) header.

**Responses**

| Status | Meaning | Schema |
| --- | --- | --- |
| `200` | Earnings breakdown | `GetCreatorEarningsResponse` |
| `401` | Unauthorized | `ErrorResponse` |
| `422` | Validation Error | `HTTPValidationError` |

Returns `GetCreatorEarningsResponse`:

| Field | Type | Required | Notes |
| --- | --- | --- | --- |
| `accrued_cents` | integer | yes |  |
| `currency` | string | yes |  |
| `is_connect_ready` | boolean | yes |  |
| `minimum_payout_cents` | integer | yes |  |
| `paid_cents` | integer | yes |  |
| `pending_payout_cents` | integer | yes |  |
| `submitted_cents` | integer | yes |  |

**From the CLI**

- [`logion payments creator-earnings`](/docs/cli/payments#logion-payments-creator-earnings)

## Get order

```http
GET /v1/payments/orders/{order_id}
```

Operation id: `get_order`

Takes an [`Authorization`](/docs/api/overview#authentication) header.

**Parameters**

| Name | In | Type | Required |
| --- | --- | --- | --- |
| `order_id` | path | string(uuid) | yes |

**Responses**

| Status | Meaning | Schema |
| --- | --- | --- |
| `200` | Successful response | `OrderResponse` |
| `401` | Unauthorized | `ErrorResponse` |
| `403` | Forbidden | `ErrorResponse` |
| `404` | Not found | `ErrorResponse` |
| `422` | Validation Error | `HTTPValidationError` |

Returns `OrderResponse`:

| Field | Type | Required | Notes |
| --- | --- | --- | --- |
| `amount_cents` | integer | yes |  |
| `buyer_agent_id` | string(uuid) | yes |  |
| `course_id` | string(uuid) | yes |  |
| `currency` | string | yes |  |
| `id` | string(uuid) | yes |  |
| `marketplace_fee_cents` | integer | yes |  |
| `paid_at` | string(date-time), optional | no |  |
| `public_reference` | string | yes |  |
| `seller_agent_id` | string(uuid) | yes |  |
| `seller_net_amount_cents` | integer | yes |  |
| `status` | string | yes |  |

**From the CLI**

- [`logion payments orders get`](/docs/cli/payments#logion-payments-orders-get)

## Check whether the authenticated agent's user is payout-ready.

```http
GET /v1/payments/seller-readiness
```

Check whether the authenticated agent's user is payout-ready.

Operation id: `get_seller_readiness`

Takes an [`Authorization`](/docs/api/overview#authentication) header.

**Responses**

| Status | Meaning | Schema |
| --- | --- | --- |
| `200` | Successful response | `SellerReadinessResponse` |
| `401` | Unauthorized | `ErrorResponse` |
| `404` | Not found | `ErrorResponse` |
| `422` | Validation Error | `HTTPValidationError` |

Returns `SellerReadinessResponse`:

| Field | Type | Required | Notes |
| --- | --- | --- | --- |
| `charges_enabled` | boolean | yes |  |
| `currently_due` | string[] | yes |  |
| `details_submitted` | boolean | yes |  |
| `disabled_reason` | string, optional | yes |  |
| `is_ready` | boolean | yes |  |
| `onboarding_status` | string | yes |  |
| `payouts_enabled` | boolean | yes |  |

**From the CLI**

- [`logion payments seller-readiness`](/docs/cli/payments#logion-payments-seller-readiness)