Get payment transaction details
post
/bi/v1/{orgIdentifier}/getPaymentTransactions
First Available Version: 20.1.11
Gets payment transaction records for the given business date and location. This API only returns data for customers using 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 : paymentTransactionsPayload
Type:
objectRequest payload for payment transaction 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 dateThe business date associated with the daily control totals -
changedSinceUTC:
string(date-time)
Title:
Date and time of a changeThe 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 : paymentTransactionsDimensions
Type:
objectThe response body contains information about the payment transactions.
Show Source
-
accounts(required):
array accounts
An array of accounts
-
busDt(required):
string(date)
Title:
Business dateThe business date associated with the transactions -
curUTC(required):
string(date-time)
Title:
The current UTC date and timeThe current UTC date and time when the request is made -
locRef(required):
string
Title:
Location referenceMaximum Length:99The location reference, this may be a store number or name depending on the organization
Nested Schema : accounts
Type:
arrayAn array of accounts
Show Source
-
Array of:
object paymentTransactionsAccounts
The response body contains information about the payment transactions.
Nested Schema : paymentTransactionsAccounts
Type:
objectThe response body contains information about the payment transactions.
Show Source
-
acctCode(required):
string
Title:
Account codeMaximum Length:50Unique code of the account -
revenueCenters(required):
array revenueCenters
An array of revenue centers
Nested Schema : revenueCenters
Type:
arrayAn array of revenue centers
Show Source
-
Array of:
object paymentTransactionsRevenueCenters
The response body contains information about the account holder.
Nested Schema : paymentTransactionsRevenueCenters
Type:
objectThe response body contains information about the account holder.
Show Source
-
rvcNum(required):
integer
Title:
Revenue center numberMaximum Length:10Revenue center number -
transactions(required):
array transactions
An array of transactions
Nested Schema : transactions
Type:
arrayAn array of transactions
Show Source
-
Array of:
object paymentTransactionsTransactions
The response body contains information about the account holder.
Nested Schema : paymentTransactionsTransactions
Type:
objectThe response body contains information about the account holder.
Show Source
-
authCode(required):
string
Title:
Authorization codeMaximum Length:30Authorization code issued by the 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):
integer
Title:
Is card presentBoolean flag indicating if the card was present while making the payment -
checkNum(required):
integer
Title:
Check numberMaximum Length:10Check 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 numberMaximum Length:3Return 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:
Unique identifier of the guest checkMaximum Length:16Unique odentifier of the guest check -
guestCheckLineItemId(required):
integer
Title:
Guest check line itemMaximum Length:16Unique identifier of the guest check line item -
modPspRef(required):
string
Title:
Modification reference provided by the PSPMaximum Length:80This is the modification reference provided by the PSP, a unique ID that identifies the modification request, if applicable. -
offlineFlag(required):
boolean
Title:
Is offline flagFlag maintained to identify offline status -
payPostUTC(required):
string(date-time)
Title:
The payments posting UTC date and timeThe payments posting UTC date and time -
pmntType(required):
boolean
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) -
raPostUTC(required):
string(date-time)
Title:
The R&A posting UTC date and timeThe R&A posting UTC date and time -
rrn(required):
string
Title:
Reference retrieval NumberMaximum Length:32Reference retrieval number issued by Payment Service Provider (PSP) -
seqNum(required):
string
Title:
Unique transaction identifierMaximum Length:12Unique transaction identifier issued by Simphony Payment Interface (SPI) -
terminalID(required):
string
Title:
Payment terminal identifier issued by Payment Service Provider (PSP)Maximum Length:99Payment terminal identifier issued by Payment Service Provider (PSP) -
tipAmt(required):
number
Title:
Tip amount of the transactiontTip amount of the transaction -
tmedNum(required):
string
Title:
Tender media numberMaximum Length:16Tender media number, can be used to lookup from getTenderMediaDimensions -
transAmt(required):
number
Title:
Payment amountTotal authorized transaction amount of the payment -
transLcl(required):
string(date-time)
Title:
The transaction local store date and timeThe transaction local store date and time -
transUTC(required):
string(date-time)
Title:
The transaction UTC date and timeThe transaction UTC date and time -
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 account holder details 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 https://baseurl/bi/v1/orgidentifier/getPaymentTransactions
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: "122020-10-20T12:10:0034",
"accounts":[{
"acctCode": "8516212653197782",
"revenueCenters":[{
"rvcNum": 123,
"transactions":[{
"pspRef": "8836251672789792",
"checkNum": 1234,
"guestCheckID": 123654,
"guestCheckLineItemId": 123,
"transAmt": 2.5,
"tipAmt": 2,
"transUTC": "2020-10-20T12:10:00",
"transLcl": "2020-10-20T15:10:00",
"pmntType": "PAY",
"tmedNum": "1234",
"seqNum": "210217292426",
"wsNum": 12345,
"empNum": 54321,
"terminalID": "01234567",
"entryMode": 16,
"cardPresentFlag": 1,
"authCode": "654abc",
"cardAlias": "1234567",
"offlineFlag": 0,
"raPostUTC": "2020-10-20T12:12:00",
"payPostUTC": "2020-10-20T12:12:00",
"rrn": "abcdef123456789",
"modPspRef": "8036251672851715"
}]
}]
}]
}