Get payments account details
post
/bi/v1/{orgIdentifier}/getPaymentAccountDimensions
First Available Version: 20.1.11
Gets the payments account details. This API only returns data for customers using Oracle MICROS Payment Cloud Service.
Request
Path Parameters
-
orgIdentifier: string
Unique identifier of the organization name
The request body defines the details of the API request.
Root Schema : paymentAccountDimensionsPayload
Type:
objectRequest payload for payment account dimensions
Show Source
-
applicationName(optional):
string
Title:
Application nameMaximum Length:128The name of the application which is accessing the API -
include(optional):
string
Title:
IncludeMaximum Length:2000List of objects to include in response -
locRef:
string
Title:
Location referenceMaximum Length:99The location reference, this may be a store number or name depending on the organization -
searchCriteria(optional):
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 : paymentAccountDimensions
Type:
objectThe response body contains information about the payment account.
Show Source
-
accounts:
array accounts
An array of accounts
-
locRef:
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 accounts
The response body contains information about the account holder.
Nested Schema : accounts
Type:
objectThe response body contains information about the account holder.
Show Source
-
acctCode:
string
Title:
Unique code of the accountMaximum Length:50Unique code of the account -
acctHldrCode:
string
Title:
Unique code of the account holderMaximum Length:128Unique code of the account holder -
acctName:
string
Title:
Name of the accountMaximum Length:50Name of the account -
acctStatus:
number
Title:
Status of the payment accountStatus of the payment account.
0 = INACTIVE
1 = ACTIVE
2 = SUSPENDED
3 = CLOSED
4 = PENDING
5 = PASSED -
ccStmtName:
string
Title:
Credit card statement nameMaximum Length:100Name as it appears on card holder's credit card statement -
createdDt:
Date(date)
Title:
Date the account was createdDate the account was created
400 Response
Bad Request
Root Schema : exceptionDetailType
Type:
objectError details
Show Source
-
detail(optional):
string
Title:
Error descriptionThe description of the error -
o:errorCode:
integer
Title:
Oracle error codeOracle error code -
status(optional):
integer
Title:
StatusHTTP response code -
title:
string
Title:
TitleHigh level description of the error -
type:
string
Title:
TypeThe description of the type of HTTP error
401 Response
Unauthorized
Root Schema : exceptionDetailType
Type:
objectError details
Show Source
-
detail(optional):
string
Title:
Error descriptionThe description of the error -
o:errorCode:
integer
Title:
Oracle error codeOracle error code -
status(optional):
integer
Title:
StatusHTTP response code -
title:
string
Title:
TitleHigh level description of the error -
type:
string
Title:
TypeThe description of the type of HTTP error
403 Response
Service Unavailable
Root Schema : exceptionDetailType
Type:
objectError details
Show Source
-
detail(optional):
string
Title:
Error descriptionThe description of the error -
o:errorCode:
integer
Title:
Oracle error codeOracle error code -
status(optional):
integer
Title:
StatusHTTP response code -
title:
string
Title:
TitleHigh level description of the error -
type:
string
Title:
TypeThe description of the type of HTTP error
404 Response
Resource Not Found
Root Schema : exceptionDetailType
Type:
objectError details
Show Source
-
detail(optional):
string
Title:
Error descriptionThe description of the error -
o:errorCode:
integer
Title:
Oracle error codeOracle error code -
status(optional):
integer
Title:
StatusHTTP response code -
title:
string
Title:
TitleHigh level description of the error -
type:
string
Title:
TypeThe description of the type of HTTP error
Default Response
Unexpected Error
Root Schema : exceptionDetailType
Type:
objectError details
Show Source
-
detail(optional):
string
Title:
Error descriptionThe description of the error -
o:errorCode:
integer
Title:
Oracle error codeOracle error code -
status(optional):
integer
Title:
StatusHTTP response code -
title:
string
Title:
TitleHigh level description of the error -
type:
string
Title:
TypeThe description of the type of HTTP error
Examples
The following example shows how to get the payments account 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 {"locRef":"1234"} https://baseurl/bi/v1/orgidentifier/getPaymentAccountDimensions
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:
{
"locRef": "1234",
"accounts":[{
"acctHldrCode": "123456789",
"acctCode": "8516212653197782",
"acctName": "Account 1",
"createdDt": "2021-05-17",
"acctStatus": 1,
"ccStmtName": "Account 1"
}]
}