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

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

Inheritance diagram for Orbipay.PaymentsApi.Client.Api.PaymentApi:
Orbipay.PaymentsApi.Client.Api.IPaymentApi Orbipay.PaymentsApi.Client.Client.IApiAccessor

Public Member Functions

 PaymentApi (String basePath)
 Initializes a new instance of the PaymentApi class. More...
 
 PaymentApi (Orbipay.PaymentsApi.Client.Client.Configuration configuration=null)
 Initializes a new instance of the PaymentApi 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< PaymentResponseCreatePayment (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_CUSTOMER, CreatePaymentRequest createPaymentRequest, string requestor=null, string xOPAYHeaders=null, string traceId=null)
 Create Payment The API is used to make payments to service a customer account. Client systems can provide the unique identifier for the payment in their system as payment_reference.<p>Fee amount and fee type are conditional and should be provided if the details of the fee to be charged are maintained in the client system. The fee types that are supported in EBPP are add_to_principal and bill_separately. Alternatively, the fee information can be setup in EBPP, in which case, these fields are ignored. If fee information is setup in the system, the details of the fee are returned in the response. More...
 
ApiResponse< PaymentResponseCreatePaymentWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_CUSTOMER, CreatePaymentRequest createPaymentRequest, string requestor=null, string xOPAYHeaders=null, string traceId=null)
 Create Payment The API is used to make payments to service a customer account. Client systems can provide the unique identifier for the payment in their system as payment_reference.<p>Fee amount and fee type are conditional and should be provided if the details of the fee to be charged are maintained in the client system. The fee types that are supported in EBPP are add_to_principal and bill_separately. Alternatively, the fee information can be setup in EBPP, in which case, these fields are ignored. If fee information is setup in the system, the details of the fee are returned in the response. More...
 
async
System.Threading.Tasks.Task
< PaymentResponse
CreatePaymentAsync (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_CUSTOMER, CreatePaymentRequest createPaymentRequest, string requestor=null, string xOPAYHeaders=null, string traceId=null)
 Create Payment The API is used to make payments to service a customer account. Client systems can provide the unique identifier for the payment in their system as payment_reference.<p>Fee amount and fee type are conditional and should be provided if the details of the fee to be charged are maintained in the client system. The fee types that are supported in EBPP are add_to_principal and bill_separately. Alternatively, the fee information can be setup in EBPP, in which case, these fields are ignored. If fee information is setup in the system, the details of the fee are returned in the response. More...
 
async
System.Threading.Tasks.Task
< ApiResponse< PaymentResponse > > 
CreatePaymentAsyncWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_CUSTOMER, CreatePaymentRequest createPaymentRequest, string requestor=null, string xOPAYHeaders=null, string traceId=null)
 Create Payment The API is used to make payments to service a customer account. Client systems can provide the unique identifier for the payment in their system as payment_reference.<p>Fee amount and fee type are conditional and should be provided if the details of the fee to be charged are maintained in the client system. The fee types that are supported in EBPP are add_to_principal and bill_separately. Alternatively, the fee information can be setup in EBPP, in which case, these fields are ignored. If fee information is setup in the system, the details of the fee are returned in the response. More...
 
ApiResponse< DeleteResponseDeletePayment (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_PAYMENT, string ID_CUSTOMER, DeletePaymentRequest deletePaymentRequest, string requestor=null, string xOPAYHeaders=null, string traceId=null)
 Delete Payment The API is used to delete or cancel a payment. Payments that are under processing or have already been processed cannot be deleted. More...
 
ApiResponse< DeleteResponseDeletePaymentWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_PAYMENT, string ID_CUSTOMER, DeletePaymentRequest deletePaymentRequest, string requestor=null, string xOPAYHeaders=null, string traceId=null)
 Delete Payment The API is used to delete or cancel a payment. Payments that are under processing or have already been processed cannot be deleted. More...
 
async
System.Threading.Tasks.Task
< DeleteResponse
DeletePaymentAsync (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_PAYMENT, string ID_CUSTOMER, DeletePaymentRequest deletePaymentRequest, string requestor=null, string xOPAYHeaders=null, string traceId=null)
 Delete Payment The API is used to delete or cancel a payment. Payments that are under processing or have already been processed cannot be deleted. More...
 
async
System.Threading.Tasks.Task
< ApiResponse< DeleteResponse > > 
DeletePaymentAsyncWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_PAYMENT, string ID_CUSTOMER, DeletePaymentRequest deletePaymentRequest, string requestor=null, string xOPAYHeaders=null, string traceId=null)
 Delete Payment The API is used to delete or cancel a payment. Payments that are under processing or have already been processed cannot be deleted. More...
 
ApiResponse< Object > DeleteRecordPayment (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_PAYMENT, DeleteRecordedPaymentRequest deleteRecordedPaymentRequest, string requestor=null, string xOPAYHeaders=null, string traceId=null)
 Delete Recorded Payment The API is used to delete the recorded payment. It returns 204 http status code with empty body in successful case More...
 
ApiResponse< Object > DeleteRecordPaymentWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_PAYMENT, DeleteRecordedPaymentRequest deleteRecordedPaymentRequest, string requestor=null, string xOPAYHeaders=null, string traceId=null)
 Delete Recorded Payment The API is used to delete the recorded payment. It returns 204 http status code with empty body in successful case More...
 
async System.Threading.Tasks.Task DeleteRecordPaymentAsync (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_PAYMENT, DeleteRecordedPaymentRequest deleteRecordedPaymentRequest, string requestor=null, string xOPAYHeaders=null, string traceId=null)
 Delete Recorded Payment The API is used to delete the recorded payment. It returns 204 http status code with empty body in successful case More...
 
async
System.Threading.Tasks.Task
< ApiResponse< Object > > 
DeleteRecordPaymentAsyncWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_PAYMENT, DeleteRecordedPaymentRequest deleteRecordedPaymentRequest, string requestor=null, string xOPAYHeaders=null, string traceId=null)
 Delete Recorded Payment The API is used to delete the recorded payment. It returns 204 http status code with empty body in successful case More...
 
ApiResponse< PaymentResponseGetPayment (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_PAYMENT, string ID_CUSTOMER, string requestor=null, string xOPAYHeaders=null, string traceId=null)
 Get Payment The API is used to retrieve the details of a payment or a recorded payment by id. More...
 
ApiResponse< PaymentResponseGetPaymentWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_PAYMENT, string ID_CUSTOMER, string requestor=null, string xOPAYHeaders=null, string traceId=null)
 Get Payment The API is used to retrieve the details of a payment or a recorded payment by id. More...
 
async
System.Threading.Tasks.Task
< PaymentResponse
GetPaymentAsync (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_PAYMENT, string ID_CUSTOMER, string requestor=null, string xOPAYHeaders=null, string traceId=null)
 Get Payment The API is used to retrieve the details of a payment or a recorded payment by id. More...
 
async
System.Threading.Tasks.Task
< ApiResponse< PaymentResponse > > 
GetPaymentAsyncWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_PAYMENT, string ID_CUSTOMER, string requestor=null, string xOPAYHeaders=null, string traceId=null)
 Get Payment The API is used to retrieve the details of a payment or a recorded payment by id. More...
 
ApiResponse
< GetRecordedPaymentResponse
GetRecordPayment (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_PAYMENT, string requestor=null, string xOPAYHeaders=null, string traceId=null)
 Get Recorded Payment <b style&#x3D;&quot;color:red&quot;>This API has been deprecated, please use <a href&#x3D;&quot;#operation/getPayment&quot;>Get Payment</a> API instead.</b> <br> The API is used to retrieve the details of a payment by id. More...
 
ApiResponse
< GetRecordedPaymentResponse
GetRecordPaymentWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_PAYMENT, string requestor=null, string xOPAYHeaders=null, string traceId=null)
 Get Recorded Payment <b style&#x3D;&quot;color:red&quot;>This API has been deprecated, please use <a href&#x3D;&quot;#operation/getPayment&quot;>Get Payment</a> API instead.</b> <br> The API is used to retrieve the details of a payment by id. More...
 
async
System.Threading.Tasks.Task
< GetRecordedPaymentResponse
GetRecordPaymentAsync (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_PAYMENT, string requestor=null, string xOPAYHeaders=null, string traceId=null)
 Get Recorded Payment <b style&#x3D;&quot;color:red&quot;>This API has been deprecated, please use <a href&#x3D;&quot;#operation/getPayment&quot;>Get Payment</a> API instead.</b> <br> The API is used to retrieve the details of a payment by id. More...
 
