Orbipay.PaymentsApi.Client.Api.IFundingAccountApi Interface Reference

More...

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

Public Member Functions
ApiResponse < FundingAccountResponse >	AddFundingAccount (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_CUSTOMER, AddFundingAccountRequest addFundingAccountRequest, string requestor=null, string xOPAYHeaders=null, string traceId=null)
	Add Funding Account More...
ApiResponse < FundingAccountResponse >	AddFundingAccountWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_CUSTOMER, AddFundingAccountRequest addFundingAccountRequest, string requestor=null, string xOPAYHeaders=null, string traceId=null)
	Add Funding Account More...
ApiResponse< DeleteResponse >	DeleteFundingAccount (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_FUNDING_ACCOUNT, string ID_CUSTOMER, DeleteFundingAccountRequest deleteFundingAccountRequest, string requestor=null, string xOPAYHeaders=null, string traceId=null)
	Delete Funding Account More...
ApiResponse< DeleteResponse >	DeleteFundingAccountWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_FUNDING_ACCOUNT, string ID_CUSTOMER, DeleteFundingAccountRequest deleteFundingAccountRequest, string requestor=null, string xOPAYHeaders=null, string traceId=null)
	Delete Funding Account More...
ApiResponse < FundingAccountResponse >	GetFundingAccount (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_FUNDING_ACCOUNT, string ID_CUSTOMER, string requestor=null, string xOPAYHeaders=null, string traceId=null)
	Get Funding Account More...
ApiResponse < FundingAccountResponse >	GetFundingAccountWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_FUNDING_ACCOUNT, string ID_CUSTOMER, string requestor=null, string xOPAYHeaders=null, string traceId=null)
	Get Funding Account More...
ApiResponse < FundingAccountResponse >	ReplaceFundingAccount (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_FUNDING_ACCOUNT, string ID_CUSTOMER, ReplaceFundingAccountRequest replaceFundingAccountRequest, string requestor=null, string xOPAYHeaders=null, string traceId=null)
	Replace Funding Account More...
ApiResponse < FundingAccountResponse >	ReplaceFundingAccountWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_FUNDING_ACCOUNT, string ID_CUSTOMER, ReplaceFundingAccountRequest replaceFundingAccountRequest, string requestor=null, string xOPAYHeaders=null, string traceId=null)
	Replace Funding Account More...
ApiResponse < FundingAccountsResponse >	RetrieveFundingAccounts (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_CUSTOMER, string requestor=null, string xOPAYHeaders=null, string traceId=null, string pageSize=null, string accountNumber=null, List< string > status=null, string abaRoutingNumber=null, List< string > accountType=null, string accountSubtype=null)
	Retrieve Funding Accounts More...
ApiResponse < FundingAccountsResponse >	RetrieveFundingAccountsWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_CUSTOMER, string requestor=null, string xOPAYHeaders=null, string traceId=null, string pageSize=null, string accountNumber=null, List< string > status=null, string abaRoutingNumber=null, List< string > accountType=null, string accountSubtype=null)
	Retrieve Funding Accounts More...
ApiResponse < FundingAccountsResponse >	RetrieveFundingAccountsPage (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_CUSTOMER, string queryId, string requestor=null, string xOPAYHeaders=null, string traceId=null, string pageSize=null, string fromIndex=null, string toIndex=null)
	Retrieve Funding Accounts Pagination More...
ApiResponse < FundingAccountsResponse >	RetrieveFundingAccountsPageWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_CUSTOMER, string queryId, string requestor=null, string xOPAYHeaders=null, string traceId=null, string pageSize=null, string fromIndex=null, string toIndex=null)
	Retrieve Funding Accounts Pagination More...
ApiResponse < FundingAccountResponse >	UpdateFundingAccount (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_FUNDING_ACCOUNT, string ID_CUSTOMER, UpdateFundingAccountRequest updateFundingAccountRequest, string requestor=null, string xOPAYHeaders=null, string traceId=null)
	Update Funding Account More...
ApiResponse < FundingAccountResponse >	UpdateFundingAccountWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_FUNDING_ACCOUNT, string ID_CUSTOMER, UpdateFundingAccountRequest updateFundingAccountRequest, string requestor=null, string xOPAYHeaders=null, string traceId=null)
	Update Funding Account More...
System.Threading.Tasks.Task < FundingAccountResponse >	AddFundingAccountAsync (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_CUSTOMER, AddFundingAccountRequest addFundingAccountRequest, string requestor=null, string xOPAYHeaders=null, string traceId=null)
	Add Funding Account More...
System.Threading.Tasks.Task < ApiResponse < FundingAccountResponse > >	AddFundingAccountAsyncWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_CUSTOMER, AddFundingAccountRequest addFundingAccountRequest, string requestor=null, string xOPAYHeaders=null, string traceId=null)
	Add Funding Account More...
System.Threading.Tasks.Task < DeleteResponse >	DeleteFundingAccountAsync (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_FUNDING_ACCOUNT, string ID_CUSTOMER, DeleteFundingAccountRequest deleteFundingAccountRequest, string requestor=null, string xOPAYHeaders=null, string traceId=null)
	Delete Funding Account More...
System.Threading.Tasks.Task < ApiResponse< DeleteResponse > >	DeleteFundingAccountAsyncWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_FUNDING_ACCOUNT, string ID_CUSTOMER, DeleteFundingAccountRequest deleteFundingAccountRequest, string requestor=null, string xOPAYHeaders=null, string traceId=null)
	Delete Funding Account More...
System.Threading.Tasks.Task < FundingAccountResponse >	GetFundingAccountAsync (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_FUNDING_ACCOUNT, string ID_CUSTOMER, string requestor=null, string xOPAYHeaders=null, string traceId=null)
	Get Funding Account More...
System.Threading.Tasks.Task < ApiResponse < FundingAccountResponse > >	GetFundingAccountAsyncWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_FUNDING_ACCOUNT, string ID_CUSTOMER, string requestor=null, string xOPAYHeaders=null, string traceId=null)
	Get Funding Account More...
System.Threading.Tasks.Task < FundingAccountResponse >	ReplaceFundingAccountAsync (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_FUNDING_ACCOUNT, string ID_CUSTOMER, ReplaceFundingAccountRequest replaceFundingAccountRequest, string requestor=null, string xOPAYHeaders=null, string traceId=null)
	Replace Funding Account More...
System.Threading.Tasks.Task < ApiResponse < FundingAccountResponse > >	ReplaceFundingAccountAsyncWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_FUNDING_ACCOUNT, string ID_CUSTOMER, ReplaceFundingAccountRequest replaceFundingAccountRequest, string requestor=null, string xOPAYHeaders=null, string traceId=null)
	Replace Funding Account More...
System.Threading.Tasks.Task < FundingAccountsResponse >	RetrieveFundingAccountsAsync (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_CUSTOMER, string requestor=null, string xOPAYHeaders=null, string traceId=null, string pageSize=null, string accountNumber=null, List< string > status=null, string abaRoutingNumber=null, List< string > accountType=null, string accountSubtype=null)
	Retrieve Funding Accounts More...
System.Threading.Tasks.Task < ApiResponse < FundingAccountsResponse > >	RetrieveFundingAccountsAsyncWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_CUSTOMER, string requestor=null, string xOPAYHeaders=null, string traceId=null, string pageSize=null, string accountNumber=null, List< string > status=null, string abaRoutingNumber=null, List< string > accountType=null, string accountSubtype=null)
	Retrieve Funding Accounts More...
System.Threading.Tasks.Task < FundingAccountsResponse >	RetrieveFundingAccountsPageAsync (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_CUSTOMER, string queryId, string requestor=null, string xOPAYHeaders=null, string traceId=null, string pageSize=null, string fromIndex=null, string toIndex=null)
	Retrieve Funding Accounts Pagination More...
System.Threading.Tasks.Task < ApiResponse < FundingAccountsResponse > >	RetrieveFundingAccountsPageAsyncWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_CUSTOMER, string queryId, string requestor=null, string xOPAYHeaders=null, string traceId=null, string pageSize=null, string fromIndex=null, string toIndex=null)
	Retrieve Funding Accounts Pagination More...
System.Threading.Tasks.Task < FundingAccountResponse >	UpdateFundingAccountAsync (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_FUNDING_ACCOUNT, string ID_CUSTOMER, UpdateFundingAccountRequest updateFundingAccountRequest, string requestor=null, string xOPAYHeaders=null, string traceId=null)
	Update Funding Account More...
System.Threading.Tasks.Task < ApiResponse < FundingAccountResponse > >	UpdateFundingAccountAsyncWithHttpInfo (string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_FUNDING_ACCOUNT, string ID_CUSTOMER, UpdateFundingAccountRequest updateFundingAccountRequest, string requestor=null, string xOPAYHeaders=null, string traceId=null)
	Update Funding Account 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<FundingAccountResponse> Orbipay.PaymentsApi.Client.Api.IFundingAccountApi.AddFundingAccount	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_CUSTOMER,
		AddFundingAccountRequest	addFundingAccountRequest,
		string	requestor = null,
		string	xOPAYHeaders = null,
		string	traceId = null
	)

Add Funding Account

This API is used to add a funding account for the customer. The funding account is available for servicing all the customer accounts the customer holds. An exhaustive set of account types are supported as funding accounts as indicated in the field account_subtype. ABA routing number and account sub-type are mandatory for bank accounts. Expiry date, address fields and Card CVV are required for card accounts.

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.
addFundingAccountRequest	JSON containing all the attributes of the Funding account to be added to customer.
requestor	The identifier for the requestor of the API. (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<FundingAccountResponse>

Implemented in Orbipay.PaymentsApi.Client.Api.FundingAccountApi.

System.Threading.Tasks.Task<FundingAccountResponse> Orbipay.PaymentsApi.Client.Api.IFundingAccountApi.AddFundingAccountAsync	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_CUSTOMER,
		AddFundingAccountRequest	addFundingAccountRequest,
		string	requestor = null,
		string	xOPAYHeaders = null,
		string	traceId = null
	)

Add Funding Account

