org.gsm.oneapi.responsebean.payment
Class AmountReservationTransaction

java.lang.Object
  extended by org.gsm.oneapi.responsebean.payment.AmountReservationTransaction
All Implemented Interfaces:
java.io.Serializable

public class AmountReservationTransaction
extends java.lang.Object
implements java.io.Serializable

The main part of the OneAPI response for the "Reservation" payment operations including "Reserve Initial", "Reserve Additonal", "Charge Reserved" and "Release Reservation"

See Also:
Serialized Form

Nested Class Summary
static class AmountReservationTransaction.PaymentAmount
          the details of the actual payment are confirmed in the PaymentAmount inner class
 
Constructor Summary
AmountReservationTransaction()
           
 
Method Summary
 java.lang.String getClientCorrelator()
          return the clientCorrelator ensures the same payment request is only applied once
 java.lang.String getEndUserId()
          return the MSISDN or Anonymous Caller Reference of the user being charged
 AmountReservationTransaction.PaymentAmount getPaymentAmount()
          return the detail of the payment/ charge
 java.lang.String getReferenceCode()
          return your reference for reconciliation purposes.
 java.lang.Integer getReferenceSequence()
          return the sequence number for the reservation charging functions.
 java.lang.String getResourceURL()
          return the server allocated reference URL for this payment request
 java.lang.String getServerReferenceCode()
          return the server's reference code for this payment request - it must be used in any related payment requests
 java.lang.String getTransactionOperationStatus()
          return confirmation of the charging operation
 void setClientCorrelator(java.lang.String clientCorrelator)
          set the clientCorrelator ensures the same payment request is only applied once.
 void setEndUserId(java.lang.String endUserId)
          set the MSISDN or Anonymous Caller Reference of the user being charged.
 void setPaymentAmount(AmountReservationTransaction.PaymentAmount paymentAmount)
          set the detail of the payment/ charge.
 void setReferenceCode(java.lang.String referenceCode)
          set your reference for reconciliation purposes.
 void setReferenceSequence(java.lang.Integer referenceSequence)
          set the sequence number for the reservation charging functions.
 void setResourceURL(java.lang.String resourceURL)
          set the server allocated reference URL for this payment request.
 void setServerReferenceCode(java.lang.String serverReferenceCode)
          set the server's reference code for this payment request - it must be used in any related payment requests.
 void setTransactionOperationStatus(java.lang.String transactionOperationStatus)
          set confirmation of the charging operation.
 java.lang.String toString()
          generate a textual representation of the AmountReservationTransaction including all nested elements and classes
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

AmountReservationTransaction

public AmountReservationTransaction()
Method Detail

getClientCorrelator

public java.lang.String getClientCorrelator()
return the clientCorrelator ensures the same payment request is only applied once


getEndUserId

public java.lang.String getEndUserId()
return the MSISDN or Anonymous Caller Reference of the user being charged


getReferenceCode

public java.lang.String getReferenceCode()
return your reference for reconciliation purposes. The operator should include it in reports so that you can match their view of what has been sold with yours by matching the referenceCodes.


getReferenceSequence

public java.lang.Integer getReferenceSequence()
return the sequence number for the reservation charging functions. This allows the server to distinguish easily between new and repeated requests in the case of a communication failure.


getServerReferenceCode

public java.lang.String getServerReferenceCode()
return the server's reference code for this payment request - it must be used in any related payment requests


getResourceURL

public java.lang.String getResourceURL()
return the server allocated reference URL for this payment request


getTransactionOperationStatus

public java.lang.String getTransactionOperationStatus()
return confirmation of the charging operation


setClientCorrelator

public void setClientCorrelator(java.lang.String clientCorrelator)
set the clientCorrelator ensures the same payment request is only applied once. This is called internally to set the contents according to the JSON response.


setEndUserId

public void setEndUserId(java.lang.String endUserId)
set the MSISDN or Anonymous Caller Reference of the user being charged. This is called internally to set the contents according to the JSON response.


setReferenceCode

public void setReferenceCode(java.lang.String referenceCode)
set your reference for reconciliation purposes. The operator should include it in reports so that you can match their view of what has been sold with yours by matching the referenceCodes.. This is called internally to set the contents according to the JSON response.


setReferenceSequence

public void setReferenceSequence(java.lang.Integer referenceSequence)
set the sequence number for the reservation charging functions. This allows the server to distinguish easily between new and repeated requests in the case of a communication failure.


setServerReferenceCode

public void setServerReferenceCode(java.lang.String serverReferenceCode)
set the server's reference code for this payment request - it must be used in any related payment requests. This is called internally to set the contents according to the JSON response.


setResourceURL

public void setResourceURL(java.lang.String resourceURL)
set the server allocated reference URL for this payment request. This is called internally to set the contents according to the JSON response.


setTransactionOperationStatus

public void setTransactionOperationStatus(java.lang.String transactionOperationStatus)
set confirmation of the charging operation. This is called internally to set the contents according to the JSON response.


getPaymentAmount

public AmountReservationTransaction.PaymentAmount getPaymentAmount()
return the detail of the payment/ charge


setPaymentAmount

public void setPaymentAmount(AmountReservationTransaction.PaymentAmount paymentAmount)
set the detail of the payment/ charge. the detail of the payment/ charge


toString

public java.lang.String toString()
generate a textual representation of the AmountReservationTransaction including all nested elements and classes

Overrides:
toString in class java.lang.Object