Get payment chargeback details
post
/bi/v1/{orgIdentifier}/getPaymentChargebacks
First Available Version: 20.1.11
Gets payment transaction records for the given record 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 : paymentChargebacksPayload
Type:
objectRequest payload for payment chargeback 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 -
recordDt(required):
string(date)
Title:
Record dateThe record date associated with the transactions -
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 : paymentChargebacksDimensions
Type:
objectThe response body contains information about the payment chargebacks.
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 -
recordDt(required):
string(date)
Title:
Chargeback record dateThe record date associated with the chargeback transactions
Nested Schema : accounts
Type:
arrayAn array of accounts
Show Source
-
Array of:
object paymentChargebacksAccounts
The response body contains information about the accounts.
Nested Schema : paymentChargebacksAccounts
Type:
objectThe response body contains information about the 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 paymentChargebacksRevenueCenters
The response body contains information about the payment chargebacks revenue centre.
Nested Schema : paymentChargebacksRevenueCenters
Type:
objectThe response body contains information about the payment chargebacks revenue centre.
Show Source
-
chargebacks(required):
array chargebacks
An array of chargebacks
-
rvcNum(required):
integer
Title:
Revenue center numberMaximum Length:10Revenue center number
Nested Schema : chargebacks
Type:
arrayAn array of chargebacks
Show Source
-
Array of:
object paymentChargebackschargebacks
The response body contains information about the payment chargebacks.
Nested Schema : paymentChargebackschargebacks
Type:
objectThe response body contains information about the payment chargebacks.
Show Source
-
autodefense(required):
boolean
Title:
Is transaction autodefendedWas the transaction autodefended by the payment service provider (PSP) -
busDt(required):
string(date)
Title:
Business dateThe business date associated with the transaction -
checkNum(required):
integer
Title:
Check numberMaximum Length:10Number of the check related to the transaction -
chgbkRsnCode(required):
string
Title:
Chargeback reason codeMaximum Length:30Chargeback reason code -
chgbkSchemeCode(required):
string
Title:
Card schemeMaximum Length:30Card scheme -
currStatus(required):
Boolean
Title:
Chargeback statusIndicates if this record is the current status of the chargeback. Downstream systems should reset the current status flag of prior records to "false" -
disputeAmt(required):
number
Title:
Amount charged-backAmount charged-back -
disputeCur(required):
string
Title:
Currency of the transactionMaximum Length:3Currency of the transaction -
disputeEndUTC(required):
string(date-time)
Title:
End of the dispute defense periodDate and time of day when dispute defense period ended -
disputePspRef(required):
string
Title:
Chargeback referenceMaximum Length:256PSP reference of the chargeback transaction -
disputeRsn(required):
string
Title:
Chargeback reason descriptionMaximum Length:256Chargeback reason description -
disputeUTC(required):
string(date-time)
Title:
Dispute date and timeThe UTC Date and time of when the chargeback transaction was initiated -
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 -
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. -
pmntType(required):
string
Title:
Type of the paymentMaximum Length:30Type of the payment. Possible values: PAY, VOID, CANCEL, REFUND, ADJUSTMENT -
pspRef(required):
string
Title:
Transaction referenceMaximum Length:64Reference identifying the original transaction, issued by Payment Service Provider (PSP) -
recordType(required):
string
Title:
Record typeMaximum Length:50Shows the record type. Possible values: REQUESTFORINFORMATION, NOTIFICATIONOFFRAUD, CHARGEBACK, INFORMATIONSUPPLIED, CHARGEBACKREVERSED, NOTIFICATIONOFCHARGEBACK, SECONDCHARGEBACK, ACQUIRERPREARBITRATIONUPLOADED, PREARBITRATIONWON, PREARBITRATIONLOST -
transAmt(required):
number
Title:
Transaction amountAmount of the disputed payment transaction
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/getPaymentChargebacks
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:
{
"recordDt": "2020-10-20",
"locRef": "1234",
"accounts":[{
"acctCode": "8516212653197782",
"revenueCenters":[{
"rvcNum": 123,
"chargebacks":[{
"recordType": "REQUESTFORINFORMATION",
"disputePspRef": "12345678",
"pmntType": "PAY",
"checkNum": 1234,
"guestCheckID": 123654,
"guestCheckLineItemId": 123,
"disputeUTC": "2020-10-20T12:10:00",
"transAmt": 2.5,
"disputeCur": "USD",
"disputeAmt": 2.5,
"currStatus": "True",
"chgbkSchemeCode": "Visa",
"chgbkRsnCode": "12.6",
"disputeRsn": "Duplicate Processing/Paid by Other Means",
"pspRef": "8836251672789792",
"busDt": "2020-10-20",
"autodefense": "false",
"disputeEndUTC": "2020-10-20T12:12:00",
"modPspRef": "8036251672851715"
}]
}]
}]
}