This API is used to add a funding account for the customer. The funding account is available for servicing all the customer accounts the customer holds. An exhaustive set of account types are supported as funding accounts as indicated in the field account_subtype. ABA routing number and account sub-type are mandatory for bank accounts. Expiry date, address fields and Card CVV are required for card accounts.

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.
addFundingAccountRequest	JSON containing all the attributes of the Funding account to be added to customer.
requestor	The identifier for the requestor of the API. (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 FundingAccountResponse

Implemented in Orbipay.PaymentsApi.Client.Api.FundingAccountApi.

System.Threading.Tasks.Task<ApiResponse<FundingAccountResponse> > Orbipay.PaymentsApi.Client.Api.IFundingAccountApi.AddFundingAccountAsyncWithHttpInfo	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_CUSTOMER,
		AddFundingAccountRequest	addFundingAccountRequest,
		string	requestor = null,
		string	xOPAYHeaders = null,
		string	traceId = null
	)

Add Funding Account

This API is used to add a funding account for the customer. The funding account is available for servicing all the customer accounts the customer holds. An exhaustive set of account types are supported as funding accounts as indicated in the field account_subtype. ABA routing number and account sub-type are mandatory for bank accounts. Expiry date, address fields and Card CVV are required for card accounts.

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.
addFundingAccountRequest	JSON containing all the attributes of the Funding account to be added to customer.
requestor	The identifier for the requestor of the API. (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 (FundingAccountResponse)

Implemented in Orbipay.PaymentsApi.Client.Api.FundingAccountApi.

ApiResponse<FundingAccountResponse> Orbipay.PaymentsApi.Client.Api.IFundingAccountApi.AddFundingAccountWithHttpInfo	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_CUSTOMER,
		AddFundingAccountRequest	addFundingAccountRequest,
		string	requestor = null,
		string	xOPAYHeaders = null,
		string	traceId = null
	)

Add Funding Account

This API is used to add a funding account for the customer. The funding account is available for servicing all the customer accounts the customer holds. An exhaustive set of account types are supported as funding accounts as indicated in the field account_subtype. ABA routing number and account sub-type are mandatory for bank accounts. Expiry date, address fields and Card CVV are required for card accounts.

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.
addFundingAccountRequest	JSON containing all the attributes of the Funding account to be added to customer.
requestor	The identifier for the requestor of the API. (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 FundingAccountResponse

Implemented in Orbipay.PaymentsApi.Client.Api.FundingAccountApi.

ApiResponse<DeleteResponse> Orbipay.PaymentsApi.Client.Api.IFundingAccountApi.DeleteFundingAccount	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_FUNDING_ACCOUNT,
		string	ID_CUSTOMER,
		DeleteFundingAccountRequest	deleteFundingAccountRequest,
		string	requestor = null,
		string	xOPAYHeaders = null,
		string	traceId = null
	)

Delete Funding Account

The Delete Funding Account API is used to delete the funding account of a customer. All pending payments made with that account are cancelled upon deletion of the funding account.

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException

Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
ID_FUNDING_ACCOUNT	The unique identifier assigned by EBPP to the Funding Account.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
deleteFundingAccountRequest	Details of account to be deleted.
requestor	The identifier for the requestor of the API. (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.FundingAccountApi.

System.Threading.Tasks.Task<DeleteResponse> Orbipay.PaymentsApi.Client.Api.IFundingAccountApi.DeleteFundingAccountAsync	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_FUNDING_ACCOUNT,
		string	ID_CUSTOMER,
		DeleteFundingAccountRequest	deleteFundingAccountRequest,
		string	requestor = null,
		string	xOPAYHeaders = null,
		string	traceId = null
	)

Delete Funding Account

The Delete Funding Account API is used to delete the funding account of a customer. All pending payments made with that account are cancelled upon deletion of the funding account.

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException

Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
ID_FUNDING_ACCOUNT	The unique identifier assigned by EBPP to the Funding Account.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
deleteFundingAccountRequest	Details of account to be deleted.
requestor	The identifier for the requestor of the API. (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.FundingAccountApi.

System.Threading.Tasks.Task<ApiResponse<DeleteResponse> > Orbipay.PaymentsApi.Client.Api.IFundingAccountApi.DeleteFundingAccountAsyncWithHttpInfo	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_FUNDING_ACCOUNT,
		string	ID_CUSTOMER,
		DeleteFundingAccountRequest	deleteFundingAccountRequest,
		string	requestor = null,
		string	xOPAYHeaders = null,
		string	traceId = null
	)

Delete Funding Account

The Delete Funding Account API is used to delete the funding account of a customer. All pending payments made with that account are cancelled upon deletion of the funding account.

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException

Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
ID_FUNDING_ACCOUNT	The unique identifier assigned by EBPP to the Funding Account.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
deleteFundingAccountRequest	Details of account to be deleted.
requestor	The identifier for the requestor of the API. (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.FundingAccountApi.

ApiResponse<DeleteResponse> Orbipay.PaymentsApi.Client.Api.IFundingAccountApi.DeleteFundingAccountWithHttpInfo	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_FUNDING_ACCOUNT,
		string	ID_CUSTOMER,
		DeleteFundingAccountRequest	deleteFundingAccountRequest,
		string	requestor = null,
		string	xOPAYHeaders = null,
		string	traceId = null
	)

