Payment Management API

REST API

Historic version

This is a old version of this API.

View stable version

Overview

The Payments API provides the standardized client interface to Payment Systems for notifying about performed payments or refunds. Examples of Payment API originators (clients) include Web servers, mobile app servers, Contact center dashboards or retail store systems. 

Version History

15 May 2026 – CTK updated date query parameters previously required values to be enclosed in double quotes. This has been corrected — dates are now passed unquoted. docker-compose has been expanded to enable proxy settings by default, simplifying CTK execution in corporate HTTP proxy environments. README files have been updated to document proxy configuration.

12 Mar 2026 TMF676 v4.0.0 release: This update includes fixes and minor improvements to the CTK and Reference Implementation. The update corrects the use of a string for a datetime filter parameter, which has now been aligned to the proper ISO 8601 date-time format. README files have also been improved with clearer guidance, including suggested proxy configuration for Docker images to support testing vendor implementations across different networks. The Docker image tag has been incremented from v1.0.0 to v1.0.1 to reflect this patch update.

API No.

TMF676

Stable version

v4.0

This Version

v1.0.0

Types

RESTful

DOMAIN

Customer

IPR MODE

Apache 2.0 unless stated

Release Date

01 Feb 2018

API assets v1.0.0

Swagger

OPEN API SPECIFICATION

API user guide / specification

API USER GUIDE (RAND)

Conformance profile

Conformance Profile (RAND)

Components

ODA Components are the software building blocks of a cloud native digital service provider’s network and IT systems, designed for plug-and-play interoperability in a standardized deployment environment (the ODA Canvas). This is a list of ODA Components that expose this API either as a Mandatory or Optional API.