List Order Payments - Parrot External API

This endpoint retrieves order payments within a specified time range, with pagination support.

It includes details such as the payment status, order id, payment type, amount, tip, and total cost. The response also includes pagination metadata.

Note: startTimestamp and endTimestamp must be at most 48 hours apart.

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Body

Example

{
    "pagination": {
        "next": null,
        "previous": null,
        "count": 1,
        "current": 0,
        "pageSize": 10
    },
    "data": [
        {
            "uuid": "5c4a30da-ec63-4f45-adf5-88f956c51550",
            "createdAt": "2024-07-21T17:19:26Z",
            "storeUuid": "dd68ea6f-c87c-438a-abe6-4df2ad6a8b46",
            "status": "CHARGED",
            "orderReference": "210724-P-0002",
            "orderUuid": "93fb7f3b-2c0b-40c5-8ea9-0ce0ae30a7db",
            "userId": 14386,
            "createdByUserUuid": "b74d8b20-ef33-4046-94b3-ca7b4b623e54",
            "brandName": "Parrot Cafe",
            "brandUuid": "19041084-3910-406f-bf03-bf6a83d9badf",
            "paymentTypeName": "Efectivo",
            "paymentTypeUuid": "e80b0749-ea91-426e-bc86-c5073f29bc02",
            "tip": 0.00,
            "amount": 173.00,
            "total": 173.00
        },
        {
            "uuid": "69740213-0156-4496-87d3-b6d063d961fc",
            "createdAt": "2024-07-21T18:49:08Z",
            "storeUuid": "dd68ea6f-c87c-438a-abe6-4df2ad6a8b46",
            "status": "CHARGED",
            "orderReference": "210724-P-0003",
            "orderUuid": "f44c0d45-e2cf-4eae-9316-dd1c9340e99b",
            "userId": 14386,
            "createdByUserUuid": "b74d8b20-ef33-4046-94b3-ca7b4b623e54",
            "brandName": "Parrot Cafe",
            "brandUuid": "19041084-3910-406f-bf03-bf6a83d9badf",
            "paymentTypeName": "Efectivo",
            "paymentTypeUuid": "e80b0749-ea91-426e-bc86-c5073f29bc02",
            "tip": 0.00,
            "amount": 55.00,
            "total": 55.00
        }
    ],
    "datetime": "2025-05-12T17:13:54-06:00"
}