async
System.Threading.Tasks.Task
< ApiResponse
< GetRecordedPaymentResponse > > 
GetRecordPaymentAsyncWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_PAYMENT, string requestor=null, string xOPAYHeaders=null, string traceId=null)
 Get Recorded Payment <b style&#x3D;&quot;color:red&quot;>This API has been deprecated, please use <a href&#x3D;&quot;#operation/getPayment&quot;>Get Payment</a> API instead.</b> <br> The API is used to retrieve the details of a payment by id. More...
 
ApiResponse
< RecordedPaymentResponse
RecordPayment (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, RecordPaymentRequest recordPaymentRequest, string requestor=null, string xOPAYHeaders=null, string traceId=null)
 Record Payment The API is used to record payments in EBPP those are made and fulfilled outside EBPP. More...
 
ApiResponse
< RecordedPaymentResponse
RecordPaymentWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, RecordPaymentRequest recordPaymentRequest, string requestor=null, string xOPAYHeaders=null, string traceId=null)
 Record Payment The API is used to record payments in EBPP those are made and fulfilled outside EBPP. More...
 
async
System.Threading.Tasks.Task
< RecordedPaymentResponse
RecordPaymentAsync (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, RecordPaymentRequest recordPaymentRequest, string requestor=null, string xOPAYHeaders=null, string traceId=null)
 Record Payment The API is used to record payments in EBPP those are made and fulfilled outside EBPP. More...
 
async
System.Threading.Tasks.Task
< ApiResponse
< RecordedPaymentResponse > > 
RecordPaymentAsyncWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, RecordPaymentRequest recordPaymentRequest, string requestor=null, string xOPAYHeaders=null, string traceId=null)
 Record Payment The API is used to record payments in EBPP those are made and fulfilled outside EBPP. More...
 
ApiResponse< PaymentResponseRetrieveFeePayment (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_FEE, string ID_CUSTOMER, string requestor=null, string xOPAYHeaders=null, string traceId=null)
 Get Fee Payment The API is used to retrieve the details of a fee payment by id. More...
 
ApiResponse< PaymentResponseRetrieveFeePaymentWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_FEE, string ID_CUSTOMER, string requestor=null, string xOPAYHeaders=null, string traceId=null)
 Get Fee Payment The API is used to retrieve the details of a fee payment by id. More...
 
async
System.Threading.Tasks.Task
< PaymentResponse
RetrieveFeePaymentAsync (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_FEE, string ID_CUSTOMER, string requestor=null, string xOPAYHeaders=null, string traceId=null)
 Get Fee Payment The API is used to retrieve the details of a fee payment by id. More...
 
async
System.Threading.Tasks.Task
< ApiResponse< PaymentResponse > > 
RetrieveFeePaymentAsyncWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_FEE, string ID_CUSTOMER, string requestor=null, string xOPAYHeaders=null, string traceId=null)
 Get Fee Payment The API is used to retrieve the details of a fee payment by id. More...
 
ApiResponse< PaymentsResponseRetrievePayments (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 > paymentScheduleType=null, List< string > paymentMethod=null, string fromDate=null, string toDate=null, string pageSize=null, string queryId=null, string fromIndex=null, string toIndex=null)
 Retrieve Payments The API is used to retrieve the payments and recorded payments made by a customer. Payments can be filtered using the confirmation number, customer account, funding account, status and payment schedule type, payment method, by date range and others mentioned below. If no dates are provided for retrieval, payments in the last six months and all the payments scheduled for a future date are returned. In case a payment has failed due to ACH returns, then the payment return date and the return code will be available in the response. If the requestor type is customer then the id_customer request parameter is mandatory. The results are sorted in descending order of the payment_date followed by the last_modified_time. More...
 
ApiResponse< PaymentsResponseRetrievePaymentsWithHttpInfo (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 > paymentScheduleType=null, List< string > paymentMethod=null, string fromDate=null, string toDate=null, string pageSize=null, string queryId=null, string fromIndex=null, string toIndex=null)
 Retrieve Payments The API is used to retrieve the payments and recorded payments made by a customer. Payments can be filtered using the confirmation number, customer account, funding account, status and payment schedule type, payment method, by date range and others mentioned below. If no dates are provided for retrieval, payments in the last six months and all the payments scheduled for a future date are returned. In case a payment has failed due to ACH returns, then the payment return date and the return code will be available in the response. If the requestor type is customer then the id_customer request parameter is mandatory. The results are sorted in descending order of the payment_date followed by the last_modified_time. More...
 
async
System.Threading.Tasks.Task
< PaymentsResponse
RetrievePaymentsAsync (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 > paymentScheduleType=null, List< string > paymentMethod=null, string fromDate=null, string toDate=null, string pageSize=null, string queryId=null, string fromIndex=null, string toIndex=null)
 Retrieve Payments The API is used to retrieve the payments and recorded payments made by a customer. Payments can be filtered using the confirmation number, customer account, funding account, status and payment schedule type, payment method, by date range and others mentioned below. If no dates are provided for retrieval, payments in the last six months and all the payments scheduled for a future date are returned. In case a payment has failed due to ACH returns, then the payment return date and the return code will be available in the response. If the requestor type is customer then the id_customer request parameter is mandatory. The results are sorted in descending order of the payment_date followed by the last_modified_time. More...
 
async
System.Threading.Tasks.Task
< ApiResponse
< PaymentsResponse > > 
RetrievePaymentsAsyncWithHttpInfo (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 > paymentScheduleType=null, List< string > paymentMethod=null, string fromDate=null, string toDate=null, string pageSize=null, string queryId=null, string fromIndex=null, string toIndex=null)
 Retrieve Payments The API is used to retrieve the payments and recorded payments made by a customer. Payments can be filtered using the confirmation number, customer account, funding account, status and payment schedule type, payment method, by date range and others mentioned below. If no dates are provided for retrieval, payments in the last six months and all the payments scheduled for a future date are returned. In case a payment has failed due to ACH returns, then the payment return date and the return code will be available in the response. If the requestor type is customer then the id_customer request parameter is mandatory. The results are sorted in descending order of the payment_date followed by the last_modified_time. More...
 
ApiResponse
< RecordedPaymentsResponse
RetrieveRecordPayments (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string idCustomer, string requestor=null, string xOPAYHeaders=null, string traceId=null, string idCustomerAccount=null, string confirmationNumber=null, List< string > paymentMethod=null, List< string > status=null, string fromDate=null, string toDate=null, string pageSize=null, string queryId=null, string fromIndex=null, string toIndex=null)
 Retrieve Recorded Payments <b style&#x3D;&quot;color:red&quot;>This API has been deprecated, please use <a href&#x3D;&quot;#operation/retrievePayments&quot;>Retrieve Payments</a> API instead.</b> <br> The API is used to retrieve the payments made by a customer. Payments can be filtered using the confirmation number, customer account, status, by date range and others mentioned below. If no dates are provided for retrieval, payments in the last six months and all the payments scheduled for a future date are returned. In case a payment has failed due to ACH returns, then the payment return date and the return code will be available in the response. More...
 
ApiResponse
< RecordedPaymentsResponse
RetrieveRecordPaymentsWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string idCustomer, string requestor=null, string xOPAYHeaders=null, string traceId=null, string idCustomerAccount=null, string confirmationNumber=null, List< string > paymentMethod=null, List< string > status=null, string fromDate=null, string toDate=null, string pageSize=null, string queryId=null, string fromIndex=null, string toIndex=null)
 Retrieve Recorded Payments <b style&#x3D;&quot;color:red&quot;>This API has been deprecated, please use <a href&#x3D;&quot;#operation/retrievePayments&quot;>Retrieve Payments</a> API instead.</b> <br> The API is used to retrieve the payments made by a customer. Payments can be filtered using the confirmation number, customer account, status, by date range and others mentioned below. If no dates are provided for retrieval, payments in the last six months and all the payments scheduled for a future date are returned. In case a payment has failed due to ACH returns, then the payment return date and the return code will be available in the response. More...
 
