# Get merchant onboarding request by reference

This endpoint retrieves the details of a merchant onboarding request for a loyalty partner to review, including the location details, business details, and the current status of each integration.

Endpoint: GET /locations/merchant-onboarding/loyalty/{onboardingReference}
Version: 1.0
Security: JWT

## Path parameters:

  - `onboardingReference` (string, required)
    The unique reference identifier for the merchant onboarding request.

## Header parameters:

  - `Authorization` (string, required)

## Response 200 fields (application/json):

  - `onboardingId` (string, required)
    The unique reference identifier for the merchant onboarding request.

  - `tcLocationId` (string, required)
    The Tyro Connect location identifier.

  - `status` (string, required)
    The overall status of the onboarding request.
    Enum: "IN_PROGRESS", "COMPLETED"

  - `locationDetails` (object)
    Details about the merchant location being onboarded.

  - `locationDetails.name` (string)
    Name of the merchant location.

  - `locationDetails.address` (string)
    Street address of the merchant location.

  - `locationDetails.postcode` (string)
    Postal code of the merchant location.

  - `locationDetails.countryIsoCode` (string)
    ISO code of the country where the merchant location is situated.

  - `locationDetails.timezone` (string)
    Timezone of the merchant location (e.g., "Australia/Sydney").

  - `locationDetails.phoneNumber` (string)
    Contact phone number for the merchant location.

  - `businessDetails` (object, required)
    Details about the merchant's business.

  - `businessDetails.abn` (string, required)
    Australian Business Number (ABN) of the merchant.

  - `businessDetails.entityName` (string)
    Registered entity name of the merchant.

  - `businessDetails.address` (string, required)
    Street address of the merchant's business.

  - `businessDetails.postcode` (string, required)
    Postal code of the merchant's business.

  - `businessDetails.countryIsoCode` (string, required)
    ISO code of the country where the merchant's business is situated.

  - `integrations` (array, required)
    The list of integrations and their current onboarding status.

  - `integrations.name` (string, required)
    The name of the integration (e.g., loyalty).

  - `integrations.status` (string, required)
    The current status of this integration's onboarding.
    Enum: "PENDING", "SUCCESS", "REJECTED_BY_PARTNER"

## Response 404 fields (application/json):

  - `error` (string)
    The error message.


## Response 401 fields

## Response 403 fields