Data Models

CreateInvoiceRequest

{
  "client": {
    "name": "string",
    "email": "string",
    "phone": "string",
    "referenceID": "string",
    "cryptoAddress": "string"
  },
  "amount": 23.1,
  "description": "string",
  "partialPaymentsEnabled": false,
  "tippingEnabled": true,
  "btcOnly": false,
  "dueDate": "2026-03-01T00:00:00.000Z"
}

Invoice (Status/List Item)

{
  "id": "66da1bc34f03a871430c1a71",
  "client": {
    "name": "Optional Customer Name",
    "email": "[email protected]",
    "phone": "[phone]",
    "referenceID": "order-10001"
  },
  "paidAmount": 0.1,
  "subTotal": 0.1,
  "total": 0.1,
  "partialPaymentsEnabled": false,
  "tippingEnabled": true,
  "currency": "USDC",
  "completed": true,
  "description": "Optional Order Description",
  "transactions": [
    {
      "tx": "0xd1c7fe2821a9df5240f3d31e570a760322fa979f84c0655a8f9f857023e7064f",
      "sender": "0x2F67f1426f33E25A920F0b2139cd460fDfb8997C",
      "amount": 0.1,
      "cryptoAmount": 100000,
      "timestamp": "2024-09-05T21:00:27.000Z",
      "network": "MATIC_POLYGON"
    }
  ],
  "createdAt": "2024-09-05T20:59:47.429Z",
  "merchant": {
    "name": "Business Name",
    "initiator": "POS API Key Name"
  }
}

Transaction

{
  "tx": "0xd1c7fe2821a9df5240f3d31e570a760322fa979f84c0655a8f9f857023e7064f",
  "sender": "0x2F67f1426f33E25A920F0b2139cd460fDfb8997C",
  "amount": 0.1,
  "cryptoAmount": 100000,
  "timestamp": "2024-09-05T21:00:27.000Z",
  "network": "MATIC_POLYGON"
}

CallbackEnvelope

{
  "signature": "hex_sha256",
  "data": {
    "id": "66da1bc34f03a871430c1a71",
    "completed": true,
    "paidAmount": 0.1,
    "transactions": []
  }
}

Notes

• list-txs currently omits tippingEnabled from projected results.

• status/{id} includes tippingEnabled.

• client.cryptoAddress is accepted on create request validation but is not currently projected in status/list responses.