List payments | Welcome to cash-app Documentation

curl https://api.cash.app/network/v1/payments \
     -H "Accept: Accept" \
     -H "X-Region: X-Region" \
     -H "X-Signature: X-Signature" \
     -H "User-Agent: User-Agent"

{
  "payments": [
    {
      "id": "PWC_4nn21zy6t0v2yhqg5bvhk7xkq",
      "amount": 1500,
      "net_amount": 1000,
      "captured_amount": 1000,
      "voided_amount": 0,
      "refunded_amount": 100,
      "currency": "USD",
      "customer_id": "CST_AQmxh4y_QGoNNIG5NUw0jttqyYedL1LklACQdyJ3H-Vs6WmLtP6A_C7XjQNohvY",
      "merchant_id": "MMI_4vxs5egfk7hmta3qx2h6rp91x",
      "grant_id": "GRG_221243dc6985a6819ff6950c1a21332f7bc4a46ebd49b5a7002908ab768e8e5ff7831e084d0d2c9d8d939793b55eff50",
      "status": "AUTHORIZED",
      "created_at": "2022-01-01T12:00:00Z",
      "updated_at": "2022-01-05T12:00:00Z",
      "capture_before": "2022-01-08T12:00:00Z",
      "refund_ids": [
        "PWCR_da1v3j4p3z15y47adpzzq0whj"
      ],
      "reference_id": "external-id",
      "metadata": {},
      "enrichments": {
        "initiation": {
          "actor": "CUSTOMER"
        },
        "recurring_series_id": "string",
        "statement_descriptor": "string",
        "restricted_categories": [
          "ALCOHOL"
        ]
      },
      "decline_errors": [
        {
          "category": "API_ERROR",
          "code": "MISSING_REQUIRED_FIELD",
          "detail": "Missing required parameter.",
          "field": "field_a[2].field_b"
        }
      ],
      "fee_amount": 1.1,
      "fee_rate": {
        "basis_points": 160,
        "fixed_amount": 20
      },
      "authorization_updates": [
        {
          "id": "string",
          "amount": 1,
          "currency": "USD",
          "status": "AUTHORIZED",
          "created_at": "2024-01-15T09:30:00Z",
          "payment_id": "string",
          "previous_amount": 1,
          "reference_id": "string",
          "metadata": {},
          "decline_errors": [
            {
              "category": "API_ERROR",
              "code": "MISSING_REQUIRED_FIELD",
              "detail": "Missing required parameter.",
              "field": "field_a[2].field_b"
            }
          ]
        }
      ]
    }
  ],
  "cursor": "string"
}

Returns a list of payments matching the given query parameters.

This endpoint is rate limited to 100 QPS.

Scopes: PAYMENTS_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.

reference_idstringOptional1-1024 characters

Filters results to only include payments with a reference_id matching the given value.

customer_idstringOptional1-128 characters

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

merchant_idstringOptional1-128 characters

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

limitintegerOptional1-100Defaults to 50

Maximum number of payments to return.

Response

paymentslist of objects

List of payments 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

Headers

Query parameters

Response

Errors