Business Hierarchy

Retrieve a business by its globally unique reference.

GET /v1/merchant/admin/business/{businessReference}

Auth: API key (VantagePayAdminClient).

Parameters

Name	In	Required	Description
businessReference	path	Yes	The globally unique reference of the business to retrieve.

Responses

Status	Description
200	The request was successful and the business was returned.
400	The request failed validation, the error object will contain further information.
401	The authorization information provided is not valid, authentication is required to access this resource.
403	The authorization header does not contain the correct type or you do not have access to this resource.
404	The business with the specified reference was not found.
422	The request payload is invalid, the error object will contain further information.
429	Too many requests are being sent concurrently or rate limiting has taken effect.
500	An unexpected error occurred, the error object will contain further information.

Response body

Field	Type	Required	Description
success	boolean	No	Gets a value indicating whether the operation was successful.
result	object	No	The legal business entity associated with a merchant, used for KYB verification and settlement.

{
  "success": true,
  "result": {
    "reference": "00000000-0000-0000-0000-000000000000",
    "parentBusinessReference": "00000000-0000-0000-0000-000000000000",
    "createdDate": "string",
    "yourReference": "string",
    "source": "string",
    "name": "string",
    "emailAddress": "string",
    "mobileNumber": "string",
    "phoneNumber": "string",
    "isEmailVerified": true,
    "isMobileNumberVerified": true,
    "isActive": true
  }
}

Code samples

WARNING

The JavaScript SDK does not cover admin APIs - use the .NET SDK.

.NET

var business = await adminClient.Merchants.GetBusinessAsync(Guid.Parse("7f8e9d0c-1a2b-4c3d-9e8f-0a1b2c3d4e5f"));

---

Retrieve the full business hierarchy for the specified business reference.

GET /v1/merchant/admin/business/hierarchy/{businessReference}

Auth: API key (VantagePayAdminClient).

Parameters

Name	In	Required	Description
businessReference	path	Yes	The globally unique reference of the business whose hierarchy to retrieve.

Responses

Status	Description
200	The request was successful and the business hierarchy was returned.
400	The request failed validation, the error object will contain further information.
401	The authorization information provided is not valid, authentication is required to access this resource.
403	The authorization header does not contain the correct type or you do not have access to this resource.
404	The business with the specified reference was not found.
422	The request payload is invalid, the error object will contain further information.
429	Too many requests are being sent concurrently or rate limiting has taken effect.
500	An unexpected error occurred, the error object will contain further information.

Response body

Field	Type	Required	Description
success	boolean	No	Gets a value indicating whether the operation was successful.
result	object	No	Represents a node in a merchant business hierarchy, containing the business identity and its nested sub-businesses and directly-owned merchants.

{
  "success": true,
  "result": {
    "subBusinesses": [],
    "merchants": [],
    "name": "string",
    "reference": "00000000-0000-0000-0000-000000000000",
    "externalReference": "string",
    "isActive": true
  }
}

Code samples

WARNING

The JavaScript SDK does not cover admin APIs - use the .NET SDK.

.NET

var hierarchy = await adminClient.Merchants.GetBusinessHierarchyAsync(Guid.Parse("7f8e9d0c-1a2b-4c3d-9e8f-0a1b2c3d4e5f"));