Orbipay.PaymentsApi.Client.Api.IPaymentEnrollmentApi Interface Reference

More...

Inheritance diagram for Orbipay.PaymentsApi.Client.Api.IPaymentEnrollmentApi:

Public Member Functions
ApiResponse < PBTEnrollmentResponse >	ManagePBTEnrollment (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string requestor, ManagePBTRequest managePBTRequest, string xOPAYHeaders=null, string traceId=null)
	Manage PBT Enrollment More...
ApiResponse < PBTEnrollmentResponse >	ManagePBTEnrollmentWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string requestor, ManagePBTRequest managePBTRequest, string xOPAYHeaders=null, string traceId=null)
	Manage PBT Enrollment More...
ApiResponse < PBTEnrollmentsResponse >	RetrievePBTs (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string requestor, string idCustomer, string xOPAYHeaders=null, string traceId=null, string idCustomerAccount=null)
	Retrieve PBT Enrollments More...
ApiResponse < PBTEnrollmentsResponse >	RetrievePBTsWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string requestor, string idCustomer, string xOPAYHeaders=null, string traceId=null, string idCustomerAccount=null)
	Retrieve PBT Enrollments More...
System.Threading.Tasks.Task < PBTEnrollmentResponse >	ManagePBTEnrollmentAsync (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string requestor, ManagePBTRequest managePBTRequest, string xOPAYHeaders=null, string traceId=null)
	Manage PBT Enrollment More...
System.Threading.Tasks.Task < ApiResponse < PBTEnrollmentResponse > >	ManagePBTEnrollmentAsyncWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string requestor, ManagePBTRequest managePBTRequest, string xOPAYHeaders=null, string traceId=null)
	Manage PBT Enrollment More...
System.Threading.Tasks.Task < PBTEnrollmentsResponse >	RetrievePBTsAsync (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string requestor, string idCustomer, string xOPAYHeaders=null, string traceId=null, string idCustomerAccount=null)
	Retrieve PBT Enrollments More...
System.Threading.Tasks.Task < ApiResponse < PBTEnrollmentsResponse > >	RetrievePBTsAsyncWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string requestor, string idCustomer, string xOPAYHeaders=null, string traceId=null, string idCustomerAccount=null)
	Retrieve PBT Enrollments More...
Public Member Functions inherited from Orbipay.PaymentsApi.Client.Client.IApiAccessor
String	GetBasePath ()
	Gets the base path of the API client. More...

Additional Inherited Members
Properties inherited from Orbipay.PaymentsApi.Client.Client.IApiAccessor
Configuration	Configuration [get, set]
	Gets or sets the configuration object More...
ExceptionFactory	ExceptionFactory [get, set]
	Provides a factory method hook for the creation of exceptions. More...

Detailed Description

This class subject to change without prior notice, Please dont use this class directly.

Member Function Documentation

ApiResponse<PBTEnrollmentResponse> Orbipay.PaymentsApi.Client.Api.IPaymentEnrollmentApi.ManagePBTEnrollment	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	requestor,
		ManagePBTRequest	managePBTRequest,
		string	xOPAYHeaders = null,
		string	traceId = null
	)

Manage PBT Enrollment

This API allows the management of Pay-By-Text (PBT) enrollment for a given customer by providing details such as phone number, customer account, funding account, and enrollment status. The API supports three main functionalities, which are create new enrollment, update existing enrollment or unenroll existing enrollment

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException

Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
requestor	The identifier for the requestor of the API.
managePBTRequest	JSON containing all the fields required to manage a customer for PBT enrollment.
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)

Returns

ApiResponse<PBTEnrollmentResponse>

Implemented in Orbipay.PaymentsApi.Client.Api.PaymentEnrollmentApi.

System.Threading.Tasks.Task<PBTEnrollmentResponse> Orbipay.PaymentsApi.Client.Api.IPaymentEnrollmentApi.ManagePBTEnrollmentAsync	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	requestor,
		ManagePBTRequest	managePBTRequest,
		string	xOPAYHeaders = null,
		string	traceId = null
	)

Manage PBT Enrollment

This API allows the management of Pay-By-Text (PBT) enrollment for a given customer by providing details such as phone number, customer account, funding account, and enrollment status. The API supports three main functionalities, which are create new enrollment, update existing enrollment or unenroll existing enrollment

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException

Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
requestor	The identifier for the requestor of the API.
managePBTRequest	JSON containing all the fields required to manage a customer for PBT enrollment.
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)

Returns

Task of PBTEnrollmentResponse

Implemented in Orbipay.PaymentsApi.Client.Api.PaymentEnrollmentApi.

System.Threading.Tasks.Task<ApiResponse<PBTEnrollmentResponse> > Orbipay.PaymentsApi.Client.Api.IPaymentEnrollmentApi.ManagePBTEnrollmentAsyncWithHttpInfo	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	requestor,
		ManagePBTRequest	managePBTRequest,
		string	xOPAYHeaders = null,
		string	traceId = null
	)

Manage PBT Enrollment

This API allows the management of Pay-By-Text (PBT) enrollment for a given customer by providing details such as phone number, customer account, funding account, and enrollment status. The API supports three main functionalities, which are create new enrollment, update existing enrollment or unenroll existing enrollment

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException

Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
requestor	The identifier for the requestor of the API.
managePBTRequest	JSON containing all the fields required to manage a customer for PBT enrollment.
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)

Returns

Task of ApiResponse (PBTEnrollmentResponse)

Implemented in Orbipay.PaymentsApi.Client.Api.PaymentEnrollmentApi.

ApiResponse<PBTEnrollmentResponse> Orbipay.PaymentsApi.Client.Api.IPaymentEnrollmentApi.ManagePBTEnrollmentWithHttpInfo	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	requestor,
		ManagePBTRequest	managePBTRequest,
		string	xOPAYHeaders = null,
		string	traceId = null
	)

Manage PBT Enrollment

This API allows the management of Pay-By-Text (PBT) enrollment for a given customer by providing details such as phone number, customer account, funding account, and enrollment status. The API supports three main functionalities, which are create new enrollment, update existing enrollment or unenroll existing enrollment

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException

Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
requestor	The identifier for the requestor of the API.
managePBTRequest	JSON containing all the fields required to manage a customer for PBT enrollment.
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)

Returns

ApiResponse of PBTEnrollmentResponse

Implemented in Orbipay.PaymentsApi.Client.Api.PaymentEnrollmentApi.

ApiResponse<PBTEnrollmentsResponse> Orbipay.PaymentsApi.Client.Api.IPaymentEnrollmentApi.RetrievePBTs	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	requestor,
		string	idCustomer,
		string	xOPAYHeaders = null,
		string	traceId = null,
		string	idCustomerAccount = null
	)

Retrieve PBT Enrollments

The API can be utilized to retrieve the enrollment details of Pay by Text (PBT) for a specified customer based on search criteria.

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException

Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
requestor	The identifier for the requestor of the API.
idCustomer	The unique identifier assigned by EBPP to the customer.
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)
idCustomerAccount	The unique identifier assigned by EBPP to the customer account (optional)

Returns

ApiResponse<PBTEnrollmentsResponse>

Implemented in Orbipay.PaymentsApi.Client.Api.PaymentEnrollmentApi.

System.Threading.Tasks.Task<PBTEnrollmentsResponse> Orbipay.PaymentsApi.Client.Api.IPaymentEnrollmentApi.RetrievePBTsAsync	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	requestor,
		string	idCustomer,
		string	xOPAYHeaders = null,
		string	traceId = null,
		string	idCustomerAccount = null
	)

Retrieve PBT Enrollments

The API can be utilized to retrieve the enrollment details of Pay by Text (PBT) for a specified customer based on search criteria.

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException

Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
requestor	The identifier for the requestor of the API.
idCustomer	The unique identifier assigned by EBPP to the customer.
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)
idCustomerAccount	The unique identifier assigned by EBPP to the customer account (optional)

Returns

Task of PBTEnrollmentsResponse

Implemented in Orbipay.PaymentsApi.Client.Api.PaymentEnrollmentApi.

System.Threading.Tasks.Task<ApiResponse<PBTEnrollmentsResponse> > Orbipay.PaymentsApi.Client.Api.IPaymentEnrollmentApi.RetrievePBTsAsyncWithHttpInfo	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	requestor,
		string	idCustomer,
		string	xOPAYHeaders = null,
		string	traceId = null,
		string	idCustomerAccount = null
	)

Retrieve PBT Enrollments

The API can be utilized to retrieve the enrollment details of Pay by Text (PBT) for a specified customer based on search criteria.

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException

Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
requestor	The identifier for the requestor of the API.
idCustomer	The unique identifier assigned by EBPP to the customer.
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)
idCustomerAccount	The unique identifier assigned by EBPP to the customer account (optional)

Returns

Task of ApiResponse (PBTEnrollmentsResponse)

Implemented in Orbipay.PaymentsApi.Client.Api.PaymentEnrollmentApi.

ApiResponse<PBTEnrollmentsResponse> Orbipay.PaymentsApi.Client.Api.IPaymentEnrollmentApi.RetrievePBTsWithHttpInfo	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	requestor,
		string	idCustomer,
		string	xOPAYHeaders = null,
		string	traceId = null,
		string	idCustomerAccount = null
	)

Retrieve PBT Enrollments

The API can be utilized to retrieve the enrollment details of Pay by Text (PBT) for a specified customer based on search criteria.

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException

Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
requestor	The identifier for the requestor of the API.
idCustomer	The unique identifier assigned by EBPP to the customer.
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)
idCustomerAccount	The unique identifier assigned by EBPP to the customer account (optional)

Returns

ApiResponse of PBTEnrollmentsResponse

Implemented in Orbipay.PaymentsApi.Client.Api.PaymentEnrollmentApi.

---

The documentation for this interface was generated from the following file:

• src/Orbipay.PaymentsApi.Client/Api/PaymentEnrollmentApi.cs