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

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

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

	PaymentSetupApi (Orbipay.PaymentsApi.Client.Client.Configuration configuration=null)
	Initializes a new instance of the PaymentSetupApi 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< PaymentSetupResponse >	CreateRecurringPaymentSetup (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_CUSTOMER, CreatePaymentSetupRequest createPaymentSetupRequest, string requestor=null, string xOPAYHeaders=null, string traceId=null)
	Create Payment Setup The API is used to set up recurring payments to service a customer account. More...

ApiResponse< PaymentSetupResponse >	CreateRecurringPaymentSetupWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_CUSTOMER, CreatePaymentSetupRequest createPaymentSetupRequest, string requestor=null, string xOPAYHeaders=null, string traceId=null)
	Create Payment Setup The API is used to set up recurring payments to service a customer account. More...

async System.Threading.Tasks.Task < PaymentSetupResponse >	CreateRecurringPaymentSetupAsync (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_CUSTOMER, CreatePaymentSetupRequest createPaymentSetupRequest, string requestor=null, string xOPAYHeaders=null, string traceId=null)
	Create Payment Setup The API is used to set up recurring payments to service a customer account. More...

async System.Threading.Tasks.Task < ApiResponse < PaymentSetupResponse > >	CreateRecurringPaymentSetupAsyncWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_CUSTOMER, CreatePaymentSetupRequest createPaymentSetupRequest, string requestor=null, string xOPAYHeaders=null, string traceId=null)
	Create Payment Setup The API is used to set up recurring payments to service a customer account. More...

ApiResponse< DeleteResponse >	DeletePaymentSetup (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_PAYMENT_SETUP, string ID_CUSTOMER, DeletePaymentSetupRequest deletePaymentSetupRequest, string requestor=null, string xOPAYHeaders=null, string traceId=null)
	Delete Payment Setup The API is used to delete or cancel a recurring payment setup. Cancelling a payment setup will also cancel all the pending and future payments under the setup. More...

ApiResponse< DeleteResponse >	DeletePaymentSetupWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_PAYMENT_SETUP, string ID_CUSTOMER, DeletePaymentSetupRequest deletePaymentSetupRequest, string requestor=null, string xOPAYHeaders=null, string traceId=null)
	Delete Payment Setup The API is used to delete or cancel a recurring payment setup. Cancelling a payment setup will also cancel all the pending and future payments under the setup. More...

async System.Threading.Tasks.Task < DeleteResponse >	DeletePaymentSetupAsync (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_PAYMENT_SETUP, string ID_CUSTOMER, DeletePaymentSetupRequest deletePaymentSetupRequest, string requestor=null, string xOPAYHeaders=null, string traceId=null)
	Delete Payment Setup The API is used to delete or cancel a recurring payment setup. Cancelling a payment setup will also cancel all the pending and future payments under the setup. More...

async System.Threading.Tasks.Task < ApiResponse< DeleteResponse > >	DeletePaymentSetupAsyncWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_PAYMENT_SETUP, string ID_CUSTOMER, DeletePaymentSetupRequest deletePaymentSetupRequest, string requestor=null, string xOPAYHeaders=null, string traceId=null)
	Delete Payment Setup The API is used to delete or cancel a recurring payment setup. Cancelling a payment setup will also cancel all the pending and future payments under the setup. More...

ApiResponse< PaymentSetupResponse >	GetPaymentSetup (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_PAYMENT_SETUP, string ID_CUSTOMER, string requestor=null, string xOPAYHeaders=null, string traceId=null)
	Get Payment Setup The API is used to retrieve the details of a recurring payment setup by id. More...

ApiResponse< PaymentSetupResponse >	GetPaymentSetupWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_PAYMENT_SETUP, string ID_CUSTOMER, string requestor=null, string xOPAYHeaders=null, string traceId=null)
	Get Payment Setup The API is used to retrieve the details of a recurring payment setup by id. More...

async System.Threading.Tasks.Task < PaymentSetupResponse >	GetPaymentSetupAsync (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_PAYMENT_SETUP, string ID_CUSTOMER, string requestor=null, string xOPAYHeaders=null, string traceId=null)
	Get Payment Setup The API is used to retrieve the details of a recurring payment setup by id. More...

async System.Threading.Tasks.Task < ApiResponse < PaymentSetupResponse > >	GetPaymentSetupAsyncWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_PAYMENT_SETUP, string ID_CUSTOMER, string requestor=null, string xOPAYHeaders=null, string traceId=null)
	Get Payment Setup The API is used to retrieve the details of a recurring payment setup by id. More...

ApiResponse < PaymentSetupsResponse >	RetrievePaymentSetups (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string requestor=null, string xOPAYHeaders=null, string traceId=null, string idCustomer=null, string idFundingAccount=null, string idCustomerAccount=null, string confirmationNumber=null, List< string > status=null, List< string > paymentSetupScheduleType=null, string fromDate=null, string toDate=null, string pageSize=null, string queryId=null, string fromIndex=null, string toIndex=null)
	Retrieve Payment Setups The API is used to retrieve the recurring and autopay payments setup made against a customer account. The setup can be filtered using the confirmation number, customer account, funding account, status and payment setup schedule type, by date range and others mentioned below. If no dates are provided for retrieval, recurring payments set up in the last six months and all the ones in future are returned. If the requestor type is customer then the id_customer request parameter is mandatory. The results are sorted in descending order of the payment_start_date followed by the last_modified_time. More...

ApiResponse < PaymentSetupsResponse >	RetrievePaymentSetupsWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string requestor=null, string xOPAYHeaders=null, string traceId=null, string idCustomer=null, string idFundingAccount=null, string idCustomerAccount=null, string confirmationNumber=null, List< string > status=null, List< string > paymentSetupScheduleType=null, string fromDate=null, string toDate=null, string pageSize=null, string queryId=null, string fromIndex=null, string toIndex=null)
	Retrieve Payment Setups The API is used to retrieve the recurring and autopay payments setup made against a customer account. The setup can be filtered using the confirmation number, customer account, funding account, status and payment setup schedule type, by date range and others mentioned below. If no dates are provided for retrieval, recurring payments set up in the last six months and all the ones in future are returned. If the requestor type is customer then the id_customer request parameter is mandatory. The results are sorted in descending order of the payment_start_date followed by the last_modified_time. More...

async System.Threading.Tasks.Task < PaymentSetupsResponse >	RetrievePaymentSetupsAsync (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string requestor=null, string xOPAYHeaders=null, string traceId=null, string idCustomer=null, string idFundingAccount=null, string idCustomerAccount=null, string confirmationNumber=null, List< string > status=null, List< string > paymentSetupScheduleType=null, string fromDate=null, string toDate=null, string pageSize=null, string queryId=null, string fromIndex=null, string toIndex=null)
	Retrieve Payment Setups The API is used to retrieve the recurring and autopay payments setup made against a customer account. The setup can be filtered using the confirmation number, customer account, funding account, status and payment setup schedule type, by date range and others mentioned below. If no dates are provided for retrieval, recurring payments set up in the last six months and all the ones in future are returned. If the requestor type is customer then the id_customer request parameter is mandatory. The results are sorted in descending order of the payment_start_date followed by the last_modified_time. More...

async System.Threading.Tasks.Task < ApiResponse < PaymentSetupsResponse > >	RetrievePaymentSetupsAsyncWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string requestor=null, string xOPAYHeaders=null, string traceId=null, string idCustomer=null, string idFundingAccount=null, string idCustomerAccount=null, string confirmationNumber=null, List< string > status=null, List< string > paymentSetupScheduleType=null, string fromDate=null, string toDate=null, string pageSize=null, string queryId=null, string fromIndex=null, string toIndex=null)
	Retrieve Payment Setups The API is used to retrieve the recurring and autopay payments setup made against a customer account. The setup can be filtered using the confirmation number, customer account, funding account, status and payment setup schedule type, by date range and others mentioned below. If no dates are provided for retrieval, recurring payments set up in the last six months and all the ones in future are returned. If the requestor type is customer then the id_customer request parameter is mandatory. The results are sorted in descending order of the payment_start_date followed by the last_modified_time. More...

ApiResponse< PaymentSetupResponse >	UpdatePaymentSetup (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_PAYMENT_SETUP, string ID_CUSTOMER, UpdatePaymentSetupRequest updatePaymentSetupRequest, string requestor=null, string xOPAYHeaders=null, string traceId=null)
	Update Payment Setup The API is used to edit a payment Setup. Only autopay payment setup is allowed to edit. More...

ApiResponse< PaymentSetupResponse >	UpdatePaymentSetupWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_PAYMENT_SETUP, string ID_CUSTOMER, UpdatePaymentSetupRequest updatePaymentSetupRequest, string requestor=null, string xOPAYHeaders=null, string traceId=null)
	Update Payment Setup The API is used to edit a payment Setup. Only autopay payment setup is allowed to edit. More...

async System.Threading.Tasks.Task < PaymentSetupResponse >	UpdatePaymentSetupAsync (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_PAYMENT_SETUP, string ID_CUSTOMER, UpdatePaymentSetupRequest updatePaymentSetupRequest, string requestor=null, string xOPAYHeaders=null, string traceId=null)
	Update Payment Setup The API is used to edit a payment Setup. Only autopay payment setup is allowed to edit. More...

async System.Threading.Tasks.Task < ApiResponse < PaymentSetupResponse > >	UpdatePaymentSetupAsyncWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_PAYMENT_SETUP, string ID_CUSTOMER, UpdatePaymentSetupRequest updatePaymentSetupRequest, string requestor=null, string xOPAYHeaders=null, string traceId=null)
	Update Payment Setup The API is used to edit a payment Setup. Only autopay payment setup is allowed to edit. 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.PaymentSetupApi.PaymentSetupApi ( String basePath )

Initializes a new instance of the PaymentSetupApi class.

Returns

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

Initializes a new instance of the PaymentSetupApi class using Configuration object

Parameters

configuration An instance of Configuration

Returns

Member Function Documentation

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

Add default header.

Parameters

key	Header field name.
value	Header field value.

Returns

ApiResponse<PaymentSetupResponse> Orbipay.PaymentsApi.Client.Api.PaymentSetupApi.CreateRecurringPaymentSetup	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_CUSTOMER,
		CreatePaymentSetupRequest	createPaymentSetupRequest,
		string	requestor = `null`,
		string	xOPAYHeaders = `null`,
		string	traceId = `null`
	)

Create Payment Setup The API is used to set up recurring payments to service a customer account.

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.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
createPaymentSetupRequest	JSON containing all the fields required to create a recurring payment setup.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)

Returns: PaymentSetupResponse

Implements Orbipay.PaymentsApi.Client.Api.IPaymentSetupApi.

async System.Threading.Tasks.Task<PaymentSetupResponse> Orbipay.PaymentsApi.Client.Api.PaymentSetupApi.CreateRecurringPaymentSetupAsync	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_CUSTOMER,
		CreatePaymentSetupRequest	createPaymentSetupRequest,
		string	requestor = `null`,
		string	xOPAYHeaders = `null`,
		string	traceId = `null`
	)

Create Payment Setup The API is used to set up recurring payments to service a customer account.

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.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
createPaymentSetupRequest	JSON containing all the fields required to create a recurring payment setup.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
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 PaymentSetupResponse

Implements Orbipay.PaymentsApi.Client.Api.IPaymentSetupApi.

async System.Threading.Tasks.Task<ApiResponse<PaymentSetupResponse> > Orbipay.PaymentsApi.Client.Api.PaymentSetupApi.CreateRecurringPaymentSetupAsyncWithHttpInfo	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_CUSTOMER,
		CreatePaymentSetupRequest	createPaymentSetupRequest,
		string	requestor = `null`,
		string	xOPAYHeaders = `null`,
		string	traceId = `null`
	)

Create Payment Setup The API is used to set up recurring payments to service a customer account.

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.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
createPaymentSetupRequest	JSON containing all the fields required to create a recurring payment setup.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
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 (PaymentSetupResponse)

