> ## Documentation Index > Fetch the complete documentation index at: https://docs.crown-brlv.com/llms.txt > Use this file to discover all available pages before exploring further. # List Orders by State > Lists orders in the given states that reached them on the given day (America/Sao_Paulo), oldest first by when they reached them. states=completed with a date lists the orders that completed that day, so a partner can reconcile a day of orders against its own records; states=pending-payment,pending-delivery lists every order still pending. Without states, orders in every state; without a date, on any day. Covers the authenticated account and, for callers with the manage-holders capability, every one of its sub-accounts, each order carrying its account-id. Paginated: up to limit orders per page (default 50, at most 100); pass the next-cursor of a page as cursor to get the next one, until next-cursor is null. Requires API access. ## OpenAPI ````yaml GET /api/v1/orders openapi: 3.1.0 info: title: Crown API & Webhooks version: 1.0.0 description: >- Open API 3 docs for Crown API Webhook events that Crown will POST to your configured endpoint URL. All webhooks expect a 200 OK response. Payloads use kebab-case for all keys to match the Crown API conventions. servers: - url: https://app.crown-brlv.com description: Production server security: [] paths: /api/v1/orders: get: summary: List orders description: >- Lists orders in the given states that reached them on the given day (America/Sao_Paulo), oldest first by when they reached them. states=completed with a date lists the orders that completed that day, so a partner can reconcile a day of orders against its own records; states=pending-payment,pending-delivery lists every order still pending. Without states, orders in every state; without a date, on any day. Covers the authenticated account and, for callers with the manage-holders capability, every one of its sub-accounts, each order carrying its account-id. Paginated: up to limit orders per page (default 50, at most 100); pass the next-cursor of a page as cursor to get the next one, until next-cursor is null. Requires API access. parameters: - in: query name: states required: false schema: type: string pattern: >- ^(pending-payment|pending-delivery|rolling-back|completed|rolled-back|expired|payment-returned|rejected)(,(pending-payment|pending-delivery|rolling-back|completed|rolled-back|expired|payment-returned|rejected))*$ example: pending-payment,pending-delivery description: >- States to list, comma separated, out of: pending-payment, pending-delivery, rolling-back, completed, rolled-back, expired, payment-returned, rejected. Omit it for every state. - in: query name: date required: false schema: type: string format: date example: '2026-10-09' description: >- Day the orders reached their state, in America/Sao_Paulo: the day they were created while pending, the day they completed once completed, and the day of their last state change otherwise. Omit it for any day. - in: query name: cursor required: false schema: type: string pattern: >- ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,9})?Z_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ example: 2026-10-09T13:04:16.344Z_01a120c1-cf85-70e7-b319-f6194a8061c4 description: The next-cursor of the previous page. Omit it for the first page. - in: query name: limit required: false schema: type: integer format: int32 example: 50 description: Orders per page, from 1 to 100. Defaults to 50. responses: '200': description: Orders retrieved successfully content: application/json: schema: type: object properties: orders: type: array items: type: object properties: base-rate: type: string format: decimal description: Base exchange rate between assets example: '1.0000' state-updated-at: type: string example: '2024-01-15T10:30:00Z' format: date-time description: >- ISO 8601 timestamp when the order state was last updated payment-term: type: string description: >- Payment term the order's quote was priced under ('d1'). Absent for orders that must be paid today. The brcode expiration is the settlement cut-off of the next business day. example: d1 qr-code-base64: type: string description: >- Base64-encoded PNG QR code rendered from the brcode payload. fee-amount: type: string format: decimal description: Fee charged for the order. example: '0.50' expiration: type: string example: '2024-01-15T10:30:00Z' format: date-time description: ISO 8601 timestamp when the brcode expires. effective-rate: type: string format: decimal description: Effective rate including fees example: '0.9950' state: type: string enum: - pending-payment - pending-delivery - rolling-back - completed - rolled-back - expired - payment-returned - rejected description: >- Current state of the order. `pending-payment` is a `brcode` order waiting for its PIX. `pending-delivery` has been paid and its target asset is on its way. `rolling-back` is being undone. `completed` is the happy end. `rolled-back` means the order was undone for a reason other than funding. `expired` is a brcode order whose funding window closed with no payment: nothing was charged and nothing is owed. `payment-returned` is a brcode order whose PIX arrived after the window: the payment is being returned to the account it came from. `rejected` means the order could not go ahead. example: pending-payment target-asset: type: string enum: - tempo/brlv - eth-base/brlv - eth-mainnet/brlv - fiat/brl - eth-base/usdt - fiat/usd - eth-mainnet/usdt - eth-mainnet/usdc - eth-base/wbrly - eth-base/usdc - eth-base/brly description: The asset being converted to example: eth-base/brlv rate-lock: type: string description: >- Quote rate lock the order's quote was granted. Present only when a rate lock above the base validity was used. example: 10m account-id: type: string format: uuid description: >- Account the order belongs to: the caller or one of its sub-accounts example: 01a11333-d4db-70cb-8c00-baad6625fb47 id: type: string format: uuid description: Unique identifier for the created order example: 660e8400-e29b-41d4-a716-446655440001 quote-id: type: string format: uuid description: Identifier of the quote this order was created from example: 550e8400-e29b-41d4-a716-446655440000 fee-asset: type: string enum: - tempo/brlv - eth-base/brlv - eth-mainnet/brlv - fiat/brl - eth-base/usdt - fiat/usd - eth-mainnet/usdt - eth-mainnet/usdc - eth-base/wbrly - eth-base/usdc - eth-base/brly description: Asset in which the fee is denominated. example: fiat/brl source-asset: type: string enum: - tempo/brlv - eth-base/brlv - eth-mainnet/brlv - fiat/brl - eth-base/usdt - fiat/usd - eth-mainnet/usdt - eth-mainnet/usdc - eth-base/wbrly - eth-base/usdc - eth-base/brly description: The asset being converted from example: fiat/brl source-amount: type: string format: decimal description: Amount of source asset to be converted example: '100.50' completed-at: oneOf: - type: string example: '2024-01-15T10:30:00Z' format: date-time - type: 'null' description: >- ISO 8601 timestamp when the order completed. Null until it does. created-at: type: string example: '2024-01-15T10:30:00Z' format: date-time description: ISO 8601 timestamp when the order was created brcode: type: string description: >- EMV PIX copy-paste payload for the brcode (present only for source-payment-method brcode). example: 00020101021226890014br.gov.bcb.pix... target-amount: type: string format: decimal description: Amount of target asset to be received example: '99.75' additionalProperties: false required: - base-rate - state-updated-at - effective-rate - state - target-asset - account-id - id - quote-id - source-asset - source-amount - completed-at - created-at - target-amount description: >- Orders in the requested states, oldest first by when they reached them next-cursor: oneOf: - type: string - type: 'null' description: >- Pass as cursor to get the next page. Null on the last page. additionalProperties: false required: - orders - next-cursor '400': description: Bad request - Invalid input parameters content: application/json: schema: type: object properties: error: type: object properties: type: type: string message: type: string code: type: string additionalProperties: false required: - type - message - code description: Bad request error details additionalProperties: false required: - error '403': description: Forbidden - Access denied content: application/json: schema: type: object properties: error: type: object properties: type: type: string message: type: string code: type: string additionalProperties: false required: - type - message - code description: Forbidden access error details additionalProperties: false required: - error '404': description: Not found - Resource does not exist content: application/json: schema: type: object properties: error: type: object properties: type: type: string message: type: string code: type: string additionalProperties: false required: - type - message - code description: Resource not found error details additionalProperties: false required: - error '422': description: Unprocessable entity - Validation failed content: application/json: schema: type: object properties: error: type: object properties: type: type: string message: type: string code: type: string additionalProperties: false required: - type - message - code description: Validation error details additionalProperties: false required: - error ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.