Delete Funding Account

The Delete Funding Account API is used to delete the funding account of a customer. All pending payments made with that account are cancelled upon deletion of the funding account.

Exceptions

Orbipay.PaymentsApi.Client.Client.ApiException

Thrown when fails to make API call

Parameters

channel	The channel through which the API is invoked.
clientKey	The unique identifier assigned by EBPP to the client.
product	The product identifier corresponding to the API.
timestamp	The timestamp for the moment when the API request is created.
idempotentRequestKey	The unique token that clients can generate and maintain in order to identify an API request.
requestorType	Type of the requestor of the API.
ID_FUNDING_ACCOUNT	The unique identifier assigned by EBPP to the Funding Account.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
deleteFundingAccountRequest	Details of account to be deleted.
requestor	The identifier for the requestor of the API. (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.FundingAccountApi.

ApiResponse<FundingAccountResponse> Orbipay.PaymentsApi.Client.Api.IFundingAccountApi.GetFundingAccount	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_FUNDING_ACCOUNT,
		string	ID_CUSTOMER,
		string	requestor = null,
		string	xOPAYHeaders = null,
		string	traceId = null
	)

Get Funding Account

The Get Funding Account API is used to retrieve the details of the funding account based on the 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_FUNDING_ACCOUNT	The unique identifier assigned by EBPP to the Funding Account.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
requestor	The identifier for the requestor of the API. (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<FundingAccountResponse>

Implemented in Orbipay.PaymentsApi.Client.Api.FundingAccountApi.

System.Threading.Tasks.Task<FundingAccountResponse> Orbipay.PaymentsApi.Client.Api.IFundingAccountApi.GetFundingAccountAsync	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_FUNDING_ACCOUNT,
		string	ID_CUSTOMER,
		string	requestor = null,
		string	xOPAYHeaders = null,
		string	traceId = null
	)

Get Funding Account

The Get Funding Account API is used to retrieve the details of the funding account based on the 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_FUNDING_ACCOUNT	The unique identifier assigned by EBPP to the Funding Account.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
requestor	The identifier for the requestor of the API. (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 FundingAccountResponse

Implemented in Orbipay.PaymentsApi.Client.Api.FundingAccountApi.

System.Threading.Tasks.Task<ApiResponse<FundingAccountResponse> > Orbipay.PaymentsApi.Client.Api.IFundingAccountApi.GetFundingAccountAsyncWithHttpInfo	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_FUNDING_ACCOUNT,
		string	ID_CUSTOMER,
		string	requestor = null,
		string	xOPAYHeaders = null,
		string	traceId = null
	)

Get Funding Account

The Get Funding Account API is used to retrieve the details of the funding account based on the 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_FUNDING_ACCOUNT	The unique identifier assigned by EBPP to the Funding Account.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
requestor	The identifier for the requestor of the API. (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 (FundingAccountResponse)

Implemented in Orbipay.PaymentsApi.Client.Api.FundingAccountApi.

ApiResponse<FundingAccountResponse> Orbipay.PaymentsApi.Client.Api.IFundingAccountApi.GetFundingAccountWithHttpInfo	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_FUNDING_ACCOUNT,
		string	ID_CUSTOMER,
		string	requestor = null,
		string	xOPAYHeaders = null,
		string	traceId = null
	)

Get Funding Account

The Get Funding Account API is used to retrieve the details of the funding account based on the 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_FUNDING_ACCOUNT	The unique identifier assigned by EBPP to the Funding Account.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
requestor	The identifier for the requestor of the API. (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 FundingAccountResponse

Implemented in Orbipay.PaymentsApi.Client.Api.FundingAccountApi.

ApiResponse<FundingAccountResponse> Orbipay.PaymentsApi.Client.Api.IFundingAccountApi.ReplaceFundingAccount	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_FUNDING_ACCOUNT,
		string	ID_CUSTOMER,
		ReplaceFundingAccountRequest	replaceFundingAccountRequest,
		string	requestor = null,
		string	xOPAYHeaders = null,
		string	traceId = null
	)

Replace Funding Account

The API is used to replace the funding account details. The type of the funding account cannot be replaced. In other words, a card account cannot be replaced to a bank account and vice versa. CVV is mandatory to make any change to a card account.Replacing a funding account updates the account information on all pending payments made using that account but does not change the details on payments that have been completed.

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_FUNDING_ACCOUNT	The unique identifier assigned by EBPP to the Funding Account.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
replaceFundingAccountRequest	JSON containing all the attributes of the Funding account to be replaced.
requestor	The identifier for the requestor of the API. (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<FundingAccountResponse>

Implemented in Orbipay.PaymentsApi.Client.Api.FundingAccountApi.

System.Threading.Tasks.Task<FundingAccountResponse> Orbipay.PaymentsApi.Client.Api.IFundingAccountApi.ReplaceFundingAccountAsync	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_FUNDING_ACCOUNT,
		string	ID_CUSTOMER,
		ReplaceFundingAccountRequest	replaceFundingAccountRequest,
		string	requestor = null,
		string	xOPAYHeaders = null,
		string	traceId = null
	)

Replace Funding Account

