Get payment payout details
post
/bi/v1/{orgIdentifier}/getPaymentPayouts
First Available Version: 20.1.11
Gets payment transaction records for the given booking 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 : paymentPayoutsPayload
Type:
objectRequest payload for payment payout details
Show Source
-
applicationName:
string
Title:
Application nameMaximum Length:128The name of the application which is accessing the API -
bookingDt(required):
string(date)
Title:
Booking dateThe booking date associated with the payout transactions -
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 : paymentPayoutsDimensions
Type:
objectThe response body contains information about the payment payouts.
Show Source
-
accounts(required):
array accounts
An array of accounts
-
bookingDt(required):
string(date)
Title:
Booking dateThe booking date associated with the payout transactions -
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 paymentPayoutsAccounts
The response body contains information about the payment payouts accounts.
Nested Schema : paymentPayoutsAccounts
Type:
objectThe response body contains information about the payment payouts accounts.
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 paymentPayoutsRevenueCenters
The response body contains information about the payment payouts revenue centre.
Nested Schema : paymentPayoutsRevenueCenters
Type:
objectThe response body contains information about the payment payouts revenue centre.
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 paymentPayoutsBusinessDates
The response body contains information about the payment payouts business dates.
Nested Schema : paymentPayoutsBusinessDates
Type:
objectThe response body contains information about the payment payouts business dates.
Show Source
-
busDt(required):
string(date)
Title:
Business dateThe business date associated with the transactions -
payouts(required):
array payouts
An array of payouts
Nested Schema : payouts
Type:
arrayAn array of payouts
Show Source
-
Array of:
object paymentPayoutsPayouts
The response body contains information about the payment payouts.
Nested Schema : paymentPayoutsPayouts
Type:
objectThe response body contains information about the payment payouts.
Show Source
-
payoutDetails(required):
array payoutDetails
An array of payout details
-
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)
Nested Schema : payoutDetails
Type:
arrayAn array of payout details
Show Source
-
Array of:
object paymentPayoutsPayoutDetails
The response body contains information about the payment payouts details.
Nested Schema : paymentPayoutsPayoutDetails
Type:
objectThe response body contains information about the payment payouts details.
Show Source
-
feePayoutPspRef:
string
Title:
The PSP fee payout referenceMaximum Length:80The fee payout reference issues by the PSP, a unique ID that identifies the payout of the fees associated with the transactions. This attribute will not be returned in the response if value is 0 or null.First available version 20.2
-
merchAcctRef(required):
string
Title:
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 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. -
oracleFees:
string
Title:
The processing feesMaximum Length:80The amount of fees withheld for processing the payment transaction. This attribute will not be returned in the response if value is 0 or null.First available version 20.2
-
payoutAmt(required):
number
Title:
Payout amountAmount of the payout transaction -
payoutCurr(required):
string
Title:
Payout currencyMaximum Length:3Currency of the payout transaction -
payoutPspRef(required):
string
Title:
Payout referenceMaximum Length:64Reference identifying the payout issued by Payment Service Provider (PSP) -
payoutType(required):
string
Title:
Payout typeMaximum Length:50Record Type of the payout. Possible values: TRANS, FEE, or TRANSANDFEE -
posTransDateTime(required):
string(date-time)
Title:
POS transaction business date and timePOS transaction business date and time associated with the payout transactions -
pspTransDateTime(required):
string(date-time)
Title:
PSP transaction date and timePSP transaction date and time in UTC timezone associated with the payout transactions -
pymtDtlID(required):
string
Title:
Payment status unique identifierMaximum Length:80Unique identifier for each status a payment transaction flows through during processing. Use this ID to link the payment POS transaction to subsequent settlement and payout transactions.First available version 20.2
-
pymtID(required):
string
Title:
Payment unique identifierMaximum Length:80Unique identifier for a payment transaction. Use this ID to link the payment POS transaction to subsequent settlement and payout transactions.First available version 20.2
-
recordType(required):
string
Title:
Record typeMaximum Length:50Record Type of the payout. Possible values: CREDITED, CREDITFAILED, DEBITED, DEBITFAILED, CHARGEBACK, CHARGEBACKREVERSED, CREDITREVERSED, SECONDCHARGEBACK, FUNDTRANSFER, PAYOUT -
transPayoutPspRef:
string
Title:
The PSP transaction payout referenceMaximum Length:80The transaction payout reference issues by the PSP, a unique ID that identifies the payout of the transaction amount. This attribute will not be returned in the response if value is 0 or null.First available version 20.2
400 Response
Bad Request
Root Schema : exceptionDetailType
Type:
objectException 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:
objectException 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:
objectException 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:
objectException 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:
objectException 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/getPaymentPayouts
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:
{
"bookingDt": "2020-10-20",
"locRef: "1234",
"accounts":[{
"acctCode": 8516212653197782,
"revenueCenters":[{
"rvcNum": 123,
"businessDates":[{
"busDt": "2020-10-20",
"payouts":[{
"pspRef": 2342435436,
"payoutDetails":[{
"merchAcctRef": "Oracle_Merchant",
"merchRef": "999-991720391116",
"modPspRef": "8036251672851715",
"payoutCur": "USD",
"recordType": "Payout",
"pspTransDateTime": "2020-10-20T12:10:00",
"posTransDateTime": "2020-10-20T12:10:00",
"payoutType": "TRANSANDFEE",
"payoutPspRef": "8836251672789792",
"payoutAmt": 1.23,
"pymtID": "123456",
"pymtDtlID": "123456",
"transPayoutPspRef": "123456",
"feePayoutPspRef": "123456",
"oracleFees": "123"
}]
}]
}]
}]
}]
}