REST API
Auth
POST/v2/Payment/Auth

Auth (Pre-Authorization) reserves funds on a cardholder's account without capturing the transaction. All the responses have GeneralResponse section that informs about successful result or error. See Error Codes and Messages.

Body Parameters

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