Implements Orbipay.PaymentsApi.Client.Api.IPaymentSetupApi.

ApiResponse< PaymentSetupResponse > Orbipay.PaymentsApi.Client.Api.PaymentSetupApi.CreateRecurringPaymentSetupWithHttpInfo	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_CUSTOMER,
		CreatePaymentSetupRequest	createPaymentSetupRequest,
		string	requestor = `null`,
		string	xOPAYHeaders = `null`,
		string	traceId = `null`
	)

Create Payment Setup The API is used to set up recurring payments to service a customer account.

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.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
createPaymentSetupRequest	JSON containing all the fields required to create a recurring payment setup.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
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 PaymentSetupResponse

Implements Orbipay.PaymentsApi.Client.Api.IPaymentSetupApi.

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

Gets the default header.

Returns: Dictionary of HTTP header

ApiResponse<DeleteResponse> Orbipay.PaymentsApi.Client.Api.PaymentSetupApi.DeletePaymentSetup	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_PAYMENT_SETUP,
		string	ID_CUSTOMER,
		DeletePaymentSetupRequest	deletePaymentSetupRequest,
		string	requestor = `null`,
		string	xOPAYHeaders = `null`,
		string	traceId = `null`
	)

Delete Payment Setup The API is used to delete or cancel a recurring payment setup. Cancelling a payment setup will also cancel all the pending and future payments under the setup.

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.
ID_PAYMENT_SETUP	The unique identifier assigned by EBPP to the payment setup.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
deletePaymentSetupRequest	JSON containing all the fields required to delete a payment. Setup.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)

Returns: DeleteResponse

Implements Orbipay.PaymentsApi.Client.Api.IPaymentSetupApi.

async System.Threading.Tasks.Task<DeleteResponse> Orbipay.PaymentsApi.Client.Api.PaymentSetupApi.DeletePaymentSetupAsync	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_PAYMENT_SETUP,
		string	ID_CUSTOMER,
		DeletePaymentSetupRequest	deletePaymentSetupRequest,
		string	requestor = `null`,
		string	xOPAYHeaders = `null`,
		string	traceId = `null`
	)

Delete Payment Setup The API is used to delete or cancel a recurring payment setup. Cancelling a payment setup will also cancel all the pending and future payments under the setup.

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.
ID_PAYMENT_SETUP	The unique identifier assigned by EBPP to the payment setup.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
deletePaymentSetupRequest	JSON containing all the fields required to delete a payment. Setup.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
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 DeleteResponse

Implements Orbipay.PaymentsApi.Client.Api.IPaymentSetupApi.

async System.Threading.Tasks.Task<ApiResponse<DeleteResponse> > Orbipay.PaymentsApi.Client.Api.PaymentSetupApi.DeletePaymentSetupAsyncWithHttpInfo	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_PAYMENT_SETUP,
		string	ID_CUSTOMER,
		DeletePaymentSetupRequest	deletePaymentSetupRequest,
		string	requestor = `null`,
		string	xOPAYHeaders = `null`,
		string	traceId = `null`
	)

Delete Payment Setup The API is used to delete or cancel a recurring payment setup. Cancelling a payment setup will also cancel all the pending and future payments under the setup.

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.
ID_PAYMENT_SETUP	The unique identifier assigned by EBPP to the payment setup.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
deletePaymentSetupRequest	JSON containing all the fields required to delete a payment. Setup.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
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 (DeleteResponse)

Implements Orbipay.PaymentsApi.Client.Api.IPaymentSetupApi.

ApiResponse< DeleteResponse > Orbipay.PaymentsApi.Client.Api.PaymentSetupApi.DeletePaymentSetupWithHttpInfo	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_PAYMENT_SETUP,
		string	ID_CUSTOMER,
		DeletePaymentSetupRequest	deletePaymentSetupRequest,
		string	requestor = `null`,
		string	xOPAYHeaders = `null`,
		string	traceId = `null`
	)

