Get payment settlement details
post
/bi/v1/{orgIdentifier}/getPaymentSettlements
First Available Version: 20.1.11
Gets Payment settlement records for the given settlement 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 : paymentSettlementsPayload
Type:
objectRequest payload for payment settlement details
Show Source
-
applicationName:
string
Title:
Application nameMaximum Length:128The name of the application which is accessing the API -
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 -
stlmtDt(required):
string(date)
Title:
Payment settlement dateThe settlement date associated with the payment settlement details
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : paymentSettlementsDimensions
Type:
objectThe response body contains information about the payment settlement details.
Show Source
-
accounts(required):
array accounts
An array of accounts
-
locRef(required):
string
Title:
Location referenceMaximum Length:99The location reference, this may be a store number or name depending on the organization -
stlmtDt(required):
string(date)
Title:
Payment settlement dateThe settlement date associated with the payment settlement details
Nested Schema : accounts
Type:
arrayAn array of accounts
Show Source
-
Array of:
object paymentSettlementsAccounts
The response body contains information about the account holder.
Nested Schema : paymentSettlementsAccounts
Type:
objectThe response body contains information about the account holder.
Show Source
-
acctCode(required):
string
Title:
Account codeMaximum Length:50Account code -
revenueCenters(required):
array revenueCenters
An array of revenue centers
Nested Schema : revenueCenters
Type:
arrayAn array of revenue centers
Show Source
-
Array of:
object paymentSettlementsRevenueCenters
The response body contains information about the account holder.
Nested Schema : paymentSettlementsRevenueCenters
Type:
objectThe response body contains information about the account holder.
Show Source
-
businessDates(required):
array businessDates
An array of business dates
-
rvcNum(required):
integer
Title:
Revenue center numberMaximum Length:10Revenue center number
Nested Schema : businessDates
Type:
arrayAn array of business dates
Show Source
-
Array of:
object paymentSettlementsBusinessDates
The response body contains information about the account holder.
Nested Schema : paymentSettlementsBusinessDates
Type:
objectThe response body contains information about the account holder.
Show Source
-
busDt(required):
string(date)
Title:
Business date associated with the settlementBusiness Date associated with the settlement -
settlements(required):
array settlements
An array of settlement transactions
Nested Schema : settlements
Type:
arrayAn array of settlement transactions
Show Source
-
Array of:
object paymentSettlementsSettlements
The response body contains information about the account holder.
Nested Schema : paymentSettlementsSettlements
Type:
objectThe response body contains information about the account holder.
Show Source
-
batchNum:
number
Title:
Number of the batch in which the transaction was settledNumber of the batch in which the transaction was settled. Always NULL if journalType = "FUNDTRANSFER" -
cardBin:
string
Title:
Masked credit card numberMaximum Length:20Masked credit card number. Always NULL if journalType = "FUNDTRANSFER" -
cardNotPrsntFee(required):
number
Title:
Card not present fee of the transactionCard not present fee of the transaction -
cardNotPrsntRate(required):
number
Title:
Card not present rate of the transactionCard not present rate of the transaction -
cardPrsntFee(required):
number
Title:
Card present fee of the transactionCard present fee of the transaction -
cardPrsntRate(required):
number
Title:
Card present rate of the transactionCard present rate of the transaction -
chgbkFee:
number
Title:
Chargeback fee of the transactionChargeback fee of the transaction. Always NULL if journalType = "FUNDTRANSFER" -
createdUTC(required):
string(date)
Title:
The UTC date and time when the transaction was createdThe UTC date and time when the transaction was created -
currStatusFlag(required):
integer
Title:
Current status of the transaction settlementFlag indicating if this is the current status of the transaction settlement. Always NULL if journalType = "FUNDTRANSFER" -
grossCredit:
number
Title:
Gross credit of the transactionGross credit of the transaction. Always NULL if journalType = "FUNDTRANSFER" -
grossCur:
string
Title:
Currency of the transactionMaximum Length:3Currency of the transaction. Always NULL if journalType = "FUNDTRANSFER" -
grossDebit:
number
Title:
Gross debit of the transactionGross debit of the transaction. Always NULL if journalType = "FUNDTRANSFER" -
isReferenced:
integer
Title:
A flag to signify whether the transaction is referencedA flag to signify whether the transaction is referenced. Always NULL if journalType = "FUNDTRANSFER" -
journalType(required):
string
Title:
Journal type of the transactionMaximum Length:50Journal type of the transaction. Possible values are: SETTLED, REFUNDED, CHARGEBACK, CHARGEBACKREVERSED, SECONDCHARGEBACK, FUNDTRANSFER -
merchAcctRef(required):
string
Title:
The name of the merchant accountMaximum Length:255The name of the merchant account -
merchRef(required):
string
Title:
Merchant reference for the transactionMaximum Length:80Merchant reference for the transaction. -
modPspRef(required):
string
Title:
Modification PSP referenceMaximum Length:80For records of Journal Type Settled, Refunded, Chargeback, this is the modification PSP reference, a unique ID that identifies the modification request. -
pmntMethod(required):
string
Title:
Method of paymentMaximum Length:30Method of payment -
pmntMethodVar(required):
string
Title:
Variant of the method of paymentMaximum Length:50Variant of the method of payment -
pspRef(required):
string
Title:
Reference identifying the transaction, issued by Payment Service Provider (PSP)Maximum Length:64Reference identifying the transaction, issued by Payment Service Provider (PSP) -
rrn(required):
string
Title:
Reference retrieval numberMaximum Length:64Reference retrieval number issued by payment service provider
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/getPaymentSettlements
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:
{
"stlmtDt": "2021-07-03",
"locRef: "1234",
"accounts":[{
"acctCode": "8516212653197782",
"revenueCenters":[{
"rvcNum": 123,
"businessDates":[{
"busDt": "2021-07-01",
"settlements":[{
"merchAcctRef": "Oracle_Merchant",
"pspRef": "8836251672789792",
"merchRef": "999-991720391116",
"modPspRef": "8036251672851715",
"pmntMethod": "Visa",
"pmntMethodVar": "visacommercialcredit",
"createdUTC": "2021-07-01T12:10:00",
"journalType": "Settled",
"currStatusFlag": 1,
"grossCur": "USD",
"grossDebit": 123.45,
"grossCredit": 123.45,
"cardPrsntRate": 0.12,
"cardPrsntFee": 0.05,
"cardNotPrsntRate": 0.15,
"cardNotPrsntFee": 0.05,
"chgbkFee": 15,
"batchNum": 123,
"rrn": "abcdef123456789",
"isReferenced": 1,
"cardBin": "123456****9876"
}]
}]
}]
}]
}