> ## Documentation Index
> Fetch the complete documentation index at: https://docs.chip-in.asia/llms.txt
> Use this file to discover all available pages before exploring further.

# Install the skill

> Easily integrate with CHIP Collect by using an AI agent.

## Description

The command provided is for the user to install the `SKILL.md` to assist with the integration of CHIP payment links using an AI agent.
The `SKILL.md` contains manual instructions for the agent to integrate CHIP payment gateway and generate checkout URLs so the user can verify the integration end-to-end.

## Conventions for AI agents

CHIP exposes a machine-readable entry point at
[`/llms.txt`](/llms.txt) that lists the canonical base URLs, path
conventions, and authentication headers for both products. When generating
integration code for CHIP Collect:

* **CHIP Collect** resource paths are **plural with a trailing slash**
  (e.g. `/purchases/{id}/`, not `/purchase/{id}/`).
  Base URL: `https://gate.chip-in.asia/api/v1`.
* All CHIP Collect endpoints require
  `Authorization: Bearer <secret_key>`.
* **Never invent a path.** If the doc or OpenAPI spec doesn't show it, it
  doesn't exist. If a path you "remember" isn't in the spec, the spec wins.

The raw OpenAPI spec is served at
[`/openapi/chip-collect.yaml`](/openapi/chip-collect.yaml) for direct
consumption by coding agents.

## Requirements

* Cursor, Codex or any AI-powered IDE
* Know how to execute terminal command and prompt AI agent

## Install

Run this command in your project root to install the skill.

```bash theme={null}
npx -y github:CHIPAsia/skill
```

Once executed, a `SKILL.md` file is generated inside the `chip-skill/` folder in your root repository.

***

## Example prompt

Use this prompt after installing the skill to generate a dummy payment link.

```
Create a dummy payment link,
The expected output is:
- a chip-env file to store CHIP's Secret Key and Brand ID
- executable code that will generate a checkout URL.
- instructions on where to get the credentials
- the command to execute the code
Use chip-skill/SKILL.md as a reference.
```

***

## What to do next

Once the code is generated, follow these steps to test your integration.

<Steps>
  <Step title="Insert your credentials">
    Add your CHIP Secret Key and Brand ID into the generated `chip-env` file.
  </Step>

  <Step title="Run the executable code">
    Execute the generated code using the command provided. <br /> A checkout URL will be printed to your terminal.
  </Step>

  <Step title="Click the checkout URL">
    Open the URL in your browser to make a dummy payment. Please use the test mode API key.
  </Step>
</Steps>

<Warning>
  Always use a **test mode API key** when generating dummy payment links. <br /> Do not use your live credentials for testing.
</Warning>

<Info>
  How to identify a dummy payment link? <br />
  Dummy payment link will execute fake payment instead of redirect to bank page when user click pay.
</Info>

***

## Get your credentials

Retrieve your Brand ID and API keys from the CHIP merchant portal.

<CardGroup cols={2}>
  <Card title="Brand ID" icon="fingerprint" href="https://portal.chip-in.asia/collect/developers/brands">
    Get your Brand ID from the CHIP merchant portal.
  </Card>

  <Card title="API keys" icon="key" href="https://portal.chip-in.asia/collect/developers/api-keys">
    Get your Secret Key from the CHIP merchant portal.
  </Card>
</CardGroup>

***

## Source documents

The raw OpenAPI spec is the canonical machine-readable source of truth
for CHIP Collect. Coding agents should consume it directly.

<CardGroup cols={1}>
  <Card title="CHIP Collect OpenAPI spec" icon="code" href="/openapi/chip-collect.yaml">
    Raw `chip-collect.yaml` OpenAPI 3.1 spec.
  </Card>

  <Card title="CHIP Collect skill source" icon="github" href="https://github.com/CHIPAsia/skill">
    Source for the CHIP Collect AI skill and the canonical `SKILL.md`.
  </Card>
</CardGroup>

<Info>
  Looking for **CHIP Send (payouts)** instead? See
  [Install the CHIP Send skill](/chip-send/api-reference/vibe-coding-guide).
  The two skills are independent and can be installed in the same project.
</Info>