Postman collection - link to postman collection (imported from swagger (latest version v3))

Transaction Request

{
  "Tpn": "z11table02",
  "clerk_id": null,
  "table_num": null,
  "ticket_num": null,
  "guest_num": null,
  "Key": null,
  "RegisterId": "3636099",
  "AuthKey": "zbhRAW9N6x",
  "get_list": true,
  "server_num": null,
  "invoice_num": null,
  "Login": null
}
{
  "Tpn": "z11table02",
  "CalledUrl": "http://test.dvmms.com/denovoInventory/api/v3/TableApp/1095",
  "CalledMethod": "/RequestTransaction",
  "RequestType": "POST",
  "ResponseCode": 200,
  "ResponseText": "OK",
  "DateTime": "2023-09-29T12:47:56.436696Z"
}

 REQUEST FIELD DESCRIPTION

Value

Type

Comments

tpn

string

TPN

Clerk_id

int

Value of prompt “Clerk”. Not mandatory (unused) field  for AURA. Now it is server_num

Table_num

int

Value of prompt “Table”  

Ticket_num

int

Value of prompt “Ticket”. Not mandatory (unused) field  for AURA. Now it is  invoice_num

Guest_num

int

Value of prompt “Guest”  

Key

string

Not mandatory(unused) field

RegisterId

string

CashRegister ID on Proxy

AuthKey

string

Proxy AuthKey

get_list

boolean

True - Value of prompt “All”

False - Value of prompt “Server”, “Table”, “Invoice”

server_num

int

Server ID

invoice_num

int

Invoice ID

Login

 

 

Select (Invoice list) 

https://test.spinpos.net/spin/swagger/ui/index#!/Register/Register_SelectInvoice

JSON Request

{
  "Title": "Invoices for payment",
  "InvoiceList": [
    {
      "Id": "07075b86-f82b-4f93-9c85-6f70218e3fdc",
      "Name": "87-2 (sdfsf)",
      "Amount": 10687,
      "Type": "Open"
    },
    {
      "Id": "77f30401-d3f1-4a9b-9f08-deaa19aaa764",
      "Name": "87-5 (Table 15)",
      "Amount": 1091,
      "Type": "Open"
    },
    {
      "Id": "e53fc3b9-e470-4273-bf01-631d2492bf98",
      "Name": "2 (Table 5)",
      "Amount": 20452,
      "Type": "Open"
    },
    {
      "Id": "fd331f70-82b8-4316-902e-134ee5fa0a0f",
      "Name": "1 (Table 4)",
      "Amount": 0,
      "Type": "Open"
    }
  ],
  "Tpn": "z11table02",
  "Authkey": "zbhRAW9N6x"
}

JSON Response

{
  "SelectedInvoiceId": "77f30401-d3f1-4a9b-9f08-deaa19aaa764",
  "GeneralResponse": {
    "Message": "Selected"
  }
}
 REQUEST FIELD DESCRIPTION

Value

Type

Comments

Title

string, optional

Title

InvoiceList

Id

string

Unique order ID

Name

string, optional

Name of order

Amount

int

Amount you need to pay for the order

Type

string

Possible values: ['Open', 'Incomplete', 'Closed']

Tpn

string

TPN

Authkey

string, optional

Proxy AuthKey

SPInProxyTimeout

int, optional

SPIn Timeout

CustomFields

optional

Additional fields that you can to use in your request

Pay (Invoice data)

https://test.spinpos.net/spin/swagger/ui/index#!/Register/Register_PaymentInvoice

JSON Request

{
  "ReferenceId": "77f30401-d3f1-4a9b-9f08-deaa19aaa764",
  "InvoiceData": {
    "Id": "77f30401-d3f1-4a9b-9f08-deaa19aaa764",
    "Name": "87-5",
    "TotalAmount": 1091,
    "PaidAmount": 0,
    "Goods": [
      {
        "Name": "Cash",
        "Amount": 1090,
        "Quantity": 1
      },
      {
        "Name": "--Opt1",
        "Amount": 210,
        "Quantity": 1
      },
      {
        "Name": "--Opt1",
        "Amount": 420,
        "Quantity": 1
      }
    ],
    "Payments": []
  },
  "Tpn": "z11table02",
  "Authkey": "zbhRAW9N6x"
}

