Orbipay.PaymentsApi.Client.Api.IPaymentApi Interface Reference

More...

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, string traceId=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, string traceId=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, string traceId=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, string traceId=null)
	Delete Payment 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 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 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, string traceId=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, string traceId=null)
	Get Payment 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 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 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 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 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, string traceId=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, string traceId=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 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 More...
ApiResponse< PaymentsResponse >	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 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 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 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 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 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, string traceId=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, string traceId=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, string traceId=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, string traceId=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, string traceId=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, string traceId=null)
	Delete Payment More...
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 More...
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 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, string traceId=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, string traceId=null)
	Get Payment More...
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 More...
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 More...
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 More...
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 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, string traceId=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, string traceId=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 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 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 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 More...
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 More...
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 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 traceId=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 traceId=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, string traceId=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, string traceId=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,
		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.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)
traceId	The unique reference that can be used for tracing and debugging an API call. (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,
		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.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)
traceId	The unique reference that can be used for tracing and debugging an API call. (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,
		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.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)
traceId	The unique reference that can be used for tracing and debugging an API call. (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,
		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.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)
traceId	The unique reference that can be used for tracing and debugging an API call. (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,
		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.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)
traceId	The unique reference that can be used for tracing and debugging an API call. (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,
		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.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)
traceId	The unique reference that can be used for tracing and debugging an API call. (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,
		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.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)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)

Returns

Task of ApiResponse (DeleteResponse)

Implemented in Orbipay.PaymentsApi.Client.Api.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,
		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.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)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)

Returns

ApiResponse of DeleteResponse

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

ApiResponse<Object> Orbipay.PaymentsApi.Client.Api.IPaymentApi.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.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.
deleteRecordedPaymentRequest	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)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)

Returns

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

System.Threading.Tasks.Task Orbipay.PaymentsApi.Client.Api.IPaymentApi.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.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.
deleteRecordedPaymentRequest	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)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)

Returns

Task of void

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

System.Threading.Tasks.Task<ApiResponse<Object> > Orbipay.PaymentsApi.Client.Api.IPaymentApi.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.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.
deleteRecordedPaymentRequest	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)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)

Returns

Task of ApiResponse

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

ApiResponse<Object> Orbipay.PaymentsApi.Client.Api.IPaymentApi.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.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.
deleteRecordedPaymentRequest	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)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)

Returns

ApiResponse of Object(void)

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,
		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.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)
traceId	The unique reference that can be used for tracing and debugging an API call. (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,
		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.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)
traceId	The unique reference that can be used for tracing and debugging an API call. (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,
		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.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)
traceId	The unique reference that can be used for tracing and debugging an API call. (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,
		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.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)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)

Returns

ApiResponse of PaymentResponse

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

ApiResponse<GetRecordedPaymentResponse> Orbipay.PaymentsApi.Client.Api.IPaymentApi.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.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.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)

Returns

ApiResponse<GetRecordedPaymentResponse>

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

System.Threading.Tasks.Task<GetRecordedPaymentResponse> Orbipay.PaymentsApi.Client.Api.IPaymentApi.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.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.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)

Returns

Task of GetRecordedPaymentResponse

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

System.Threading.Tasks.Task<ApiResponse<GetRecordedPaymentResponse> > Orbipay.PaymentsApi.Client.Api.IPaymentApi.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.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.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)

Returns

Task of ApiResponse (GetRecordedPaymentResponse)

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

ApiResponse<GetRecordedPaymentResponse> Orbipay.PaymentsApi.Client.Api.IPaymentApi.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.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.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)

Returns

ApiResponse of GetRecordedPaymentResponse

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

ApiResponse<RecordedPaymentResponse> Orbipay.PaymentsApi.Client.Api.IPaymentApi.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.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.
recordPaymentRequest	JSON containing all the fields required to record 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)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)

Returns

ApiResponse<RecordedPaymentResponse>

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

System.Threading.Tasks.Task<RecordedPaymentResponse> Orbipay.PaymentsApi.Client.Api.IPaymentApi.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.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.
recordPaymentRequest	JSON containing all the fields required to record 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)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)

Returns

Task of RecordedPaymentResponse

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

System.Threading.Tasks.Task<ApiResponse<RecordedPaymentResponse> > Orbipay.PaymentsApi.Client.Api.IPaymentApi.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.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.
recordPaymentRequest	JSON containing all the fields required to record 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)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)

Returns

Task of ApiResponse (RecordedPaymentResponse)

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

ApiResponse<RecordedPaymentResponse> Orbipay.PaymentsApi.Client.Api.IPaymentApi.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.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.
recordPaymentRequest	JSON containing all the fields required to record 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)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)

Returns

ApiResponse of RecordedPaymentResponse

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,
		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.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)
traceId	The unique reference that can be used for tracing and debugging an API call. (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,
		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.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)
traceId	The unique reference that can be used for tracing and debugging an API call. (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,
		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.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)
traceId	The unique reference that can be used for tracing and debugging an API call. (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,
		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.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)
