Retrieve payout | Welcome to cash-app Documentation

{
  "payout": {
    "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": 50,
    "fee_rate": {
      "basis_points": 160,
      "fixed_amount": 20
    },
    "note": "Payment for consulting work completed in January",
    "metadata": {
      "key": "value"
    },
    "decline_errors": [
      {
        "category": "INVALID_REQUEST_ERROR",
        "code": "MISSING_REQUIRED_FIELD",
        "detail": "Missing required parameter.",
        "field": "field_a[2].field_b"
      }
    ]
  }
}

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)

Retrieves a payout by its ID.

This endpoint is not rate-limited.

Scopes: PAYOUTS_READ

Path parameters

payout_idstringRequired

The ID of the payout to retrieve.

Response

payoutobject

Errors

404

Retrieve Payout Request Not Found Error

Path parameters

Headers

Response

Errors