# Organization API: Billing & Payouts: Commerce

> The 3 Organization API operations for commerce.

Source: https://docs.coritan.com/api/reference/organizations/billing-payouts/commerce/

Part of [Billing & Payouts](/api/reference/organizations/billing-payouts/).

## Operations

| Method | Path | Summary |
| --- | --- | --- |
| GET | [`/api/v1/orgs/{org_slug}/commerce/payouts`](#op-get-api-v1-orgs-org-slug-commerce-payouts) | List payouts |
| POST | [`/api/v1/orgs/{org_slug}/commerce/payouts`](#op-post-api-v1-orgs-org-slug-commerce-payouts) | Ask for the payable balance in a currency now |
| GET | [`/api/v1/orgs/{org_slug}/commerce/payouts/{payout_id}`](#op-get-api-v1-orgs-org-slug-commerce-payouts-payout-id) | The payout and the ledger rows it holds, oldest first |

### List payouts {#op-get-api-v1-orgs-org-slug-commerce-payouts}

`GET /api/v1/orgs/{org_slug}/commerce/payouts`

Newest first, with ``summary``: the schedule and, per currency, what is
payable now, the minimum and any payout still open.

#### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `org_slug` | path | string | yes |  |
| `status` | query | string or null | no | A status, or open for both open ones. |
| `currency_code` | query | string or null | no |  |
| `limit` | query | integer | no | Default: `50`. |
| `offset` | query | integer | no | Default: `0`. |

#### Responses

| Status | Meaning |
| --- | --- |
| `200` | Success. |
| `422` | The request is not valid. `detail` lists each problem. |

### Ask for the payable balance in a currency now {#op-post-api-v1-orgs-org-slug-commerce-payouts}

`POST /api/v1/orgs/{org_slug}/commerce/payouts`

Ask for the payable balance in a currency now. 409 with ``error``
``nothing_payable``, ``below_minimum``, ``payout_open`` or ``held`` when
there is none to make; the balance carries.

#### Parameters

| Name | In | Type | Required |
| --- | --- | --- | --- |
| `org_slug` | path | string | yes |
| `Idempotency-Key` | header | string or null | no |

#### Request body

`application/json` (required)

| Field | Type | Required |
| --- | --- | --- |
| `currency_code` | string | yes |

#### Responses

| Status | Meaning |
| --- | --- |
| `201` | Success. |
| `422` | The request is not valid. `detail` lists each problem. |

### The payout and the ledger rows it holds, oldest first {#op-get-api-v1-orgs-org-slug-commerce-payouts-payout-id}

`GET /api/v1/orgs/{org_slug}/commerce/payouts/{payout_id}`

The payout and the ledger rows it holds, oldest first.

#### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `payout_id` | path | string | yes |  |
| `org_slug` | path | string | yes |  |
| `limit` | query | integer | no | Ledger rows per page. Default: `100`. |
| `offset` | query | integer | no | Default: `0`. |

#### Responses

| Status | Meaning |
| --- | --- |
| `200` | Success. |
| `422` | The request is not valid. `detail` lists each problem. |