Skip to main content

invoice

Create Invoice​

POST /merchant-integrations/create-invoice

You can allow your users, staff or customers to send you invoices using this endpoint, it will enable you generate vouchers for them easily, allowing them redeem it to their desired accounts.

Request Body​

{
  "blockchainNetworkId": "string",
  "currencyId": "string",
  "dueDate": "string",
  "invoiceDate": "string",
  "invoiceItems": [
    {
      "description": "string",
      "quantity": 0,
      "unitPrice": 0
    }
  ],
  "merchantUserId": "string"
}

Response​

{
  "code": 0,
  "message": "string",
  "status": "string"
}

Fetch Invoices​

GET /merchant-integrations/fetch-invoices

Retrieve a paginated list of customers invoices.

Query Parameters​

  • page: Page number (default: 1)
  • limit: Items per page (default: 10)
  • filter: paid, pending, rejected

Response​

{
  "code": 0,
  "data": {
    "invoices": [
      {
        "blockchainNetwork": {
          "blockExplorerUrl": "string",
          "chainID": "string",
          "id": "string",
          "networkName": "string"
        },
        "createdAt": "string",
        "currency": {
          "abbrev": "string",
          "currencyType": "string",
          "id": "string",
          "image": "string",
          "isActive": true,
          "name": "string",
          "symbol": "string"
        },
        "dueDate": "string",
        "id": "string",
        "invoiceDate": "string",
        "invoiceItems": [
          {
            "createdAt": "string",
            "description": "string",
            "id": "string",
            "quantity": 0,
            "totalPrice": 0,
            "unitPrice": 0,
            "updatedAt": "string"
          }
        ],
        "invoiceNumber": "string",
        "merchantUser": {
          "email": "string",
          "id": "string",
          "name": "string"
        },
        "status": "string",
        "totalAmount": 0,
        "updatedAt": "string",
        "userId": "string"
      }
    ],
    "total": 0
  },
  "message": "string",
  "status": "string"
}