Delete Payment Setup The API is used to delete or cancel a recurring payment setup. Cancelling a payment setup will also cancel all the pending and future payments under the setup.

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.
ID_PAYMENT_SETUP	The unique identifier assigned by EBPP to the payment setup.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
deletePaymentSetupRequest	JSON containing all the fields required to delete a payment. Setup.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
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 DeleteResponse

Implements Orbipay.PaymentsApi.Client.Api.IPaymentSetupApi.

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

Gets the base path of the API client.

The base path

Implements Orbipay.PaymentsApi.Client.Client.IApiAccessor.

ApiResponse<PaymentSetupResponse> Orbipay.PaymentsApi.Client.Api.PaymentSetupApi.GetPaymentSetup	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_PAYMENT_SETUP,
		string	ID_CUSTOMER,
		string	requestor = `null`,
		string	xOPAYHeaders = `null`,
		string	traceId = `null`
	)

Get Payment Setup The API is used to retrieve the details of a recurring payment setup by id.

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.
ID_PAYMENT_SETUP	The unique identifier assigned by EBPP to the payment setup.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)

Returns: PaymentSetupResponse

Implements Orbipay.PaymentsApi.Client.Api.IPaymentSetupApi.

async System.Threading.Tasks.Task<PaymentSetupResponse> Orbipay.PaymentsApi.Client.Api.PaymentSetupApi.GetPaymentSetupAsync	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_PAYMENT_SETUP,
		string	ID_CUSTOMER,
		string	requestor = `null`,
		string	xOPAYHeaders = `null`,
		string	traceId = `null`
	)

Get Payment Setup The API is used to retrieve the details of a recurring payment setup by id.

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.
ID_PAYMENT_SETUP	The unique identifier assigned by EBPP to the payment setup.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
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 PaymentSetupResponse

Implements Orbipay.PaymentsApi.Client.Api.IPaymentSetupApi.

async System.Threading.Tasks.Task<ApiResponse<PaymentSetupResponse> > Orbipay.PaymentsApi.Client.Api.PaymentSetupApi.GetPaymentSetupAsyncWithHttpInfo	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_PAYMENT_SETUP,
		string	ID_CUSTOMER,
		string	requestor = `null`,
		string	xOPAYHeaders = `null`,
		string	traceId = `null`
	)

Get Payment Setup The API is used to retrieve the details of a recurring payment setup by id.

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.
ID_PAYMENT_SETUP	The unique identifier assigned by EBPP to the payment setup.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
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 (PaymentSetupResponse)

Implements Orbipay.PaymentsApi.Client.Api.IPaymentSetupApi.

ApiResponse< PaymentSetupResponse > Orbipay.PaymentsApi.Client.Api.PaymentSetupApi.GetPaymentSetupWithHttpInfo	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_PAYMENT_SETUP,
		string	ID_CUSTOMER,
		string	requestor = `null`,
		string	xOPAYHeaders = `null`,
		string	traceId = `null`
	)

Get Payment Setup The API is used to retrieve the details of a recurring payment setup by id.

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.
ID_PAYMENT_SETUP	The unique identifier assigned by EBPP to the payment setup.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
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 PaymentSetupResponse

Implements Orbipay.PaymentsApi.Client.Api.IPaymentSetupApi.

ApiResponse<PaymentSetupsResponse> Orbipay.PaymentsApi.Client.Api.PaymentSetupApi.RetrievePaymentSetups	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	requestor = `null`,
		string	xOPAYHeaders = `null`,
		string	traceId = `null`,
		string	idCustomer = `null`,
		string	idFundingAccount = `null`,
		string	idCustomerAccount = `null`,
		string	confirmationNumber = `null`,
		List< string >	status = `null`,
		List< string >	paymentSetupScheduleType = `null`,
		string	fromDate = `null`,
		string	toDate = `null`,
		string	pageSize = `null`,
		string	queryId = `null`,
		string	fromIndex = `null`,
		string	toIndex = `null`
	)

Retrieve Payment Setups The API is used to retrieve the recurring and autopay payments setup made against a customer account. The setup can be filtered using the confirmation number, customer account, funding account, status and payment setup schedule type, by date range and others mentioned below. If no dates are provided for retrieval, recurring payments set up in the last six months and all the ones in future are returned. If the requestor type is customer then the id_customer request parameter is mandatory. The results are sorted in descending order of the payment_start_date followed by the last_modified_time.

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. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)
idCustomer	The unique identifier assigned by EBPP to the customer. (optional)
idFundingAccount	The unique identifier assigned by EBPP to the funding account (optional)
idCustomerAccount	The unique identifier assigned by EBPP to the customer account (optional)
confirmationNumber	The confirmation number or reference provided to the customer for the successful payment. (optional)
status	The status of the payment. This can take multiple values in the format key=value1&key=value2.... (optional)
paymentSetupScheduleType	The schedule type for the payment setup. This can take multiple values in the format key=value1&key=value2.... (optional)
fromDate	The date from which recurring payments setup, matching the criteria specified, need to be retrieved. (optional)
toDate	The date upto which recurring payments setup, matching the criteria specified, need to be retrieved. (optional)
pageSize	The maximum number of objects returned in the query. (optional)
queryId	query id of the Retrieve/Search Customers lookup. (optional)
fromIndex	To fetch the next set of objects that start after this object (optional)
toIndex	To fetch the previous set of objects that end at this object (optional)

Returns: PaymentSetupsResponse

Implements Orbipay.PaymentsApi.Client.Api.IPaymentSetupApi.

async System.Threading.Tasks.Task<PaymentSetupsResponse> Orbipay.PaymentsApi.Client.Api.PaymentSetupApi.RetrievePaymentSetupsAsync	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	requestor = `null`,
		string	xOPAYHeaders = `null`,
		string	traceId = `null`,
		string	idCustomer = `null`,
		string	idFundingAccount = `null`,
		string	idCustomerAccount = `null`,
		string	confirmationNumber = `null`,
		List< string >	status = `null`,
		List< string >	paymentSetupScheduleType = `null`,
		string	fromDate = `null`,
		string	toDate = `null`,
		string	pageSize = `null`,
		string	queryId = `null`,
		string	fromIndex = `null`,
		string	toIndex = `null`
	)

Retrieve Payment Setups The API is used to retrieve the recurring and autopay payments setup made against a customer account. The setup can be filtered using the confirmation number, customer account, funding account, status and payment setup schedule type, by date range and others mentioned below. If no dates are provided for retrieval, recurring payments set up in the last six months and all the ones in future are returned. If the requestor type is customer then the id_customer request parameter is mandatory. The results are sorted in descending order of the payment_start_date followed by the last_modified_time.

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. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)
idCustomer	The unique identifier assigned by EBPP to the customer. (optional)
idFundingAccount	The unique identifier assigned by EBPP to the funding account (optional)
idCustomerAccount	The unique identifier assigned by EBPP to the customer account (optional)
confirmationNumber	The confirmation number or reference provided to the customer for the successful payment. (optional)
status	The status of the payment. This can take multiple values in the format key=value1&key=value2.... (optional)
paymentSetupScheduleType	The schedule type for the payment setup. This can take multiple values in the format key=value1&key=value2.... (optional)
fromDate	The date from which recurring payments setup, matching the criteria specified, need to be retrieved. (optional)
toDate	The date upto which recurring payments setup, matching the criteria specified, need to be retrieved. (optional)
pageSize	The maximum number of objects returned in the query. (optional)
queryId	query id of the Retrieve/Search Customers lookup. (optional)
fromIndex	To fetch the next set of objects that start after this object (optional)
toIndex	To fetch the previous set of objects that end at this object (optional)

Returns: Task of PaymentSetupsResponse

Implements Orbipay.PaymentsApi.Client.Api.IPaymentSetupApi.

async System.Threading.Tasks.Task<ApiResponse<PaymentSetupsResponse> > Orbipay.PaymentsApi.Client.Api.PaymentSetupApi.RetrievePaymentSetupsAsyncWithHttpInfo	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	requestor = `null`,
		string	xOPAYHeaders = `null`,
		string	traceId = `null`,
		string	idCustomer = `null`,
		string	idFundingAccount = `null`,
		string	idCustomerAccount = `null`,
		string	confirmationNumber = `null`,
		List< string >	status = `null`,
		List< string >	paymentSetupScheduleType = `null`,
		string	fromDate = `null`,
		string	toDate = `null`,
		string	pageSize = `null`,
		string	queryId = `null`,
		string	fromIndex = `null`,
		string	toIndex = `null`
	)

