Get executed orders report

curl -G https://api-sandbox.koywe.com/api/v1/organizations/org3_8821b7b4-7f0c-45d9-aa5f-a9ce41ee2f1e/merchants/mrc_2e8f96ab-dbd5-45f9-b4b6-645945daf340/accounts/acc_0031c537-2301-40ab-9153-0f7c48505350/reports/orders \
     -H "Authorization: Bearer <token>" \
     -d from=2025-01-01 \
     -d to=2025-01-31

{
  "accountId": "acc_abc123",
  "currency": "CLP",
  "periodStart": "2025-01-01T00:00:00Z",
  "periodEnd": "2025-01-31T23:59:59Z",
  "orders": [
    {
      "orderId": "ord_abc123",
      "type": "PAYIN",
      "status": "DRAFT",
      "amountIn": "1000000.00",
      "amountOut": "1000.00",
      "originCurrency": "CLP",
      "destinationCurrency": "USD",
      "createdAt": "2025-01-15T10:30:00Z",
      "counterparty": {
        "name": "Juan Pérez",
        "identifier": "12345678-9"
      },
      "completedAt": "2025-01-15T10:35:00Z",
      "externalId": "INV-2025-001"
    }
  ],
  "summary": {
    "totalOrders": 150,
    "byType": {
      "PAYIN": 100,
      "PAYOUT": 50
    },
    "byStatus": {
      "COMPLETED": 140,
      "PENDING": 10
    }
  },
  "pagination": {
    "hasMore": true,
    "limit": 50,
    "cursor": "cursor"
  },
  "generatedAt": "2025-01-31T12:00:00Z"
}

Retrieves a report of all orders associated with the specified account within the date range.

Features:

Lists all orders (PAYINs, PAYOUTs, transfers, etc.) for the account
Includes order type, status, amounts, currencies
Counterparty information when available
Summary statistics by type and status

Filters:

Filter by order type (PAYIN, PAYOUT, BALANCE_TRANSFER, etc.)
Filter by order status (COMPLETED, PENDING, FAILED, etc.)

Note: This report shows orders/deals, not ledger movements. For balance reconciliation, use the ledger-statement endpoint.

Example: GET /v1/organizations/org3_xxx/merchants/mrc_xxx/accounts/acc_xxx/reports/orders?from=2025-01-01&to=2025-01-31&type=PAYIN&status=COMPLETED

Retrieves a report of all orders associated with the specified account within the date range. **Features:** - Lists all orders (PAYINs, PAYOUTs, transfers, etc.) for the account - Includes order type, status, amounts, currencies - Counterparty information when available - Summary statistics by type and status **Filters:** - Filter by order type (PAYIN, PAYOUT, BALANCE_TRANSFER, etc.) - Filter by order status (COMPLETED, PENDING, FAILED, etc.) **Note:** This report shows orders/deals, not ledger movements. For balance reconciliation, use the ledger-statement endpoint. **Example:** `GET /v1/organizations/org3_xxx/merchants/mrc_xxx/accounts/acc_xxx/reports/orders?from=2025-01-01&to=2025-01-31&type=PAYIN&status=COMPLETED`

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

organizationIdstringRequired

Organization ID

merchantIdstringRequired

Merchant ID

accountIdstringRequired

Virtual account ID

Query parameters

fromstringRequired

Start date (YYYY-MM-DD)

tostringRequired

End date (YYYY-MM-DD)

typeenumOptional

Filter by order type

statusenumOptional

Filter by order status

cursorstringOptional

Cursor for pagination (from previous response)

limitdoubleOptional1-100Defaults to 50

Number of items per page

Response

Orders report generated successfully

accountIdstring

Virtual account ID

currencystring

Currency of the account

periodStartdatetime

Start of the reporting period

periodEnddatetime

End of the reporting period

orderslist of objects

List of orders in chronological order

summaryobject

Summary statistics for the report

paginationobject

Pagination information

generatedAtdatetime

Timestamp when this report was generated

Errors