List payouts | Welcome to cash-app Documentation

import requests
url = "https://api.cash.app/network/v1/payouts"
headers = {
    "Accept": "Accept",
    "X-Region": "X-Region",
    "X-Signature": "X-Signature",
    "User-Agent": "User-Agent"
}
response = requests.get(url, headers=headers)
print(response.json())

{
  "payouts": [
    {
      "payout_id": "CAPO_4nn21zy6t0v2yhqg5bvhk7xkq",
      "grant_id": "GRG_221243dc6985a6819ff6950c1a21332f7bc4a46ebd49b5a7002908ab768e8e5ff7831e084d0d2c9d8d939793b55eff50",
      "amount": 1500,
      "currency": "USD",
      "status": "CAPTURED",
      "merchant_id": "MMI_4vxs5egfk7hmta3qx2h6rp91x",
      "purpose": "SERVICES",
      "customer_id": "CST_AQmxh4y_QGoNNIG5NUw0jttqyYedL1LklACQdyJ3H-Vs6WmLtP6A_C7XjQNohvY",
      "authorized_amount": 1500,
      "captured_amount": 1500,
      "declined_amount": 0,
      "voided_amount": 0,
      "reference_id": "external-id",
      "fee_amount": 1.1,
      "fee_rate": {
        "basis_points": 160,
        "fixed_amount": 20
      },
      "note": "Payment for consulting work completed in January",
      "metadata": {},
      "decline_errors": [
        {
          "category": "API_ERROR",
          "code": "MISSING_REQUIRED_FIELD",
          "detail": "Missing required parameter.",
          "field": "field_a[2].field_b"
        }
      ]
    }
  ],
  "cursor": "string"
}

Early Access

Payouts is an early access feature. We’re actively improving this API based on your feedback.

Early access features come with some caveats:

May evolve rapidly, requiring integration updates
Not subject to our 10 year version support policy
Not subject to SLAs (unless specified in a contract)

Returns a list of payouts matching the given query parameters.

This endpoint is rate limited to 100 QPS.

Scopes: PAYOUTS_READ

<Warning title="Early Access" icon="robot-astromech"> Payouts is an **early access** feature. We're actively improving this API based on your feedback. Early access features come with some caveats: * May evolve rapidly, requiring integration updates * Not subject to our 10 year version support policy * Not subject to SLAs (unless specified in a contract) </Warning> Returns a list of payouts matching the given query parameters. **This endpoint is rate limited to 100 QPS.** Scopes: `PAYOUTS_READ`

Query parameters

cursorstringOptional>=1 character

A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query.

merchant_idstringOptional1-128 characters

Filters results to include only payouts made to a merchant that matches the given ID.

customer_idstringOptional1-128 characters

Filters results to include only payouts made to a customer that matches the given ID.

limitintegerOptional1-100Defaults to 50

Maximum number of payouts to return.

Response

payoutslist of objects

List of payouts matching the given query parameters.

cursorstring

The pagination cursor to be used in a subsequent request. If empty, this is the final response.

Errors

400

Bad Request Error

Early Access

Headers

Query parameters

Response

Errors

Early Access