# API Endpoints

> **Sandbox Base URL:**\
> `https://engine-sandbox.convergegate.com`
>
> **Authentication:**
>
> * **BearerAuth** → Required for all merchant-initiated payment requests.
> * **SignatureAuth** → Used by Convergegate for webhook callbacks.

***

#### 💳 Payments (Merchant → API) — **BearerAuth**

| Method    | Endpoint                           | Description                                                                                                                                                    |
| --------- | ---------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **POST**  | `/api/v1/payments`                 | Create a payment. Include details like `paymentType`, `currency`, and `paymentMethod`. Returns payment `id`, `state` (`CHECKOUT`), and optional `redirectUrl`. |
| **GET**   | `/api/v1/payments`                 | Retrieve a paginated list of payments. Supports filters such as `offset`, `limit`, `created.gte/lt`, `updated.gte/lt`, `referenceId.eq`.                       |
| **GET**   | `/api/v1/payments/{id}`            | Retrieve a single payment by its 32-character alphanumeric `id`.                                                                                               |
| **PATCH** | `/api/v1/payments/{id}`            | Execute a deposit without redirect (requires browser/device details). Coordinate with support before use.                                                      |
| **POST**  | `/api/v1/payments/{id}/capture`    | Capture an **AUTHORIZED** payment (full or partial via `amount`).                                                                                              |
| **POST**  | `/api/v1/payments/{id}/void`       | Void an **AUTHORIZED** payment (moves to `CANCELLED`, no further capture possible).                                                                            |
| **GET**   | `/api/v1/payments/{id}/operations` | Get the timeline of processing operations for the payment (newest first).                                                                                      |

#### Start Testing Now

Quickly jump into the available endpoints below and explore the different payment flows.

{% content-ref url="/pages/pThL8WPy4Z3by0EudORh" %}
[Get Payments](/v1/payments/get-payments.md)
{% endcontent-ref %}

{% content-ref url="/pages/3e6HjBMIIartoFOwIMKn" %}
[Create Payments](/v1/payments/create-payments.md)
{% endcontent-ref %}

{% content-ref url="/pages/jBK4R1GiF84jgEtTqzTl" %}
[Find Payments](/v1/payments/find-payments.md)
{% endcontent-ref %}

{% content-ref url="/pages/KOHGMYY56o53eDhpPHit" %}
[Execute deposit](/v1/payments/execute-deposit.md)
{% endcontent-ref %}

{% content-ref url="/pages/ct9JO95zKUzOOhN6Wh9L" %}
[Capture payment](/v1/payments/capture-payment.md)
{% endcontent-ref %}

{% content-ref url="/pages/GjGZNLegaYgsA5GSTvvS" %}
[Void payment](/v1/payments/void-payment.md)
{% endcontent-ref %}

{% content-ref url="/pages/ZnkW8dDgcITxhNOb8pWc" %}
[Get operations](/v1/payments/get-operations.md)
{% endcontent-ref %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://developer.convergegate.com/v1/overview/api-endpoints.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.