Get payment account holders
post
/bi/v1/{orgIdentifier}/getPaymentAccountHolderDimensions
First Available Version: 20.1.11
Gets the payment account holder details. 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 : paymentAccountHolderPayload
Type:
objectRequest payload for payment ccount holder dimensions
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 -
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 : paymentAccountHolderDimensions
Type:
objectThe response body contains information about the payment account holder.
Show Source
-
accountHolders(required):
array accountHolders
An array of account holder details
Nested Schema : accountHolders
Type:
arrayAn array of account holder details
Show Source
-
Array of:
object accountHolders
The response body contains information about the account holder.
Nested Schema : accountHolders
Type:
objectThe response body contains information about the account holder.
Show Source
-
acctHldrCode(required):
string
Title:
Unique code of the account holderMaximum Length:128Unique code of the account holder -
acctHldrName(required):
string
Title:
Name of the account holderMaximum Length:50Name of the account holder -
acctHldrStatus(required):
number
Title:
Status of the account holderStatus of the account holder
0 = INACTIVE
1 = ACTIVE
2 = SUSPENDED
3 = CLOSED
4 = PENDING
5 = PASSED -
busEmail(required):
string
Title:
Business email of the account holderMaximum Length:2000Business email of the account holder -
city(required):
string
Title:
City of the account holderMaximum Length:2000City of the account holder -
countryCode(required):
string
Title:
Country code of the account holderMaximum Length:3Country code of the account holder ISO 3166-1 alpha-2 -
createdDt(required):
Date(date)
Title:
Date the account was createdDate the account was created -
phoneNum(required):
string
Title:
Phone number of the account holderMaximum Length:2000Phone number of the account holder -
state(required):
string
Title:
State of the account holderMaximum Length:2000State of the account holder -
stlmtCur(required):
string
Title:
Currency used for settlementMaximum Length:3Currency used for settlement -
streetName(required):
string
Title:
Street name of the account holderMaximum Length:2000Street name of the account holder -
streetNum(required):
string
Title:
Street number of the account holderMaximum Length:2000Street number of the account holder -
verification(required):
number
Title:
Verification status of the account holderVerification status of the account holder
-1 = Verification not required
0 = Verification not started
1 = Verification Passed
2 = Needs action
3 = Verification failed
4 = Verification in progress -
webAddr(required):
string
Title:
Web address of the account holderMaximum Length:2000Web address of the account holder -
zip(required):
string
Title:
Zip code of the account holderMaximum Length:2000Zip code of the account holder
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/getPaymentAccountHolderDimensions
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:
{
"accountHolders":[{
"acctHldrCode": "123456789",
"acctHldrName": "Customer 1",
"stlmtCur": "USD",
"acctHldrStatus": 2,
"verification": 1,
"busEmail": "abc@corporate.com",
"phoneNum": "9876543210",
"webAddr": "www.abc.com",
"streetNum": "12345",
"streetName": "Boulevard Avenue",
"city": "Atlanta",
"state": "GA",
"zip": "12345",
"countryCode": "US",
"createdDt": "2021-04-12"
}]
}