GoPay REST API

Name: GoPay REST API
Brand: GoPay REST API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentPaymentsPayment Processingoauth2,basic10 EndpointsREST

For Agents

Create GoPay payments, refund or capture transactions, manage recurring billing cycles, and pull eshop account statements via OAuth2-scoped bearer tokens.

Install Jentic One Beta

Connect the GoPay REST API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the GoPay REST API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with GoPay REST API.

Create a payment with redirect or inline checkout for cards, bank buttons, and the GoPay wallet

Capture a previously preauthorized payment to settle funds at fulfillment time

Refund a captured payment in full or partial amount with reason metadata

GET STARTED

Start building with GoPay REST API

Explore with Jentic

View OpenAPI Document

The GoPay REST API processes online payments through the GoPay payment gateway, with support for one-time payments, recurring payments, preauthorizations, refunds, and account statement retrieval. It serves Central European e-commerce merchants with payment instruments specific to local markets such as bank buttons, GoPay wallet, and card payments. Authentication uses OAuth2 client credentials over HTTP Basic to obtain bearer tokens scoped to payment-create, payment-all, or account-statement permissions. Integration covers the full payment lifecycle from creation through capture, recurrence, and void.

Use Cases

Patterns agents use GoPay REST API for, with concrete tasks.

★ Czech and Slovak Checkout

Accept payments from Central European shoppers using locally preferred methods including bank buttons, the GoPay wallet, and major card schemes. The API creates a payment object that returns a hosted gateway URL or inline payload, then exposes status, capture, and refund endpoints to drive the order lifecycle. Settlement currencies and instruments adjust automatically per eshop GoID.

Create a GoPay payment for 1500 CZK with payer email customer@example.com, return the gateway URL, then poll /payments/payment/{id} until state is PAID.

Subscription and Recurring Billing

Power subscription products by creating a parent recurring payment and triggering on-demand or scheduled recurrences against it. The /payments/payment/{id}/create-recurrence endpoint charges the same payer using the saved instrument, while void-recurrence ends the chain when a customer cancels. Refunds operate on individual recurrences without breaking the parent.

Trigger a 499 CZK monthly recurrence on parent payment id 3000123456 and confirm the new payment state is PAID before extending the subscription.

Preauthorize and Capture

Hold funds at order placement and settle only after fulfillment using the preauthorization flow. Create a payment in PREAUTHORIZED state, then call /payments/payment/{id}/capture when the order ships or void-authorization to release the hold. This pattern matches travel, marketplace, and made-to-order workflows where the final amount or fulfillment timing is uncertain.

Capture 250.00 EUR on preauthorized payment id 3000999111 once the warehouse confirms shipment, otherwise call void-authorization.

AI Agent Reconciliation Workflow

An autonomous finance agent pulls daily eshop account statements from /accounts/account-statement, joins them against internal order records, and flags mismatches for review. Using Jentic, the agent discovers GoPay endpoints by intent, fetches scoped OAuth2 tokens from the credential vault, and never sees raw client secrets in its prompt window.

Fetch the GoPay account statement for goid 8123456789 between 2026-06-01 and 2026-06-08, then return any payments with status PAID that have no matching internal order id.

Key Endpoints

10 endpoints — the gopay rest api processes online payments through the gopay payment gateway, with support for one-time payments, recurring payments, preauthorizations, refunds, and account statement retrieval.

METHOD

PATH

DESCRIPTION

POST

/oauth2/token

Issue a scoped OAuth2 bearer token

POST

/payments/payment

Create a new payment

GET

/payments/payment/{id}

Retrieve payment status and detail

POST

/payments/payment/{id}/refund

Refund a captured payment

POST

/payments/payment/{id}/create-recurrence

Trigger an on-demand recurrence

POST

/payments/payment/{id}/capture

Capture a preauthorized payment

POST

/payments/payment/{id}/void-authorization

Void an outstanding authorization

GET

/accounts/account-statement

Download an eshop account statement

POST

/oauth2/token

Issue a scoped OAuth2 bearer token

POST

/payments/payment

Create a new payment

GET

/payments/payment/{id}

Retrieve payment status and detail

POST

/payments/payment/{id}/refund

Refund a captured payment

POST

/payments/payment/{id}/create-recurrence

Trigger an on-demand recurrence

Why Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

GoPay client_id and client_secret are stored encrypted in the Jentic vault (MAXsystem). Agents receive short-lived OAuth2 bearer tokens scoped to the requested permission, never the raw credentials.

Intent-based discovery

Agents search by intent (e.g., 'create a recurring payment') and Jentic returns the matching GoPay operation with its input schema, so the agent can call /payments/payment/{id}/create-recurrence without browsing GoPay docs.

Time to first call

Direct GoPay integration: 3-5 days for OAuth2 plumbing, recurrence handling, and webhook reconciliation. Through Jentic: under 1 hour to search, load schema, and execute.

FAQs

Specific to using GoPay REST API through Jentic.

What authentication does the GoPay REST API use?

The API uses OAuth2 client credentials. You POST your client_id and client_secret as HTTP Basic to /oauth2/token requesting a scope of payment-create, payment-all, or account-statement, and receive a bearer token used in the Authorization header for subsequent calls. Through Jentic, the client secret stays in the encrypted vault and the agent only ever sees a short-lived scoped token.

Can I issue a partial refund with the GoPay API?

Yes. POST to /payments/payment/{id}/refund with an amount smaller than the original payment to refund partially, or omit it to refund in full. The endpoint returns the refund result and updates the parent payment so subsequent retrievals reflect the new outstanding balance.

How do I set up recurring payments through GoPay?

Create an initial payment with a recurrence object describing the period and end date, then trigger each subsequent charge by POSTing to /payments/payment/{id}/create-recurrence on the parent payment id. Call /payments/payment/{id}/void-recurrence when the customer cancels to stop future charges.

What payment methods does the GoPay API support?

GET /eshops/eshop/{goid}/payment-instruments/{currency} returns the live list of instruments available for your eshop and currency. Typical instruments include cards, bank buttons for Czech and Slovak banks, the GoPay wallet, Apple Pay, Google Pay, and bank transfer.

How do I integrate the GoPay API with an AI agent through Jentic?

Run pip install jentic, then use the Jentic search query 'create a gopay payment' to discover the POST /payments/payment operation, load its input schema, and execute the call. Jentic handles the OAuth2 token exchange and credential isolation automatically. Get started at https://app.jentic.com/sign-up.

Why is there no official OpenAPI spec for GoPay REST API?

GoPay does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call GoPay REST API via structured tooling. It is validated against the live API and kept up to date. Get started at https://app.jentic.com/sign-up.

GoPay REST API

Connect the GoPay REST API to your agent

Capabilities

Start building with GoPay REST API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs