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

Public Member Functions
ApiResponse< PaymentResponse >	CreatePayment (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_CUSTOMER, CreatePaymentRequest createPaymentRequest, string requestor=null, string xOPAYHeaders=null)
	Create Payment More...

ApiResponse< PaymentResponse >	CreatePaymentWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_CUSTOMER, CreatePaymentRequest createPaymentRequest, string requestor=null, string xOPAYHeaders=null)
	Create Payment More...

ApiResponse< DeleteResponse >	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)
	Delete Payment More...

ApiResponse< DeleteResponse >	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)
	Delete Payment More...

ApiResponse< PaymentResponse >	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)
	Get Payment More...

ApiResponse< PaymentResponse >	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)
	Get Payment More...

ApiResponse< PaymentResponse >	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)
	Get Fee Payment More...

ApiResponse< PaymentResponse >	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)
	Get Fee Payment More...

ApiResponse< PaymentsResponse >	RetrievePayments (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string requestor=null, string xOPAYHeaders=null, string idCustomer=null, string idFundingAccount=null, string idCustomerAccount=null, string confirmationNumber=null, List< string > status=null, List< string > paymentScheduleType=null, string fromDate=null, string toDate=null, string pageSize=null, string queryId=null, string fromIndex=null, string toIndex=null)
	Retrieve Payments More...

ApiResponse< PaymentsResponse >	RetrievePaymentsWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string requestor=null, string xOPAYHeaders=null, string idCustomer=null, string idFundingAccount=null, string idCustomerAccount=null, string confirmationNumber=null, List< string > status=null, List< string > paymentScheduleType=null, string fromDate=null, string toDate=null, string pageSize=null, string queryId=null, string fromIndex=null, string toIndex=null)
	Retrieve Payments 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 saveFundingAccount=null)
	Simple Payment 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 saveFundingAccount=null)
	Simple Payment More...

ApiResponse< PaymentResponse >	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)
	Update Payment More...

ApiResponse< PaymentResponse >	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)
	Update Payment More...

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)
	Create Payment More...

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)
	Create Payment More...

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)
	Delete Payment More...

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)
	Delete Payment More...

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)
	Get Payment More...

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)
	Get Payment More...

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)
	Get Fee Payment More...

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)
	Get Fee Payment More...

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 idCustomer=null, string idFundingAccount=null, string idCustomerAccount=null, string confirmationNumber=null, List< string > status=null, List< string > paymentScheduleType=null, string fromDate=null, string toDate=null, string pageSize=null, string queryId=null, string fromIndex=null, string toIndex=null)
	Retrieve Payments More...

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 idCustomer=null, string idFundingAccount=null, string idCustomerAccount=null, string confirmationNumber=null, List< string > status=null, List< string > paymentScheduleType=null, string fromDate=null, string toDate=null, string pageSize=null, string queryId=null, string fromIndex=null, string toIndex=null)
	Retrieve Payments More...

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 saveFundingAccount=null)
	Simple Payment More...

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 saveFundingAccount=null)
	Simple Payment More...

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)
	Update Payment More...

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)
	Update Payment More...

Public Member Functions inherited from Orbipay.PaymentsApi.Client.Client.IApiAccessor
String	GetBasePath ()
	Gets the base path of the API client. More...

Additional Inherited Members
Properties inherited from Orbipay.PaymentsApi.Client.Client.IApiAccessor
Configuration	Configuration `[get, set]`
	Gets or sets the configuration object More...

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

Detailed Description

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

Member Function Documentation

ApiResponse<PaymentResponse> Orbipay.PaymentsApi.Client.Api.IPaymentApi.CreatePayment	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_CUSTOMER,
		CreatePaymentRequest	createPaymentRequest,
		string	requestor = `null`,
		string	xOPAYHeaders = `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.ApiException Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
createPaymentRequest	JSON containing all the fields required to make a payment.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)

Returns: ApiResponse<PaymentResponse>

Implemented in Orbipay.PaymentsApi.Client.Api.PaymentApi.

System.Threading.Tasks.Task<PaymentResponse> Orbipay.PaymentsApi.Client.Api.IPaymentApi.CreatePaymentAsync	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_CUSTOMER,
		CreatePaymentRequest	createPaymentRequest,
		string	requestor = `null`,
		string	xOPAYHeaders = `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.ApiException Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
createPaymentRequest	JSON containing all the fields required to make a payment.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)

Returns: Task of PaymentResponse

Implemented in Orbipay.PaymentsApi.Client.Api.PaymentApi.

System.Threading.Tasks.Task<ApiResponse<PaymentResponse> > Orbipay.PaymentsApi.Client.Api.IPaymentApi.CreatePaymentAsyncWithHttpInfo	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_CUSTOMER,
		CreatePaymentRequest	createPaymentRequest,
		string	requestor = `null`,
		string	xOPAYHeaders = `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.ApiException Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
createPaymentRequest	JSON containing all the fields required to make a payment.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)

Returns: Task of ApiResponse (PaymentResponse)

Implemented in Orbipay.PaymentsApi.Client.Api.PaymentApi.

ApiResponse<PaymentResponse> Orbipay.PaymentsApi.Client.Api.IPaymentApi.CreatePaymentWithHttpInfo	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_CUSTOMER,
		CreatePaymentRequest	createPaymentRequest,
		string	requestor = `null`,
		string	xOPAYHeaders = `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.ApiException Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
createPaymentRequest	JSON containing all the fields required to make a payment.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)

Returns: ApiResponse of PaymentResponse

Implemented in Orbipay.PaymentsApi.Client.Api.PaymentApi.

ApiResponse<DeleteResponse> Orbipay.PaymentsApi.Client.Api.IPaymentApi.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`
	)

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.ApiException Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
ID_PAYMENT	The unique identifier assigned by EBPP to the payment.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
deletePaymentRequest	Details of payment to be deleted/cancelled
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)

Returns: ApiResponse<DeleteResponse>

Implemented in Orbipay.PaymentsApi.Client.Api.PaymentApi.

System.Threading.Tasks.Task<DeleteResponse> Orbipay.PaymentsApi.Client.Api.IPaymentApi.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`
	)

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.ApiException Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
ID_PAYMENT	The unique identifier assigned by EBPP to the payment.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
deletePaymentRequest	Details of payment to be deleted/cancelled
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)

Returns: Task of DeleteResponse

Implemented in Orbipay.PaymentsApi.Client.Api.PaymentApi.

System.Threading.Tasks.Task<ApiResponse<DeleteResponse> > Orbipay.PaymentsApi.Client.Api.IPaymentApi.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`
	)

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.ApiException Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
ID_PAYMENT	The unique identifier assigned by EBPP to the payment.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
deletePaymentRequest	Details of payment to be deleted/cancelled
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)

Returns: Task of ApiResponse (DeleteResponse)

Implemented in Orbipay.PaymentsApi.Client.Api.PaymentApi.

ApiResponse<DeleteResponse> Orbipay.PaymentsApi.Client.Api.IPaymentApi.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`
	)

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.ApiException Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
ID_PAYMENT	The unique identifier assigned by EBPP to the payment.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
deletePaymentRequest	Details of payment to be deleted/cancelled
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)

Returns: ApiResponse of DeleteResponse

Implemented in Orbipay.PaymentsApi.Client.Api.PaymentApi.

ApiResponse<PaymentResponse> Orbipay.PaymentsApi.Client.Api.IPaymentApi.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`
	)

Get Payment

The API is used to retrieve the details of a payment by id.

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
ID_PAYMENT	The unique identifier assigned by EBPP to the payment.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)

Returns: ApiResponse<PaymentResponse>

Implemented in Orbipay.PaymentsApi.Client.Api.PaymentApi.

System.Threading.Tasks.Task<PaymentResponse> Orbipay.PaymentsApi.Client.Api.IPaymentApi.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`
	)

Get Payment

The API is used to retrieve the details of a payment by id.

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
ID_PAYMENT	The unique identifier assigned by EBPP to the payment.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)

Returns: Task of PaymentResponse

Implemented in Orbipay.PaymentsApi.Client.Api.PaymentApi.

System.Threading.Tasks.Task<ApiResponse<PaymentResponse> > Orbipay.PaymentsApi.Client.Api.IPaymentApi.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`
	)

Get Payment

The API is used to retrieve the details of a payment by id.

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
ID_PAYMENT	The unique identifier assigned by EBPP to the payment.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)

Returns: Task of ApiResponse (PaymentResponse)

Implemented in Orbipay.PaymentsApi.Client.Api.PaymentApi.

ApiResponse<PaymentResponse> Orbipay.PaymentsApi.Client.Api.IPaymentApi.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`
	)

Get Payment

