Create payout

Beta

POST

/payouts

POST

/network/v1/payouts

curl -X POST https://api.cash.app/network/v1/payouts \
     -H "Content-Type: application/json" \
     -d '{
  "idempotency_key": "e345c3fb-1caa-46fd-b0d3-aa6c7b00ab19",
  "payout": {
    "amount": 1500,
    "currency": "USD",
    "merchant_id": "MMI_4vxs5egfk7hmta3qx2h6rp91x",
    "grant_id": "GRG_221243dc6985a6819ff6950c1a21332f7bc4a46ebd49b5a7002908ab768e8e5ff7831e084d0d2c9d8d939793b55eff50",
    "purpose": "SERVICES",
    "capture": true,
    "note": "Payment for consulting work completed in January"
  }
}'

{
  "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
  }
}

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)

Creates a payout to a customer. A payout allows a merchant to send money to a customer’s Cash App account.

This endpoint is not rate-limited.

Scopes: PAYOUTS_WRITE

Request

This endpoint expects an object.

idempotency_keystringRequired1-64 characters

A unique identifier which can be used by Cash App to de-duplicate retries of this request, making it idempotent. For more information, see Idempotency.

payoutobjectRequired

Data about the payout to create.

Response

Created

payoutobjectOptional

Errors

400

Create Payout Request Bad Request Error

Headers

Request

Response

Errors