The API is used to replace the funding account details. The type of the funding account cannot be replaced. In other words, a card account cannot be replaced to a bank account and vice versa. CVV is mandatory to make any change to a card account.Replacing a funding account updates the account information on all pending payments made using that account but does not change the details on payments that have been completed.

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_FUNDING_ACCOUNT	The unique identifier assigned by EBPP to the Funding Account.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
replaceFundingAccountRequest	JSON containing all the attributes of the Funding account to be replaced.
requestor	The identifier for the requestor of the API. (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 FundingAccountResponse

Implemented in Orbipay.PaymentsApi.Client.Api.FundingAccountApi.

System.Threading.Tasks.Task<ApiResponse<FundingAccountResponse> > Orbipay.PaymentsApi.Client.Api.IFundingAccountApi.ReplaceFundingAccountAsyncWithHttpInfo	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_FUNDING_ACCOUNT,
		string	ID_CUSTOMER,
		ReplaceFundingAccountRequest	replaceFundingAccountRequest,
		string	requestor = null,
		string	xOPAYHeaders = null,
		string	traceId = null
	)

Replace Funding Account

The API is used to replace the funding account details. The type of the funding account cannot be replaced. In other words, a card account cannot be replaced to a bank account and vice versa. CVV is mandatory to make any change to a card account.Replacing a funding account updates the account information on all pending payments made using that account but does not change the details on payments that have been completed.

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_FUNDING_ACCOUNT	The unique identifier assigned by EBPP to the Funding Account.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
replaceFundingAccountRequest	JSON containing all the attributes of the Funding account to be replaced.
requestor	The identifier for the requestor of the API. (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 (FundingAccountResponse)

Implemented in Orbipay.PaymentsApi.Client.Api.FundingAccountApi.

ApiResponse<FundingAccountResponse> Orbipay.PaymentsApi.Client.Api.IFundingAccountApi.ReplaceFundingAccountWithHttpInfo	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_FUNDING_ACCOUNT,
		string	ID_CUSTOMER,
		ReplaceFundingAccountRequest	replaceFundingAccountRequest,
		string	requestor = null,
		string	xOPAYHeaders = null,
		string	traceId = null
	)

Replace Funding Account

The API is used to replace the funding account details. The type of the funding account cannot be replaced. In other words, a card account cannot be replaced to a bank account and vice versa. CVV is mandatory to make any change to a card account.Replacing a funding account updates the account information on all pending payments made using that account but does not change the details on payments that have been completed.

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_FUNDING_ACCOUNT	The unique identifier assigned by EBPP to the Funding Account.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
replaceFundingAccountRequest	JSON containing all the attributes of the Funding account to be replaced.
requestor	The identifier for the requestor of the API. (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 FundingAccountResponse

Implemented in Orbipay.PaymentsApi.Client.Api.FundingAccountApi.

ApiResponse<FundingAccountsResponse> Orbipay.PaymentsApi.Client.Api.IFundingAccountApi.RetrieveFundingAccounts	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_CUSTOMER,
		string	requestor = null,
		string	xOPAYHeaders = null,
		string	traceId = null,
		string	pageSize = null,
		string	accountNumber = null,
		List< string >	status = null,
		string	abaRoutingNumber = null,
		List< string >	accountType = null,
		string	accountSubtype = null
	)

Retrieve Funding Accounts

This API is used to retrieve all the funding accounts associated with a customer. Accounts can be filtered using the account number, the ABA routing number (for bank accounts), the account status, account type, account sub-type and others mentioned below. The results are sorted based on their last_modified_time in descending order. The API responds with the first page of the list of funding accounts matching the criteria.

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.
requestor	The identifier for the requestor of the API. (optional)
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)
pageSize	The maximum number of objects returned in the query. (optional)
accountNumber	The Account Number to get details of. (optional)
status	The status of the funding account in EBPP. This can take multiple values in the format key=value1&key=value2.... (optional)
abaRoutingNumber	The ABA/Routing number for the bank account. (optional)
accountType	The type of the funding account. This can take multiple values in the format key=value1&key=value2.... (optional)
accountSubtype	The sub type of the funding account. This is derived by EBPP in the case of card funding accounts. (optional)

Returns

ApiResponse<FundingAccountsResponse>

Implemented in Orbipay.PaymentsApi.Client.Api.FundingAccountApi.

System.Threading.Tasks.Task<FundingAccountsResponse> Orbipay.PaymentsApi.Client.Api.IFundingAccountApi.RetrieveFundingAccountsAsync	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_CUSTOMER,
		string	requestor = null,
		string	xOPAYHeaders = null,
		string	traceId = null,
		string	pageSize = null,
		string	accountNumber = null,
		List< string >	status = null,
		string	abaRoutingNumber = null,
		List< string >	accountType = null,
		string	accountSubtype = null
	)

Retrieve Funding Accounts

