Skip to content
ESENGo to the Portal

API Reference

Every endpoint of the Integration API and the Auth API OAuth2 flow, with its parameters, responses and errors.

The reference is interactive and generated from each API's OpenAPI document. The guides explain when to use each endpoint and in what order.

Integration APICharges, payer validation and locations.Auth APIOAuth2 to connect merchant accounts.

Integration API

Creates and manages charges on behalf of connected merchant accounts. Every request carries the merchant's idToken as Bearer: see Connect merchant accounts.

Endpoint Guide
GET /payment-request Create charges
POST /payment-request Create charges
POST /payment-request/bulk Create charges
GET /payment-request/{referenceId} Create charges
PATCH /payment-request/{referenceId} Create charges
PATCH /payment-request/{referenceId}/customer Reconciliation
POST /payment-request/{referenceId}/cancel Create charges
GET /payer-lookup Reconciliation
PUT /my-integration/tenant Locations

Open the Integration API reference

Auth API: OAuth2

The flow a merchant account uses to authorize your integration, and that you use to renew or revoke its tokens.

Endpoint Guide
GET /integration/oauth2/authorize Connect merchant accounts
POST /integration/oauth2/token Connect merchant accounts
POST /integration/oauth2/refresh Connect merchant accounts
POST /integration/oauth2/revoke Connect merchant accounts

Open the Auth API reference

OpenAPI

The OpenAPI documents and the Postman collection can be downloaded from Operations and errors.