async
System.Threading.Tasks.Task
< RecordedPaymentsResponse
RetrieveRecordPaymentsAsync (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string idCustomer, string requestor=null, string xOPAYHeaders=null, string traceId=null, string idCustomerAccount=null, string confirmationNumber=null, List< string > paymentMethod=null, List< string > status=null, string fromDate=null, string toDate=null, string pageSize=null, string queryId=null, string fromIndex=null, string toIndex=null)
 Retrieve Recorded Payments <b style&#x3D;&quot;color:red&quot;>This API has been deprecated, please use <a href&#x3D;&quot;#operation/retrievePayments&quot;>Retrieve Payments</a> API instead.</b> <br> The API is used to retrieve the payments made by a customer. Payments can be filtered using the confirmation number, customer account, status, by date range and others mentioned below. If no dates are provided for retrieval, payments in the last six months and all the payments scheduled for a future date are returned. In case a payment has failed due to ACH returns, then the payment return date and the return code will be available in the response. More...
 
async
System.Threading.Tasks.Task
< ApiResponse
< RecordedPaymentsResponse > > 
RetrieveRecordPaymentsAsyncWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string idCustomer, string requestor=null, string xOPAYHeaders=null, string traceId=null, string idCustomerAccount=null, string confirmationNumber=null, List< string > paymentMethod=null, List< string > status=null, string fromDate=null, string toDate=null, string pageSize=null, string queryId=null, string fromIndex=null, string toIndex=null)
 Retrieve Recorded Payments <b style&#x3D;&quot;color:red&quot;>This API has been deprecated, please use <a href&#x3D;&quot;#operation/retrievePayments&quot;>Retrieve Payments</a> API instead.</b> <br> The API is used to retrieve the payments made by a customer. Payments can be filtered using the confirmation number, customer account, status, by date range and others mentioned below. If no dates are provided for retrieval, payments in the last six months and all the payments scheduled for a future date are returned. In case a payment has failed due to ACH returns, then the payment return date and the return code will be available in the response. More...
 
ApiResponse
< SimplePaymentResponse
SimplePayment (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, SimplePaymentRequest simplePaymentRequest, string requestor=null, string xOPAYHeaders=null, string traceId=null, string saveFundingAccount=null)
 Simple Payment The API is used to make payments to service a customer account. Client systems can provide the unique identifier for the payment in their system as payment_reference. Fee amount and fee type are conditional and should be provided if the details of the fee to be charged are maintained in the client system. The fee types that are supported in EBPP are add_to_principal and bill_separately. Alternatively, the fee information can be setup in EBPP, in which case, these fields are ignored. If fee information is setup in the system, the details of the fee are returned in the response. This API updates the details of the customer, customer account and the funding account if those exist in EBPP or creates them otherwise. More...
 
ApiResponse
< SimplePaymentResponse
SimplePaymentWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, SimplePaymentRequest simplePaymentRequest, string requestor=null, string xOPAYHeaders=null, string traceId=null, string saveFundingAccount=null)
 Simple Payment The API is used to make payments to service a customer account. Client systems can provide the unique identifier for the payment in their system as payment_reference. Fee amount and fee type are conditional and should be provided if the details of the fee to be charged are maintained in the client system. The fee types that are supported in EBPP are add_to_principal and bill_separately. Alternatively, the fee information can be setup in EBPP, in which case, these fields are ignored. If fee information is setup in the system, the details of the fee are returned in the response. This API updates the details of the customer, customer account and the funding account if those exist in EBPP or creates them otherwise. More...
 
async
System.Threading.Tasks.Task
< SimplePaymentResponse
SimplePaymentAsync (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, SimplePaymentRequest simplePaymentRequest, string requestor=null, string xOPAYHeaders=null, string traceId=null, string saveFundingAccount=null)
 Simple Payment The API is used to make payments to service a customer account. Client systems can provide the unique identifier for the payment in their system as payment_reference. Fee amount and fee type are conditional and should be provided if the details of the fee to be charged are maintained in the client system. The fee types that are supported in EBPP are add_to_principal and bill_separately. Alternatively, the fee information can be setup in EBPP, in which case, these fields are ignored. If fee information is setup in the system, the details of the fee are returned in the response. This API updates the details of the customer, customer account and the funding account if those exist in EBPP or creates them otherwise. More...
 
async
System.Threading.Tasks.Task
< ApiResponse
< SimplePaymentResponse > > 
SimplePaymentAsyncWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, SimplePaymentRequest simplePaymentRequest, string requestor=null, string xOPAYHeaders=null, string traceId=null, string saveFundingAccount=null)
 Simple Payment The API is used to make payments to service a customer account. Client systems can provide the unique identifier for the payment in their system as payment_reference. Fee amount and fee type are conditional and should be provided if the details of the fee to be charged are maintained in the client system. The fee types that are supported in EBPP are add_to_principal and bill_separately. Alternatively, the fee information can be setup in EBPP, in which case, these fields are ignored. If fee information is setup in the system, the details of the fee are returned in the response. This API updates the details of the customer, customer account and the funding account if those exist in EBPP or creates them otherwise. More...
 
ApiResponse< PaymentResponseUpdatePayment (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_PAYMENT, string ID_CUSTOMER, UpdatePaymentRequest updatePaymentRequest, string requestor=null, string xOPAYHeaders=null, string traceId=null)
 Update Payment The API is used to edit a payment. Only payments in scheduled status can be edited. More...
 
ApiResponse< PaymentResponseUpdatePaymentWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_PAYMENT, string ID_CUSTOMER, UpdatePaymentRequest updatePaymentRequest, string requestor=null, string xOPAYHeaders=null, string traceId=null)
 Update Payment The API is used to edit a payment. Only payments in scheduled status can be edited. More...
 
async
System.Threading.Tasks.Task
< PaymentResponse
UpdatePaymentAsync (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_PAYMENT, string ID_CUSTOMER, UpdatePaymentRequest updatePaymentRequest, string requestor=null, string xOPAYHeaders=null, string traceId=null)
 Update Payment The API is used to edit a payment. Only payments in scheduled status can be edited. More...
 
async
System.Threading.Tasks.Task
< ApiResponse< PaymentResponse > > 
UpdatePaymentAsyncWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_PAYMENT, string ID_CUSTOMER, UpdatePaymentRequest updatePaymentRequest, string requestor=null, string xOPAYHeaders=null, string traceId=null)
 Update Payment The API is used to edit a payment. Only payments in scheduled status can be edited. 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.PaymentApi.PaymentApi ( String  basePath)

Initializes a new instance of the PaymentApi class.

Returns
Orbipay.PaymentsApi.Client.Api.PaymentApi.PaymentApi ( Orbipay.PaymentsApi.Client.Client.Configuration  configuration = null)

Initializes a new instance of the PaymentApi class using Configuration object

Parameters
configurationAn instance of Configuration
Returns

Member Function Documentation

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

Add default header.

Parameters
keyHeader field name.
valueHeader field value.
Returns
ApiResponse<PaymentResponse> Orbipay.PaymentsApi.Client.Api.PaymentApi.CreatePayment ( string  channel,
string  clientKey,
string  product,
string  timestamp,
string  idempotentRequestKey,
string  requestorType,
string  ID_CUSTOMER,
CreatePaymentRequest  createPaymentRequest,
string  requestor = null,
string  xOPAYHeaders = null,
string  traceId = null 
)

Create Payment The API is used to make payments to service a customer account. Client systems can provide the unique identifier for the payment in their system as payment_reference.<p>Fee amount and fee type are conditional and should be provided if the details of the fee to be charged are maintained in the client system. The fee types that are supported in EBPP are add_to_principal and bill_separately. Alternatively, the fee information can be setup in EBPP, in which case, these fields are ignored. If fee information is setup in the system, the details of the fee are returned in the response.

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.
createPaymentRequestJSON containing all the fields required to make a payment.
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
PaymentResponse

Implements Orbipay.PaymentsApi.Client.Api.IPaymentApi.

async System.Threading.Tasks.Task<PaymentResponse> Orbipay.PaymentsApi.Client.Api.PaymentApi.CreatePaymentAsync ( string  channel,
string  clientKey,
string  product,
string  timestamp,
string  idempotentRequestKey,
string  requestorType,
string  ID_CUSTOMER,
CreatePaymentRequest  createPaymentRequest,
string  requestor = null,
string  xOPAYHeaders = null,
string  traceId = null 
)

Create Payment The API is used to make payments to service a customer account. Client systems can provide the unique identifier for the payment in their system as payment_reference.<p>Fee amount and fee type are conditional and should be provided if the details of the fee to be charged are maintained in the client system. The fee types that are supported in EBPP are add_to_principal and bill_separately. Alternatively, the fee information can be setup in EBPP, in which case, these fields are ignored. If fee information is setup in the system, the details of the fee are returned in the response.

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.
createPaymentRequestJSON containing all the fields required to make a payment.
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 PaymentResponse

Implements Orbipay.PaymentsApi.Client.Api.IPaymentApi.

async System.Threading.Tasks.Task<ApiResponse<PaymentResponse> > Orbipay.PaymentsApi.Client.Api.PaymentApi.CreatePaymentAsyncWithHttpInfo ( string  channel,
string  clientKey,
string  product,
string  timestamp,
string  idempotentRequestKey,
string  requestorType,
string  ID_CUSTOMER,
CreatePaymentRequest  createPaymentRequest,
string  requestor = null,
string  xOPAYHeaders = null,
string  traceId = null 
)

Create Payment The API is used to make payments to service a customer account. Client systems can provide the unique identifier for the payment in their system as payment_reference.<p>Fee amount and fee type are conditional and should be provided if the details of the fee to be charged are maintained in the client system. The fee types that are supported in EBPP are add_to_principal and bill_separately. Alternatively, the fee information can be setup in EBPP, in which case, these fields are ignored. If fee information is setup in the system, the details of the fee are returned in the response.

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.
createPaymentRequestJSON containing all the fields required to make a payment.
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 (PaymentResponse)

Implements Orbipay.PaymentsApi.Client.Api.IPaymentApi.

ApiResponse< PaymentResponse > Orbipay.PaymentsApi.Client.Api.PaymentApi.CreatePaymentWithHttpInfo ( string  channel,
string  clientKey,
string  product,
string  timestamp,
string  idempotentRequestKey,
string  requestorType,
string  ID_CUSTOMER,
CreatePaymentRequest  createPaymentRequest,
string  requestor = null,
string  xOPAYHeaders = null,
string  traceId = null 
)

Create Payment The API is used to make payments to service a customer account. Client systems can provide the unique identifier for the payment in their system as payment_reference.<p>Fee amount and fee type are conditional and should be provided if the details of the fee to be charged are maintained in the client system. The fee types that are supported in EBPP are add_to_principal and bill_separately. Alternatively, the fee information can be setup in EBPP, in which case, these fields are ignored. If fee information is setup in the system, the details of the fee are returned in the response.

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.
createPaymentRequestJSON containing all the fields required to make a payment.
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 PaymentResponse

Implements Orbipay.PaymentsApi.Client.Api.IPaymentApi.

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

Gets the default header.

Returns
Dictionary of HTTP header
ApiResponse<DeleteResponse> Orbipay.PaymentsApi.Client.Api.PaymentApi.DeletePayment ( string  channel,
string  clientKey,
string  product,
string  timestamp,
string  idempotentRequestKey,
string  requestorType,
string  ID_PAYMENT,
string  ID_CUSTOMER,
DeletePaymentRequest  deletePaymentRequest,
string  requestor = null,
string  xOPAYHeaders = null,
string  traceId = null 
)

Delete Payment The API is used to delete or cancel a payment. Payments that are under processing or have already been processed cannot be deleted.

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_PAYMENTThe unique identifier assigned by EBPP to the payment.
ID_CUSTOMERThe unique identifier assigned by EBPP to the customer.
deletePaymentRequestDetails of payment to be deleted/cancelled
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
DeleteResponse

Implements Orbipay.PaymentsApi.Client.Api.IPaymentApi.

async System.Threading.Tasks.Task<DeleteResponse> Orbipay.PaymentsApi.Client.Api.PaymentApi.DeletePaymentAsync ( string  channel,
string  clientKey,
string  product,
string  timestamp,
string  idempotentRequestKey,
string  requestorType,
string  ID_PAYMENT,
string  ID_CUSTOMER,
DeletePaymentRequest  deletePaymentRequest,
string  requestor = null,
string  xOPAYHeaders = null,
string  traceId = null 
)

Delete Payment The API is used to delete or cancel a payment. Payments that are under processing or have already been processed cannot be deleted.

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_PAYMENTThe unique identifier assigned by EBPP to the payment.
ID_CUSTOMERThe unique identifier assigned by EBPP to the customer.
deletePaymentRequestDetails of payment to be deleted/cancelled
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

Implements Orbipay.PaymentsApi.Client.Api.IPaymentApi.

async System.Threading.Tasks.Task<ApiResponse<DeleteResponse> > Orbipay.PaymentsApi.Client.Api.PaymentApi.DeletePaymentAsyncWithHttpInfo ( string  channel,
string  clientKey,
string  product,
string  timestamp,
string  idempotentRequestKey,
string  requestorType,
string  ID_PAYMENT,
string  ID_CUSTOMER,
DeletePaymentRequest  deletePaymentRequest,
string  requestor = null,
string  xOPAYHeaders = null,
string  traceId = null 
)

Delete Payment The API is used to delete or cancel a payment. Payments that are under processing or have already been processed cannot be deleted.

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_PAYMENTThe unique identifier assigned by EBPP to the payment.
ID_CUSTOMERThe unique identifier assigned by EBPP to the customer.
deletePaymentRequestDetails of payment to be deleted/cancelled
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)

Implements Orbipay.PaymentsApi.Client.Api.IPaymentApi.

ApiResponse< DeleteResponse > Orbipay.PaymentsApi.Client.Api.PaymentApi.DeletePaymentWithHttpInfo ( string  channel,
string  clientKey,
string  product,
string  timestamp,
string  idempotentRequestKey,
string  requestorType,
string  ID_PAYMENT,
string  ID_CUSTOMER,
DeletePaymentRequest  deletePaymentRequest,
string  requestor = null,
string  xOPAYHeaders = null,
string  traceId = null 
)

Delete Payment The API is used to delete or cancel a payment. Payments that are under processing or have already been processed cannot be deleted.

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_PAYMENTThe unique identifier assigned by EBPP to the payment.
ID_CUSTOMERThe unique identifier assigned by EBPP to the customer.
deletePaymentRequestDetails of payment to be deleted/cancelled
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

Implements Orbipay.PaymentsApi.Client.Api.IPaymentApi.

ApiResponse<Object> Orbipay.PaymentsApi.Client.Api.PaymentApi.DeleteRecordPayment ( string  channel,
string  clientKey,
string  product,
string  timestamp,
string  idempotentRequestKey,
string  requestorType,
string  ID_PAYMENT,
DeleteRecordedPaymentRequest  deleteRecordedPaymentRequest,
string  requestor = null,
string  xOPAYHeaders = null,
string  traceId = null 
)

Delete Recorded Payment The API is used to delete the recorded payment. It returns 204 http status code with empty body in successful case

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_PAYMENTThe unique identifier assigned by EBPP to the payment.
deleteRecordedPaymentRequestDetails of payment to be deleted/cancelled
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

Implements Orbipay.PaymentsApi.Client.Api.IPaymentApi.

async System.Threading.Tasks.Task Orbipay.PaymentsApi.Client.Api.PaymentApi.DeleteRecordPaymentAsync ( string  channel,
string  clientKey,
string  product,
string  timestamp,
string  idempotentRequestKey,
string  requestorType,
string  ID_PAYMENT,
DeleteRecordedPaymentRequest  deleteRecordedPaymentRequest,
string  requestor = null,
string  xOPAYHeaders = null,
string  traceId = null 
)

Delete Recorded Payment The API is used to delete the recorded payment. It returns 204 http status code with empty body in successful case

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_PAYMENTThe unique identifier assigned by EBPP to the payment.
deleteRecordedPaymentRequestDetails of payment to be deleted/cancelled
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 void

Implements Orbipay.PaymentsApi.Client.Api.IPaymentApi.

async System.Threading.Tasks.Task<ApiResponse<Object> > Orbipay.PaymentsApi.Client.Api.PaymentApi.DeleteRecordPaymentAsyncWithHttpInfo ( string  channel,
string  clientKey,
string  product,
string  timestamp,
string  idempotentRequestKey,
string  requestorType,
string  ID_PAYMENT,
DeleteRecordedPaymentRequest  deleteRecordedPaymentRequest,
string  requestor = null,
string  xOPAYHeaders = null,
string  traceId = null 
)

Delete Recorded Payment The API is used to delete the recorded payment. It returns 204 http status code with empty body in successful case

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_PAYMENTThe unique identifier assigned by EBPP to the payment.
deleteRecordedPaymentRequestDetails of payment to be deleted/cancelled
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

Implements Orbipay.PaymentsApi.Client.Api.IPaymentApi.

ApiResponse<Object> Orbipay.PaymentsApi.Client.Api.PaymentApi.DeleteRecordPaymentWithHttpInfo ( string  channel,
string  clientKey,
string  product,
string  timestamp,
string  idempotentRequestKey,
string  requestorType,
string  ID_PAYMENT,
DeleteRecordedPaymentRequest  deleteRecordedPaymentRequest,
string  requestor = null,
string  xOPAYHeaders = null,
string  traceId = null 
)

Delete Recorded Payment The API is used to delete the recorded payment. It returns 204 http status code with empty body in successful case

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_PAYMENTThe unique identifier assigned by EBPP to the payment.
deleteRecordedPaymentRequestDetails of payment to be deleted/cancelled
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 Object(void)

Implements Orbipay.PaymentsApi.Client.Api.IPaymentApi.

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

Gets the base path of the API client.

The base path

Implements Orbipay.PaymentsApi.Client.Client.IApiAccessor.

ApiResponse<PaymentResponse> Orbipay.PaymentsApi.Client.Api.PaymentApi.GetPayment ( string  channel,
string  clientKey,
string  product,
string  timestamp,
string  idempotentRequestKey,
string  requestorType,
string  ID_PAYMENT,
string  ID_CUSTOMER,
string  requestor = null,
string  xOPAYHeaders = null,
string  traceId = null 
)

Get Payment The API is used to retrieve the details of a payment or a recorded payment 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_PAYMENTThe unique identifier assigned by EBPP to the payment.
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
PaymentResponse

Implements Orbipay.PaymentsApi.Client.Api.IPaymentApi.

async System.Threading.Tasks.Task<PaymentResponse> Orbipay.PaymentsApi.Client.Api.PaymentApi.GetPaymentAsync ( string  channel,
string  clientKey,
string  product,
string  timestamp,
string  idempotentRequestKey,
string  requestorType,
string  ID_PAYMENT,
string  ID_CUSTOMER,
string  requestor = null,
string  xOPAYHeaders = null,
string  traceId = null 
)

Get Payment The API is used to retrieve the details of a payment or a recorded payment 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_PAYMENTThe unique identifier assigned by EBPP to the payment.
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 PaymentResponse

Implements Orbipay.PaymentsApi.Client.Api.IPaymentApi.

async System.Threading.Tasks.Task<ApiResponse<PaymentResponse> > Orbipay.PaymentsApi.Client.Api.PaymentApi.GetPaymentAsyncWithHttpInfo ( string  channel,
string  clientKey,
string  product,
string  timestamp,
string  idempotentRequestKey,
string  requestorType,
string  ID_PAYMENT,
string  ID_CUSTOMER,
string  requestor = null,
string  xOPAYHeaders = null,
string  traceId = null 
)

Get Payment The API is used to retrieve the details of a payment or a recorded payment 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_PAYMENTThe unique identifier assigned by EBPP to the payment.
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 (PaymentResponse)

Implements Orbipay.PaymentsApi.Client.Api.IPaymentApi.

ApiResponse< PaymentResponse > Orbipay.PaymentsApi.Client.Api.PaymentApi.GetPaymentWithHttpInfo ( string  channel,
string  clientKey,
string  product,
string  timestamp,
string  idempotentRequestKey,
string  requestorType,
string  ID_PAYMENT,
string  ID_CUSTOMER,
string  requestor = null,
string  xOPAYHeaders = null,
string  traceId = null 
)

Get Payment The API is used to retrieve the details of a payment or a recorded payment 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_PAYMENTThe unique identifier assigned by EBPP to the payment.
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 PaymentResponse

Implements Orbipay.PaymentsApi.Client.Api.IPaymentApi.

ApiResponse<GetRecordedPaymentResponse> Orbipay.PaymentsApi.Client.Api.PaymentApi.GetRecordPayment ( string  channel,
string  clientKey,
string  product,
string  timestamp,
string  idempotentRequestKey,
string  requestorType,
string  ID_PAYMENT,
string  requestor = null,
string  xOPAYHeaders = null,
string  traceId = null 
)

Get Recorded Payment <b style&#x3D;&quot;color:red&quot;>This API has been deprecated, please use <a href&#x3D;&quot;#operation/getPayment&quot;>Get Payment</a> API instead.</b> <br> The API is used to retrieve the details of a payment 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_PAYMENTThe unique identifier assigned by EBPP to the payment.
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
GetRecordedPaymentResponse

Implements Orbipay.PaymentsApi.Client.Api.IPaymentApi.

async System.Threading.Tasks.Task<GetRecordedPaymentResponse> Orbipay.PaymentsApi.Client.Api.PaymentApi.GetRecordPaymentAsync ( string  channel,
string  clientKey,
string  product,
string  timestamp,
string  idempotentRequestKey,
string  requestorType,
string  ID_PAYMENT,
string  requestor = null,
string  xOPAYHeaders = null,
string  traceId = null 
)

Get Recorded Payment <b style&#x3D;&quot;color:red&quot;>This API has been deprecated, please use <a href&#x3D;&quot;#operation/getPayment&quot;>Get Payment</a> API instead.</b> <br> The API is used to retrieve the details of a payment 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_PAYMENTThe unique identifier assigned by EBPP to the payment.
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 GetRecordedPaymentResponse

Implements Orbipay.PaymentsApi.Client.Api.IPaymentApi.

async System.Threading.Tasks.Task<ApiResponse<GetRecordedPaymentResponse> > Orbipay.PaymentsApi.Client.Api.PaymentApi.GetRecordPaymentAsyncWithHttpInfo ( string  channel,
string  clientKey,
string  product,
string  timestamp,
string  idempotentRequestKey,
string  requestorType,
string  ID_PAYMENT,
string  requestor = null,
string  xOPAYHeaders = null,
string  traceId = null 
)

Get Recorded Payment <b style&#x3D;&quot;color:red&quot;>This API has been deprecated, please use <a href&#x3D;&quot;#operation/getPayment&quot;>Get Payment</a> API instead.</b> <br> The API is used to retrieve the details of a payment 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_PAYMENTThe unique identifier assigned by EBPP to the payment.
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 (GetRecordedPaymentResponse)

Implements Orbipay.PaymentsApi.Client.Api.IPaymentApi.

ApiResponse< GetRecordedPaymentResponse > Orbipay.PaymentsApi.Client.Api.PaymentApi.GetRecordPaymentWithHttpInfo ( string  channel,
string  clientKey,
string  product,
string  timestamp,
string  idempotentRequestKey,
string  requestorType,
string  ID_PAYMENT,
string  requestor = null,
string  xOPAYHeaders = null,
string  traceId = null 
)

Get Recorded Payment <b style&#x3D;&quot;color:red&quot;>This API has been deprecated, please use <a href&#x3D;&quot;#operation/getPayment&quot;>Get Payment</a> API instead.</b> <br> The API is used to retrieve the details of a payment 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_PAYMENTThe unique identifier assigned by EBPP to the payment.
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 GetRecordedPaymentResponse

Implements Orbipay.PaymentsApi.Client.Api.IPaymentApi.

ApiResponse<RecordedPaymentResponse> Orbipay.PaymentsApi.Client.Api.PaymentApi.RecordPayment ( string  channel,
string  clientKey,
string  product,
string  timestamp,
string  idempotentRequestKey,
string  requestorType,
RecordPaymentRequest  recordPaymentRequest,
string  requestor = null,
string  xOPAYHeaders = null,
string  traceId = null 
)

Record Payment The API is used to record payments in EBPP those are made and fulfilled outside EBPP.

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.
recordPaymentRequestJSON containing all the fields required to record a payment.
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
RecordedPaymentResponse

Implements Orbipay.PaymentsApi.Client.Api.IPaymentApi.

async System.Threading.Tasks.Task<RecordedPaymentResponse> Orbipay.PaymentsApi.Client.Api.PaymentApi.RecordPaymentAsync ( string  channel,
string  clientKey,
string  product,
string  timestamp,
string  idempotentRequestKey,
string  requestorType,
RecordPaymentRequest  recordPaymentRequest,
string  requestor = null,
string  xOPAYHeaders = null,
string  traceId = null 
)

Record Payment The API is used to record payments in EBPP those are made and fulfilled outside EBPP.

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.
recordPaymentRequestJSON containing all the fields required to record a payment.
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 RecordedPaymentResponse

Implements Orbipay.PaymentsApi.Client.Api.IPaymentApi.

async System.Threading.Tasks.Task<ApiResponse<RecordedPaymentResponse> > Orbipay.PaymentsApi.Client.Api.PaymentApi.RecordPaymentAsyncWithHttpInfo ( string  channel,
string  clientKey,
string  product,
string  timestamp,
string  idempotentRequestKey,
string  requestorType,
RecordPaymentRequest  recordPaymentRequest,
string  requestor = null,
string  xOPAYHeaders = null,
string  traceId = null 
)

Record Payment The API is used to record payments in EBPP those are made and fulfilled outside EBPP.

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.
recordPaymentRequestJSON containing all the fields required to record a payment.
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 (RecordedPaymentResponse)

Implements Orbipay.PaymentsApi.Client.Api.IPaymentApi.

ApiResponse< RecordedPaymentResponse > Orbipay.PaymentsApi.Client.Api.PaymentApi.RecordPaymentWithHttpInfo ( string  channel,
string  clientKey,
string  product,
string  timestamp,
string  idempotentRequestKey,
string  requestorType,
RecordPaymentRequest  recordPaymentRequest,
string  requestor = null,
string  xOPAYHeaders = null,
string  traceId = null 
)

Record Payment The API is used to record payments in EBPP those are made and fulfilled outside EBPP.

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.
recordPaymentRequestJSON containing all the fields required to record a payment.
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 RecordedPaymentResponse

Implements Orbipay.PaymentsApi.Client.Api.IPaymentApi.

ApiResponse<PaymentResponse> Orbipay.PaymentsApi.Client.Api.PaymentApi.RetrieveFeePayment ( string  channel,
string  clientKey,
string  product,
string  timestamp,
string  idempotentRequestKey,
string  requestorType,
string  ID_FEE,
string  ID_CUSTOMER,
string  requestor = null,
string  xOPAYHeaders = null,
string  traceId = null 
)

Get Fee Payment The API is used to retrieve the details of a fee payment 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 OrbiPay 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_FEEThe unique identifier assigned by OrbiPay to the FeePayment.
ID_CUSTOMERThe unique identifier assigned by OrbiPay 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
PaymentResponse

Implements Orbipay.PaymentsApi.Client.Api.IPaymentApi.

async System.Threading.Tasks.Task<PaymentResponse> Orbipay.PaymentsApi.Client.Api.PaymentApi.RetrieveFeePaymentAsync ( string  channel,
string  clientKey,
string  product,
string  timestamp,
string  idempotentRequestKey,
string  requestorType,
string  ID_FEE,
string  ID_CUSTOMER,
string  requestor = null,
string  xOPAYHeaders = null,
string  traceId = null 
)

Get Fee Payment The API is used to retrieve the details of a fee payment 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 OrbiPay 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_FEEThe unique identifier assigned by OrbiPay to the FeePayment.
ID_CUSTOMERThe unique identifier assigned by OrbiPay 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 PaymentResponse

Implements Orbipay.PaymentsApi.Client.Api.IPaymentApi.

async System.Threading.Tasks.Task<ApiResponse<PaymentResponse> > Orbipay.PaymentsApi.Client.Api.PaymentApi.RetrieveFeePaymentAsyncWithHttpInfo ( string  channel,
string  clientKey,
string  product,
string  timestamp,
string  idempotentRequestKey,
string  requestorType,
string  ID_FEE,
string  ID_CUSTOMER,
string  requestor = null,
string  xOPAYHeaders = null,
string  traceId = null 
)

Get Fee Payment The API is used to retrieve the details of a fee payment 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 OrbiPay 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_FEEThe unique identifier assigned by OrbiPay to the FeePayment.
ID_CUSTOMERThe unique identifier assigned by OrbiPay 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 (PaymentResponse)

Implements Orbipay.PaymentsApi.Client.Api.IPaymentApi.

ApiResponse< PaymentResponse > Orbipay.PaymentsApi.Client.Api.PaymentApi.RetrieveFeePaymentWithHttpInfo ( string  channel,
string  clientKey,
string  product,
string  timestamp,
string  idempotentRequestKey,
string  requestorType,
string  ID_FEE,
string  ID_CUSTOMER,
string  requestor = null,
string  xOPAYHeaders = null,
string  traceId = null 
)

Get Fee Payment The API is used to retrieve the details of a fee payment 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 OrbiPay 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_FEEThe unique identifier assigned by OrbiPay to the FeePayment.
ID_CUSTOMERThe unique identifier assigned by OrbiPay 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 PaymentResponse

Implements Orbipay.PaymentsApi.Client.Api.IPaymentApi.

ApiResponse<PaymentsResponse> Orbipay.PaymentsApi.Client.Api.PaymentApi.RetrievePayments ( 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 >  paymentScheduleType = null,
List< string >  paymentMethod = null,
string  fromDate = null,
string  toDate = null,
string  pageSize = null,
string  queryId = null,
string  fromIndex = null,
string  toIndex = null 
)

Retrieve Payments The API is used to retrieve the payments and recorded payments made by a customer. Payments can be filtered using the confirmation number, customer account, funding account, status and payment schedule type, payment method, by date range and others mentioned below. If no dates are provided for retrieval, payments in the last six months and all the payments scheduled for a future date are returned. In case a payment has failed due to ACH returns, then the payment return date and the return code will be available in the response. If the requestor type is customer then the id_customer request parameter is mandatory. The results are sorted in descending order of the payment_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)
paymentScheduleTypeThe schedule type for the payment setup. This can take multiple values in the format key&#x3D;value1&key&#x3D;value2.... (optional)
paymentMethodThe fulfillment method for the payment. (optional)
fromDateThe date from which payments, matching the criteria specified, need to be retrieved. (optional)
toDateThe date upto which payments, 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
PaymentsResponse

Implements Orbipay.PaymentsApi.Client.Api.IPaymentApi.

async System.Threading.Tasks.Task<PaymentsResponse> Orbipay.PaymentsApi.Client.Api.PaymentApi.RetrievePaymentsAsync ( 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 >  paymentScheduleType = null,
List< string >  paymentMethod = null,
string  fromDate = null,
string  toDate = null,
string  pageSize = null,
string  queryId = null,
string  fromIndex = null,
string  toIndex = null 
)

Retrieve Payments The API is used to retrieve the payments and recorded payments made by a customer. Payments can be filtered using the confirmation number, customer account, funding account, status and payment schedule type, payment method, by date range and others mentioned below. If no dates are provided for retrieval, payments in the last six months and all the payments scheduled for a future date are returned. In case a payment has failed due to ACH returns, then the payment return date and the return code will be available in the response. If the requestor type is customer then the id_customer request parameter is mandatory. The results are sorted in descending order of the payment_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)
paymentScheduleTypeThe schedule type for the payment setup. This can take multiple values in the format key&#x3D;value1&key&#x3D;value2.... (optional)
paymentMethodThe fulfillment method for the payment. (optional)
fromDateThe date from which payments, matching the criteria specified, need to be retrieved. (optional)
toDateThe date upto which payments, 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 PaymentsResponse

Implements Orbipay.PaymentsApi.Client.Api.IPaymentApi.

async System.Threading.Tasks.Task<ApiResponse<PaymentsResponse> > Orbipay.PaymentsApi.Client.Api.PaymentApi.RetrievePaymentsAsyncWithHttpInfo ( 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 >  paymentScheduleType = null,
List< string >  paymentMethod = null,
string  fromDate = null,
string  toDate = null,
string  pageSize = null,
string  queryId = null,
string  fromIndex = null,
string  toIndex = null 
)

Retrieve Payments The API is used to retrieve the payments and recorded payments made by a customer. Payments can be filtered using the confirmation number, customer account, funding account, status and payment schedule type, payment method, by date range and others mentioned below. If no dates are provided for retrieval, payments in the last six months and all the payments scheduled for a future date are returned. In case a payment has failed due to ACH returns, then the payment return date and the return code will be available in the response. If the requestor type is customer then the id_customer request parameter is mandatory. The results are sorted in descending order of the payment_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)
paymentScheduleTypeThe schedule type for the payment setup. This can take multiple values in the format key&#x3D;value1&key&#x3D;value2.... (optional)
paymentMethodThe fulfillment method for the payment. (optional)
fromDateThe date from which payments, matching the criteria specified, need to be retrieved. (optional)
toDateThe date upto which payments, 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 (PaymentsResponse)

Implements Orbipay.PaymentsApi.Client.Api.IPaymentApi.

ApiResponse< PaymentsResponse > Orbipay.PaymentsApi.Client.Api.PaymentApi.RetrievePaymentsWithHttpInfo ( 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 >  paymentScheduleType = null,
List< string >  paymentMethod = null,
string  fromDate = null,
string  toDate = null,
string  pageSize = null,
string  queryId = null,
string  fromIndex = null,
string  toIndex = null 
)

Retrieve Payments The API is used to retrieve the payments and recorded payments made by a customer. Payments can be filtered using the confirmation number, customer account, funding account, status and payment schedule type, payment method, by date range and others mentioned below. If no dates are provided for retrieval, payments in the last six months and all the payments scheduled for a future date are returned. In case a payment has failed due to ACH returns, then the payment return date and the return code will be available in the response. If the requestor type is customer then the id_customer request parameter is mandatory. The results are sorted in descending order of the payment_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)
paymentScheduleTypeThe schedule type for the payment setup. This can take multiple values in the format key&#x3D;value1&key&#x3D;value2.... (optional)
paymentMethodThe fulfillment method for the payment. (optional)
fromDateThe date from which payments, matching the criteria specified, need to be retrieved. (optional)
toDateThe date upto which payments, 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 PaymentsResponse

Implements Orbipay.PaymentsApi.Client.Api.IPaymentApi.

ApiResponse<RecordedPaymentsResponse> Orbipay.PaymentsApi.Client.Api.PaymentApi.RetrieveRecordPayments ( string  channel,
string  clientKey,
string  product,
string  timestamp,
string  idempotentRequestKey,
string  requestorType,
string  idCustomer,
string  requestor = null,
string  xOPAYHeaders = null,
string  traceId = null,
string  idCustomerAccount = null,
string  confirmationNumber = null,
List< string >  paymentMethod = null,
List< string >  status = null,
string  fromDate = null,
string  toDate = null,
string  pageSize = null,
string  queryId = null,
string  fromIndex = null,
string  toIndex = null 
)

Retrieve Recorded Payments <b style&#x3D;&quot;color:red&quot;>This API has been deprecated, please use <a href&#x3D;&quot;#operation/retrievePayments&quot;>Retrieve Payments</a> API instead.</b> <br> The API is used to retrieve the payments made by a customer. Payments can be filtered using the confirmation number, customer account, status, by date range and others mentioned below. If no dates are provided for retrieval, payments in the last six months and all the payments scheduled for a future date are returned. In case a payment has failed due to ACH returns, then the payment return date and the return code will be available in the response.

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.
idCustomerThe 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)
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)
paymentMethodThe non fulfillment method for the payment. This can take multiple values in the format key&#x3D;value1&key&#x3D;value2.... (optional)
statusThe status of the payment. This can take multiple values in the format key&#x3D;value1&key&#x3D;value2.... (optional)
fromDateThe date from which payments, matching the criteria specified, need to be retrieved. (optional)
toDateThe date upto which payments, 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 Payments 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
RecordedPaymentsResponse

Implements Orbipay.PaymentsApi.Client.Api.IPaymentApi.

async System.Threading.Tasks.Task<RecordedPaymentsResponse> Orbipay.PaymentsApi.Client.Api.PaymentApi.RetrieveRecordPaymentsAsync ( string  channel,
string  clientKey,
string  product,
string  timestamp,
string  idempotentRequestKey,
string  requestorType,
string  idCustomer,
string  requestor = null,
string  xOPAYHeaders = null,
string  traceId = null,
string  idCustomerAccount = null,
string  confirmationNumber = null,
List< string >  paymentMethod = null,
List< string >  status = null,
string  fromDate = null,
string  toDate = null,
string  pageSize = null,
string  queryId = null,
string  fromIndex = null,
string  toIndex = null 
)

Retrieve Recorded Payments <b style&#x3D;&quot;color:red&quot;>This API has been deprecated, please use <a href&#x3D;&quot;#operation/retrievePayments&quot;>Retrieve Payments</a> API instead.</b> <br> The API is used to retrieve the payments made by a customer. Payments can be filtered using the confirmation number, customer account, status, by date range and others mentioned below. If no dates are provided for retrieval, payments in the last six months and all the payments scheduled for a future date are returned. In case a payment has failed due to ACH returns, then the payment return date and the return code will be available in the response.

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.
idCustomerThe 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)
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)
paymentMethodThe non fulfillment method for the payment. This can take multiple values in the format key&#x3D;value1&key&#x3D;value2.... (optional)
statusThe status of the payment. This can take multiple values in the format key&#x3D;value1&key&#x3D;value2.... (optional)
fromDateThe date from which payments, matching the criteria specified, need to be retrieved. (optional)
toDateThe date upto which payments, 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 Payments 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 RecordedPaymentsResponse

Implements Orbipay.PaymentsApi.Client.Api.IPaymentApi.

async System.Threading.Tasks.Task<ApiResponse<RecordedPaymentsResponse> > Orbipay.PaymentsApi.Client.Api.PaymentApi.RetrieveRecordPaymentsAsyncWithHttpInfo ( string  channel,
string  clientKey,
string  product,
string  timestamp,
string  idempotentRequestKey,
string  requestorType,
string  idCustomer,
string  requestor = null,
string  xOPAYHeaders = null,
string  traceId = null,
string  idCustomerAccount = null,
string  confirmationNumber = null,
List< string >  paymentMethod = null,
List< string >  status = null,
string  fromDate = null,
string  toDate = null,
string  pageSize = null,
string  queryId = null,
string  fromIndex = null,
string  toIndex = null 
)

Retrieve Recorded Payments <b style&#x3D;&quot;color:red&quot;>This API has been deprecated, please use <a href&#x3D;&quot;#operation/retrievePayments&quot;>Retrieve Payments</a> API instead.</b> <br> The API is used to retrieve the payments made by a customer. Payments can be filtered using the confirmation number, customer account, status, by date range and others mentioned below. If no dates are provided for retrieval, payments in the last six months and all the payments scheduled for a future date are returned. In case a payment has failed due to ACH returns, then the payment return date and the return code will be available in the response.

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.
idCustomerThe 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)
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)
paymentMethodThe non fulfillment method for the payment. This can take multiple values in the format key&#x3D;value1&key&#x3D;value2.... (optional)
statusThe status of the payment. This can take multiple values in the format key&#x3D;value1&key&#x3D;value2.... (optional)
fromDateThe date from which payments, matching the criteria specified, need to be retrieved. (optional)
toDateThe date upto which payments, 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 Payments 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 (RecordedPaymentsResponse)

Implements Orbipay.PaymentsApi.Client.Api.IPaymentApi.

ApiResponse< RecordedPaymentsResponse > Orbipay.PaymentsApi.Client.Api.PaymentApi.RetrieveRecordPaymentsWithHttpInfo ( string  channel,
string  clientKey,
string  product,
string  timestamp,
string  idempotentRequestKey,
string  requestorType,
string  idCustomer,
string  requestor = null,
string  xOPAYHeaders = null,
string  traceId = null,
string  idCustomerAccount = null,
string  confirmationNumber = null,
List< string >  paymentMethod = null,
List< string >  status = null,
string  fromDate = null,
string  toDate = null,
string  pageSize = null,
string  queryId = null,
string  fromIndex = null,
string  toIndex = null 
)

Retrieve Recorded Payments <b style&#x3D;&quot;color:red&quot;>This API has been deprecated, please use <a href&#x3D;&quot;#operation/retrievePayments&quot;>Retrieve Payments</a> API instead.</b> <br> The API is used to retrieve the payments made by a customer. Payments can be filtered using the confirmation number, customer account, status, by date range and others mentioned below. If no dates are provided for retrieval, payments in the last six months and all the payments scheduled for a future date are returned. In case a payment has failed due to ACH returns, then the payment return date and the return code will be available in the response.

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.
idCustomerThe 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)
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)
paymentMethodThe non fulfillment method for the payment. This can take multiple values in the format key&#x3D;value1&key&#x3D;value2.... (optional)
statusThe status of the payment. This can take multiple values in the format key&#x3D;value1&key&#x3D;value2.... (optional)
fromDateThe date from which payments, matching the criteria specified, need to be retrieved. (optional)
toDateThe date upto which payments, 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 Payments 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 RecordedPaymentsResponse

Implements Orbipay.PaymentsApi.Client.Api.IPaymentApi.

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

Sets the base path of the API client.

The base path

ApiResponse<SimplePaymentResponse> Orbipay.PaymentsApi.Client.Api.PaymentApi.SimplePayment ( string  channel,
string  clientKey,
string  product,
string  timestamp,
string  idempotentRequestKey,
string  requestorType,
SimplePaymentRequest  simplePaymentRequest,
string  requestor = null,
string  xOPAYHeaders = null,
string  traceId = null,
string  saveFundingAccount = null 
)