The API is used to retrieve the details of a payment by id.

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
ID_PAYMENT	The unique identifier assigned by EBPP to the payment.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)

Returns: ApiResponse of PaymentResponse

Implemented in Orbipay.PaymentsApi.Client.Api.PaymentApi.

ApiResponse<PaymentResponse> Orbipay.PaymentsApi.Client.Api.IPaymentApi.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`
	)

Get Fee Payment

The API is used to retrieve the details of a fee payment by id.

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by OrbiPay to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
ID_FEE	The unique identifier assigned by OrbiPay to the FeePayment.
ID_CUSTOMER	The unique identifier assigned by OrbiPay to the customer.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)

Returns: ApiResponse<PaymentResponse>

Implemented in Orbipay.PaymentsApi.Client.Api.PaymentApi.

System.Threading.Tasks.Task<PaymentResponse> Orbipay.PaymentsApi.Client.Api.IPaymentApi.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`
	)

Get Fee Payment

The API is used to retrieve the details of a fee payment by id.

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by OrbiPay to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
ID_FEE	The unique identifier assigned by OrbiPay to the FeePayment.
ID_CUSTOMER	The unique identifier assigned by OrbiPay to the customer.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)

Returns: Task of PaymentResponse

Implemented in Orbipay.PaymentsApi.Client.Api.PaymentApi.

System.Threading.Tasks.Task<ApiResponse<PaymentResponse> > Orbipay.PaymentsApi.Client.Api.IPaymentApi.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`
	)

Get Fee Payment

The API is used to retrieve the details of a fee payment by id.

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by OrbiPay to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
ID_FEE	The unique identifier assigned by OrbiPay to the FeePayment.
ID_CUSTOMER	The unique identifier assigned by OrbiPay to the customer.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)

Returns: Task of ApiResponse (PaymentResponse)

Implemented in Orbipay.PaymentsApi.Client.Api.PaymentApi.

ApiResponse<PaymentResponse> Orbipay.PaymentsApi.Client.Api.IPaymentApi.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`
	)

Get Fee Payment

The API is used to retrieve the details of a fee payment by id.

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by OrbiPay to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
ID_FEE	The unique identifier assigned by OrbiPay to the FeePayment.
ID_CUSTOMER	The unique identifier assigned by OrbiPay to the customer.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)

Returns: ApiResponse of PaymentResponse

Implemented in Orbipay.PaymentsApi.Client.Api.PaymentApi.

ApiResponse<PaymentsResponse> Orbipay.PaymentsApi.Client.Api.IPaymentApi.RetrievePayments	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	requestor = `null`,
		string	xOPAYHeaders = `null`,
		string	idCustomer = `null`,
		string	idFundingAccount = `null`,
		string	idCustomerAccount = `null`,
		string	confirmationNumber = `null`,
		List< string >	status = `null`,
		List< string >	paymentScheduleType = `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 made by a customer. Payments can be filtered using the confirmation number, customer account, funding account, status and payment schedule type, 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.

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)
idCustomer	The unique identifier assigned by EBPP to the customer. (optional)
idFundingAccount	The unique identifier assigned by EBPP to the funding account (optional)
idCustomerAccount	The unique identifier assigned by EBPP to the customer account (optional)
confirmationNumber	The confirmation number or reference provided to the customer for the successful payment. (optional)
status	The status of the payment. This can take multiple values in the format key=value1&key=value2.... (optional)
paymentScheduleType	The schedule type for the payment setup. This can take multiple values in the format key=value1&key=value2.... (optional)
fromDate	The date from which payments, matching the criteria specified, need to be retrieved. (optional)
toDate	The date upto which payments, matching the criteria specified, need to be retrieved. (optional)
pageSize	The maximum number of objects returned in the query. (optional)
queryId	query id of the Retrieve/Search Customers lookup. (optional)
fromIndex	To fetch the next set of objects that start after this object (optional)
toIndex	To fetch the previous set of objects that end at this object (optional)

Returns: ApiResponse<PaymentsResponse>

Implemented in Orbipay.PaymentsApi.Client.Api.PaymentApi.

System.Threading.Tasks.Task<PaymentsResponse> Orbipay.PaymentsApi.Client.Api.IPaymentApi.RetrievePaymentsAsync	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	requestor = `null`,
		string	xOPAYHeaders = `null`,
		string	idCustomer = `null`,
		string	idFundingAccount = `null`,
		string	idCustomerAccount = `null`,
		string	confirmationNumber = `null`,
		List< string >	status = `null`,
		List< string >	paymentScheduleType = `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 made by a customer. Payments can be filtered using the confirmation number, customer account, funding account, status and payment schedule type, 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.

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)
idCustomer	The unique identifier assigned by EBPP to the customer. (optional)
idFundingAccount	The unique identifier assigned by EBPP to the funding account (optional)
idCustomerAccount	The unique identifier assigned by EBPP to the customer account (optional)
confirmationNumber	The confirmation number or reference provided to the customer for the successful payment. (optional)
status	The status of the payment. This can take multiple values in the format key=value1&key=value2.... (optional)
paymentScheduleType	The schedule type for the payment setup. This can take multiple values in the format key=value1&key=value2.... (optional)
fromDate	The date from which payments, matching the criteria specified, need to be retrieved. (optional)
toDate	The date upto which payments, matching the criteria specified, need to be retrieved. (optional)
pageSize	The maximum number of objects returned in the query. (optional)
queryId	query id of the Retrieve/Search Customers lookup. (optional)
fromIndex	To fetch the next set of objects that start after this object (optional)
toIndex	To fetch the previous set of objects that end at this object (optional)

Returns: Task of PaymentsResponse

Implemented in Orbipay.PaymentsApi.Client.Api.PaymentApi.

System.Threading.Tasks.Task<ApiResponse<PaymentsResponse> > Orbipay.PaymentsApi.Client.Api.IPaymentApi.RetrievePaymentsAsyncWithHttpInfo	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	requestor = `null`,
		string	xOPAYHeaders = `null`,
		string	idCustomer = `null`,
		string	idFundingAccount = `null`,
		string	idCustomerAccount = `null`,
		string	confirmationNumber = `null`,
		List< string >	status = `null`,
		List< string >	paymentScheduleType = `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 made by a customer. Payments can be filtered using the confirmation number, customer account, funding account, status and payment schedule type, 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.

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)
idCustomer	The unique identifier assigned by EBPP to the customer. (optional)
idFundingAccount	The unique identifier assigned by EBPP to the funding account (optional)
idCustomerAccount	The unique identifier assigned by EBPP to the customer account (optional)
confirmationNumber	The confirmation number or reference provided to the customer for the successful payment. (optional)
status	The status of the payment. This can take multiple values in the format key=value1&key=value2.... (optional)
paymentScheduleType	The schedule type for the payment setup. This can take multiple values in the format key=value1&key=value2.... (optional)
fromDate	The date from which payments, matching the criteria specified, need to be retrieved. (optional)
toDate	The date upto which payments, matching the criteria specified, need to be retrieved. (optional)
pageSize	The maximum number of objects returned in the query. (optional)
queryId	query id of the Retrieve/Search Customers lookup. (optional)
fromIndex	To fetch the next set of objects that start after this object (optional)
toIndex	To fetch the previous set of objects that end at this object (optional)

Returns: Task of ApiResponse (PaymentsResponse)

Implemented in Orbipay.PaymentsApi.Client.Api.PaymentApi.

ApiResponse<PaymentsResponse> Orbipay.PaymentsApi.Client.Api.IPaymentApi.RetrievePaymentsWithHttpInfo	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	requestor = `null`,
		string	xOPAYHeaders = `null`,
		string	idCustomer = `null`,
		string	idFundingAccount = `null`,
		string	idCustomerAccount = `null`,
		string	confirmationNumber = `null`,
		List< string >	status = `null`,
		List< string >	paymentScheduleType = `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 made by a customer. Payments can be filtered using the confirmation number, customer account, funding account, status and payment schedule type, 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.

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)
idCustomer	The unique identifier assigned by EBPP to the customer. (optional)
idFundingAccount	The unique identifier assigned by EBPP to the funding account (optional)
idCustomerAccount	The unique identifier assigned by EBPP to the customer account (optional)
confirmationNumber	The confirmation number or reference provided to the customer for the successful payment. (optional)
status	The status of the payment. This can take multiple values in the format key=value1&key=value2.... (optional)
paymentScheduleType	The schedule type for the payment setup. This can take multiple values in the format key=value1&key=value2.... (optional)
fromDate	The date from which payments, matching the criteria specified, need to be retrieved. (optional)
toDate	The date upto which payments, matching the criteria specified, need to be retrieved. (optional)
pageSize	The maximum number of objects returned in the query. (optional)
queryId	query id of the Retrieve/Search Customers lookup. (optional)
fromIndex	To fetch the next set of objects that start after this object (optional)
toIndex	To fetch the previous set of objects that end at this object (optional)

