# Payouts

Payouts represent the movement of money between a Shopify Payments
account balance and a connected bank account.

## Resource Properties

### Payouts

* id: The unique identifier of the payout
  * Type: x-string
  * Example: 54534554564
* status:           The transfer status of the payout. The value will be one of the following:
          <ul>
            <li>
              <strong>scheduled</strong>: The payout has been created and had transactions assigned to it, but
              it has not yet been submitted to the bank.
            </li>
            <li><strong>in_transit</strong>: The payout has been submitted to the bank for processing.</li>
            <li><strong>paid</strong>: The payout has been successfully deposited into the bank.</li>
            <li><strong>failed</strong>: The payout has been declined by the bank.</li>
            <li><strong>canceled</strong>: The payout has been canceled by Shopify.</li>
          </ul>

  * Type: x-string
  * Example: "scheduled"
* date:           The date (<a href="https://en.wikipedia.org/wiki/ISO_8601">ISO 8601 format</a>) when the payout was issued.

  * Type: x-string
  * Example: "2018-03-22"
* currency: The ISO 4217 currency code of the payout.
  * Type: x-string
  * Example: "USD"
* amount: The total amount of the payout, in a decimal formatted string.
  * Type: x-string
  * Example: "102.53"
## Return a list of all payouts

Retrieves a list of all payouts ordered by payout date, with the most recent being first.
          <strong>Note:</strong> This endpoint implements pagination by using links that are provided in the response header. To learn more, refer to <a href='/api/usage/pagination-rest'>Make paginated requests to the REST Admin API</a>.

### Endpoint
/admin/api/#{api_version}/shopify_payments/payouts.json (GET)

### Parameters
* api_version (required): 
* date: Filter the response to payouts made on the specified date.
* date_max: Filter the response to payouts made inclusively before the specified date.
* date_min: Filter the response to payouts made inclusively after the specified date.
* last_id: Filter the response to payouts made before the specified ID.
* since_id: Filter the response to payouts made after the specified ID.
* status: Filter the response to payouts made with the specified status.

### Responses
#### 200
Return a list of all payouts

Examples:
##### List all payouts ordered newest to oldest
Request:
```
GET /admin/api/unstable/shopify_payments/payouts.json
```

Response:
```
HTTP/1.1 200 OK
{"payouts":[{"id":512467833,"status":"failed","date":"2013-12-01","currency":"USD","amount":"43.12","summary":{"adjustments_fee_amount":"0.12","adjustments_gross_amount":"2.13","charges_fee_amount":"1.32","charges_gross_amount":"45.52","refunds_fee_amount":"-0.23","refunds_gross_amount":"-3.54","reserved_funds_fee_amount":"0.00","reserved_funds_gross_amount":"0.00","retried_payouts_fee_amount":"0.00","retried_payouts_gross_amount":"0.00"}},{"id":39438702,"status":"in_transit","date":"2013-11-01","currency":"USD","amount":"43.12","summary":{"adjustments_fee_amount":"0.12","adjustments_gross_amount":"2.13","charges_fee_amount":"1.32","charges_gross_amount":"45.52","refunds_fee_amount":"-0.23","refunds_gross_amount":"-3.54","reserved_funds_fee_amount":"0.00","reserved_funds_gross_amount":"0.00","retried_payouts_fee_amount":"0.00","retried_payouts_gross_amount":"0.00"}},{"id":917000993,"status":"failed","date":"2012-11-13","currency":"USD","amount":"41.90","summary":{"adjustments_fee_amount":"0.12","adjustments_gross_amount":"2.13","charges_fee_amount":"1.32","charges_gross_amount":"44.52","refunds_fee_amount":"-0.23","refunds_gross_amount":"-3.54","reserved_funds_fee_amount":"0.00","reserved_funds_gross_amount":"0.00","retried_payouts_fee_amount":"0.00","retried_payouts_gross_amount":"0.00"}},{"id":867808544,"status":"paid","date":"2012-11-12","currency":"USD","amount":"41.90","summary":{"adjustments_fee_amount":"0.12","adjustments_gross_amount":"2.13","charges_fee_amount":"1.32","charges_gross_amount":"44.52","refunds_fee_amount":"-0.23","refunds_gross_amount":"-3.54","reserved_funds_fee_amount":"0.00","reserved_funds_gross_amount":"0.00","retried_payouts_fee_amount":"0.00","retried_payouts_gross_amount":"0.00"}},{"id":725076685,"status":"paid","date":"2012-11-12","currency":"USD","amount":"41.90","summary":{"adjustments_fee_amount":"0.12","adjustments_gross_amount":"2.13","charges_fee_amount":"1.32","charges_gross_amount":"44.52","refunds_fee_amount":"-0.23","refunds_gross_amount":"-3.54","reserved_funds_fee_amount":"0.00","reserved_funds_gross_amount":"0.00","retried_payouts_fee_amount":"0.00","retried_payouts_gross_amount":"0.00"}},{"id":714327683,"status":"failed","date":"2012-11-12","currency":"USD","amount":"41.90","summary":{"adjustments_fee_amount":"0.12","adjustments_gross_amount":"2.13","charges_fee_amount":"1.32","charges_gross_amount":"44.52","refunds_fee_amount":"-0.23","refunds_gross_amount":"-3.54","reserved_funds_fee_amount":"0.00","reserved_funds_gross_amount":"0.00","retried_payouts_fee_amount":"0.00","retried_payouts_gross_amount":"0.00"}},{"id":631321250,"status":"scheduled","date":"2012-11-12","currency":"USD","amount":"41.90","summary":{"adjustments_fee_amount":"0.12","adjustments_gross_amount":"2.13","charges_fee_amount":"1.32","charges_gross_amount":"44.52","refunds_fee_amount":"-0.23","refunds_gross_amount":"-3.54","reserved_funds_fee_amount":"0.00","reserved_funds_gross_amount":"0.00","retried_payouts_fee_amount":"0.00","retried_payouts_gross_amount":"0.00"}},{"id":623721858,"status":"paid","date":"2012-11-12","currency":"USD","amount":"41.90","summary":{"adjustments_fee_amount":"0.12","adjustments_gross_amount":"2.13","charges_fee_amount":"1.32","charges_gross_amount":"44.52","refunds_fee_amount":"-0.23","refunds_gross_amount":"-3.54","reserved_funds_fee_amount":"0.00","reserved_funds_gross_amount":"0.00","retried_payouts_fee_amount":"0.00","retried_payouts_gross_amount":"0.00"}}]}
```
##### List all payouts up to a specified date
Request:
```
GET /admin/api/unstable/shopify_payments/payouts.json
```

