|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface AmountCharging
The interface containing the charge operations by amount.
Method Summary | |
---|---|
void |
chargeAmount(java.net.URI endUserIdentifier,
ChargingInformation charge,
java.lang.String referenceCode)
This operation results in directly charging to the account indicated by the end user identifier. |
void |
refundAmount(java.net.URI endUserIdentifier,
ChargingInformation charge,
java.lang.String referenceCode)
This operation results in directly applying a refund to the account indicated by the end user identifier. |
Method Detail |
---|
void chargeAmount(java.net.URI endUserIdentifier, ChargingInformation charge, java.lang.String referenceCode) throws java.rmi.RemoteException, PolicyException, ServiceException
This operation results in directly charging to the account indicated by the end user identifier. The charge is specified as a ChargingInformation data structure, consisting of information on the amount to be charged and a description to appear on the bill. The reference code is used to uniquely identify the request; it is the application's responsibility to provide a unique reference code within the scope of the application.
ServiceException from ES 202 391-1 [2]:
* SVC0001 - Service error.
* SVC0002 - Invalid input value.
* SVC0007 - Invalid charging information
* SVC0270 - Charge failed.
PolicyException from ES 202 391-1 [2]:
* POL0001 - Policy error.
endUserIdentifier
- xsd:anyURI
The end user's account to be chargedcharge
- common:ChargingInformation
Information on the charge to be made. In the ChargingInformation structure:
* the description element is information to appear on the bill.
* the amount to be charged appears either directly in the amount element or encoded in the code element. If both these elements are missing or empty, a service exception (SVC0007) will be thrown.
* the optional currency element specifies the currency to be used for the charge.
referenceCode
- xsd:string
Textual information to uniquely identify the request, for example, in case of disputes
java.rmi.RemoteException
PolicyException
ServiceException
void refundAmount(java.net.URI endUserIdentifier, ChargingInformation charge, java.lang.String referenceCode) throws java.rmi.RemoteException, PolicyException, ServiceException
This operation results in directly applying a refund to the account indicated by the end user identifier. The refund is specified as a currency amount. The billing text field is used for textual information to appear on the bill. The reference code is used to uniquely identify the request; it is the application's responsibility to provide a unique reference code within the scope of the application.
ServiceException from ES 202 391-1 [2]:
* SVC0001 - Service error.
* SVC0002 - Invalid input value.
* SVC0007 - Invalid charging information
* SVC0270 - Charge failed.
PolicyException from ES 202 391-1 [2]:
* POL0001 - Policy error.
endUserIdentifier
- xsd:anyURI
The end user's account to be refundedcharge
- common:ChargingInformation
Information on the refund to be made. In the ChargingInformation structure:
* the description element is information to appear on the bill.
* the amount to be refunded appears either directly in the amount element or encoded in the code element. If both these elements are missing or empty, a service exception (SVC0007) will be thrown.
* the optional currency element specifies the currency to be used for the refund.
referenceCode
- xsd:string
Textual information to uniquely identify the request, for example, in case of disputes
java.rmi.RemoteException
PolicyException
ServiceException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |