Parrot External API
  1. Endpoints
Parrot External API
  • Home
  • Changelog
  • Authentication and Usage
  • Endpoints
    • Inventory Management
      • List Suppliers
      • List Supplies
    • Orders
      • List Orders
      • V1 - List Order Items
      • V2 - List Order Items
      • List Product Types
    • Discounts
      • List Discounts
      • List Discount Usages
    • List All Stores
      GET
    • List Order Invoices
      GET
    • List Order Payments
      GET
    • List Cashier Sessions
      GET
    • List Store Users
      GET
  1. Endpoints

List Order Payments

GET
/v1/order-payments
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.

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Query Params
startTimestamp
string 
required
Example:
2024-03-27T19:00:00-06:00
endTimestamp
string 
required
Example:
2024-03-28T19:00:00-06:00
pageSize
integer 
optional
Example:
3
page
string 
optional
Example:
0
storeUUID
array[string]
optional
Example:
["a2f09385-7f1b-436c-9baa-bb9cf1174c25"]

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/v1/order-payments?startTimestamp=2024-03-27T19:00:00-06:00&endTimestamp=2024-03-28T19:00:00-06:00&pageSize=3&page=0&storeUUID=a2f09385-7f1b-436c-9baa-bb9cf1174c25'

Responses

🟢200OK
application/json
Body
pagination
object 
required
next
null 
required
previous
null 
required
count
integer 
required
current
integer 
required
pageSize
integer 
required
data
array [object {15}] 
required
uuid
string 
required
createdAt
string 
required
storeUuid
string 
required
status
string 
required
orderReference
string 
required
orderUuid
string 
required
userId
integer 
required
createdByUserUuid
string 
required
brandName
string 
required
brandUuid
string 
required
paymentTypeName
string 
required
paymentTypeUuid
string 
required
tip
integer 
required
amount
integer 
required
total
integer 
required
datetime
string 
required
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"
}
Modified at 2025-07-01 17:39:19
Previous
List Order Invoices
Next
List Cashier Sessions
Built with