Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

CSG Systems Payment Methods API

Payment method tokenization and management

CSG Systems Payment Methods API is one of 7 APIs that CSG Systems publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Payment Methods. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, a changelog, a support channel, and 1 JSON Schema.

This API exposes 2 operations across 1 path, and defines 7 schemas. It is described by OpenAPI 3.1.0, at version 3.0.0.

Requests are made against 2 base URLs: https://api.forte.net/v3, https://sandbox.forte.net/api/v3.

2 operations 1 paths 7 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
3.0.0
Base URL
https://api.forte.net/v3
Authentication
HTTP Basic
Resource Areas
1

Authentication & Security 1

CSG Systems Payment Methods API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • basicAuth — HTTP Basic authentication using API access ID as username and API secure key as password. Include organization ID and location ID in the X-Forte-Auth-Organizat…

Paths & Operations 2

Across 1 path, the API surfaces 2 operations — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Payment Methods 2

Payment method tokenization and management

GET
/organizations/{organizationId}/locations/{locationId}/paymentmethods
List payment methods for a location
listPaymentMethods 3 params → 200
POST
/organizations/{organizationId}/locations/{locationId}/paymentmethods
Create a payment method token
createPaymentMethod 2 params body → 201

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are PaymentMethod (6 properties), CardRequest (6 properties), CardInfo (5 properties), EcheckRequest (4 properties). Each schema is shown below with its type and property counts.

CardRequest
object
6 properties
CardInfo
object
5 properties
PaymentMethodRequest
object
4 properties 1 required
PaymentMethodList
object
2 properties
PaymentMethod
object
6 properties
EcheckRequest
object
4 properties
EcheckInfo
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

csg-payment-methods-api-openapi.yml Raw ↑

Other APIs CSG Systems publishes across the network.

CSG Forte.js
CSG Forte React Native SDK
CSG Singleview Billing API
CSG Systems Customers API
CSG Systems Settlements API
CSG Systems Transactions API