Fetch the orders list of a project for the current user

GET /users/{user_id}/projects/{project_id}/orders

Fetch the orders list of a project for the current user.

Path parameters

  • user_id string Required

    User id

  • project_id string Required

    Project id

Query parameters

  • status string

    Filter orders by status. Values: open, paid, settled, cancelled

  • distributable boolean

    Filter orders ready to be distributable

  • updated_at string

    Filter orders that has been updated from a specific date

  • order_code string

    Filter orders by its order_code

Responses

  • 200

    The orders list of the project

    Hide response attributes Show response attributes array[object]
    • id string(uuid)
    • amount number(float)
    • cancelled_at string(datetime) | null
    • currency string
    • sender_iban string | null
    • user_id string(uuid)
    • created_at string(datetime)
    • updated_at string(datetime)
    • project_code string
    • disposable_capital boolean | null
    • suitable_income boolean | null
    • order_code string
    • status object
      Hide status attributes Show status attributes object
      • id string(uuid)
      • order_id string(uuid)
      • title string
      • reason string | null
    • payment_details object
      Hide payment_details attributes Show payment_details attributes object
      • account_name string
      • bank_name string
      • bic string
      • iban string
      • reference_code string
    • wallet_address string | null
    • external_metadata object(json)
GET /users/{user_id}/projects/{project_id}/orders
curl \
 -X GET https://client-subdomain.bitbond.net/api/v1/users/{user_id}/projects/{project_id}/orders
Response examples (200)
[
  {
    "id": "string",
    "amount": 42.0,
    "cancelled_at": "string",
    "currency": "string",
    "sender_iban": "string",
    "user_id": "string",
    "created_at": "string",
    "updated_at": "string",
    "project_code": "string",
    "disposable_capital": true,
    "suitable_income": true,
    "order_code": "string",
    "status": {
      "id": "string",
      "order_id": "string",
      "title": "string",
      "reason": "string"
    },
    "payment_details": {
      "account_name": "string",
      "bank_name": "string",
      "bic": "string",
      "iban": "string",
      "reference_code": "string"
    },
    "wallet_address": "string",
    "external_metadata": {}
  }
]
Response examples (200)
[
  {
    "id": "string",
    "amount": 42.0,
    "cancelled_at": "string",
    "currency": "string",
    "sender_iban": "string",
    "user_id": "string",
    "created_at": "string",
    "updated_at": "string",
    "project_code": "string",
    "disposable_capital": true,
    "suitable_income": true,
    "order_code": "string",
    "status": {
      "id": "string",
      "order_id": "string",
      "title": "string",
      "reason": "string"
    },
    "payment_details": {
      "account_name": "string",
      "bank_name": "string",
      "bic": "string",
      "iban": "string",
      "reference_code": "string"
    },
    "wallet_address": "string",
    "external_metadata": {}
  }
]