traceId	The unique reference that can be used for tracing and debugging an API call. (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	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.ApiException

Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)
idCustomer	The unique identifier assigned by EBPP to the customer. (optional)
idFundingAccount	The unique identifier assigned by EBPP to the funding account (optional)
idCustomerAccount	The unique identifier assigned by EBPP to the customer account (optional)
confirmationNumber	The confirmation number or reference provided to the customer for the successful payment. (optional)
status	The status of the payment. This can take multiple values in the format key&#x3D;value1&key&#x3D;value2.... (optional)
paymentScheduleType	The schedule type for the payment setup. This can take multiple values in the format key&#x3D;value1&key&#x3D;value2.... (optional)
paymentMethod	The fulfillment method for the payment. (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	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.ApiException

Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)
idCustomer	The unique identifier assigned by EBPP to the customer. (optional)
idFundingAccount	The unique identifier assigned by EBPP to the funding account (optional)
idCustomerAccount	The unique identifier assigned by EBPP to the customer account (optional)
confirmationNumber	The confirmation number or reference provided to the customer for the successful payment. (optional)
status	The status of the payment. This can take multiple values in the format key&#x3D;value1&key&#x3D;value2.... (optional)
paymentScheduleType	The schedule type for the payment setup. This can take multiple values in the format key&#x3D;value1&key&#x3D;value2.... (optional)
paymentMethod	The fulfillment method for the payment. (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	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.ApiException

Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)
idCustomer	The unique identifier assigned by EBPP to the customer. (optional)
idFundingAccount	The unique identifier assigned by EBPP to the funding account (optional)
idCustomerAccount	The unique identifier assigned by EBPP to the customer account (optional)
confirmationNumber	The confirmation number or reference provided to the customer for the successful payment. (optional)
status	The status of the payment. This can take multiple values in the format key&#x3D;value1&key&#x3D;value2.... (optional)
paymentScheduleType	The schedule type for the payment setup. This can take multiple values in the format key&#x3D;value1&key&#x3D;value2.... (optional)
paymentMethod	The fulfillment method for the payment. (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	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.ApiException

Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)
idCustomer	The unique identifier assigned by EBPP to the customer. (optional)
idFundingAccount	The unique identifier assigned by EBPP to the funding account (optional)
idCustomerAccount	The unique identifier assigned by EBPP to the customer account (optional)
confirmationNumber	The confirmation number or reference provided to the customer for the successful payment. (optional)
status	The status of the payment. This can take multiple values in the format key&#x3D;value1&key&#x3D;value2.... (optional)
paymentScheduleType	The schedule type for the payment setup. This can take multiple values in the format key&#x3D;value1&key&#x3D;value2.... (optional)
paymentMethod	The fulfillment method for the payment. (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<RecordedPaymentsResponse> Orbipay.PaymentsApi.Client.Api.IPaymentApi.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.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.
idCustomer	The unique identifier assigned by EBPP to the customer.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)
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)
paymentMethod	The non fulfillment method for the payment. This can take multiple values in the format key&#x3D;value1&key&#x3D;value2.... (optional)
status	The status of the payment. This can take multiple values in the format key&#x3D;value1&key&#x3D;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 Payments 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<RecordedPaymentsResponse>

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

System.Threading.Tasks.Task<RecordedPaymentsResponse> Orbipay.PaymentsApi.Client.Api.IPaymentApi.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.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.
idCustomer	The unique identifier assigned by EBPP to the customer.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)
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)
paymentMethod	The non fulfillment method for the payment. This can take multiple values in the format key&#x3D;value1&key&#x3D;value2.... (optional)
status	The status of the payment. This can take multiple values in the format key&#x3D;value1&key&#x3D;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 Payments 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 RecordedPaymentsResponse

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

System.Threading.Tasks.Task<ApiResponse<RecordedPaymentsResponse> > Orbipay.PaymentsApi.Client.Api.IPaymentApi.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.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.
idCustomer	The unique identifier assigned by EBPP to the customer.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)
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)
paymentMethod	The non fulfillment method for the payment. This can take multiple values in the format key&#x3D;value1&key&#x3D;value2.... (optional)
status	The status of the payment. This can take multiple values in the format key&#x3D;value1&key&#x3D;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 Payments 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 (RecordedPaymentsResponse)

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

ApiResponse<RecordedPaymentsResponse> Orbipay.PaymentsApi.Client.Api.IPaymentApi.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.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.
idCustomer	The unique identifier assigned by EBPP to the customer.
requestor	The identifier for the requestor of the API. If the requestor_type is <b>system</b>, requestor is optional. (optional)
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)
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)
paymentMethod	The non fulfillment method for the payment. This can take multiple values in the format key&#x3D;value1&key&#x3D;value2.... (optional)
status	The status of the payment. This can take multiple values in the format key&#x3D;value1&key&#x3D;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 Payments 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 RecordedPaymentsResponse

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	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.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)
traceId	The unique reference that can be used for tracing and debugging an API call. (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	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.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)
traceId	The unique reference that can be used for tracing and debugging an API call. (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	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.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)
traceId	The unique reference that can be used for tracing and debugging an API call. (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	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.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)
traceId	The unique reference that can be used for tracing and debugging an API call. (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,
		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.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)
traceId	The unique reference that can be used for tracing and debugging an API call. (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,
		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.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)
traceId	The unique reference that can be used for tracing and debugging an API call. (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,
		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.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)
traceId	The unique reference that can be used for tracing and debugging an API call. (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,
		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.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)
traceId	The unique reference that can be used for tracing and debugging an API call. (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