Get SPI payment details
post
/bi/v1/{orgIdentifier}/getSPIPaymentDetails
First Available Version: 20.1.11
The API gets credit card payment transaction records for the given business date and location. This API returns data for customer who are using the Simphony Payment Interface (SPI). It does not return data for customers of Oracle MICROS Payment Cloud Service.
Request
Path Parameters
-
orgIdentifier(required): string
Unique identifier of the organization name
The request body defines the details of the API request.
Root Schema : spiPaymentDetailsrequestPayload
Type:
objectRequest payload for SPI payment details
Show Source
-
applicationName:
string
Title:
Application NameMaximum Length:128The name of the application which is accessing the API. -
busDt(required):
string(date)
Title:
Business DateBusiness date of the transaction -
changedSinceUTC:
string(date-time)
Title:
Changed Since Data Time UTCThe UTC date and time of a change made in the transaction -
include:
string
Title:
IncludeMaximum Length:2000List of objects to include in response -
locRef(required):
string
Title:
Location ReferenceMaximum Length:99The location reference, this may be a store number or name depending on the organization -
searchCriteria:
string
Title:
Search CriteriaMaximum Length:2000Search criteria to filter results based on field value
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : spiPaymentDetails
Type:
objectThe response body contains information about the SPI payment details for the specified location and business date after a given date time.
Show Source
-
busDt(required):
string(date)
Title:
Business DateThe business date associated with the transactions -
curUTC(required):
string(date-time)
Title:
Date and time in UTCThe current UTC date and time -
locRef(required):
string
Title:
Location ReferenceMaximum Length:99The location reference, this may be a store number or name depending on the organization -
revenueCenters(required):
array revenueCenters
An array of revenue centers
Nested Schema : revenueCenters
Type:
arrayAn array of revenue centers
Show Source
-
Array of:
object spiPaymentDetailsRVC
The response body contains SPI payment transactions associated with a revenue center
Nested Schema : spiPaymentDetailsRVC
Type:
objectThe response body contains SPI payment transactions associated with a revenue center
Show Source
-
rvcNum(required):
integer
Title:
Revenue center numberMaximum Length:10Revenue Center number -
transactions(required):
array transactions
An array of credit card transactions in the revenue center
Nested Schema : transactions
Type:
arrayAn array of credit card transactions in the revenue center
Show Source
-
Array of:
object spiPaymentDetail
The response body contains SPI payment transactions associated with a revenue center
Nested Schema : spiPaymentDetail
Type:
objectThe response body contains SPI payment transactions associated with a revenue center
Show Source
-
amt(required):
number
Title:
Payemnt transaction amountTransaction amount of the payment -
authCode(required):
string
Title:
Authorization CodeMaximum Length:30Authorization Code of the payment transaction, issues by Payment Service Provider (PSP) -
cardAlias(required):
string
Title:
Payment card aliasMaximum Length:64A value that can be used to uniquely identify the payment card used. It cannot be used for card payments. -
cardPresentFlag(required):
boolean
Title:
Is card presentBoolean flag indicating if the card was present while making the payment -
chkNum(required):
integer
Title:
Check NumberMaximum Length:8Check Number -
empNum(required):
integer
Title:
Employee numberMaximum Length:16Employee number of the transaction employee, can be used to lookup from getEmployeeDimensions -
entryMode(required):
integer
Title:
Entry mode numberReturn a numeric representation of the entry mode of the payment transaction. Following are possible values and their description:
Entry Mode Enumeration:Entry Mode Entry Mode Description 0 EMV Fallback 1 Swiping without PIN (Backwards compatibility 6.1) 2 Manual enter card number (Backwards compatibility 6.1) 3 Swiping with PIN (Backwards compatibility 6.1) 4 EMV without PIN (Backwards compatibility 6.1) 5 EMV with offline PIN (Backwards compatibility 6.1) 6 EMV with on line PIN (Backwards compatibility 6.1) 7 Proximity via Magnetic Stripe (Backwards compatibility 6.1) 8 Proximity via ICC 9 Others 10 EMV Fallback (Signature Verification) 11 Proximity via Magnetic Stripe (Signature Verification) 12 Proximity via Magnetic Stripe (No CVM) 13 Proximity via ICC (Signature Verification) 14 Proximity via ICC (PIN Verification) 15 Proximity via ICC (Customer Device Verified) 16 Proximity via ICC (No CVM) 17 Swiping without PIN (Signature Verification) 18 Swiping with PIN (PIN Verification) 19 Swiping (No CVM ) 20 Manual enter card number (Signature Verification) 21 Manual enter card number (No CVM) 22 EMV (Signature Verification) 23 EMV (PIN Verification) 24 EMV (PIN & Signature Verification) 25 EMV (No CVM) 26 E-Wallet Payment 27 Saved Card Token (No CVM) -
guestCheckID(required):
integer
Title:
Guest Check identifierMaximum Length:16Unique identifier of the Guest Check -
guestCheckLineItemId(required):
integer
Title:
Guest check Line item identifierMaximum Length:16Unique identifier of the Guest Check Line item -
offlineFlag(required):
boolean
Title:
Is offline flagFlag maintained to identify offline status -
pmntType(required):
string
Title:
Type of the paymentMaximum Length:30Type of the payment. Possible values: PAY, VOID, CANCEL, REFUND, ADJUSTMENT -
pspRef(required):
string
Title:
Reference identifying the transactionMaximum Length:64Reference identifying the transaction, issued by Payment Service Provider (PSP) -
rrn(required):
string
Title:
Retrieval Reference NumberRetrieval Reference Number, issued by Payment Service Provider -
seqNum(required):
string
Title:
Transaction identifierMaximum Length:12Unique transaction identifier issued by Simphony Payment Interface (SPI) -
terminalID(required):
string
Title:
Payment Terminal IdentifierMaximum Length:99Payment Terminal Identifier issued by Payment Service Provider (PSP) -
tip:
number
Title:
Tip amountTip amount of the transaction. This attribute will not be returned in the response if value if null or zero. -
tmedNum(required):
integer
Title:
Tender media numberMaximum Length:16Tender media number, can be used to lookup from getTenderMediaDimensions -
transLcl(required):
string
Title:
The transaction date and time in local store timezoneThe transaction date and time in local store timezone -
transUTC(required):
string
Title:
The transaction date and time in UTC timzoneThe transaction date and time in UTC timzone -
wsNum(required):
integer
Title:
Workstation numberMaximum Length:16Workstation number, can be used to lookup from getLocationDimensions
400 Response
Bad Request
Root Schema : exceptionDetailType
Type:
objectError details
Show Source
-
detail:
string
Title:
Error descriptionThe description of the error -
o:errorCode(required):
integer
Title:
Oracle error codeOracle error code -
status:
integer
Title:
StatusHTTP response code -
title(required):
string
Title:
TitleHigh level description of the error -
type(required):
string
Title:
TypeThe description of the type of HTTP error
401 Response
Unauthorized
Root Schema : exceptionDetailType
Type:
objectError details
Show Source
-
detail:
string
Title:
Error descriptionThe description of the error -
o:errorCode(required):
integer
Title:
Oracle error codeOracle error code -
status:
integer
Title:
StatusHTTP response code -
title(required):
string
Title:
TitleHigh level description of the error -
type(required):
string
Title:
TypeThe description of the type of HTTP error
403 Response
Service Unavailable
Root Schema : exceptionDetailType
Type:
objectError details
Show Source
-
detail:
string
Title:
Error descriptionThe description of the error -
o:errorCode(required):
integer
Title:
Oracle error codeOracle error code -
status:
integer
Title:
StatusHTTP response code -
title(required):
string
Title:
TitleHigh level description of the error -
type(required):
string
Title:
TypeThe description of the type of HTTP error
404 Response
Resource Not Found
Root Schema : exceptionDetailType
Type:
objectError details
Show Source
-
detail:
string
Title:
Error descriptionThe description of the error -
o:errorCode(required):
integer
Title:
Oracle error codeOracle error code -
status:
integer
Title:
StatusHTTP response code -
title(required):
string
Title:
TitleHigh level description of the error -
type(required):
string
Title:
TypeThe description of the type of HTTP error
Default Response
Unexpected Error
Root Schema : exceptionDetailType
Type:
objectError details
Show Source
-
detail:
string
Title:
Error descriptionThe description of the error -
o:errorCode(required):
integer
Title:
Oracle error codeOracle error code -
status:
integer
Title:
StatusHTTP response code -
title(required):
string
Title:
TitleHigh level description of the error -
type(required):
string
Title:
TypeThe description of the type of HTTP error
Examples
The following example shows how to get the payment detail for a specified location and business date after a given date time by submitting a POST request on the REST resource using cURL. For more information, see Use cURL
curl -i -X POST -H "Authorization: Bearer" -H "Content-Type:application/json" -d {"locRef":"1234","busDt":"2020-10-20","changedSinceUTC":"2020-10-20T13:00:00"} https://baseurl/bi/v1/orgidentifier/getSPIPaymentDetails
Example of Response Header
The following shows an example of the response header.
HTTP/1.1 200 OK Date: Tue, 20 Oct 2020 21:24:33 GMT Transfer-Encoding: chunked Content-Type: application/json
Example of Response Body
The following example shows the contents of the response body in JSON format:
{
"busDt": "2020-10-20",
"locRef: "1234",
"curUTC": "2020-10-20T14:00:00",
"revenueCenters":[{
"rvcNum": 123,
"transactions":[{
"pspRef": "VNV7FG58XCGMMM52",
"chkNum": 7,
"guestCheckID": 124563,
"guestCheckLineItemId": 123,
"amt": 123.45,
"tip": 123.45,
"transUTC": "2019-07-20T13:58:58",
"transLcl": "2019-07-20T07:58:58",
"pmntType": "PAY",
"tmedNum": 15253,
"seqNum": "670086133130",
"wsNum": 1,
"empNum": 12345,
"terminalID": "P400Plus-804139629",
"entryMode": 1,
"cardPresentFlag": "true",
"authCode": "03587B",
"cardAlias": "76349057583904834AB",
"offlineFlag": "true",
"rrn": "SH5JZZ2GSM2J8HH2"
}]
}]
}