Retrieve Payment Setups The API is used to retrieve the recurring and autopay payments setup made against a customer account. The setup can be filtered using the confirmation number, customer account, funding account, status and payment setup schedule type, by date range and others mentioned below. If no dates are provided for retrieval, recurring payments set up in the last six months and all the ones in future are returned. If the requestor type is customer then the id_customer request parameter is mandatory. The results are sorted in descending order of the payment_start_date followed by the last_modified_time.

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. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)
idCustomer	The unique identifier assigned by EBPP to the customer. (optional)
idFundingAccount	The unique identifier assigned by EBPP to the funding account (optional)
idCustomerAccount	The unique identifier assigned by EBPP to the customer account (optional)
confirmationNumber	The confirmation number or reference provided to the customer for the successful payment. (optional)
status	The status of the payment. This can take multiple values in the format key=value1&key=value2.... (optional)
paymentSetupScheduleType	The schedule type for the payment setup. This can take multiple values in the format key=value1&key=value2.... (optional)
fromDate	The date from which recurring payments setup, matching the criteria specified, need to be retrieved. (optional)
toDate	The date upto which recurring payments setup, matching the criteria specified, need to be retrieved. (optional)
pageSize	The maximum number of objects returned in the query. (optional)
queryId	query id of the Retrieve/Search Customers lookup. (optional)
fromIndex	To fetch the next set of objects that start after this object (optional)
toIndex	To fetch the previous set of objects that end at this object (optional)

Returns: Task of ApiResponse (PaymentSetupsResponse)

Implements Orbipay.PaymentsApi.Client.Api.IPaymentSetupApi.

ApiResponse< PaymentSetupsResponse > Orbipay.PaymentsApi.Client.Api.PaymentSetupApi.RetrievePaymentSetupsWithHttpInfo	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	requestor = `null`,
		string	xOPAYHeaders = `null`,
		string	traceId = `null`,
		string	idCustomer = `null`,
		string	idFundingAccount = `null`,
		string	idCustomerAccount = `null`,
		string	confirmationNumber = `null`,
		List< string >	status = `null`,
		List< string >	paymentSetupScheduleType = `null`,
		string	fromDate = `null`,
		string	toDate = `null`,
		string	pageSize = `null`,
		string	queryId = `null`,
		string	fromIndex = `null`,
		string	toIndex = `null`
	)

Retrieve Payment Setups The API is used to retrieve the recurring and autopay payments setup made against a customer account. The setup can be filtered using the confirmation number, customer account, funding account, status and payment setup schedule type, by date range and others mentioned below. If no dates are provided for retrieval, recurring payments set up in the last six months and all the ones in future are returned. If the requestor type is customer then the id_customer request parameter is mandatory. The results are sorted in descending order of the payment_start_date followed by the last_modified_time.

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. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)
idCustomer	The unique identifier assigned by EBPP to the customer. (optional)
idFundingAccount	The unique identifier assigned by EBPP to the funding account (optional)
idCustomerAccount	The unique identifier assigned by EBPP to the customer account (optional)
confirmationNumber	The confirmation number or reference provided to the customer for the successful payment. (optional)
status	The status of the payment. This can take multiple values in the format key=value1&key=value2.... (optional)
paymentSetupScheduleType	The schedule type for the payment setup. This can take multiple values in the format key=value1&key=value2.... (optional)
fromDate	The date from which recurring payments setup, matching the criteria specified, need to be retrieved. (optional)
toDate	The date upto which recurring payments setup, matching the criteria specified, need to be retrieved. (optional)
pageSize	The maximum number of objects returned in the query. (optional)
queryId	query id of the Retrieve/Search Customers lookup. (optional)
fromIndex	To fetch the next set of objects that start after this object (optional)
toIndex	To fetch the previous set of objects that end at this object (optional)