Response:
```
HTTP/1.1 200 OK
{"payouts":[{"id":867808544,"status":"paid","date":"2012-11-12","currency":"USD","amount":"41.90","summary":{"adjustments_fee_amount":"0.12","adjustments_gross_amount":"2.13","charges_fee_amount":"1.32","charges_gross_amount":"44.52","refunds_fee_amount":"-0.23","refunds_gross_amount":"-3.54","reserved_funds_fee_amount":"0.00","reserved_funds_gross_amount":"0.00","retried_payouts_fee_amount":"0.00","retried_payouts_gross_amount":"0.00"}},{"id":725076685,"status":"paid","date":"2012-11-12","currency":"USD","amount":"41.90","summary":{"adjustments_fee_amount":"0.12","adjustments_gross_amount":"2.13","charges_fee_amount":"1.32","charges_gross_amount":"44.52","refunds_fee_amount":"-0.23","refunds_gross_amount":"-3.54","reserved_funds_fee_amount":"0.00","reserved_funds_gross_amount":"0.00","retried_payouts_fee_amount":"0.00","retried_payouts_gross_amount":"0.00"}},{"id":714327683,"status":"failed","date":"2012-11-12","currency":"USD","amount":"41.90","summary":{"adjustments_fee_amount":"0.12","adjustments_gross_amount":"2.13","charges_fee_amount":"1.32","charges_gross_amount":"44.52","refunds_fee_amount":"-0.23","refunds_gross_amount":"-3.54","reserved_funds_fee_amount":"0.00","reserved_funds_gross_amount":"0.00","retried_payouts_fee_amount":"0.00","retried_payouts_gross_amount":"0.00"}},{"id":631321250,"status":"scheduled","date":"2012-11-12","currency":"USD","amount":"41.90","summary":{"adjustments_fee_amount":"0.12","adjustments_gross_amount":"2.13","charges_fee_amount":"1.32","charges_gross_amount":"44.52","refunds_fee_amount":"-0.23","refunds_gross_amount":"-3.54","reserved_funds_fee_amount":"0.00","reserved_funds_gross_amount":"0.00","retried_payouts_fee_amount":"0.00","retried_payouts_gross_amount":"0.00"}},{"id":623721858,"status":"paid","date":"2012-11-12","currency":"USD","amount":"41.90","summary":{"adjustments_fee_amount":"0.12","adjustments_gross_amount":"2.13","charges_fee_amount":"1.32","charges_gross_amount":"44.52","refunds_fee_amount":"-0.23","refunds_gross_amount":"-3.54","reserved_funds_fee_amount":"0.00","reserved_funds_gross_amount":"0.00","retried_payouts_fee_amount":"0.00","retried_payouts_gross_amount":"0.00"}}]}
```
## Return a single payout

Retrieves a single payout by id.

### Endpoint
/admin/api/#{api_version}/shopify_payments/payouts/{payout_id}.json (GET)

### Parameters
* api_version (required): 
* payout_id (required): 

### Responses
#### 200
Return a single payout

Examples:
##### Retrieves a single payout by id
Request:
```
GET /admin/api/unstable/shopify_payments/payouts/623721858.json
```

Response:
```
HTTP/1.1 200 OK
{"payout":{"id":623721858,"status":"paid","date":"2012-11-12","currency":"USD","amount":"41.90","summary":{"adjustments_fee_amount":"0.12","adjustments_gross_amount":"2.13","charges_fee_amount":"1.32","charges_gross_amount":"44.52","refunds_fee_amount":"-0.23","refunds_gross_amount":"-3.54","reserved_funds_fee_amount":"0.00","reserved_funds_gross_amount":"0.00","retried_payouts_fee_amount":"0.00","retried_payouts_gross_amount":"0.00"}}}
```