This API is used to retrieve all the funding accounts associated with a customer. Accounts can be filtered using the account number, the ABA routing number (for bank accounts), the account status, account type, account sub-type and others mentioned below. The results are sorted based on their last_modified_time in descending order. The API responds with the first page of the list of funding accounts matching the criteria.

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.
requestor	The identifier for the requestor of the API. (optional)
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)
pageSize	The maximum number of objects returned in the query. (optional)
accountNumber	The Account Number to get details of. (optional)
status	The status of the funding account in EBPP. This can take multiple values in the format key=value1&key=value2.... (optional)
abaRoutingNumber	The ABA/Routing number for the bank account. (optional)
accountType	The type of the funding account. This can take multiple values in the format key=value1&key=value2.... (optional)
accountSubtype	The sub type of the funding account. This is derived by EBPP in the case of card funding accounts. (optional)

Returns

Task of FundingAccountsResponse

Implemented in Orbipay.PaymentsApi.Client.Api.FundingAccountApi.

System.Threading.Tasks.Task<ApiResponse<FundingAccountsResponse> > Orbipay.PaymentsApi.Client.Api.IFundingAccountApi.RetrieveFundingAccountsAsyncWithHttpInfo	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_CUSTOMER,
		string	requestor = null,
		string	xOPAYHeaders = null,
		string	traceId = null,
		string	pageSize = null,
		string	accountNumber = null,
		List< string >	status = null,
		string	abaRoutingNumber = null,
		List< string >	accountType = null,
		string	accountSubtype = null
	)

Retrieve Funding Accounts

This API is used to retrieve all the funding accounts associated with a customer. Accounts can be filtered using the account number, the ABA routing number (for bank accounts), the account status, account type, account sub-type and others mentioned below. The results are sorted based on their last_modified_time in descending order. The API responds with the first page of the list of funding accounts matching the criteria.

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.
requestor	The identifier for the requestor of the API. (optional)
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)
pageSize	The maximum number of objects returned in the query. (optional)
accountNumber	The Account Number to get details of. (optional)
status	The status of the funding account in EBPP. This can take multiple values in the format key=value1&key=value2.... (optional)
abaRoutingNumber	The ABA/Routing number for the bank account. (optional)
accountType	The type of the funding account. This can take multiple values in the format key=value1&key=value2.... (optional)
accountSubtype	The sub type of the funding account. This is derived by EBPP in the case of card funding accounts. (optional)

Returns

Task of ApiResponse (FundingAccountsResponse)

Implemented in Orbipay.PaymentsApi.Client.Api.FundingAccountApi.

ApiResponse<FundingAccountsResponse> Orbipay.PaymentsApi.Client.Api.IFundingAccountApi.RetrieveFundingAccountsPage	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_CUSTOMER,
		string	queryId,
		string	requestor = null,
		string	xOPAYHeaders = null,
		string	traceId = null,
		string	pageSize = null,
		string	fromIndex = null,
		string	toIndex = null
	)

Retrieve Funding Accounts Pagination

This API is used to paginate through the list of funding accounts returned in the Retrieve Funding Accounts API.

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.
queryId	query id of the Retrieve/Search Accounts lookup.
requestor	The identifier for the requestor of the API. (optional)
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)
pageSize	The maximum number of objects returned in the query. (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<FundingAccountsResponse>

Implemented in Orbipay.PaymentsApi.Client.Api.FundingAccountApi.

System.Threading.Tasks.Task<FundingAccountsResponse> Orbipay.PaymentsApi.Client.Api.IFundingAccountApi.RetrieveFundingAccountsPageAsync	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_CUSTOMER,
		string	queryId,
		string	requestor = null,
		string	xOPAYHeaders = null,
		string	traceId = null,
		string	pageSize = null,
		string	fromIndex = null,
		string	toIndex = null
	)

Retrieve Funding Accounts Pagination

This API is used to paginate through the list of funding accounts returned in the Retrieve Funding Accounts API.

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.
queryId	query id of the Retrieve/Search Accounts lookup.
requestor	The identifier for the requestor of the API. (optional)
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)
pageSize	The maximum number of objects returned in the query. (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 FundingAccountsResponse

Implemented in Orbipay.PaymentsApi.Client.Api.FundingAccountApi.

System.Threading.Tasks.Task<ApiResponse<FundingAccountsResponse> > Orbipay.PaymentsApi.Client.Api.IFundingAccountApi.RetrieveFundingAccountsPageAsyncWithHttpInfo	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_CUSTOMER,
		string	queryId,
		string	requestor = null,
		string	xOPAYHeaders = null,
		string	traceId = null,
		string	pageSize = null,
		string	fromIndex = null,
		string	toIndex = null
	)

Retrieve Funding Accounts Pagination

This API is used to paginate through the list of funding accounts returned in the Retrieve Funding Accounts API.

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.
queryId	query id of the Retrieve/Search Accounts lookup.
requestor	The identifier for the requestor of the API. (optional)
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)
pageSize	The maximum number of objects returned in the query. (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 (FundingAccountsResponse)

Implemented in Orbipay.PaymentsApi.Client.Api.FundingAccountApi.

ApiResponse<FundingAccountsResponse> Orbipay.PaymentsApi.Client.Api.IFundingAccountApi.RetrieveFundingAccountsPageWithHttpInfo	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_CUSTOMER,
		string	queryId,
		string	requestor = null,
		string	xOPAYHeaders = null,
		string	traceId = null,
		string	pageSize = null,
		string	fromIndex = null,
		string	toIndex = null
	)

