Get Orders¶

Overview¶

Use the GetOrders endpoint to retrieve a list of orders for your partner integration. You can optionally filter orders by status.

Endpoint¶

POST https://api.brij.fi/brij.core.v1.partner.Service/GetOrders

Request Body¶

{
  "status": "AWAITING_FUNDS"
}

Or to get all orders:

{}

Request Parameters¶

Field	Type	Required	Description
`status`	string	No	Filter by order status (see Order Statuses)

Response¶

{
  "orders": [
    {
      "id": "order_abc123",
      "customerId": "cust_xyz789",
      "externalId": "ext_123",
      "partnerId": "partner_456",
      "status": "AWAITING_FUNDS",
      "sourceCurrency": "USD",
      "sourceAmount": "100.00",
      "destinationCurrency": "SOLANA_SOL",
      "destinationAmount": "1.5234",
      "transactionType": "ONRAMP",
      "network": "SOLANA",
      "paymentMethod": "USA_ACH",
      "createdAt": "2025-01-15T10:30:00Z",
      "updatedAt": "2025-01-15T10:30:00Z"
    }
  ],
  "totalCount": 1
}

Response Parameters¶

Field	Type	Description
`orders`	array	List of orders
`totalCount`	integer	Total number of matching orders

Order Object¶

See Order Object for the full structure.

Error Responses¶

Status Code	Description
`400`	Invalid request parameters
`401`	Invalid or missing API key
`404`	Partner not found
`500`	Internal server error

Examples¶

Example 1: Get All Orders¶

Retrieve all orders:

{}

Example 2: Get Orders by Status¶

Retrieve only orders awaiting funds:

{
  "status": "AWAITING_FUNDS"
}