Represents a collection of functions to interact with the API endpoints More...

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

Public Member Functions
	PaymentEnrollmentApi (String basePath)
	Initializes a new instance of the PaymentEnrollmentApi class. More...

	PaymentEnrollmentApi (Orbipay.PaymentsApi.Client.Client.Configuration configuration=null)
	Initializes a new instance of the PaymentEnrollmentApi class using Configuration object More...

String	GetBasePath ()
	Gets the base path of the API client. More...

void	SetBasePath (String basePath)
	Sets the base path of the API client. More...

IDictionary< String, String >	DefaultHeader ()
	Gets the default header. More...

void	AddDefaultHeader (string key, string value)
	Add default header. More...

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 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 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 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 More...

async 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 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 More...

async 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 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 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 The API can be utilized to retrieve the enrollment details of Pay by Text (PBT) for a specified customer based on search criteria. 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 The API can be utilized to retrieve the enrollment details of Pay by Text (PBT) for a specified customer based on search criteria. More...

async 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 The API can be utilized to retrieve the enrollment details of Pay by Text (PBT) for a specified customer based on search criteria. More...

async 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 The API can be utilized to retrieve the enrollment details of Pay by Text (PBT) for a specified customer based on search criteria. More...

Properties
Orbipay.PaymentsApi.Client.Client.Configuration	Configuration `[get, set]`
	Gets or sets the configuration object More...

Orbipay.PaymentsApi.Client.Client.ExceptionFactory	ExceptionFactory `[get, set]`
	Provides a factory method hook for the creation of exceptions. More...

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

Represents a collection of functions to interact with the API endpoints

Constructor & Destructor Documentation

Orbipay.PaymentsApi.Client.Api.PaymentEnrollmentApi.PaymentEnrollmentApi ( String basePath )

Initializes a new instance of the PaymentEnrollmentApi class.

Returns

Orbipay.PaymentsApi.Client.Api.PaymentEnrollmentApi.PaymentEnrollmentApi ( Orbipay.PaymentsApi.Client.Client.Configuration configuration = null )

Initializes a new instance of the PaymentEnrollmentApi class using Configuration object

Parameters

configuration An instance of Configuration

Returns

Member Function Documentation

void Orbipay.PaymentsApi.Client.Api.PaymentEnrollmentApi.AddDefaultHeader	(	string	key,
		string	value
	)

Add default header.

Parameters

key	Header field name.
value	Header field value.

Returns

IDictionary<String, String> Orbipay.PaymentsApi.Client.Api.PaymentEnrollmentApi.DefaultHeader ( )

Gets the default header.

Returns: Dictionary of HTTP header

String Orbipay.PaymentsApi.Client.Api.PaymentEnrollmentApi.GetBasePath ( )

Gets the base path of the API client.

The base path

Implements Orbipay.PaymentsApi.Client.Client.IApiAccessor.

ApiResponse<PBTEnrollmentResponse> Orbipay.PaymentsApi.Client.Api.PaymentEnrollmentApi.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: PBTEnrollmentResponse

Implements Orbipay.PaymentsApi.Client.Api.IPaymentEnrollmentApi.

async System.Threading.Tasks.Task<PBTEnrollmentResponse> Orbipay.PaymentsApi.Client.Api.PaymentEnrollmentApi.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

Implements Orbipay.PaymentsApi.Client.Api.IPaymentEnrollmentApi.

async System.Threading.Tasks.Task<ApiResponse<PBTEnrollmentResponse> > Orbipay.PaymentsApi.Client.Api.PaymentEnrollmentApi.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)

Implements Orbipay.PaymentsApi.Client.Api.IPaymentEnrollmentApi.

ApiResponse< PBTEnrollmentResponse > Orbipay.PaymentsApi.Client.Api.PaymentEnrollmentApi.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

Implements Orbipay.PaymentsApi.Client.Api.IPaymentEnrollmentApi.

ApiResponse<PBTEnrollmentsResponse> Orbipay.PaymentsApi.Client.Api.PaymentEnrollmentApi.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: PBTEnrollmentsResponse

Implements Orbipay.PaymentsApi.Client.Api.IPaymentEnrollmentApi.

async System.Threading.Tasks.Task<PBTEnrollmentsResponse> Orbipay.PaymentsApi.Client.Api.PaymentEnrollmentApi.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

Implements Orbipay.PaymentsApi.Client.Api.IPaymentEnrollmentApi.

async System.Threading.Tasks.Task<ApiResponse<PBTEnrollmentsResponse> > Orbipay.PaymentsApi.Client.Api.PaymentEnrollmentApi.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)

Implements Orbipay.PaymentsApi.Client.Api.IPaymentEnrollmentApi.

ApiResponse< PBTEnrollmentsResponse > Orbipay.PaymentsApi.Client.Api.PaymentEnrollmentApi.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

Implements Orbipay.PaymentsApi.Client.Api.IPaymentEnrollmentApi.

void Orbipay.PaymentsApi.Client.Api.PaymentEnrollmentApi.SetBasePath ( String basePath )

Sets the base path of the API client.

The base path

Property Documentation

Orbipay.PaymentsApi.Client.Client.Configuration Orbipay.PaymentsApi.Client.Api.PaymentEnrollmentApi.Configuration

getset

Gets or sets the configuration object

An instance of the Configuration

Orbipay.PaymentsApi.Client.Client.ExceptionFactory Orbipay.PaymentsApi.Client.Api.PaymentEnrollmentApi.ExceptionFactory

getset

Provides a factory method hook for the creation of exceptions.

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

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

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation