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 Transactions API

Payment transaction processing (credit card, echeck, scheduled)

CSG Systems Transactions 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 Transactions. 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 4 operations across 2 paths, and defines 11 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.

4 operations 2 paths 11 schemas 2 GET1 POST1 PUT

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 Transactions 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 4

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

Transactions 4

Payment transaction processing (credit card, echeck, scheduled)

GET
/organizations/{organizationId}/locations/{locationId}/transactions
List transactions for a location
listTransactions 8 params → 200401403
POST
/organizations/{organizationId}/locations/{locationId}/transactions
Create a payment transaction
createTransaction 2 params body → 201400
GET
/organizations/{organizationId}/locations/{locationId}/transactions/{transactionId}
Get transaction details
getTransaction 3 params → 200404
PUT
/organizations/{organizationId}/locations/{locationId}/transactions/{transactionId}
Update a transaction (void or capture)
updateTransaction 3 params body → 200

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are Transaction (15 properties), TransactionRequest (10 properties), Address (8 properties), TransactionResponse (7 properties). Each schema is shown below with its type and property counts.

Transaction
object
15 properties
CardRequest
object
6 properties
CardInfo
object
5 properties
TransactionList
object
4 properties
TransactionRequest
object
10 properties 2 required
TransactionUpdateRequest
object
2 properties 1 required
Address
object
8 properties
TransactionResponse
object
7 properties
Error
object
3 properties
EcheckRequest
object
4 properties
EcheckInfo
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

csg-transactions-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 Payment Methods API
CSG Systems Settlements API