Returns: ApiResponse of PaymentSetupsResponse

Implements Orbipay.PaymentsApi.Client.Api.IPaymentSetupApi.

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

Sets the base path of the API client.

The base path

ApiResponse<PaymentSetupResponse> Orbipay.PaymentsApi.Client.Api.PaymentSetupApi.UpdatePaymentSetup	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_PAYMENT_SETUP,
		string	ID_CUSTOMER,
		UpdatePaymentSetupRequest	updatePaymentSetupRequest,
		string	requestor = `null`,
		string	xOPAYHeaders = `null`,
		string	traceId = `null`
	)

Update Payment Setup The API is used to edit a payment Setup. Only autopay payment setup is allowed to edit.

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.
ID_PAYMENT_SETUP	The unique identifier assigned by EBPP to the payment setup.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
updatePaymentSetupRequest	Details of the Payment Setup to be updated.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)

Returns: PaymentSetupResponse

Implements Orbipay.PaymentsApi.Client.Api.IPaymentSetupApi.

async System.Threading.Tasks.Task<PaymentSetupResponse> Orbipay.PaymentsApi.Client.Api.PaymentSetupApi.UpdatePaymentSetupAsync	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_PAYMENT_SETUP,
		string	ID_CUSTOMER,
		UpdatePaymentSetupRequest	updatePaymentSetupRequest,
		string	requestor = `null`,
		string	xOPAYHeaders = `null`,
		string	traceId = `null`
	)

Update Payment Setup The API is used to edit a payment Setup. Only autopay payment setup is allowed to edit.

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.
ID_PAYMENT_SETUP	The unique identifier assigned by EBPP to the payment setup.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
updatePaymentSetupRequest	Details of the Payment Setup to be updated.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
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 PaymentSetupResponse

Implements Orbipay.PaymentsApi.Client.Api.IPaymentSetupApi.

async System.Threading.Tasks.Task<ApiResponse<PaymentSetupResponse> > Orbipay.PaymentsApi.Client.Api.PaymentSetupApi.UpdatePaymentSetupAsyncWithHttpInfo	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_PAYMENT_SETUP,
		string	ID_CUSTOMER,
		UpdatePaymentSetupRequest	updatePaymentSetupRequest,
		string	requestor = `null`,
		string	xOPAYHeaders = `null`,
		string	traceId = `null`
	)

Update Payment Setup The API is used to edit a payment Setup. Only autopay payment setup is allowed to edit.

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.
ID_PAYMENT_SETUP	The unique identifier assigned by EBPP to the payment setup.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
updatePaymentSetupRequest	Details of the Payment Setup to be updated.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
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 (PaymentSetupResponse)

Implements Orbipay.PaymentsApi.Client.Api.IPaymentSetupApi.

ApiResponse< PaymentSetupResponse > Orbipay.PaymentsApi.Client.Api.PaymentSetupApi.UpdatePaymentSetupWithHttpInfo	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_PAYMENT_SETUP,
		string	ID_CUSTOMER,
		UpdatePaymentSetupRequest	updatePaymentSetupRequest,
		string	requestor = `null`,
		string	xOPAYHeaders = `null`,
		string	traceId = `null`
	)

Update Payment Setup The API is used to edit a payment Setup. Only autopay payment setup is allowed to edit.

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.
ID_PAYMENT_SETUP	The unique identifier assigned by EBPP to the payment setup.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
updatePaymentSetupRequest	Details of the Payment Setup to be updated.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
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 PaymentSetupResponse

Implements Orbipay.PaymentsApi.Client.Api.IPaymentSetupApi.

Property Documentation

Orbipay.PaymentsApi.Client.Client.Configuration Orbipay.PaymentsApi.Client.Api.PaymentSetupApi.Configuration

getset

Gets or sets the configuration object

An instance of the Configuration

Orbipay.PaymentsApi.Client.Client.ExceptionFactory Orbipay.PaymentsApi.Client.Api.PaymentSetupApi.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/PaymentSetupApi.cs

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation