API Endpoints

Sandbox Base URL: https://engine-sandbox.convergegate.com

Authentication:

  • BearerAuth → Required for all merchant-initiated payment requests.

  • SignatureAuth → Used by Nowacash 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.

Get PaymentsCreate PaymentsFind PaymentsExecute depositCapture paymentVoid paymentGet operations

Last updated