Package com.orbipay.paymentsapi.client.wrappers

Class InvocationContext

  • public class InvocationContext
extends java.lang.Object

    • Constructor Summary

      Constructors 
      Constructor Description
      InvocationContext()  
      InvocationContext​(java.lang.String secret, java.lang.String idempotentRequestKey, java.lang.String xOPAYHeaders)
      Deprecated.
      InvocationContext​(java.lang.String secret, java.lang.String idempotentRequestKey, java.lang.String xOPAYHeaders, java.lang.String apiKey, java.lang.String authScheme)
      Deprecated.
      InvocationContext​(java.lang.String secret, java.lang.String idempotentRequestKey, java.lang.String xOPAYHeaders, java.lang.String apiKey, java.lang.String authScheme, java.lang.String traceId)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static InvocationContext fromJson​(java.lang.String json)  
      java.lang.String getApiKey()
      Get apiKey
      java.lang.String getAuthScheme()
      Get authScheme
      java.lang.String getChannel()
      The channel through which the API is invoked.
      java.lang.String getClientKey()
      The unique identifier assigned by EBPP to the client.
      java.lang.String getIdempotentRequestKey()
      The unique token that clients can generate and maintain in order to identify an API request.
      java.lang.String getProduct()
      The product identifier corresponding to the API.
      java.lang.String getRequestor()
      The identifier for the requestor of the API.
      java.lang.String getRequestorType()
      Type of the requestor of the API.
      java.lang.String getRequestUuid()
      The unique ID for the request, generated by EBPP, that can be used for tracing and audit trail.
      java.lang.String getResponseCodes()
      Codes corresponding to any additional information or warning, pertaining to the API call, in a comma separated format, that are returned in the response.
      java.lang.String getResponseText()
      The text detailing any additional information or warning, pertaining to the API call, in a pipe separated format, that is returned in the response.
      java.lang.String getSecret()
      Get secret
      java.lang.String getTimestamp()
      The timestamp for the moment when the API request is created.
      java.lang.String getTraceId()
      The unique reference that can be used for tracing and debugging an API call.
      java.lang.String getXOPAYHeaders()
      Intended for the future use.
      java.lang.String toJson()  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • InvocationContext

        public InvocationContext()

      • InvocationContext

        public InvocationContext​(java.lang.String secret,
                         java.lang.String idempotentRequestKey,
                         java.lang.String xOPAYHeaders,
                         java.lang.String apiKey,
                         java.lang.String authScheme,
                         java.lang.String traceId)

      • InvocationContext

        @Deprecated
public InvocationContext​(java.lang.String secret,
                         java.lang.String idempotentRequestKey,
                         java.lang.String xOPAYHeaders)
        Deprecated.

      • InvocationContext

        @Deprecated
public InvocationContext​(java.lang.String secret,
                         java.lang.String idempotentRequestKey,
                         java.lang.String xOPAYHeaders,
                         java.lang.String apiKey,
                         java.lang.String authScheme)
        Deprecated.

    • Method Detail

      • getClientKey

        public java.lang.String getClientKey()
        The unique identifier assigned by EBPP to the client.
        Returns:
        clientKey

      • getProduct

        public java.lang.String getProduct()
        The product identifier corresponding to the API.
        Returns:
        product

      • getTraceId

        public java.lang.String getTraceId()
        The unique reference that can be used for tracing and debugging an API call.
        Returns:
        traceId

      • getXOPAYHeaders

        public java.lang.String getXOPAYHeaders()
        Intended for the future use.
        Returns:
        xOPAYHeaders

      • getRequestorType

        public java.lang.String getRequestorType()
        Type of the requestor of the API.
        Returns:
        requestorType

      • getIdempotentRequestKey

        public java.lang.String getIdempotentRequestKey()
        The unique token that clients can generate and maintain in order to identify an API request.
        Returns:
        idempotentRequestKey

      • getRequestUuid

        public java.lang.String getRequestUuid()
        The unique ID for the request, generated by EBPP, that can be used for tracing and audit trail.
        Returns:
        requestUuid

      • getChannel

        public java.lang.String getChannel()
        The channel through which the API is invoked.
        Returns:
        channel

      • getResponseCodes

        public java.lang.String getResponseCodes()
        Codes corresponding to any additional information or warning, pertaining to the API call, in a comma separated format, that are returned in the response.
        Returns:
        responseCodes

      • getResponseText

        public java.lang.String getResponseText()
        The text detailing any additional information or warning, pertaining to the API call, in a pipe separated format, that is returned in the response.
        Returns:
        responseText

      • getRequestor

        public java.lang.String getRequestor()
        The identifier for the requestor of the API.
        Returns:
        requestor

      • getTimestamp

        public java.lang.String getTimestamp()
        The timestamp for the moment when the API request is created.
        Returns:
        timestamp

      • getSecret

        public java.lang.String getSecret()
        Get secret
        Returns:
        secret

      • getApiKey

        public java.lang.String getApiKey()
        Get apiKey
        Returns:
        apiKey

      • getAuthScheme

        public java.lang.String getAuthScheme()
        Get authScheme
        Returns:
        authScheme