JSON Response

{
  "GeneralResponse": {
    "Message": "OK"
  }
}
 REQUEST FIELD DESCRIPTION

Value

Type

Comments

InvoiceData

Id

string, optional

Unique order ID

Name

string, optional

Name of order

TotalAmount

int

Amount you need to pay for the order

PaidAmount

int

Amount you have already paid

Goods

Name

string, optional

Item name

Amount

int, optional

Amount you need to pay for item

Quantity

int, optional

Item quantity

InvoicePayment

ReferenceId

string, optional

Reference id for performed payment

Name

string, optional

Name of payment type

Amount

int, optional

Amount you paid

TipAmount

int, optional

Tip amount that was added to payment

Tpn

string

TPN

Authkey

string, optional

Proxy AuthKey

SPInProxyTimeout

int, optional

SPIn Timeout

CustomFields

optional

Additional fields that you can to use in your request

Invoice data

JSON Request

{
  "Trans": [
    {
      "PaymType": "Credit",
      "TransType": "Sale",
      "InvNum": "77f30401-d3f1-4a9b-9f08-deaa19aaa764",
      "RefId": "inv230929160452",
      "Amount": "1091",
      "Tip": "0",
      "Untipped": "false",
      "BatchNum": "19",
      "CardType": "VISA",
      "CardholderName": "YOU%2fA%20GIFT%20FOR",
      "AcntLast4": "2827",
      "AuthCode": "TAS083"
    }
  ],
  "Status": "OK",
  "RefId": "77f30401-d3f1-4a9b-9f08-deaa19aaa764",
  "RegId": "3636099",
  "AuthKey": "zbhRAW9N6x",
  "Tpn": "z11table02"
}

XML Response

{
  "Tpn": "z11table02",
  "CalledUrl": "http://test.dvmms.com/denovoInventory/api/v3/TableApp/1095",
  "CalledMethod": "/InvoiceData",
  "RequestType": "POST",
  "ResponseCode": 202,
  "ResponseText": "Accepted",
  "DateTime": "2023-09-29T12:48:31.3385165Z"
}

Status

https://test.spinpos.net/spin/swagger/ui/index#!/Register/Register_Status

JSON Requiest

{
  "PaymentType": "Credit",
  "ReferenceId": "inv230929160452",
  "PrintReceipt": "No",
  "GetReceipt": "Both",
  "CaptureSignature": true,
  "Tpn": "z11table02",
  "Authkey": "zbhRAW9N6x"
}

JSON Response

