GET api/Entities/Details?entityCode={entityCode}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| entityCode | string |
Required |
Body Parameters
None.
Response Information
Resource Description
BaseEntity| Name | Description | Type | Additional information |
|---|---|---|---|
| EntityCode | string |
None. |
|
| EntityCommonName | string |
None. |
|
| EntityType | string |
None. |
|
| Status | string |
None. |
|
| EntityGoLiveDate | date |
None. |
|
| EntityInactiveDate | date |
None. |
|
| RegNo | string |
None. |
|
| RegNoLabel | string |
None. |
|
| IsTestMerchantAccount | boolean |
None. |
|
| OperatingCountry | string |
None. |
|
| HasPendingChanges | boolean |
None. |
|
| HasPendingBankAccountChanges | boolean |
None. |
|
| QueryDuration | time interval |
None. |
|
| ReadOnly | boolean |
None. |
|
| IsDeleteable | boolean |
None. |
|
| TimeZoneID | integer |
None. |
|
| ReconciliationGroupID | string |
None. |
|
| IsAggregated | boolean |
None. |
|
| IsTestBankAccountConfigured | boolean |
None. |
|
| FIListHasTestBank | boolean |
None. |
|
| FinancialInstitutionListName | string |
None. |
|
| BypassGoLiveCheckList | boolean |
None. |
|
| IsShoppingCartMerchant | boolean |
None. |
|
| MccCode | string |
None. |
|
| MccTitle | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"EntityCode": "sample string 1",
"EntityCommonName": "sample string 2",
"EntityType": "sample string 3",
"Status": "sample string 4",
"EntityGoLiveDate": "2026-04-07T20:04:22.3030999+10:00",
"EntityInactiveDate": "2026-04-07T20:04:22.3030999+10:00",
"RegNo": "sample string 5",
"RegNoLabel": "sample string 6",
"IsTestMerchantAccount": true,
"OperatingCountry": "sample string 8",
"HasPendingChanges": true,
"HasPendingBankAccountChanges": true,
"QueryDuration": "00:00:00.1234567",
"ReadOnly": true,
"IsDeleteable": true,
"TimeZoneID": 13,
"ReconciliationGroupID": "sample string 14",
"IsAggregated": true,
"IsTestBankAccountConfigured": true,
"FIListHasTestBank": true,
"FinancialInstitutionListName": "sample string 18",
"BypassGoLiveCheckList": true,
"IsShoppingCartMerchant": true,
"MccCode": "sample string 21",
"MccTitle": "sample string 22"
}
application/xml, text/xml
Sample:
<BaseEntity xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ConsoleAPI.Internal.Models.Entities"> <BypassGoLiveCheckList>true</BypassGoLiveCheckList> <EntityCode>sample string 1</EntityCode> <EntityCommonName>sample string 2</EntityCommonName> <EntityGoLiveDate>2026-04-07T20:04:22.3030999+10:00</EntityGoLiveDate> <EntityInactiveDate>2026-04-07T20:04:22.3030999+10:00</EntityInactiveDate> <EntityType>sample string 3</EntityType> <FIListHasTestBank>true</FIListHasTestBank> <FinancialInstitutionListName>sample string 18</FinancialInstitutionListName> <HasPendingBankAccountChanges>true</HasPendingBankAccountChanges> <HasPendingChanges>true</HasPendingChanges> <IsAggregated>true</IsAggregated> <IsDeleteable>true</IsDeleteable> <IsShoppingCartMerchant>true</IsShoppingCartMerchant> <IsTestBankAccountConfigured>true</IsTestBankAccountConfigured> <IsTestMerchantAccount>true</IsTestMerchantAccount> <MccCode>sample string 21</MccCode> <MccTitle>sample string 22</MccTitle> <OperatingCountry>sample string 8</OperatingCountry> <QueryDuration>PT0.1234567S</QueryDuration> <ReadOnly>true</ReadOnly> <ReconciliationGroupID>sample string 14</ReconciliationGroupID> <RegNo>sample string 5</RegNo> <RegNoLabel>sample string 6</RegNoLabel> <Status>sample string 4</Status> <TimeZoneID>13</TimeZoneID> </BaseEntity>