Get a list of orders

1 import requests 2 3 url = "https://api.koywe.com/api/v1/organizations/organizationId/merchants/merchantId/orders" 4 5 querystring = {"pageSize":"10","pageNumber":"1","sort":"createdAt:desc","includeResolvedPaymentLinks":"false"} 6 7 headers = {"Authorization": "Bearer <token>"} 8 9 response = requests.get(url, headers=headers, params=querystring) 10 11 print(response.json())

1 { 2 "pagination": { 3 "current": 1, 4 "next": 1.1, 5 "previous": 1.1, 6 "totalPages": 1, 7 "totalCount": 1, 8 "pageSize": "pageSize", 9 "sort": "sort" 10 }, 11 "orders": [ 12 { 13 "id": "ord_123456789", 14 "type": "PAYIN", 15 "destinationAccountId": "bank-account-123", 16 "originCurrencySymbol": "COP", 17 "destinationCurrencySymbol": "COP", 18 "amountIn": 1000000, 19 "amountOut": 900000, 20 "dueDate": "2026-01-28T12:36:55.523694Z", 21 "description": "Payment for invoice #1234", 22 "externalId": "payin-ext-001", 23 "paymentMethods": [ 24 { 25 "method": "PSE", 26 "extra": { 27 "bankAccount": { 28 "name": "BANCOLOMBIA" 29 }, 30 "phone": { 31 "countryCode": "+57", 32 "number": "3178901234" 33 }, 34 "email": "email" 35 } 36 } 37 ], 38 "quoteId": "quote-123", 39 "contactId": "contact-123", 40 "enforcedDocument": "45676946", 41 "sendEmail": true, 42 "sendNotification": true, 43 "sendWhatsapp": true, 44 "sendReminders": true, 45 "providedAction": "https://checkout.row.com/order/123456789", 46 "providedActionType": "QR", 47 "createdAt": "2025-06-13T22:54:54.363Z", 48 "status": "DRAFT" 49 } 50 ] 51 }

Retrieves a paginated list of orders for the specified merchant with optional filtering by status, type, date range, and currency.

Path parameters

merchantIdstringRequired

Merchant ID

organizationIdstringRequired

Organization ID

Query parameters

statusenumOptional

Filter by order status

Allowed values:

typeenumOptional

Filter by order type

startDatedatetimeOptional

Filter orders created on or after this date (ISO 8601 format)

endDatedatetimeOptional

Filter orders created on or before this date (ISO 8601 format)

currencyIdstringOptional

Filter by currency ID

pageSizedoubleOptionalDefaults to 10

Number of items per page

pageNumberdoubleOptionalDefaults to 1

Page number to retrieve

sortstringOptional

Sort order (e.g., “createdAt:desc”)

includeResolvedPaymentLinksbooleanOptionalDefaults to false

Whether to include resolved payment link URLs

Response

Orders retrieved successfully

paginationobject

orderslist of objects

Get a list of orders

Path parameters

Headers

Query parameters

Response

Errors