swagger-java-client

Prepay Balance Management

• API version: 4.0.0
  • Build date: 2023-10-06T18:35:09.617630+01:00[Europe/Dublin]

TMF API Reference: TMF654 - Prepay Balance Management ### Draft : 19.5 - January 2020 The Prepay Balance Management API enables consumers to manage the balance, recharge (top-up), transfer, reserve, unreserve, deduct and balance adjustments of a bucket. A bucket is understood in the context of this API to be an entity that keeps track of the balance available to use services. Every bucket will measure balance in different units, it can be monetary or non-monetary (e.g.: number of sms that are available, number of GB of data available, …) ### Resources - Bucket - TopupBalance - AdjustBalance - TransferBalance - ReserveBalance - AccumulatedBalance - BalanceActionHistory ### Operations - Retrieve the balance information on a bucket for a given product (individual or aggregated). - Retrieve the list of balance-related operations performed over a given product - Retrieve information about all the top-up operations stored in the server filtered by some criteria. - Perform a new top up operation (recharge) - Retrieve detailed information about a top-up operation previously processed by the server. - Retrieve the current and historic status information about a top-up operation previously processed by the server. - Perform a new transfer operation - Retrieve information about all the transfer operations stored in the server filtered by some criteria - Retrieve detailed information about a transfer operation previously processed by the server - Retrieve the current and historic status information about a transfer operation previously processed by the server. - Retrieve information about all the adjustments stored in the server filtered by some criteria. - Perform a new adjustment operation - Retrieve detailed information about a balance adjustment operation previously processed by the server - Reserve a balance on a bucket. - Unreserve a balance on a bucket. - Retrieve aggregated (accumulative) balances for a bucket.

Automatically generated by the Swagger Codegen

Requirements

Building the API client library requires:

1. Java 1.7+
2. Maven/Gradle

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>io.swagger</groupId>
  <artifactId>swagger-java-client</artifactId>
  <version>1.0.0</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "io.swagger:swagger-java-client:1.0.0"

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

• target/swagger-java-client-1.0.0.jar
• target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccumulatedBalanceApi;

import java.io.File;
import java.util.*;

public class AccumulatedBalanceApiExample {

