Dejavoo

SPIn REST API Methods

Sale

Return

Tip Adjust

Auth

Capture

Void

Summary Report

Daily Report

Printer

Status

Status List

Offline Status

Settle

Get Signature

User Choice

User Input

Disclaimer

Terminal Connection Status

Select Invoice

Payment Invoice

Abort Transaction

Cart

Get Card

Gift

Reload

Reissue

Refund

Redeem

Inquire

Deactivate

Activate

Receipt format

Signature

Extended Data for Responses

Error Codes and Messages

Transaction types scheme

L2L3

Remove Level3 Item

View Level3 Item

Add Level3 Item

Intermediate status

Get Intermediate Status

Post Intermediate Status

SPInAPI

SPIn Proxy RESTful API

Production

SandBox

Sale is the most common request that user to do payment on a terminal.All the responses have <code class="slate-code">GeneralResponse</code> section that informs about successful result or error. See <a href="https://app.theneo.io/dejavoo/spin/error-codes-and-messages" target="_blank">Error Codes and Messages.</a>

Sale is the most common request that user to do payment on a terminal.All the responses have 

 section that informs about successful result or error. See 

Amount

TipAmount

Text in receipt format that terminal prints as a part of terminal receipt

ExternalReceipt

Indicates electronic data capture (EDC) type.

PaymentType

Alphanumeric SPIn transaction identifier. Has to be unique within one batch.

ReferenceId

Indicates if any of receipt copies should be printed after the transaction.

PrintReceipt

Indicates if any of receipt copies should be returned in response.

GetReceipt

Merchant number for multi-merchant environment. 
If not present in multi-merchant environment, transaction will be cancelled.

MerchantNumber

InvoiceNumber

Indicates whether customer signature should be captured or not in course of transaction.

CaptureSignature

Indicates whether extended transaction data should be returned or not.

GetExtendedData

Indicates whether register is ready to receive intermediate status or not.

IsReadyForIS

Information for callback with transaction result.

CallbackInfo

Terminal profile number.
Can be used to identify the terminal in SPIn Proxy environment.

Terminal identifier for register. [Obsolete]
Can be used to identify the terminal instead of Tpn in SPIn Proxy environment. Required if no Tpn.

RegisterId

Merchant's authorization password. Required if no SPInToken.

Authkey

Timeout for processing transaction with SPIn proxy. If null, the default timeout will be used.

SPInProxyTimeout

A collection of custom fields in key-value format.

CustomFields

GeneralResponse

Indicates electronic data capture  ['Credit', 'Debit', 'EBT', 'Card'].

Indicates Transaction Type (Sale, Void, Auth, etc).

TransactionType

Amounts

Authorization code provided by payment processor.

AuthCode

Alphanumeric unique SPin transaction identifier.

SerialNumber

BatchNumber

TransactionNumber

Indicates whether transaction was voided or not.

Voided

Indicates customer signature if it was captured.

Using the token obtained in sale response POS can perform new authorisation using "Transact"”" api of iPosPays. This sale request will not require any card interaction at the payment device.

IPosToken

This token could be required for future transactions using the same card

Token

Reference Retrieval Number provided by iPOSPay Gateway. Uses for iPos gateway Api.

Merchant number for multi-merchant environment.

Merchant name for multi-merchant environment.

MerchantName

ExtendedDataByApplication

CardData

EMVData

Receipts

Return is an independent operation and it does not relate to any Sale transaction. Please use a unique ReferenceID for Return request. You may do return on any amount. For a terminal app Return operation is not related to any Sale that you did in the past. Return does charge back and behaves as Sale only vice-versa and add money on card balance.

Return is an independent operation and it does not relate to any Sale transaction. Please use a unique ReferenceID for Return request. You may do return on any amount. For a terminal app Return operation is not related to any Sale that you did in the past. Return does charge back and behaves as Sale only vice-versa and add money on card balance.

BadRequest

Void operation cancels operation that it is referring to. Void need to do before Settlement. You cannot do Void after Settlement in this case you will need to do Return.Insert line aboveInsert line belowDeleteVoid may be done for <a href="https://app.theneo.io/dejavoo/spin/spin-rest-api-methods/sale" target="_blank">Sale</a>, <a href="https://app.theneo.io/dejavoo/spin/spin-rest-api-methods/return" target="_blank">Return</a>, <a href="https://app.theneo.io/dejavoo/spin/spin-rest-api-methods/auth" target="_blank">Auth</a>, <a href="https://app.theneo.io/dejavoo/spin/spin-rest-api-methods/capture" target="_blank">Capture</a> requests.Insert line aboveInsert line belowDeleteTo do void you need to know ReferenceID and amount of transaction that you void.<div class="slate-div"></div><div class="slate-div"></div>

Void operation cancels operation that it is referring to. Void need to do before Settlement. You cannot do Void after Settlement in this case you will need to do Return.

To do void you need to know ReferenceID and amount of transaction that you void.

SummaryDetails

DailyDetails

The number of transaction wants to retrieve.

TransactionFromIndex

TransactionToIndex

Transactions

Terminal profile number.
Can be used to identify the terminal in SPIn Proxy environment. Required if no RegisterId.

 A collection of custom fields in key-value format. 
 Numeric fields must contain a decimal point. For example: 
"CustomFee": 1.0 or
"CustomFee": 1.00 or
"CustomFee": "1.00"

The field indicating the type of settlement processing. Standard close, remove all batch data, or settle without validation.

SettlementType

SettleDetails

Prompts a dialog on terminal to draw a signature on terminal screen. <div class="slate-div"></div><div class="slate-div"></div>

Prompts a dialog on terminal to draw a signature on terminal screen. 

Title

ChoiceOptions

SelectedOption

Timeout

MaxLength

HiddenInput

Type

InputedString

request.tpn

request.registerId

request.authkey

Terminal status - Online, Offline, or Not Found

TerminalStatus

Description of validations error for invalid request

ErrorDescription

InvoiceList

SelectedInvoiceId

InvoiceData

Prompt

Track1

Track2

Account

EntryType

Signature that terminals returns is .PNG image coded in Base64 format.

Signature that terminals returns is .PNG image coded in Base64 format.

 section that informs about successful result or error with error code and description

0xxx - Successful responses from terminal application

20xx - Error response from SPIN Proxy Server

21xx - Error response from SPIN Proxy Server Async Requests with Call-back

Description: scheme describes how which transaction types can apply to original transaction, for example you can't do Void and Tip adjust without sale (Sale root)

Sections