Retrieve Funding Accounts Pagination

This API is used to paginate through the list of funding accounts returned in the Retrieve Funding Accounts API.

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.
queryId	query id of the Retrieve/Search Accounts lookup.
requestor	The identifier for the requestor of the API. (optional)
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)
pageSize	The maximum number of objects returned in the query. (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 FundingAccountsResponse

Implemented in Orbipay.PaymentsApi.Client.Api.FundingAccountApi.

ApiResponse<FundingAccountsResponse> Orbipay.PaymentsApi.Client.Api.IFundingAccountApi.RetrieveFundingAccountsWithHttpInfo	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_CUSTOMER,
		string	requestor = null,
		string	xOPAYHeaders = null,
		string	traceId = null,
		string	pageSize = null,
		string	accountNumber = null,
		List< string >	status = null,
		string	abaRoutingNumber = null,
		List< string >	accountType = null,
		string	accountSubtype = null
	)

Retrieve Funding Accounts

This API is used to retrieve all the funding accounts associated with a customer. Accounts can be filtered using the account number, the ABA routing number (for bank accounts), the account status, account type, account sub-type and others mentioned below. The results are sorted based on their last_modified_time in descending order. The API responds with the first page of the list of funding accounts matching the criteria.

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.
requestor	The identifier for the requestor of the API. (optional)
xOPAYHeaders	Intended for the future use. (optional)
traceId	The unique reference that can be used for tracing and debugging an API call. (optional)
pageSize	The maximum number of objects returned in the query. (optional)
accountNumber	The Account Number to get details of. (optional)
status	The status of the funding account in EBPP. This can take multiple values in the format key=value1&key=value2.... (optional)
abaRoutingNumber	The ABA/Routing number for the bank account. (optional)
accountType	The type of the funding account. This can take multiple values in the format key=value1&key=value2.... (optional)
accountSubtype	The sub type of the funding account. This is derived by EBPP in the case of card funding accounts. (optional)

Returns

ApiResponse of FundingAccountsResponse

Implemented in Orbipay.PaymentsApi.Client.Api.FundingAccountApi.

ApiResponse<FundingAccountResponse> Orbipay.PaymentsApi.Client.Api.IFundingAccountApi.UpdateFundingAccount	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_FUNDING_ACCOUNT,
		string	ID_CUSTOMER,
		UpdateFundingAccountRequest	updateFundingAccountRequest,
		string	requestor = null,
		string	xOPAYHeaders = null,
		string	traceId = null
	)

Update Funding Account

The API is used to edit the funding account details. The type of the funding account cannot be changed. In other words, a card account cannot be changed to a bank account and vice versa. The sub-type of a bank account can be changed. For e.g., a saving account can be updated to a money market account. However, the sub-type cannot be updated for a card account. CVV is mandatory to make any change to a card account. The Id of the funding account gets updated to a new value if the account number is updated. Editing a funding account updates the account information on all pending payments made using that account but does not change the details on payments that have been completed. <br><br> Below are the possible funding account state transformation. | from_status | to_status | allowed requestor_type | | - – – – – – - | - – – – – – - | - – – – – – - | | active | deleted| <ul> <li>external_user</li> <li> client_agent</li> <li> system</li> <li> customer</li></ul> | | active | frozen | <ul> <li>external_user </li> <li> client_agent </li> <li> system</li></ul> | | active | inactive | <ul> <li>external_user </li> <li> client_agent </li> <li> system</li></ul> | | active | unverified | <ul> <li>system</li></ul> | | frozen | active | <ul> <li>external_user </li> <li> client_agent</li></ul> | | inactive | active | <ul> <li>external_user </li> <li> client_agent </li> <li> system</li></ul> |

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_FUNDING_ACCOUNT	The unique identifier assigned by EBPP to the Funding Account.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
updateFundingAccountRequest	JSON containing all the attributes of the Funding account to be updated.
requestor	The identifier for the requestor of the API. (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<FundingAccountResponse>

Implemented in Orbipay.PaymentsApi.Client.Api.FundingAccountApi.

System.Threading.Tasks.Task<FundingAccountResponse> Orbipay.PaymentsApi.Client.Api.IFundingAccountApi.UpdateFundingAccountAsync	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_FUNDING_ACCOUNT,
		string	ID_CUSTOMER,
		UpdateFundingAccountRequest	updateFundingAccountRequest,
		string	requestor = null,
		string	xOPAYHeaders = null,
		string	traceId = null
	)

Update Funding Account

