My Project
 All Classes Namespaces Files Functions Variables Typedefs Properties Pages
Orbipay.PaymentsApi.Client.Api.IPaymentSetupApi Interface Reference

More...

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

Public Member Functions

ApiResponse< PaymentSetupResponseCreateRecurringPaymentSetup (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 More...
 
ApiResponse< PaymentSetupResponseCreateRecurringPaymentSetupWithHttpInfo (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 More...
 
ApiResponse< DeleteResponseDeletePaymentSetup (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 More...
 
ApiResponse< DeleteResponseDeletePaymentSetupWithHttpInfo (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 More...
 
ApiResponse< PaymentSetupResponseGetPaymentSetup (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 More...
 
ApiResponse< PaymentSetupResponseGetPaymentSetupWithHttpInfo (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 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 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 More...
 
ApiResponse< PaymentSetupResponseUpdatePaymentSetup (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 More...
 
ApiResponse< PaymentSetupResponseUpdatePaymentSetupWithHttpInfo (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 More...
 
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 More...
 
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 More...
 
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 More...
 
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 More...
 
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 More...
 
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 More...
 
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 More...
 
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 More...
 
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 More...
 
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 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<PaymentSetupResponse> Orbipay.PaymentsApi.Client.Api.IPaymentSetupApi.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.ApiExceptionThrown when fails to make API call
Parameters
channelThe channel through which the API is invoked.
clientKeyThe unique identifier assigned by EBPP to the client.
productThe product identifier corresponding to the API.
timestampThe timestamp for the moment when the API request is created.
idempotentRequestKeyThe unique token that clients can generate and maintain in order to identify an API request.
requestorTypeType of the requestor of the API.
ID_CUSTOMERThe unique identifier assigned by EBPP to the customer.
createPaymentSetupRequestJSON containing all the fields required to create a recurring payment setup.
requestorThe identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeadersIntended for the future use. (optional)
traceIdThe unique reference that can be used for tracing and debugging an API call. (optional)
Returns
ApiResponse<PaymentSetupResponse>

Implemented in Orbipay.PaymentsApi.Client.Api.PaymentSetupApi.

System.Threading.Tasks.Task<PaymentSetupResponse> Orbipay.PaymentsApi.Client.Api.IPaymentSetupApi.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.ApiExceptionThrown when fails to make API call
Parameters
channelThe channel through which the API is invoked.
clientKeyThe unique identifier assigned by EBPP to the client.
productThe product identifier corresponding to the API.
timestampThe timestamp for the moment when the API request is created.
idempotentRequestKeyThe unique token that clients can generate and maintain in order to identify an API request.
requestorTypeType of the requestor of the API.
ID_CUSTOMERThe unique identifier assigned by EBPP to the customer.
createPaymentSetupRequestJSON containing all the fields required to create a recurring payment setup.
requestorThe identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeadersIntended for the future use. (optional)
traceIdThe unique reference that can be used for tracing and debugging an API call. (optional)
Returns
Task of PaymentSetupResponse

Implemented in Orbipay.PaymentsApi.Client.Api.PaymentSetupApi.

System.Threading.Tasks.Task<ApiResponse<PaymentSetupResponse> > Orbipay.PaymentsApi.Client.Api.IPaymentSetupApi.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.ApiExceptionThrown when fails to make API call
Parameters
channelThe channel through which the API is invoked.
clientKeyThe unique identifier assigned by EBPP to the client.
productThe product identifier corresponding to the API.
timestampThe timestamp for the moment when the API request is created.
idempotentRequestKeyThe unique token that clients can generate and maintain in order to identify an API request.
requestorTypeType of the requestor of the API.
ID_CUSTOMERThe unique identifier assigned by EBPP to the customer.
createPaymentSetupRequestJSON containing all the fields required to create a recurring payment setup.
requestorThe identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeadersIntended for the future use. (optional)
traceIdThe unique reference that can be used for tracing and debugging an API call. (optional)
Returns
Task of ApiResponse (PaymentSetupResponse)

Implemented in Orbipay.PaymentsApi.Client.Api.PaymentSetupApi.

ApiResponse<PaymentSetupResponse> Orbipay.PaymentsApi.Client.Api.IPaymentSetupApi.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.ApiExceptionThrown when fails to make API call
Parameters
channelThe channel through which the API is invoked.
clientKeyThe unique identifier assigned by EBPP to the client.
productThe product identifier corresponding to the API.
timestampThe timestamp for the moment when the API request is created.
idempotentRequestKeyThe unique token that clients can generate and maintain in order to identify an API request.
requestorTypeType of the requestor of the API.
ID_CUSTOMERThe unique identifier assigned by EBPP to the customer.
createPaymentSetupRequestJSON containing all the fields required to create a recurring payment setup.
requestorThe identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeadersIntended for the future use. (optional)
traceIdThe unique reference that can be used for tracing and debugging an API call. (optional)
Returns
ApiResponse of PaymentSetupResponse

Implemented in Orbipay.PaymentsApi.Client.Api.PaymentSetupApi.

ApiResponse<DeleteResponse> Orbipay.PaymentsApi.Client.Api.IPaymentSetupApi.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.ApiExceptionThrown when fails to make API call
Parameters
channelThe channel through which the API is invoked.
clientKeyThe unique identifier assigned by EBPP to the client.
productThe product identifier corresponding to the API.
timestampThe timestamp for the moment when the API request is created.
idempotentRequestKeyThe unique token that clients can generate and maintain in order to identify an API request.
requestorTypeType of the requestor of the API.
ID_PAYMENT_SETUPThe unique identifier assigned by EBPP to the payment setup.
ID_CUSTOMERThe unique identifier assigned by EBPP to the customer.
deletePaymentSetupRequestJSON containing all the fields required to delete a payment. Setup.
requestorThe identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeadersIntended for the future use. (optional)
traceIdThe unique reference that can be used for tracing and debugging an API call. (optional)
Returns
ApiResponse<DeleteResponse>

Implemented in Orbipay.PaymentsApi.Client.Api.PaymentSetupApi.

System.Threading.Tasks.Task<DeleteResponse> Orbipay.PaymentsApi.Client.Api.IPaymentSetupApi.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.ApiExceptionThrown when fails to make API call
Parameters
channelThe channel through which the API is invoked.
clientKeyThe unique identifier assigned by EBPP to the client.
productThe product identifier corresponding to the API.
timestampThe timestamp for the moment when the API request is created.
idempotentRequestKeyThe unique token that clients can generate and maintain in order to identify an API request.
requestorTypeType of the requestor of the API.
ID_PAYMENT_SETUPThe unique identifier assigned by EBPP to the payment setup.
ID_CUSTOMERThe unique identifier assigned by EBPP to the customer.
deletePaymentSetupRequestJSON containing all the fields required to delete a payment. Setup.
requestorThe identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeadersIntended for the future use. (optional)
traceIdThe unique reference that can be used for tracing and debugging an API call. (optional)
Returns
Task of DeleteResponse

Implemented in Orbipay.PaymentsApi.Client.Api.PaymentSetupApi.

System.Threading.Tasks.Task<ApiResponse<DeleteResponse> > Orbipay.PaymentsApi.Client.Api.IPaymentSetupApi.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.ApiExceptionThrown when fails to make API call
Parameters
channelThe channel through which the API is invoked.
clientKeyThe unique identifier assigned by EBPP to the client.
productThe product identifier corresponding to the API.
timestampThe timestamp for the moment when the API request is created.
idempotentRequestKeyThe unique token that clients can generate and maintain in order to identify an API request.
requestorTypeType of the requestor of the API.
ID_PAYMENT_SETUPThe unique identifier assigned by EBPP to the payment setup.
ID_CUSTOMERThe unique identifier assigned by EBPP to the customer.
deletePaymentSetupRequestJSON containing all the fields required to delete a payment. Setup.
requestorThe identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeadersIntended for the future use. (optional)
traceIdThe unique reference that can be used for tracing and debugging an API call. (optional)
Returns
Task of ApiResponse (DeleteResponse)

Implemented in Orbipay.PaymentsApi.Client.Api.PaymentSetupApi.

ApiResponse<DeleteResponse> Orbipay.PaymentsApi.Client.Api.IPaymentSetupApi.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.ApiExceptionThrown when fails to make API call
Parameters
channelThe channel through which the API is invoked.
clientKeyThe unique identifier assigned by EBPP to the client.
productThe product identifier corresponding to the API.
timestampThe timestamp for the moment when the API request is created.
idempotentRequestKeyThe unique token that clients can generate and maintain in order to identify an API request.
requestorTypeType of the requestor of the API.
ID_PAYMENT_SETUPThe unique identifier assigned by EBPP to the payment setup.
ID_CUSTOMERThe unique identifier assigned by EBPP to the customer.
deletePaymentSetupRequestJSON containing all the fields required to delete a payment. Setup.
requestorThe identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeadersIntended for the future use. (optional)
traceIdThe unique reference that can be used for tracing and debugging an API call. (optional)
Returns
ApiResponse of DeleteResponse

Implemented in Orbipay.PaymentsApi.Client.Api.PaymentSetupApi.

ApiResponse<PaymentSetupResponse> Orbipay.PaymentsApi.Client.Api.IPaymentSetupApi.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.ApiExceptionThrown when fails to make API call
Parameters
channelThe channel through which the API is invoked.
clientKeyThe unique identifier assigned by EBPP to the client.
productThe product identifier corresponding to the API.
timestampThe timestamp for the moment when the API request is created.
idempotentRequestKeyThe unique token that clients can generate and maintain in order to identify an API request.
requestorTypeType of the requestor of the API.
ID_PAYMENT_SETUPThe unique identifier assigned by EBPP to the payment setup.
ID_CUSTOMERThe unique identifier assigned by EBPP to the customer.
requestorThe identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeadersIntended for the future use. (optional)
traceIdThe unique reference that can be used for tracing and debugging an API call. (optional)
Returns
ApiResponse<PaymentSetupResponse>

Implemented in Orbipay.PaymentsApi.Client.Api.PaymentSetupApi.

System.Threading.Tasks.Task<PaymentSetupResponse> Orbipay.PaymentsApi.Client.Api.IPaymentSetupApi.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.ApiExceptionThrown when fails to make API call
Parameters
channelThe channel through which the API is invoked.
clientKeyThe unique identifier assigned by EBPP to the client.
productThe product identifier corresponding to the API.
timestampThe timestamp for the moment when the API request is created.
idempotentRequestKeyThe unique token that clients can generate and maintain in order to identify an API request.
requestorTypeType of the requestor of the API.
ID_PAYMENT_SETUPThe unique identifier assigned by EBPP to the payment setup.
ID_CUSTOMERThe unique identifier assigned by EBPP to the customer.
requestorThe identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeadersIntended for the future use. (optional)
traceIdThe unique reference that can be used for tracing and debugging an API call. (optional)
Returns
Task of PaymentSetupResponse

Implemented in Orbipay.PaymentsApi.Client.Api.PaymentSetupApi.

System.Threading.Tasks.Task<ApiResponse<PaymentSetupResponse> > Orbipay.PaymentsApi.Client.Api.IPaymentSetupApi.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.ApiExceptionThrown when fails to make API call
Parameters
channelThe channel through which the API is invoked.
clientKeyThe unique identifier assigned by EBPP to the client.
productThe product identifier corresponding to the API.
timestampThe timestamp for the moment when the API request is created.
idempotentRequestKeyThe unique token that clients can generate and maintain in order to identify an API request.
requestorTypeType of the requestor of the API.
ID_PAYMENT_SETUPThe unique identifier assigned by EBPP to the payment setup.
ID_CUSTOMERThe unique identifier assigned by EBPP to the customer.
requestorThe identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeadersIntended for the future use. (optional)
traceIdThe unique reference that can be used for tracing and debugging an API call. (optional)
Returns
Task of ApiResponse (PaymentSetupResponse)

Implemented in Orbipay.PaymentsApi.Client.Api.PaymentSetupApi.

ApiResponse<PaymentSetupResponse> Orbipay.PaymentsApi.Client.Api.IPaymentSetupApi.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.ApiExceptionThrown when fails to make API call
Parameters
channelThe channel through which the API is invoked.
clientKeyThe unique identifier assigned by EBPP to the client.
productThe product identifier corresponding to the API.
timestampThe timestamp for the moment when the API request is created.
idempotentRequestKeyThe unique token that clients can generate and maintain in order to identify an API request.
requestorTypeType of the requestor of the API.
ID_PAYMENT_SETUPThe unique identifier assigned by EBPP to the payment setup.
ID_CUSTOMERThe unique identifier assigned by EBPP to the customer.
requestorThe identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeadersIntended for the future use. (optional)
traceIdThe unique reference that can be used for tracing and debugging an API call. (optional)
Returns
ApiResponse of PaymentSetupResponse

Implemented in Orbipay.PaymentsApi.Client.Api.PaymentSetupApi.

ApiResponse<PaymentSetupsResponse> Orbipay.PaymentsApi.Client.Api.IPaymentSetupApi.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.ApiExceptionThrown when fails to make API call
Parameters
channelThe channel through which the API is invoked.
clientKeyThe unique identifier assigned by EBPP to the client.
productThe product identifier corresponding to the API.
timestampThe timestamp for the moment when the API request is created.
idempotentRequestKeyThe unique token that clients can generate and maintain in order to identify an API request.
requestorTypeType of the requestor of the API.
requestorThe identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeadersIntended for the future use. (optional)
traceIdThe unique reference that can be used for tracing and debugging an API call. (optional)
idCustomerThe unique identifier assigned by EBPP to the customer. (optional)
idFundingAccountThe unique identifier assigned by EBPP to the funding account (optional)
idCustomerAccountThe unique identifier assigned by EBPP to the customer account (optional)
confirmationNumberThe confirmation number or reference provided to the customer for the successful payment. (optional)
statusThe status of the payment. This can take multiple values in the format key&#x3D;value1&key&#x3D;value2.... (optional)
paymentSetupScheduleTypeThe schedule type for the payment setup. This can take multiple values in the format key&#x3D;value1&key&#x3D;value2.... (optional)
fromDateThe date from which recurring payments setup, matching the criteria specified, need to be retrieved. (optional)
toDateThe date upto which recurring payments setup, matching the criteria specified, need to be retrieved. (optional)
pageSizeThe maximum number of objects returned in the query. (optional)
queryIdquery id of the Retrieve/Search Customers lookup. (optional)
fromIndexTo fetch the next set of objects that start after this object (optional)
toIndexTo fetch the previous set of objects that end at this object (optional)
Returns
ApiResponse<PaymentSetupsResponse>

Implemented in Orbipay.PaymentsApi.Client.Api.PaymentSetupApi.

System.Threading.Tasks.Task<PaymentSetupsResponse> Orbipay.PaymentsApi.Client.Api.IPaymentSetupApi.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.ApiExceptionThrown when fails to make API call
Parameters
channelThe channel through which the API is invoked.
clientKeyThe unique identifier assigned by EBPP to the client.
productThe product identifier corresponding to the API.
timestampThe timestamp for the moment when the API request is created.
idempotentRequestKeyThe unique token that clients can generate and maintain in order to identify an API request.
requestorTypeType of the requestor of the API.
requestorThe identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeadersIntended for the future use. (optional)
traceIdThe unique reference that can be used for tracing and debugging an API call. (optional)
idCustomerThe unique identifier assigned by EBPP to the customer. (optional)
idFundingAccountThe unique identifier assigned by EBPP to the funding account (optional)
idCustomerAccountThe unique identifier assigned by EBPP to the customer account (optional)
confirmationNumberThe confirmation number or reference provided to the customer for the successful payment. (optional)
statusThe status of the payment. This can take multiple values in the format key&#x3D;value1&key&#x3D;value2.... (optional)
paymentSetupScheduleTypeThe schedule type for the payment setup. This can take multiple values in the format key&#x3D;value1&key&#x3D;value2.... (optional)
fromDateThe date from which recurring payments setup, matching the criteria specified, need to be retrieved. (optional)
toDateThe date upto which recurring payments setup, matching the criteria specified, need to be retrieved. (optional)
pageSizeThe maximum number of objects returned in the query. (optional)
queryIdquery id of the Retrieve/Search Customers lookup. (optional)
fromIndexTo fetch the next set of objects that start after this object (optional)
toIndexTo fetch the previous set of objects that end at this object (optional)
Returns
Task of PaymentSetupsResponse

Implemented in Orbipay.PaymentsApi.Client.Api.PaymentSetupApi.

System.Threading.Tasks.Task<ApiResponse<PaymentSetupsResponse> > Orbipay.PaymentsApi.Client.Api.IPaymentSetupApi.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.ApiExceptionThrown when fails to make API call
Parameters
channelThe channel through which the API is invoked.
clientKeyThe unique identifier assigned by EBPP to the client.
productThe product identifier corresponding to the API.
timestampThe timestamp for the moment when the API request is created.
idempotentRequestKeyThe unique token that clients can generate and maintain in order to identify an API request.
requestorTypeType of the requestor of the API.
requestorThe identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeadersIntended for the future use. (optional)
traceIdThe unique reference that can be used for tracing and debugging an API call. (optional)
idCustomerThe unique identifier assigned by EBPP to the customer. (optional)
idFundingAccountThe unique identifier assigned by EBPP to the funding account (optional)
idCustomerAccountThe unique identifier assigned by EBPP to the customer account (optional)
confirmationNumberThe confirmation number or reference provided to the customer for the successful payment. (optional)
statusThe status of the payment. This can take multiple values in the format key&#x3D;value1&key&#x3D;value2.... (optional)
paymentSetupScheduleTypeThe schedule type for the payment setup. This can take multiple values in the format key&#x3D;value1&key&#x3D;value2.... (optional)
fromDateThe date from which recurring payments setup, matching the criteria specified, need to be retrieved. (optional)
toDateThe date upto which recurring payments setup, matching the criteria specified, need to be retrieved. (optional)
pageSizeThe maximum number of objects returned in the query. (optional)
queryIdquery id of the Retrieve/Search Customers lookup. (optional)
fromIndexTo fetch the next set of objects that start after this object (optional)
toIndexTo fetch the previous set of objects that end at this object (optional)
Returns
Task of ApiResponse (PaymentSetupsResponse)

Implemented in Orbipay.PaymentsApi.Client.Api.PaymentSetupApi.

ApiResponse<PaymentSetupsResponse> Orbipay.PaymentsApi.Client.Api.IPaymentSetupApi.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.ApiExceptionThrown when fails to make API call
Parameters
channelThe channel through which the API is invoked.
clientKeyThe unique identifier assigned by EBPP to the client.
productThe product identifier corresponding to the API.
timestampThe timestamp for the moment when the API request is created.
idempotentRequestKeyThe unique token that clients can generate and maintain in order to identify an API request.
requestorTypeType of the requestor of the API.
requestorThe identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeadersIntended for the future use. (optional)
traceIdThe unique reference that can be used for tracing and debugging an API call. (optional)
idCustomerThe unique identifier assigned by EBPP to the customer. (optional)
idFundingAccountThe unique identifier assigned by EBPP to the funding account (optional)
idCustomerAccountThe unique identifier assigned by EBPP to the customer account (optional)
confirmationNumberThe confirmation number or reference provided to the customer for the successful payment. (optional)
statusThe status of the payment. This can take multiple values in the format key&#x3D;value1&key&#x3D;value2.... (optional)
paymentSetupScheduleTypeThe schedule type for the payment setup. This can take multiple values in the format key&#x3D;value1&key&#x3D;value2.... (optional)
fromDateThe date from which recurring payments setup, matching the criteria specified, need to be retrieved. (optional)
toDateThe date upto which recurring payments setup, matching the criteria specified, need to be retrieved. (optional)
pageSizeThe maximum number of objects returned in the query. (optional)
queryIdquery id of the Retrieve/Search Customers lookup. (optional)
fromIndexTo fetch the next set of objects that start after this object (optional)
toIndexTo fetch the previous set of objects that end at this object (optional)
Returns
ApiResponse of PaymentSetupsResponse

Implemented in Orbipay.PaymentsApi.Client.Api.PaymentSetupApi.

ApiResponse<PaymentSetupResponse> Orbipay.PaymentsApi.Client.Api.IPaymentSetupApi.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.ApiExceptionThrown when fails to make API call
Parameters
channelThe channel through which the API is invoked.
clientKeyThe unique identifier assigned by EBPP to the client.
productThe product identifier corresponding to the API.
timestampThe timestamp for the moment when the API request is created.
idempotentRequestKeyThe unique token that clients can generate and maintain in order to identify an API request.
requestorTypeType of the requestor of the API.
ID_PAYMENT_SETUPThe unique identifier assigned by EBPP to the payment setup.
ID_CUSTOMERThe unique identifier assigned by EBPP to the customer.
updatePaymentSetupRequestDetails of the Payment Setup to be updated.
requestorThe identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeadersIntended for the future use. (optional)
traceIdThe unique reference that can be used for tracing and debugging an API call. (optional)
Returns
ApiResponse<PaymentSetupResponse>

Implemented in Orbipay.PaymentsApi.Client.Api.PaymentSetupApi.

System.Threading.Tasks.Task<PaymentSetupResponse> Orbipay.PaymentsApi.Client.Api.IPaymentSetupApi.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.ApiExceptionThrown when fails to make API call
Parameters
channelThe channel through which the API is invoked.
clientKeyThe unique identifier assigned by EBPP to the client.
productThe product identifier corresponding to the API.
timestampThe timestamp for the moment when the API request is created.
idempotentRequestKeyThe unique token that clients can generate and maintain in order to identify an API request.
requestorTypeType of the requestor of the API.
ID_PAYMENT_SETUPThe unique identifier assigned by EBPP to the payment setup.
ID_CUSTOMERThe unique identifier assigned by EBPP to the customer.
updatePaymentSetupRequestDetails of the Payment Setup to be updated.
requestorThe identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeadersIntended for the future use. (optional)
traceIdThe unique reference that can be used for tracing and debugging an API call. (optional)
Returns
Task of PaymentSetupResponse

Implemented in Orbipay.PaymentsApi.Client.Api.PaymentSetupApi.

System.Threading.Tasks.Task<ApiResponse<PaymentSetupResponse> > Orbipay.PaymentsApi.Client.Api.IPaymentSetupApi.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.ApiExceptionThrown when fails to make API call
Parameters
channelThe channel through which the API is invoked.
clientKeyThe unique identifier assigned by EBPP to the client.
productThe product identifier corresponding to the API.
timestampThe timestamp for the moment when the API request is created.
idempotentRequestKeyThe unique token that clients can generate and maintain in order to identify an API request.
requestorTypeType of the requestor of the API.
ID_PAYMENT_SETUPThe unique identifier assigned by EBPP to the payment setup.
ID_CUSTOMERThe unique identifier assigned by EBPP to the customer.
updatePaymentSetupRequestDetails of the Payment Setup to be updated.
requestorThe identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeadersIntended for the future use. (optional)
traceIdThe unique reference that can be used for tracing and debugging an API call. (optional)
Returns
Task of ApiResponse (PaymentSetupResponse)

Implemented in Orbipay.PaymentsApi.Client.Api.PaymentSetupApi.

ApiResponse<PaymentSetupResponse> Orbipay.PaymentsApi.Client.Api.IPaymentSetupApi.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.ApiExceptionThrown when fails to make API call
Parameters
channelThe channel through which the API is invoked.
clientKeyThe unique identifier assigned by EBPP to the client.
productThe product identifier corresponding to the API.
timestampThe timestamp for the moment when the API request is created.
idempotentRequestKeyThe unique token that clients can generate and maintain in order to identify an API request.
requestorTypeType of the requestor of the API.
ID_PAYMENT_SETUPThe unique identifier assigned by EBPP to the payment setup.
ID_CUSTOMERThe unique identifier assigned by EBPP to the customer.
updatePaymentSetupRequestDetails of the Payment Setup to be updated.
requestorThe identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeadersIntended for the future use. (optional)
traceIdThe unique reference that can be used for tracing and debugging an API call. (optional)
Returns
ApiResponse of PaymentSetupResponse

Implemented in Orbipay.PaymentsApi.Client.Api.PaymentSetupApi.


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