> ## Documentation Index
> Fetch the complete documentation index at: https://developer.starpayethiopia.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Started with StarPay

> Account setup and sandbox onboarding for Star-Pay merchants.

## 1. Create a StarPay Sandbox Account

Before integrating StarPay, you need a sandbox account for testing.

1. Visit **starpayethiopia.com** to create a sandbox merchant account.

<img src="https://mintcdn.com/starpay-fa6403ea/Ia6jBgeqNmMXzKvC/images/starpay-homepage.png?fit=max&auto=format&n=Ia6jBgeqNmMXzKvC&q=85&s=0457ab39e21d49fcc121a193d8475209" alt="StarPay homepage" style={{ width: '100%', borderRadius: '1rem', marginTop: '1rem', marginBottom: '1rem' }} width="1851" height="992" data-path="images/starpay-homepage.png" />

2. Complete the registration form with the required information.

<img src="https://mintcdn.com/starpay-fa6403ea/Ia6jBgeqNmMXzKvC/images/signup-form.png?fit=max&auto=format&n=Ia6jBgeqNmMXzKvC&q=85&s=3801c5d27124427c48ff245f08ddb88f" alt="StarPay signup form" style={{ width: '100%', borderRadius: '1rem', marginTop: '1rem', marginBottom: '1rem' }} width="2592" height="1676" data-path="images/signup-form.png" />

3. After your account is created, a unique **Sandbox Merchant ID** will be sent to your verified phone number via SMS.

<img src="https://mintcdn.com/starpay-fa6403ea/Ia6jBgeqNmMXzKvC/images/verify-phone.png?fit=max&auto=format&n=Ia6jBgeqNmMXzKvC&q=85&s=0193388a57a8cbf68c11cc318e6e6a8c" alt="StarPay phone verification" style={{ width: '100%', borderRadius: '1rem', marginTop: '1rem', marginBottom: '1rem' }} width="2592" height="1676" data-path="images/verify-phone.png" />

4. Sign in to the **StarPay Sandbox Merchant Portal** using your Merchant ID and registered phone number.

<img src="https://mintcdn.com/starpay-fa6403ea/Ia6jBgeqNmMXzKvC/images/starpay-dashboard.png?fit=max&auto=format&n=Ia6jBgeqNmMXzKvC&q=85&s=c58b6c5a98a8f05d843b61aa22a49b2a" alt="StarPay dashboard" style={{ width: '100%', borderRadius: '1rem', marginTop: '1rem', marginBottom: '1rem' }} width="2592" height="1614" data-path="images/starpay-dashboard.png" />

***

## 2. Generate API Credentials

API credentials are required to authenticate requests and securely receive payment notifications.

1. Log in to the Merchant Portal.
2. Navigate to **API Keys**.

<img src="https://mintcdn.com/starpay-fa6403ea/Ia6jBgeqNmMXzKvC/images/navigate-to-api-key.png?fit=max&auto=format&n=Ia6jBgeqNmMXzKvC&q=85&s=cc6a54d90efcfd0427bc319235d4ed1d" alt="Navigate to API Keys" style={{ width: '100%', borderRadius: '1rem', marginTop: '1rem', marginBottom: '1rem' }} width="3780" height="1890" data-path="images/navigate-to-api-key.png" />

3. Generate an **API Key** by providing a name for the key.

<img src="https://mintcdn.com/starpay-fa6403ea/Ia6jBgeqNmMXzKvC/images/generateAPI.png?fit=max&auto=format&n=Ia6jBgeqNmMXzKvC&q=85&s=2835ea11ebf4cbbd694e857f4f44fdb1" alt="Generate API Key" style={{ width: '100%', borderRadius: '1rem', marginTop: '1rem', marginBottom: '1rem' }} width="2592" height="1679" data-path="images/generateAPI.png" />

4. Generate a **Callback Key**, which is used to verify signatures and secure communication between StarPay and your system.

You are now ready to initiate transactions and generate payment links.

***

## 3. Move to Production

When you are ready to accept live payments, submit your business information for review.

1. Log in to the Merchant Portal.
2. Click **Switch to Live Mode**.

<img src="https://mintcdn.com/starpay-fa6403ea/Ia6jBgeqNmMXzKvC/images/Swith-to-live-mode.png?fit=max&auto=format&n=Ia6jBgeqNmMXzKvC&q=85&s=c7dc17ca14497913e4671cd8bdab0b32" alt="Switch to Live Mode" style={{ width: '100%', borderRadius: '1rem', marginTop: '1rem', marginBottom: '1rem' }} width="3780" height="1890" data-path="images/Swith-to-live-mode.png" />

3. Provide the required business information, including:
   * Business License Number
   * TIN (Tax Identification Number)
   * Settlement Bank Account

<img src="https://mintcdn.com/starpay-fa6403ea/Ia6jBgeqNmMXzKvC/images/provide-business-info.png?fit=max&auto=format&n=Ia6jBgeqNmMXzKvC&q=85&s=3cd5487a06672ea9b88f483bee0bfc60" alt="Provide business information" style={{ width: '100%', borderRadius: '1rem', marginTop: '1rem', marginBottom: '1rem' }} width="3780" height="1890" data-path="images/provide-business-info.png" />

4. Submit your application for review.

Our team will review your information and notify you of the approval status.

## Important: API Gateway Access

After your production account is approved, API access must be enabled for your merchant account before you can start making API requests.

If API Gateway access has not been enabled, requests to the StarPay API will be rejected with the following error:

```json theme={null}
{
  "message": "API gateway feature is not enabled. If you believe this is an error, please contact your administrator."
}
```

### What to do

* Ensure your production onboarding request has been approved.
* Verify that the **API Gateway** feature has been enabled for your merchant account.
* Generate your production API credentials from the Merchant Portal.
* If you receive the error above, contact the StarPay support team or your account administrator to request API Gateway activation.

> **Note:** Production account approval and API Gateway activation are separate steps. A merchant may have an approved production account but still be unable to access the API until API Gateway access has been enabled.

***

### After Approval

Once your application is approved:

1. You will receive a **Production Merchant ID** associated with your registered phone number.
2. Sign in to the **Production Merchant Portal**.
3. Update your integration settings:

```text theme={null}
https://api.starpayethiopia.com
```

4. Generate new **Production API Keys**.
5. Generate a new **Production Callback Key**.

Your integration is now ready to process live transactions and accept real payments.