The API is used to edit the funding account details. The type of the funding account cannot be changed. In other words, a card account cannot be changed to a bank account and vice versa. The sub-type of a bank account can be changed. For e.g., a saving account can be updated to a money market account. However, the sub-type cannot be updated for a card account. CVV is mandatory to make any change to a card account. The Id of the funding account gets updated to a new value if the account number is updated. Editing a funding account updates the account information on all pending payments made using that account but does not change the details on payments that have been completed. <br><br> Below are the possible funding account state transformation. | from_status | to_status | allowed requestor_type | | - – – – – – - | - – – – – – - | - – – – – – - | | active | deleted| <ul> <li>external_user</li> <li> client_agent</li> <li> system</li> <li> customer</li></ul> | | active | frozen | <ul> <li>external_user </li> <li> client_agent </li> <li> system</li></ul> | | active | inactive | <ul> <li>external_user </li> <li> client_agent </li> <li> system</li></ul> | | active | unverified | <ul> <li>system</li></ul> | | frozen | active | <ul> <li>external_user </li> <li> client_agent</li></ul> | | inactive | active | <ul> <li>external_user </li> <li> client_agent </li> <li> system</li></ul> |

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_FUNDING_ACCOUNT	The unique identifier assigned by EBPP to the Funding Account.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
updateFundingAccountRequest	JSON containing all the attributes of the Funding account to be updated.
requestor	The identifier for the requestor of the API. (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 FundingAccountResponse

Implemented in Orbipay.PaymentsApi.Client.Api.FundingAccountApi.

System.Threading.Tasks.Task<ApiResponse<FundingAccountResponse> > Orbipay.PaymentsApi.Client.Api.IFundingAccountApi.UpdateFundingAccountAsyncWithHttpInfo	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_FUNDING_ACCOUNT,
		string	ID_CUSTOMER,
		UpdateFundingAccountRequest	updateFundingAccountRequest,
		string	requestor = null,
		string	xOPAYHeaders = null,
		string	traceId = null
	)

Update Funding Account

The API is used to edit the funding account details. The type of the funding account cannot be changed. In other words, a card account cannot be changed to a bank account and vice versa. The sub-type of a bank account can be changed. For e.g., a saving account can be updated to a money market account. However, the sub-type cannot be updated for a card account. CVV is mandatory to make any change to a card account. The Id of the funding account gets updated to a new value if the account number is updated. Editing a funding account updates the account information on all pending payments made using that account but does not change the details on payments that have been completed. <br><br> Below are the possible funding account state transformation. | from_status | to_status | allowed requestor_type | | - – – – – – - | - – – – – – - | - – – – – – - | | active | deleted| <ul> <li>external_user</li> <li> client_agent</li> <li> system</li> <li> customer</li></ul> | | active | frozen | <ul> <li>external_user </li> <li> client_agent </li> <li> system</li></ul> | | active | inactive | <ul> <li>external_user </li> <li> client_agent </li> <li> system</li></ul> | | active | unverified | <ul> <li>system</li></ul> | | frozen | active | <ul> <li>external_user </li> <li> client_agent</li></ul> | | inactive | active | <ul> <li>external_user </li> <li> client_agent </li> <li> system</li></ul> |

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_FUNDING_ACCOUNT	The unique identifier assigned by EBPP to the Funding Account.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
updateFundingAccountRequest	JSON containing all the attributes of the Funding account to be updated.
requestor	The identifier for the requestor of the API. (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 (FundingAccountResponse)

Implemented in Orbipay.PaymentsApi.Client.Api.FundingAccountApi.

ApiResponse<FundingAccountResponse> Orbipay.PaymentsApi.Client.Api.IFundingAccountApi.UpdateFundingAccountWithHttpInfo	(	string	channel,
		string	clientKey,
		string	product,
		string	timestamp,
		string	idempotentRequestKey,
		string	requestorType,
		string	ID_FUNDING_ACCOUNT,
		string	ID_CUSTOMER,
		UpdateFundingAccountRequest	updateFundingAccountRequest,
		string	requestor = null,
		string	xOPAYHeaders = null,
		string	traceId = null
	)

Update Funding Account

The API is used to edit the funding account details. The type of the funding account cannot be changed. In other words, a card account cannot be changed to a bank account and vice versa. The sub-type of a bank account can be changed. For e.g., a saving account can be updated to a money market account. However, the sub-type cannot be updated for a card account. CVV is mandatory to make any change to a card account. The Id of the funding account gets updated to a new value if the account number is updated. Editing a funding account updates the account information on all pending payments made using that account but does not change the details on payments that have been completed. <br><br> Below are the possible funding account state transformation. | from_status | to_status | allowed requestor_type | | - – – – – – - | - – – – – – - | - – – – – – - | | active | deleted| <ul> <li>external_user</li> <li> client_agent</li> <li> system</li> <li> customer</li></ul> | | active | frozen | <ul> <li>external_user </li> <li> client_agent </li> <li> system</li></ul> | | active | inactive | <ul> <li>external_user </li> <li> client_agent </li> <li> system</li></ul> | | active | unverified | <ul> <li>system</li></ul> | | frozen | active | <ul> <li>external_user </li> <li> client_agent</li></ul> | | inactive | active | <ul> <li>external_user </li> <li> client_agent </li> <li> system</li></ul> |

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_FUNDING_ACCOUNT	The unique identifier assigned by EBPP to the Funding Account.
ID_CUSTOMER	The unique identifier assigned by EBPP to the customer.
updateFundingAccountRequest	JSON containing all the attributes of the Funding account to be updated.
requestor	The identifier for the requestor of the API. (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 FundingAccountResponse

Implemented in Orbipay.PaymentsApi.Client.Api.FundingAccountApi.

---

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

• src/Orbipay.PaymentsApi.Client/Api/FundingAccountApi.cs