An invoice represents a payment on the Dots platform. Creating an invoice generates a link that the payer can be redirected to complete the payment and collect any information, such as a shipping address.

​
Invoice Object

Example
{
  "id": "8f246ca0-4ade-4296-bab4-5a6d37d9af10",
  "payer": {
    "first_name": "Steve",
    "last_name": "Pearseed",
    "username": "steve",
    "wallet": {
      "amount": 2500.0
    }
  },
  "api_app": {
    "id": "b7a00ae2-e638-4d66-9d46-adf38d810cde",
    "name": "Zappy",
    "user_id": 2
  },
  "amount": 800,
  "expiry": "2020-12-09T00:40:51.107Z",
  "status": "created",
  "link": "https://www.senddots.com/invoice/8f246ca0-4ade-4296-bab4-5a6d37d9af10",
  "items": [
    {
      "name": "Pikachu Digital Pet",
      "unit_amount": 250,
      "quantity": 1,
      "description": "A little Pikachu for your desktop"
    },
    {
      "name": "Charmander Digital Pet",
      "unit_amount": 225,
      "quantity": 2,
      "description": "A ferocius Charmander for your desktop"
    }
  ],
  "breakdown": {
    "items_total": 700,
    "tax": 100,
    "shipping": 0
  },
  "requested_information": {
    "shipping_address": null
  },
  "metadata": {}
}

​
Attributes

NameTypeDescription
idstring (uuid)UUID id of the invoice
payer.first_namestringFirst name of the payer
payer.last_namestringLast name of the payer
payer.usernamestringUsername of the payer
payer.walletobjectThe wallet of payer
payer.wallet.amountfloatThe amount of balance in cents
expirystring (date-time)Datetime when the invoice will expire
statusstringStatus of the invoive (created, completed, expired)
linkstring (uri)Link to redirect the customer to pay
itemslist[object]List of item objects
item.namestringName of the item
item.unit_amountintegerCost of 1 unit of the item
item.quantityintegerQuantity of this item
item.descriptionstringDescription of the item
breakdownobjectBreakdown of the total amount
breakdown.items_totalintegerTotal of the items (unit_amount * quantity)
breakdown.shippingintegerCost of shipping
breakdown.taxintegerTax
amountfloatTotal amount to charge the customer (sum of all breakdown fields)
requested_informationlist[string]Information requested from the user that will populate on completion of transaction, (shipping_address)