List Payments | Welcome to cash-app Documentation

{
  "totalResults": 445,
  "offset": 3,
  "limit": 1,
  "nextPageUrl": "string",
  "results": [
    {
      "id": "string",
      "token": "005.2fkv5o963b132z8ppa34srlh60987y87d55re237wsg9tr4q2",
      "status": "APPROVED",
      "created": "string",
      "originalAmount": {
        "amount": "100.00",
        "currency": "AUD"
      },
      "openToCaptureAmount": {
        "amount": "100.00",
        "currency": "AUD"
      },
      "paymentState": "AUTH_APPROVED",
      "merchantReference": "merchant-order-123",
      "refunds": [
        {
          "amount": {
            "amount": "100.00",
            "currency": "AUD"
          },
          "merchantReference": "string",
          "refundId": "string",
          "refundMerchantReference": "string",
          "refundedAt": "2023-01-01T00:00:00.000",
          "requestId": "string"
        }
      ],
      "orderDetails": {
        "consumer": {
          "email": "test@example.com",
          "givenNames": "Joe",
          "surname": "Consumer",
          "phoneNumber": "0400 000 000"
        },
        "billing": {
          "name": "Joe Consumer",
          "line1": "Level 5",
          "area1": "Melbourne",
          "region": "VIC",
          "postcode": "3000",
          "countryCode": "AU",
          "line2": "390 Collins Street",
          "phoneNumber": "0400 000 000"
        },
        "courier": {
          "shippedAt": "2025-08-24T14:15:22Z",
          "name": "USA Post",
          "tracking": "AA0000000000000",
          "priority": "STANDARD"
        },
        "items": [
          {
            "name": "Blue Carabiner",
            "quantity": 1,
            "price": {
              "amount": "100.00",
              "currency": "AUD"
            },
            "sku": "string",
            "pageUrl": "https://example.com/carabiner-354193.html",
            "imageUrl": "https://example.com/carabiner-7378-391453-1.jpg",
            "categories": [
              [
                "string"
              ]
            ],
            "estimatedShipmentDate": "2023-08-01",
            "preorder": false
          }
        ],
        "discounts": [
          {
            "displayName": "New Customer Coupon",
            "amount": {
              "amount": "100.00",
              "currency": "AUD"
            }
          }
        ],
        "taxAmount": {
          "amount": "100.00",
          "currency": "AUD"
        },
        "shippingAmount": {
          "amount": "100.00",
          "currency": "AUD"
        }
      },
      "events": [
        {
          "id": "1OUR16OTqL3DgJ3ELlwKowU9v6K",
          "created": "2023-09-01T00:00:00.000Z",
          "expires": "2023-09-01T01:00:00.000Z",
          "type": "AUTH_APPROVED",
          "amount": {
            "amount": "100.00",
            "currency": "AUD"
          },
          "paymentEventMerchantReference": "string"
        }
      ]
    }
  ]
}

This endpoint retrieves a collection of payments along with their order details.

Connection Timeouts

Timeout	Time (Seconds)
Open	10
Read	20

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Query parameters

toCreatedDatestringOptional

An inclusive end date and time to search, in ISO 8601 format.

fromCreatedDatestringOptional

An inclusive start date and time to search, in ISO 8601 format.

tokenslist of stringsOptional

One or more order tokens to search for.

includeNextLinkbooleanOptionalDefaults to false

Returns a modified pagination object which includes a URL to return the next page. The default value is false.

idslist of stringsOptional

One or more Afterpay Order IDs to search for.

merchantReferenceslist of stringsOptional

One or more Merchant Reference IDs to search for.

statuseslist of enumsOptional

One or more Afterpay Order Statuses to search for. Possible values include "APPROVED" and "DECLINED".

Allowed values:

orderByenumOptionalDefaults to createdAt

A field to order results by. If provided, must be one of "createdAt", "id", "amount", "merchantReference" or "email".

Allowed values:

ascendingbooleanOptionalDefaults to false

true to order results in ascending order, or false for descending order.

limitintegerOptional1-250Defaults to 20

The maximum number of results to return. Must be between 1 and 250.

offsetintegerOptional>=0Defaults to 0

The number of results to skip before returning results.

Response

Returns the matching Payment objects, enclosed in a Pagination object.

totalResultsintegerOptional

Total number of results

offsetintegerOptional

The offset of the pagination

limitintegerOptional

The number of payments to include in the results

nextPageUrlstringOptional

The URL of the next page of results

resultslist of objectsOptional

Errors

422

Unprocessable Entity Error

500

Internal Server Error

Authentication

Headers

Query parameters

Response

Errors