Simple Payment The API is used to make payments to service a customer account. Client systems can provide the unique identifier for the payment in their system as payment_reference. Fee amount and fee type are conditional and should be provided if the details of the fee to be charged are maintained in the client system. The fee types that are supported in EBPP are add_to_principal and bill_separately. Alternatively, the fee information can be setup in EBPP, in which case, these fields are ignored. If fee information is setup in the system, the details of the fee are returned in the response. This API updates the details of the customer, customer account and the funding account if those exist in EBPP or creates them otherwise.

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.
simplePaymentRequestJSON containing all the fields required to make a payment.
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)
saveFundingAccountquery param (optional)
Returns
SimplePaymentResponse

Implements Orbipay.PaymentsApi.Client.Api.IPaymentApi.

async System.Threading.Tasks.Task<SimplePaymentResponse> Orbipay.PaymentsApi.Client.Api.PaymentApi.SimplePaymentAsync ( string  channel,
string  clientKey,
string  product,
string  timestamp,
string  idempotentRequestKey,
string  requestorType,
SimplePaymentRequest  simplePaymentRequest,
string  requestor = null,
string  xOPAYHeaders = null,
string  traceId = null,
string  saveFundingAccount = null 
)

Simple Payment The API is used to make payments to service a customer account. Client systems can provide the unique identifier for the payment in their system as payment_reference. Fee amount and fee type are conditional and should be provided if the details of the fee to be charged are maintained in the client system. The fee types that are supported in EBPP are add_to_principal and bill_separately. Alternatively, the fee information can be setup in EBPP, in which case, these fields are ignored. If fee information is setup in the system, the details of the fee are returned in the response. This API updates the details of the customer, customer account and the funding account if those exist in EBPP or creates them otherwise.

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.
simplePaymentRequestJSON containing all the fields required to make a payment.
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)
saveFundingAccountquery param (optional)
Returns
Task of SimplePaymentResponse

Implements Orbipay.PaymentsApi.Client.Api.IPaymentApi.

async System.Threading.Tasks.Task<ApiResponse<SimplePaymentResponse> > Orbipay.PaymentsApi.Client.Api.PaymentApi.SimplePaymentAsyncWithHttpInfo ( string  channel,
string  clientKey,
string  product,
string  timestamp,
string  idempotentRequestKey,
string  requestorType,
SimplePaymentRequest  simplePaymentRequest,
string  requestor = null,
string  xOPAYHeaders = null,
string  traceId = null,
string  saveFundingAccount = null 
)

Simple Payment The API is used to make payments to service a customer account. Client systems can provide the unique identifier for the payment in their system as payment_reference. Fee amount and fee type are conditional and should be provided if the details of the fee to be charged are maintained in the client system. The fee types that are supported in EBPP are add_to_principal and bill_separately. Alternatively, the fee information can be setup in EBPP, in which case, these fields are ignored. If fee information is setup in the system, the details of the fee are returned in the response. This API updates the details of the customer, customer account and the funding account if those exist in EBPP or creates them otherwise.

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.
simplePaymentRequestJSON containing all the fields required to make a payment.
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)
saveFundingAccountquery param (optional)
Returns
Task of ApiResponse (SimplePaymentResponse)

Implements Orbipay.PaymentsApi.Client.Api.IPaymentApi.

ApiResponse< SimplePaymentResponse > Orbipay.PaymentsApi.Client.Api.PaymentApi.SimplePaymentWithHttpInfo ( string  channel,
string  clientKey,
string  product,
string  timestamp,
string  idempotentRequestKey,
string  requestorType,
SimplePaymentRequest  simplePaymentRequest,
string  requestor = null,
string  xOPAYHeaders = null,
string  traceId = null,
string  saveFundingAccount = null 
)

Simple Payment The API is used to make payments to service a customer account. Client systems can provide the unique identifier for the payment in their system as payment_reference. Fee amount and fee type are conditional and should be provided if the details of the fee to be charged are maintained in the client system. The fee types that are supported in EBPP are add_to_principal and bill_separately. Alternatively, the fee information can be setup in EBPP, in which case, these fields are ignored. If fee information is setup in the system, the details of the fee are returned in the response. This API updates the details of the customer, customer account and the funding account if those exist in EBPP or creates them otherwise.

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.
simplePaymentRequestJSON containing all the fields required to make a payment.
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)
saveFundingAccountquery param (optional)
Returns
ApiResponse of SimplePaymentResponse

Implements Orbipay.PaymentsApi.Client.Api.IPaymentApi.

ApiResponse<PaymentResponse> Orbipay.PaymentsApi.Client.Api.PaymentApi.UpdatePayment ( string  channel,
string  clientKey,
string  product,
string  timestamp,
string  idempotentRequestKey,
string  requestorType,
string  ID_PAYMENT,
string  ID_CUSTOMER,
UpdatePaymentRequest  updatePaymentRequest,
string  requestor = null,
string  xOPAYHeaders = null,
string  traceId = null 
)

Update Payment The API is used to edit a payment. Only payments in scheduled status can be edited.

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_PAYMENTThe unique identifier assigned by EBPP to the payment.
ID_CUSTOMERThe unique identifier assigned by EBPP to the customer.
updatePaymentRequestDetails of the Payment 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
PaymentResponse

Implements Orbipay.PaymentsApi.Client.Api.IPaymentApi.

async System.Threading.Tasks.Task<PaymentResponse> Orbipay.PaymentsApi.Client.Api.PaymentApi.UpdatePaymentAsync ( string  channel,
string  clientKey,
string  product,
string  timestamp,
string  idempotentRequestKey,
string  requestorType,
string  ID_PAYMENT,
string  ID_CUSTOMER,
UpdatePaymentRequest  updatePaymentRequest,
string  requestor = null,
string  xOPAYHeaders = null,
string  traceId = null 
)

Update Payment The API is used to edit a payment. Only payments in scheduled status can be edited.

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_PAYMENTThe unique identifier assigned by EBPP to the payment.
ID_CUSTOMERThe unique identifier assigned by EBPP to the customer.
updatePaymentRequestDetails of the Payment 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 PaymentResponse

Implements Orbipay.PaymentsApi.Client.Api.IPaymentApi.

async System.Threading.Tasks.Task<ApiResponse<PaymentResponse> > Orbipay.PaymentsApi.Client.Api.PaymentApi.UpdatePaymentAsyncWithHttpInfo ( string  channel,
string  clientKey,
string  product,
string  timestamp,
string  idempotentRequestKey,
string  requestorType,
string  ID_PAYMENT,
string  ID_CUSTOMER,
UpdatePaymentRequest  updatePaymentRequest,
string  requestor = null,
string  xOPAYHeaders = null,
string  traceId = null 
)

Update Payment The API is used to edit a payment. Only payments in scheduled status can be edited.

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_PAYMENTThe unique identifier assigned by EBPP to the payment.
ID_CUSTOMERThe unique identifier assigned by EBPP to the customer.
updatePaymentRequestDetails of the Payment 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 (PaymentResponse)

Implements Orbipay.PaymentsApi.Client.Api.IPaymentApi.

ApiResponse< PaymentResponse > Orbipay.PaymentsApi.Client.Api.PaymentApi.UpdatePaymentWithHttpInfo ( string  channel,
string  clientKey,
string  product,
string  timestamp,
string  idempotentRequestKey,
string  requestorType,
string  ID_PAYMENT,
string  ID_CUSTOMER,
UpdatePaymentRequest  updatePaymentRequest,
string  requestor = null,
string  xOPAYHeaders = null,
string  traceId = null 
)

Update Payment The API is used to edit a payment. Only payments in scheduled status can be edited.

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_PAYMENTThe unique identifier assigned by EBPP to the payment.
ID_CUSTOMERThe unique identifier assigned by EBPP to the customer.
updatePaymentRequestDetails of the Payment 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 PaymentResponse

Implements Orbipay.PaymentsApi.Client.Api.IPaymentApi.

Property Documentation

Orbipay.PaymentsApi.Client.Client.Configuration Orbipay.PaymentsApi.Client.Api.PaymentApi.Configuration
getset

Gets or sets the configuration object

An instance of the Configuration

Orbipay.PaymentsApi.Client.Client.ExceptionFactory Orbipay.PaymentsApi.Client.Api.PaymentApi.ExceptionFactory
getset

Provides a factory method hook for the creation of exceptions.


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