Offer all the payment features your
customers want with a fast integration
that limits your PCI scope.



  • Production Server

    For processing live transactions

  • Test Server

    For development

Most Commonly Referred to Articles

POST /invoices

Create a new invoice and send an email to the customer.

required name format description
* amountBase Money, Format: X.XX
Correct: 1000.00 or 1000
Error: $1000 or 1,000.00 or 1000.000
Base amount to charge
  attachmentId Valid file ID File to attach to the invoice email
* customerEmail Max Length 255 Email of the customer the Invoice will be sent to
  customerFirstName Max Length 16 The customer's first name
  customerIdentifier Max Length 64 Customer ID, if you have your own customer ID you would like to associate with the invoice
  customerLastName Max Length 32 The customer's last name
  invoiceNumber Max Length 32 An invoice number
  message Max Length 2048 Message to the customer, displayed in the email
  notificationType "EMAIL" or "NONE" Determines whether an email notification is sent to the customer. Defaults to "EMAIL".
* terminalId Valid Terminal ID The terminal on which to process the transaction when the invoice is paid
To attach a PDF file to the Invoice you must first save it to the Invoice system using POST /invoices/files
Invoices can be voided and reopened after creation but they cannot be edited. If an Invoice must be corrected, the original must be voided and a new Invoice created.

Example Request

curl -X POST \
  -u "login:password" \
  -H "Accept: application/json" \
  -H "X-PJ-Application-Key: YOUR_PRODUCTION_APP_KEY" \
  -d amountBase=1.99 \
  -d \
  -d customerFirstName=John \
  -d customerLastName=Doe \
  -d invoiceNumber="TO-123456" \
  -d message="Invoice for takeout order #123456" \
  -d terminalId=1

Example Response

  "amountBase" : "1.99",
  "created" : "2020-11-24T01:19:23Z",
  "customerEmail" : "",
  "customerFirstName" : "John",
  "customerIdentifier" : "customer-id",
  "customerLastName" : "Doe",
  "hostedInvoiceUrl" : ""
  "invoiceId" : "e321790e-c030-4501-aa99-09e35158c1a6",
  "invoiceNumber" : "TO-123456",
  "lastModified" : "2020-11-24T01:19:23Z",
  "message" : "Invoice for takeout order #123456",
  "status" : "OPEN",
  "terminalId" : 1