# Introduction

#### This documentation covers the merchant-facing Crypto Tap to Pay REST API

### Scope of this guide:

* [`POST /crypto/v1/createInvoice`](https://crypto-pay-docs.gradam.app/create-an-invoice)
* [`GET /crypto/v1/status/{id}`](https://crypto-pay-docs.gradam.app/get-status)
* [`GET /crypto/v1/list-txs`](https://crypto-pay-docs.gradam.app/list-transactions)
* [Callback notification contract and signature validation](https://crypto-pay-docs.gradam.app/callback-notifications)

## Quickstart

1. Complete [Initial Setup](https://crypto-pay-docs.gradam.app/initial-setup) and store your credentials:

* `apikey`
* `merchantid`

2. Create an invoice with [Create an Invoice](https://crypto-pay-docs.gradam.app/create-an-invoice).
3. Send customers to the returned `paymentURL`.
4. Track payment progress through either:

* [Get Status](https://crypto-pay-docs.gradam.app/get-status) by invoice ID
* [Callback Notifications](https://crypto-pay-docs.gradam.app/callback-notifications)

5. Pull historical activity with [List Transactions](https://crypto-pay-docs.gradam.app/list-transactions).

## Integration Flow

1. Your server calls `POST /crypto/v1/createInvoice` with invoice metadata.
2. The API returns `id` and `paymentURL`.
3. Customer pays through the hosted payment UI.
4. Settlement updates are available through status polling and optional callbacks.

## Customer Widget Flow

<figure><img src="https://3972746912-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FJLzklVTlwUOujVYl9n8E%2Fuploads%2Fgit-blob-257ce24298d798b5559a45dd1dfb70bef4e52a6b%2Flanding-connect-wallet.png?alt=media" alt="Landing screen before wallet connection"><figcaption><p><strong>1. Landing: connect wallet</strong></p></figcaption></figure>

<figure><img src="https://3972746912-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FJLzklVTlwUOujVYl9n8E%2Fuploads%2Fgit-blob-c55cee757a70b009182404cbf5ff3f9667613bbb%2Fselect-wallet.png?alt=media" alt="Wallet selection with many supported wallets"><figcaption><p><strong>2. Select wallet (580+ available)</strong></p></figcaption></figure>

<figure><img src="https://3972746912-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FJLzklVTlwUOujVYl9n8E%2Fuploads%2Fgit-blob-3fdd6f405ce112b4dddb2b0f4fdbac88646cbddd%2Fpayment-landing-page.png?alt=media" alt="Customer payment landing page"><figcaption><p><strong>3. Select a currency to pay</strong></p></figcaption></figure>

<figure><img src="https://3972746912-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FJLzklVTlwUOujVYl9n8E%2Fuploads%2Fgit-blob-fd204f935681b95af8daed3938a6539a57492e4d%2Freview-payment.png?alt=media" alt="Customer review payment step"><figcaption><p><strong>4. Review payment, option to add a tip.</strong></p></figcaption></figure>

<figure><img src="https://3972746912-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FJLzklVTlwUOujVYl9n8E%2Fuploads%2Fgit-blob-4484e1b02f6368369f5bb67100b47b162be1de79%2Fpayment-processing.png?alt=media" alt="Payment processing step"><figcaption><p><strong>5. Payment processing</strong></p></figcaption></figure>

<figure><img src="https://3972746912-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FJLzklVTlwUOujVYl9n8E%2Fuploads%2Fgit-blob-e7f5882aa3932135cd4c00d15c24bc31ce06c172%2Fcompleted-payment.png?alt=media" alt="Completed payment confirmation"><figcaption><p><strong>6. Completed payment</strong></p></figcaption></figure>

## Base URL

Use your environment-specific base URL supplied by the support/onboarding team.

All endpoint paths in this guide are relative to:

```
{BASE_URL}
```

Example:

```
{BASE_URL}/crypto/v1/createInvoice
```