REST API
Sale
POST/v2/Payment/Sale

Sale is the most common request that user to do payment on a terminal.All the responses have GeneralResponse section that informs about successful result or error. See Error Codes and Messages.

Body Parameters

Amount*
number
TipAmount
number
ExternalReceipt
string
CustomFee
number
Cart
object
PaymentType*
enum
ReferenceId*
string
PrintReceipt
enum
GetReceipt
enum
MerchantNumber
number
InvoiceNumber
string
CaptureSignature
boolean
GetExtendedData
boolean
IsReadyForIS
boolean
CallbackInfo
object
ReconId
string
IsvId
string
Tpn
string
RegisterId
string
Authkey
string
SPInProxyTimeout
number
CustomFields
object
POST/v2/Payment/Sale
1curl --location 'https://test.spinpos.net/v2/Payment/Sale' \
2--header 'Content-Type: application/json' \
3--data '{
4 "Amount": 25,
5 "TipAmount": 2.5,
6 "ExternalReceipt": "",
7 "CustomFee": "",
8 "Cart": {
9 "Amounts": [
10 {
11 "Name": "",
12 "Value": ""
13 }
14 ],
15 "CashPrices": [
16 {
17 "Name": "",
18 "Value": ""
19 }
20 ],
21 "Items": [
22 {
23 "Name": "",
24 "Price": "",
25 "UnitPrice": "",
26 "Quantity": "",
27 "AdditionalInfo": "",
28 "CustomInfos": [
29 {
30 "Name": "",
31 "Value": ""
32 }
33 ],
34 "Modifiers": [
35 {
36 "Name": "",
37 "Options": [
38 {
39 "Name": "",
40 "Price": "",
41 "Quantity": ""
42 }
43 ]
44 }
45 ]
46 }
47 ]
48 },
49 "PaymentType": "Credit",
50 "ReferenceId": "111",
51 "PrintReceipt": "No",
52 "GetReceipt": "No",
53 "MerchantNumber": "",
54 "InvoiceNumber": "",
55 "CaptureSignature": false,
56 "GetExtendedData": true,
57 "IsReadyForIS": false,
58 "CallbackInfo": {
59 "Url": ""
60 },
61 "ReconId": "",
62 "IsvId": "",
63 "Tpn": "",
64 "RegisterId": "",
65 "Authkey": "",
66 "SPInProxyTimeout": "",
67 "CustomFields": {
68 "CustomerEmail": "sai@gmail.com",
69 "CustomerMobile": "+15418996990"
70 }
71}'
Response

// Awaiting response…

Sample response
{
  "GeneralResponse": {
    "HostResponseCode": "",
    "HostResponseMessage": "",
    "ResultCode": "0",
    "StatusCode": "0000",
    "Message": "",
    "DetailedMessage": "",
    "DelayBeforeNextRequest": null
  },
  "PaymentType": "Credit",
  "TransactionType": "",
  "Amounts": {
    "TotalAmount": null,
    "Amount": null,
    "TipAmount": null,
    "FeeAmount": null,
    "TaxAmount": null
  },
  "AuthCode": "",
  "ReferenceId": "",
  "InvoiceNumber": "",
  "SerialNumber": "",
  "BatchNumber": "",
  "TransactionNumber": "",
  "Voided": false,
  "Signature": "",
  "IPosToken": "",
  "Token": "",
  "RRN": "",
  "PNReferenceId": "",
  "MerchantNumber": null,
  "MerchantName": "",
  "ExtendedDataByApplication": {},
  "CardData": {
    "CardType": "None",
    "EntryType": "None",
    "Last4": "",
    "First4": "",
    "BIN": "",
    "ExpirationDate": "",
    "Name": "",
    "CardBrand": ""
  },
  "EMVData": {
    "ApplicationName": "",
    "AID": "",
    "TVR": "",
    "TSI": "",
    "IAD": "",
    "ARC": ""
  },
  "Receipts": {
    "Customer": "",
    "Merchant": ""
  },
  "L2L3ValidationError": {
    "Description": "",
    "PoNumber": "",
    "PurchaseIdentifier": "",
    "SummaryCommodityCode": "",
    "LineItemCount": "",
    "TaxAmount": "",
    "Quantity": "",
    "UnitOfMeasure": "",
    "UnitCost": "",
    "TaxRate": "",
    "DiscountAmount": "",
    "DebitCreditIndicator": "",
    "ExtLineAmount": "",
    "QuantityExpIndicator": "",
    "UnitPriceDecimal": ""
  },
  "AutoRentalValidationError": {
    "AdjustmentAmount": "",
    "AdjustmentAuditIndicatorCode": "",
    "AgreementReferenceNumber": "",
    "PickupAddress": "",
    "PickupCity": "",
    "PickupCountry": "",
    "PickupCountryCode": "",
    "PickupDate": "",
    "PickupLocation": "",
    "PickupRegionCode": "",
    "PickupState": "",
    "RentalDistance": "",
    "RentalDistanceUnitofMeasure": "",
    "RentalDuration": "",
    "RentalPeriod": "",
    "RentalRate": "",
    "RentalTime": "",
    "ReturnAddress": "",
    "ReturnDate": "",
    "ReturnLocationId": "",
    "ReturnRegionCode": "",
    "ReturnStateCountry": "",
    "ReturnTime": "",
    "ServiceMobile": "",
    "VehicleMake": "",
    "VehicleModel": ""
  }
}