{
  "GeneralResponse": {
    "HostResponseCode": "00",
    "HostResponseMessage": "APPROVAL-Approved and Completed",
    "ResultCode": "0",
    "Message": "Approved",
    "DetailedMessage": "APPROVAL TAS083"
  },
  "PaymentType": "Credit",
  "TransactionType": "Sale",
  "Amounts": {
    "TotalAmount": 10.91,
    "Amount": 10.91,
    "TipAmount": 0.0,
    "FeeAmount": 0.0,
    "TaxAmount": 0.0
  },
  "AuthCode": "TAS083",
  "ReferenceId": "inv230929160452",
  "InvoiceNumber": "2",
  "SerialNumber": "WP20021Q20049804",
  "BatchNumber": "19",
  "TransactionNumber": "2",
  "Voided": false,
  "Signature": "iVBORw0KGgoAAAANSUhEUgAAAQ4AAAAvAQMAAAAo+LbBAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAGUExURQAAAP///6XZn90AAAAJcEhZcwAADsMAAA7DAcdvqGQAAAD7SURBVDjLjdRBEoMgDAXQOC669AgexaPJrtey04vgDVi6YEhRGCRM8Ndt3+Bv8oUmBo+nERPCZFsgcRMkfoCEaYVkmyE5XpCEARI2KyR2huSYIAkjJGwweV7TRZ7XdBE/QsKEiQhjmmSJ1GE8NZNMpO6M00ndGTM3/y+TuzOBuClHJndn3Mhv9UWlMyEm+aqkdMbEVB2SO2PPj3PXT0lh4re5dkkKY6+ZOJ2kMHSd1SNnmCNPQNa9kBhmS4d0SSBLlHbs5aoLiROhPL8useVKC3KPN/FlTUHu0WudlFVWyYch2TFxf5AFEnlvqcSLG1IlTPLRiMUkVL8T/QD1gr8g1kYiWwAAAABJRU5ErkJggg==",
  "CardData": {
    "CardType": "VISA",
    "EntryType": "Swipe",
    "Last4": "2827",
    "First4": "4847",
    "BIN": "484735",
    "Name": "YOU/A GIFT FOR"
  },
  "EMVData": {},
  "Receipts": {
    "Customer": "<IMG src=\"\"/><BR/><BR/><L>09/29/2023</L><R>16:04</R><BR/><BR/><LG><C>Sale</C></LG><BR/><BR/><LG><L>Trans #: 2</L><R>Batch #: 19</R></LG><BR/><BR/><L>CREDIT CARD</L><BR/><L>VISA</L><R>MAG STRIPE</R><BR/><L>************2827</L><R>**/**</R><BR/><L>Reference Id:</L><R>inv230929160452</R><BR/><BR/><BR/><LG><L>AMOUNT:</L><R>USD $10.91</R></LG><BR/><BR/><BR/><BR/><LG><L>TIP AMT:</L><R>$_____.__</R></LG><BR/><BR/><LG><L>TOTAL AMT:</L><R>USD $_____.__</R></LG><BR/><BR/><BR/><B><C>Tip Suggestions</C></B><BR/><BR/><L>Percent Tip</L><R>Total</R><BR/><L>10%     $1.09</L><R>12.00</R><BR/><L>15%     $1.63</L><R>12.54</R><BR/><L>20%     $2.18</L><R>13.09</R><BR/><BR/><BR/><BR/><L>Resp:</L><R>APPROVAL TAS083</R><BR/><L>Code:</L><R>TAS083</R><BR/><L>Ref #:</L><R>327212502875</R><BR/><L>TransID:</L><R>000000000330938</R><BR/><BR/><BR/><BR/><B><C>CUSTOMER COPY</C></B><BR/><BR/><BR/><BR/><BR/><BR/>",
    "Merchant": "<IMG src=\"\"/><BR/><BR/><L>09/29/2023</L><R>16:04</R><BR/><BR/><LG><C>Sale</C></LG><BR/><BR/><LG><L>Trans #: 2</L><R>Batch #: 19</R></LG><BR/><BR/><L>CREDIT CARD</L><BR/><L>VISA</L><R>MAG STRIPE</R><BR/><L>************2827</L><R>**/**</R><BR/><L>Reference Id:</L><R>inv230929160452</R><BR/><BR/><BR/><LG><L>AMOUNT:</L><R>USD $10.91</R></LG><BR/><BR/><BR/><BR/><LG><L>TIP AMT:</L><R>$_____.__</R></LG><BR/><BR/><LG><L>TOTAL AMT:</L><R>USD $_____.__</R></LG><BR/><BR/><BR/><B><C>Tip Suggestions</C></B><BR/><BR/><L>Percent Tip</L><R>Total</R><BR/><L>10%     $1.09</L><R>12.00</R><BR/><L>15%     $1.63</L><R>12.54</R><BR/><L>20%     $2.18</L><R>13.09</R><BR/><BR/><BR/><BR/><L>Resp:</L><R>APPROVAL TAS083</R><BR/><L>Code:</L><R>TAS083</R><BR/><L>Ref #:</L><R>327212502875</R><BR/><L>TransID:</L><R>000000000330938</R><BR/><BR/><BR/><C>Cardholder acknowledges</C><BR/><C>receipt of goods and</C><BR/><C>obligations set forth</C><BR/><C>by the cardholder&apos;s</C><BR/><C>agreement with issuer.</C><BR/><BR/><IMG src=\"sig-sig-20230929-160456-bt19tr2.bmp\"/><BR/><BR/><C>X____________________</C><BR/><C>YOU/A GIFT FOR</C><BR/><BR/><B><C>MERCHANT COPY</C></B><BR/><BR/><BR/><BR/><BR/><BR/>"
  }
}