List Payment(s)

curl -G https://global-api-sandbox.afterpay.com/v1/payments/environment:environment \
     -H "User-Agent: Afterpay Online API Simulator" \
     -H "Accept: application/json" \
     -H "Content-Type: application/json" \
     -u "<username>:<password>" \
     --data-urlencode toCreatedDate=2024-06-30T23:59:59Z \
     --data-urlencode fromCreatedDate=2024-06-01T00:00:00Z \
     -d limit=20 \
     -d offset=0 \
     -d tokens=ord_1234567890abcdef \
     -d ids=aporder_9876543210fedcba \
     -d merchantReferences=merchant-ref-001 \
     -d statuses=APPROVED \
     -d statuses=DECLINED \
     -d orderBy=createdAt \
     -d ascending=false

{
  "payments": [
    {
      "id": "aporder_9876543210fedcba",
      "token": "ord_1234567890abcdef",
      "merchantReference": "merchant-ref-001",
      "status": "APPROVED",
      "createdAt": "2024-06-15T12:34:56Z",
      "totalAmount": {
        "amount": 150,
        "currency": "AUD"
      },
      "orderDetails": {
        "items": [
          {
            "name": "Wireless Headphones",
            "sku": "WH-1000XM4",
            "quantity": 1,
            "price": {
              "amount": 150,
              "currency": "AUD"
            }
          }
        ],
        "customer": {
          "email": "customer@example.com",
          "firstName": "Jane",
          "lastName": "Doe"
        }
      }
    },
    {
      "id": "aporder_1234567890abcdef",
      "token": "ord_abcdef1234567890",
      "merchantReference": "merchant-ref-002",
      "status": "DECLINED",
      "createdAt": "2024-06-10T09:20:30Z",
      "totalAmount": {
        "amount": 75.5,
        "currency": "AUD"
      },
      "orderDetails": {
        "items": [
          {
            "name": "Bluetooth Speaker",
            "sku": "BS-500",
            "quantity": 1,
            "price": {
              "amount": 75.5,
              "currency": "AUD"
            }
          }
        ],
        "customer": {
          "email": "john.smith@example.com",
          "firstName": "John",
          "lastName": "Smith"
        }
      }
    }
  ],
  "pagination": {
    "limit": 20,
    "offset": 0,
    "total": 2
  }
}

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

Connection Timeouts

Timeout	Time (Seconds)
Open	10
Read	20

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)>.

Path parameters

environmentstringRequired

Use api-sandbox for AU/NZ, or api.us-sandbox for US.

Query parameters

toCreatedDatestringOptional

An inclusive end date and time to search, in [ISO 8601](http://www.iso.org/iso/home/standards/iso8601.htm) format.

fromCreatedDatestringOptional

An inclusive start date and time to search, in [ISO 8601](http://www.iso.org/iso/home/standards/iso8601.htm) format.

limitintegerOptionalDefaults to 20

The number of results to retrieve. Must be between 1 and 250 (inclusive).

offsetintegerOptionalDefaults to 0

The position to start the results at. The first result has a position of 0.

tokenslist of stringsOptional

One or more order tokens to search for.

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 stringsOptional

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

orderBystringOptionalDefaults to createdAt

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

ascendingbooleanOptionalDefaults to false

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

Response

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

Errors

422

Unprocessable Entity Error

500

Internal Server Error

Connection Timeouts

Authentication

Path parameters

Headers

Query parameters

Response

Errors

Connection Timeouts

Authentication

Path parameters

Headers

Query parameters

Response

Errors