    public static void main(String[] args) {
        
        AccumulatedBalanceApi apiInstance = new AccumulatedBalanceApi();
        String fields = "fields_example"; // String | Comma-separated properties to be provided in response
        Integer offset = 56; // Integer | Requested index for start of resources to be provided in response
        Integer limit = 56; // Integer | Requested number of resources to be provided in response
        try {
            List<AccumulatedBalance> result = apiInstance.listAccumulatedBalance(fields, offset, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccumulatedBalanceApi#listAccumulatedBalance");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccumulatedBalanceApi;

import java.io.File;
import java.util.*;

public class AccumulatedBalanceApiExample {

    public static void main(String[] args) {
        
        AccumulatedBalanceApi apiInstance = new AccumulatedBalanceApi();
        String id = "id_example"; // String | Identifier of the AccumulatedBalance
        String fields = "fields_example"; // String | Comma-separated properties to provide in response
        try {
            AccumulatedBalance result = apiInstance.retrieveAccumulatedBalance(id, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccumulatedBalanceApi#retrieveAccumulatedBalance");
            e.printStackTrace();
        }
    }
}

Documentation for API Endpoints

All URIs are relative to https://serverRoot/tmf-api/prepayBalanceManagement/v4

Class	Method	HTTP request	Description
AccumulatedBalanceApi	listAccumulatedBalance	GET /accumulatedBalance	List or find AccumulatedBalance objects
AccumulatedBalanceApi	retrieveAccumulatedBalance	GET /accumulatedBalance/{id}	Retrieves a AccumulatedBalance by ID
AdjustBalanceApi	createAdjustBalance	POST /adjustBalance	Creates a AdjustBalance
AdjustBalanceApi	deleteAdjustBalance	DELETE /adjustBalance/{id}	Deletes a AdjustBalance
AdjustBalanceApi	listAdjustBalance	GET /adjustBalance	List or find AdjustBalance objects
AdjustBalanceApi	patchAdjustBalance	PATCH /adjustBalance/{id}	Updates partially a AdjustBalance
AdjustBalanceApi	retrieveAdjustBalance	GET /adjustBalance/{id}	Retrieves a AdjustBalance by ID
BalanceActionHistoryApi	listBalanceActionHistory	GET /balanceActionHistory	List or find BalanceActionHistory objects
BalanceActionHistoryApi	retrieveBalanceActionHistory	GET /balanceActionHistory/{id}	Retrieves a BalanceActionHistory by ID
BucketApi	listBucket	GET /bucket	List or find Bucket objects
BucketApi	retrieveBucket	GET /bucket/{id}	Retrieves a Bucket by ID
EventsSubscriptionApi	registerListener	POST /hub	Register a listener
EventsSubscriptionApi	unregisterListener	DELETE /hub/{id}	Unregister a listener
NotificationListenersClientSideApi	listenToAdjustBalanceCancelEvent	POST /listener/adjustBalanceCancelEvent	Client listener for entity AdjustBalanceCancelEvent
NotificationListenersClientSideApi	listenToAdjustBalanceCreateEvent	POST /listener/adjustBalanceCreateEvent	Client listener for entity AdjustBalanceCreateEvent
NotificationListenersClientSideApi	listenToAdjustBalanceFailureEvent	POST /listener/adjustBalanceFailureEvent	Client listener for entity AdjustBalanceFailureEvent
NotificationListenersClientSideApi	listenToReserveBalanceCancelEvent	POST /listener/reserveBalanceCancelEvent	Client listener for entity ReserveBalanceCancelEvent
NotificationListenersClientSideApi	listenToReserveBalanceCreateEvent	POST /listener/reserveBalanceCreateEvent	Client listener for entity ReserveBalanceCreateEvent
NotificationListenersClientSideApi	listenToReserveBalanceFailureEvent	POST /listener/reserveBalanceFailureEvent	Client listener for entity ReserveBalanceFailureEvent
NotificationListenersClientSideApi	listenToTopupBalanceCancelEvent	POST /listener/topupBalanceCancelEvent	Client listener for entity TopupBalanceCancelEvent
NotificationListenersClientSideApi	listenToTopupBalanceCreateEvent	POST /listener/topupBalanceCreateEvent	Client listener for entity TopupBalanceCreateEvent
NotificationListenersClientSideApi	listenToTopupBalanceFailureEvent	POST /listener/topupBalanceFailureEvent	Client listener for entity TopupBalanceFailureEvent
NotificationListenersClientSideApi	listenToTransferBalanceCancelEvent	POST /listener/transferBalanceCancelEvent	Client listener for entity TransferBalanceCancelEvent
NotificationListenersClientSideApi	listenToTransferBalanceCreateEvent	POST /listener/transferBalanceCreateEvent	Client listener for entity TransferBalanceCreateEvent
NotificationListenersClientSideApi	listenToTransferBalanceFailureEvent	POST /listener/transferBalanceFailureEvent	Client listener for entity TransferBalanceFailureEvent
ReserveBalanceApi	createReserveBalance	POST /reserveBalance	Creates a ReserveBalance
ReserveBalanceApi	deleteReserveBalance	DELETE /reserveBalance/{id}	Deletes a ReserveBalance
ReserveBalanceApi	listReserveBalance	GET /reserveBalance	List or find ReserveBalance objects
ReserveBalanceApi	patchReserveBalance	PATCH /reserveBalance/{id}	Updates partially a ReserveBalance
ReserveBalanceApi	retrieveReserveBalance	GET /reserveBalance/{id}	Retrieves a ReserveBalance by ID
TopupBalanceApi	createTopupBalance	POST /topupBalance	Creates a TopupBalance
TopupBalanceApi	deleteTopupBalance	DELETE /topupBalance/{id}	Deletes a TopupBalance
TopupBalanceApi	listTopupBalance	GET /topupBalance	List or find TopupBalance objects
TopupBalanceApi	patchTopupBalance	PATCH /topupBalance/{id}	Updates partially a TopupBalance
TopupBalanceApi	retrieveTopupBalance	GET /topupBalance/{id}	Retrieves a TopupBalance by ID
TransferBalanceApi	createTransferBalance	POST /transferBalance	Creates a TransferBalance
TransferBalanceApi	deleteTransferBalance	DELETE /transferBalance/{id}	Deletes a TransferBalance
TransferBalanceApi	listTransferBalance	GET /transferBalance	List or find TransferBalance objects
TransferBalanceApi	patchTransferBalance	PATCH /transferBalance/{id}	Updates partially a TransferBalance
TransferBalanceApi	retrieveTransferBalance	GET /transferBalance/{id}	Retrieves a TransferBalance by ID

Documentation for Models

• AccumulatedBalance
• Action
• ActionStatusType
• Addressable
• AdjustBalance
• AdjustBalanceCancelEvent
• AdjustBalanceCancelEventPayload
• AdjustBalanceCreate
• AdjustBalanceCreateEvent
• AdjustBalanceCreateEventPayload
• AdjustBalanceFailureEvent
• AdjustBalanceFailureEventPayload
• AdjustBalanceUpdate
• AdjustType
• BalanceActionHistory
• Bucket
• BucketRef
• BucketStatusType
• ChannelRef
• CostOwnerType
• EntityRef
• Error
• EventSubscription
• EventSubscriptionInput
• Extensible
• LogicalResourceRef
• Money
• PartyAccountRef
• PaymentMethodRef
• ProductRef
• Quantity
• RecurringPeriodType
• RelatedParty
• RelatedTopupBalance
• ReserveBalance
• ReserveBalanceCancelEvent
• ReserveBalanceCancelEventPayload
• ReserveBalanceCreate
• ReserveBalanceCreateEvent
• ReserveBalanceCreateEventPayload
• ReserveBalanceFailureEvent
• ReserveBalanceFailureEventPayload
• ReserveBalanceUpdate
• TimePeriod
• TopupBalance
• TopupBalanceCancelEvent
• TopupBalanceCancelEventPayload
• TopupBalanceCreate
• TopupBalanceCreateEvent
• TopupBalanceCreateEventPayload
• TopupBalanceFailureEvent
• TopupBalanceFailureEventPayload
• TopupBalanceUpdate
• TransferBalance
• TransferBalanceCancelEvent
• TransferBalanceCancelEventPayload
• TransferBalanceCreate
• TransferBalanceCreateEvent
• TransferBalanceCreateEventPayload
• TransferBalanceFailureEvent
• TransferBalanceFailureEventPayload
• TransferBalanceUpdate
• UsageType

Documentation for Authorization

All endpoints do not require authorization. Authentication schemes defined for the API:

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author