Returns: ApiResponse of PaymentsResponse

Implemented in Orbipay.PaymentsApi.Client.Api.PaymentApi.

ApiResponse<SimplePaymentResponse> Orbipay.PaymentsApi.Client.Api.IPaymentApi.SimplePayment	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		SimplePaymentRequest	simplePaymentRequest,
		string	requestor = `null`,
		string	xOPAYHeaders = `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.ApiException Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
simplePaymentRequest	JSON containing all the fields required to make a payment.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)
saveFundingAccount	query param (optional)

Returns: ApiResponse<SimplePaymentResponse>

Implemented in Orbipay.PaymentsApi.Client.Api.PaymentApi.

System.Threading.Tasks.Task<SimplePaymentResponse> Orbipay.PaymentsApi.Client.Api.IPaymentApi.SimplePaymentAsync	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		SimplePaymentRequest	simplePaymentRequest,
		string	requestor = `null`,
		string	xOPAYHeaders = `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.ApiException Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
simplePaymentRequest	JSON containing all the fields required to make a payment.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)
saveFundingAccount	query param (optional)

Returns: Task of SimplePaymentResponse

Implemented in Orbipay.PaymentsApi.Client.Api.PaymentApi.

System.Threading.Tasks.Task<ApiResponse<SimplePaymentResponse> > Orbipay.PaymentsApi.Client.Api.IPaymentApi.SimplePaymentAsyncWithHttpInfo	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		SimplePaymentRequest	simplePaymentRequest,
		string	requestor = `null`,
		string	xOPAYHeaders = `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.ApiException Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
simplePaymentRequest	JSON containing all the fields required to make a payment.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)
saveFundingAccount	query param (optional)

Returns: Task of ApiResponse (SimplePaymentResponse)

Implemented in Orbipay.PaymentsApi.Client.Api.PaymentApi.

ApiResponse<SimplePaymentResponse> Orbipay.PaymentsApi.Client.Api.IPaymentApi.SimplePaymentWithHttpInfo	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		SimplePaymentRequest	simplePaymentRequest,
		string	requestor = `null`,
		string	xOPAYHeaders = `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.ApiException Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
simplePaymentRequest	JSON containing all the fields required to make a payment.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)
saveFundingAccount	query param (optional)

Returns: ApiResponse of SimplePaymentResponse

Implemented in Orbipay.PaymentsApi.Client.Api.PaymentApi.

ApiResponse<PaymentResponse> Orbipay.PaymentsApi.Client.Api.IPaymentApi.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`
	)

Update Payment

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

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
ID_PAYMENT	The unique identifier assigned by EBPP to the payment.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
updatePaymentRequest	Details of the Payment to be updated.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)

Returns: ApiResponse<PaymentResponse>

Implemented in Orbipay.PaymentsApi.Client.Api.PaymentApi.

System.Threading.Tasks.Task<PaymentResponse> Orbipay.PaymentsApi.Client.Api.IPaymentApi.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`
	)

Update Payment

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

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
ID_PAYMENT	The unique identifier assigned by EBPP to the payment.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
updatePaymentRequest	Details of the Payment to be updated.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)

Returns: Task of PaymentResponse

Implemented in Orbipay.PaymentsApi.Client.Api.PaymentApi.

System.Threading.Tasks.Task<ApiResponse<PaymentResponse> > Orbipay.PaymentsApi.Client.Api.IPaymentApi.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`
	)

Update Payment

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

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
ID_PAYMENT	The unique identifier assigned by EBPP to the payment.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
updatePaymentRequest	Details of the Payment to be updated.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)

Returns: Task of ApiResponse (PaymentResponse)

Implemented in Orbipay.PaymentsApi.Client.Api.PaymentApi.

ApiResponse<PaymentResponse> Orbipay.PaymentsApi.Client.Api.IPaymentApi.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`
	)

Update Payment

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

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
ID_PAYMENT	The unique identifier assigned by EBPP to the payment.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
updatePaymentRequest	Details of the Payment to be updated.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)

Returns: ApiResponse of PaymentResponse

Implemented in Orbipay.PaymentsApi.Client.Api.PaymentApi.

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

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

Public Member Functions

Additional Inherited Members

Detailed Description

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

Member Function Documentation