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

# Quickstart

> Get up and running with the PIK API in minutes — from credentials to your first settled payment.

This quickstart walks you through the fastest path to integrating PIK. By the end you will have authenticated with the PIK API, created a payment request, and seen a simulated payment settled to your wallet — all in the sandbox environment.

### Before you start

You need a PIK account. If you do not have one yet, contact the PIK team at [hi@pik.global](mailto:hello@pik.global) to get onboarded.

```mermaid theme={null}
%%{init: {'flowchart': {'curve': 'linear'}, 'themeVariables': { 'fontSize': '16px', 'fontFamily': 'arial'}}}%%
flowchart LR
    A["Get your sandbox API key"] --> B["Make your first authenticated request"]
    B --> C["Create a payment request"]
    C --> D["Simulate a payment"]
    D --> E["Check your wallet balance"]
    E --> F["Next steps: webhooks, accounts, VAN, FX, payouts"]
```

### Step 1 — Get your sandbox API key

Log in to the PIK Dashboard at [dashboard.pik.global](http://dashboard.pik.global). Navigate to Settings > API Keys > Sandbox and generate a sandbox API key. Copy it — you will use it in every API request.

All sandbox transactions are simulated. No real funds move in the sandbox environment.

### Step 2 — Make your first authenticated request

Test that your API key works by calling the account details endpoint.

Call GET [https://api-sandbox.pik.global/v1/accounts/me](https://api-sandbox.pik.global/v1/accounts/me) with the header Authorization: Bearer YOUR\_SANDBOX\_API\_KEY.

If authentication is successful, you will receive a 200 response with your platform account details. If you receive a 401, check that your API key is correct and active.

### Step 3 — Create a payment request

Create a payment request for 10 USDT.

Call POST [https://api-sandbox.pik.global/v1/payments](https://api-sandbox.pik.global/v1/payments) with the header Authorization: Bearer YOUR\_SANDBOX\_API\_KEY and a JSON body containing: currency set to USDT, amount set to 10.00, and reference set to TEST-001.

The response returns a payment\_id and the payer instructions including the USDT receiving address. Note the payment\_id — you will need it in the next step.

### Step 4 — Simulate a payment

In sandbox, use the payment simulator to trigger a settled payment without sending real funds.

Call POST [https://api-sandbox.pik.global/v1/sandbox/payments/payment\_id/simulate](https://api-sandbox.pik.global/v1/sandbox/payments/\{payment_id}/simulate) with the header Authorization: Bearer YOUR\_SANDBOX\_API\_KEY and a JSON body containing status set to settled.

PIK processes the simulated payment and fires the payment.settled webhook if you have a webhook endpoint registered. The payment status changes to settled.

### Step 5 — Check your wallet balance

Confirm the funds are in your wallet.

Call GET [https://api-sandbox.pik.global/v1/accounts/me/wallet/balances](https://api-sandbox.pik.global/v1/accounts/me/wallet/balances) with the header Authorization: Bearer YOUR\_SANDBOX\_API\_KEY.

You should see a USDT balance of 10.00 available. The simulated payment has settled to your wallet.

### Step 6 — Next steps

Now that you have a working sandbox integration, explore the full PIK product:

* Set up webhooks to receive real-time payment and payout notifications. See Webhooks.
* Create a connected account for one of your customers. See Onboarding a customer.
* Issue a Virtual Account Number so your customer can receive AUD bank transfers. See Virtual Account Numbers.
* Convert your USDT balance to AUD using PIK's FX engine. See Create a conversion.
* Send funds to an external bank account. See Payouts.

When you are ready to go live, generate a production API key from the PIK Dashboard and update your base URL to [https://api.pik.global/v1](https://api.pik.global/v1).