For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Skip to navigation

Network API Payouts

Payout

This page is for Cash App Pay Partner API.

Response

payoutobjectOptional

Example

{
  "payout_id": "CAPO_4nn21zy6t0v2yhqg5bvhk7xkq",
  "grant_id": "GRG_221243dc6985a6819ff6950c1a21332f7bc4a46ebd49b5a7002908ab768e8e5ff7831e084d0d2c9d8d939793b55eff50",
  "amount": 1500,
  "currency": "USD",
  "status": "CAPTURED",
  "merchant_id": "MMI_4vxs5egfk7hmta3qx2h6rp91x",
  "purpose": "SERVICES",
  "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": {},
  "decline_errors": [
    {
      "category": "INVALID_REQUEST_ERROR",
      "code": "MISSING_REQUIRED_FIELD",
      "detail": "Missing required parameter.",
      "field": "field_a[2].field_b"
    }
  ]
}

Was this page helpful?

Guides API Reference

Network API
Customer Request API
Management API

List brands
Create brand
Upsert brand
Retrieve brand
Update brand
Brand
List merchants
Create merchant
Upsert merchant
Retrieve merchant
Update merchant
Merchant
Event: merchant.status.updated
MerchantFeePlans
List customers
Retrieve customer
Retrieve customer grant
List customer grants
Revoke customer grant
Customer
Event: grant.created
Event: grant.status.updated
Event: customer.created
Event: customer.updated
Event: customer.deleted
List payments
Create payment
Retrieve payment
Create incremental authorization
Capture payment
Void payment
Void payment by idempotency key
Payment
Enrichments
Event: payment.status.updated
List payouts
Create payout
Retrieve payout
Payout
List balances
Retrieve balance
Balance
List refunds
Create refund
Retrieve refund
Capture refund
Void refund
Void refund by idempotency key
Refund
Event: refund.status.updated
List disputes
Retrieve dispute
Accept dispute
Challenge dispute
List dispute evidence
Create dispute evidence text
Create dispute evidence file
Delete dispute evidence
Retrieve dispute evidence
Dispute
DisputeEvidence
Event: dispute.created
Event: dispute.status.updated
Retrieve Fee Plan
List fee plans
FeeRate
FeePlan
Address
Authorization
Category
Country
Currency
Grant
Idempotency_key
Metadata
Error
ErrorResponse
ValidateOrderAmountsParam
Create request
Retrieve request
Update request
Event: customer_request.state.updated
Action
Request
Link Account Action
One Time Payment Action
On File Payment Action
On File Payout Action
Checking Balance Action
Channel
Customer Metadata
ErrorResponse
List API keys
Create API key
Retrieve API key
Delete API key
Api_key
Scopes
List webhook endpoints
Create webhook endpoint
Retrieve webhook endpoint
Update webhook endpoint
Delete webhook endpoint
List webhook events
WebhookEndpoint
WebhookEndpointStatus
EventConfiguration
ApiVersion
WebhookEvent
EventType
EventStatus
EventData
EventDataType
Create request chain
ErrorResponse
Response

Home
Afterpay
Cash App Pay Partner API