My Project
|
Represents a collection of functions to interact with the API endpoints More...
Public Member Functions | |
FundingAccountApi (String basePath) | |
Initializes a new instance of the FundingAccountApi class. More... | |
FundingAccountApi (Orbipay.PaymentsApi.Client.Client.Configuration configuration=null) | |
Initializes a new instance of the FundingAccountApi class using Configuration object More... | |
String | GetBasePath () |
Gets the base path of the API client. More... | |
void | SetBasePath (String basePath) |
Sets the base path of the API client. More... | |
IDictionary< String, String > | DefaultHeader () |
Gets the default header. More... | |
void | AddDefaultHeader (string key, string value) |
Add default header. More... | |
ApiResponse < 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 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. 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 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. More... | |
async 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 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. More... | |
async 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 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. 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 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. 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 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. More... | |
async 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 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. More... | |
async 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 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. 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 The Get Funding Account API is used to retrieve the details of the funding account based on the id. 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 The Get Funding Account API is used to retrieve the details of the funding account based on the id. More... | |
async 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 The Get Funding Account API is used to retrieve the details of the funding account based on the id. More... | |
async 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 The Get Funding Account API is used to retrieve the details of the funding account based on the id. 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 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. 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 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. More... | |
async 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 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. More... | |
async 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 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. 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 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. 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 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. More... | |
async 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 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. More... | |
async 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 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. 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 This API is used to paginate through the list of funding accounts returned in the Retrieve Funding Accounts API. 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 This API is used to paginate through the list of funding accounts returned in the Retrieve Funding Accounts API. More... | |
async 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 This API is used to paginate through the list of funding accounts returned in the Retrieve Funding Accounts API. More... | |
async 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 This API is used to paginate through the list of funding accounts returned in the Retrieve Funding Accounts API. 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 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> | 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 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> | More... | |
async 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 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> | More... | |
async 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 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> | More... | |
Properties | |
Orbipay.PaymentsApi.Client.Client.Configuration | Configuration [get, set] |
Gets or sets the configuration object More... | |
Orbipay.PaymentsApi.Client.Client.ExceptionFactory | ExceptionFactory [get, set] |
Provides a factory method hook for the creation of exceptions. More... | |
Properties inherited from Orbipay.PaymentsApi.Client.Client.IApiAccessor | |
Configuration | Configuration [get, set] |
Gets or sets the configuration object More... | |
ExceptionFactory | ExceptionFactory [get, set] |
Provides a factory method hook for the creation of exceptions. More... | |
Represents a collection of functions to interact with the API endpoints
Orbipay.PaymentsApi.Client.Api.FundingAccountApi.FundingAccountApi | ( | String | basePath | ) |
Initializes a new instance of the FundingAccountApi class.
Orbipay.PaymentsApi.Client.Api.FundingAccountApi.FundingAccountApi | ( | Orbipay.PaymentsApi.Client.Client.Configuration | configuration = null | ) |
Initializes a new instance of the FundingAccountApi class using Configuration object
configuration | An instance of Configuration |
void Orbipay.PaymentsApi.Client.Api.FundingAccountApi.AddDefaultHeader | ( | string | key, |
string | value | ||
) |
Add default header.
key | Header field name. |
value | Header field value. |
ApiResponse<FundingAccountResponse> Orbipay.PaymentsApi.Client.Api.FundingAccountApi.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.
Orbipay.PaymentsApi.Client.Client.ApiException | Thrown when fails to make API call |
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) |
Implements Orbipay.PaymentsApi.Client.Api.IFundingAccountApi.
async System.Threading.Tasks.Task<FundingAccountResponse> Orbipay.PaymentsApi.Client.Api.FundingAccountApi.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.
Orbipay.PaymentsApi.Client.Client.ApiException | Thrown when fails to make API call |
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) |
Implements Orbipay.PaymentsApi.Client.Api.IFundingAccountApi.
async System.Threading.Tasks.Task<ApiResponse<FundingAccountResponse> > Orbipay.PaymentsApi.Client.Api.FundingAccountApi.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.
Orbipay.PaymentsApi.Client.Client.ApiException | Thrown when fails to make API call |
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) |
Implements Orbipay.PaymentsApi.Client.Api.IFundingAccountApi.
ApiResponse< FundingAccountResponse > Orbipay.PaymentsApi.Client.Api.FundingAccountApi.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.
Orbipay.PaymentsApi.Client.Client.ApiException | Thrown when fails to make API call |
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) |
Implements Orbipay.PaymentsApi.Client.Api.IFundingAccountApi.
IDictionary<String, String> Orbipay.PaymentsApi.Client.Api.FundingAccountApi.DefaultHeader | ( | ) |
Gets the default header.
ApiResponse<DeleteResponse> Orbipay.PaymentsApi.Client.Api.FundingAccountApi.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.
Orbipay.PaymentsApi.Client.Client.ApiException | Thrown when fails to make API call |
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) |
Implements Orbipay.PaymentsApi.Client.Api.IFundingAccountApi.
async System.Threading.Tasks.Task<DeleteResponse> Orbipay.PaymentsApi.Client.Api.FundingAccountApi.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.
Orbipay.PaymentsApi.Client.Client.ApiException | Thrown when fails to make API call |
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) |
Implements Orbipay.PaymentsApi.Client.Api.IFundingAccountApi.
async System.Threading.Tasks.Task<ApiResponse<DeleteResponse> > Orbipay.PaymentsApi.Client.Api.FundingAccountApi.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.
Orbipay.PaymentsApi.Client.Client.ApiException | Thrown when fails to make API call |
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) |
Implements Orbipay.PaymentsApi.Client.Api.IFundingAccountApi.
ApiResponse< DeleteResponse > Orbipay.PaymentsApi.Client.Api.FundingAccountApi.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.
Orbipay.PaymentsApi.Client.Client.ApiException | Thrown when fails to make API call |
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) |
Implements Orbipay.PaymentsApi.Client.Api.IFundingAccountApi.
String Orbipay.PaymentsApi.Client.Api.FundingAccountApi.GetBasePath | ( | ) |
Gets the base path of the API client.
The base path
Implements Orbipay.PaymentsApi.Client.Client.IApiAccessor.
ApiResponse<FundingAccountResponse> Orbipay.PaymentsApi.Client.Api.FundingAccountApi.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.
Orbipay.PaymentsApi.Client.Client.ApiException | Thrown when fails to make API call |
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) |
Implements Orbipay.PaymentsApi.Client.Api.IFundingAccountApi.
async System.Threading.Tasks.Task<FundingAccountResponse> Orbipay.PaymentsApi.Client.Api.FundingAccountApi.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.
Orbipay.PaymentsApi.Client.Client.ApiException | Thrown when fails to make API call |
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) |
Implements Orbipay.PaymentsApi.Client.Api.IFundingAccountApi.
async System.Threading.Tasks.Task<ApiResponse<FundingAccountResponse> > Orbipay.PaymentsApi.Client.Api.FundingAccountApi.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.
Orbipay.PaymentsApi.Client.Client.ApiException | Thrown when fails to make API call |
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) |
Implements Orbipay.PaymentsApi.Client.Api.IFundingAccountApi.
ApiResponse< FundingAccountResponse > Orbipay.PaymentsApi.Client.Api.FundingAccountApi.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.
Orbipay.PaymentsApi.Client.Client.ApiException | Thrown when fails to make API call |
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) |
Implements Orbipay.PaymentsApi.Client.Api.IFundingAccountApi.
ApiResponse<FundingAccountResponse> Orbipay.PaymentsApi.Client.Api.FundingAccountApi.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.
Orbipay.PaymentsApi.Client.Client.ApiException | Thrown when fails to make API call |
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) |
Implements Orbipay.PaymentsApi.Client.Api.IFundingAccountApi.
async System.Threading.Tasks.Task<FundingAccountResponse> Orbipay.PaymentsApi.Client.Api.FundingAccountApi.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.
Orbipay.PaymentsApi.Client.Client.ApiException | Thrown when fails to make API call |
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) |
Implements Orbipay.PaymentsApi.Client.Api.IFundingAccountApi.
async System.Threading.Tasks.Task<ApiResponse<FundingAccountResponse> > Orbipay.PaymentsApi.Client.Api.FundingAccountApi.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.
Orbipay.PaymentsApi.Client.Client.ApiException | Thrown when fails to make API call |
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) |
Implements Orbipay.PaymentsApi.Client.Api.IFundingAccountApi.
ApiResponse< FundingAccountResponse > Orbipay.PaymentsApi.Client.Api.FundingAccountApi.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.
Orbipay.PaymentsApi.Client.Client.ApiException | Thrown when fails to make API call |
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) |
Implements Orbipay.PaymentsApi.Client.Api.IFundingAccountApi.
ApiResponse<FundingAccountsResponse> Orbipay.PaymentsApi.Client.Api.FundingAccountApi.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.
Orbipay.PaymentsApi.Client.Client.ApiException | Thrown when fails to make API call |
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) |
Implements Orbipay.PaymentsApi.Client.Api.IFundingAccountApi.
async System.Threading.Tasks.Task<FundingAccountsResponse> Orbipay.PaymentsApi.Client.Api.FundingAccountApi.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.
Orbipay.PaymentsApi.Client.Client.ApiException | Thrown when fails to make API call |
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) |
Implements Orbipay.PaymentsApi.Client.Api.IFundingAccountApi.
async System.Threading.Tasks.Task<ApiResponse<FundingAccountsResponse> > Orbipay.PaymentsApi.Client.Api.FundingAccountApi.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.
Orbipay.PaymentsApi.Client.Client.ApiException | Thrown when fails to make API call |
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) |
Implements Orbipay.PaymentsApi.Client.Api.IFundingAccountApi.
ApiResponse<FundingAccountsResponse> Orbipay.PaymentsApi.Client.Api.FundingAccountApi.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.
Orbipay.PaymentsApi.Client.Client.ApiException | Thrown when fails to make API call |
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) |
Implements Orbipay.PaymentsApi.Client.Api.IFundingAccountApi.
async System.Threading.Tasks.Task<FundingAccountsResponse> Orbipay.PaymentsApi.Client.Api.FundingAccountApi.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.
Orbipay.PaymentsApi.Client.Client.ApiException | Thrown when fails to make API call |
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) |
Implements Orbipay.PaymentsApi.Client.Api.IFundingAccountApi.
async System.Threading.Tasks.Task<ApiResponse<FundingAccountsResponse> > Orbipay.PaymentsApi.Client.Api.FundingAccountApi.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.
Orbipay.PaymentsApi.Client.Client.ApiException | Thrown when fails to make API call |
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) |
Implements Orbipay.PaymentsApi.Client.Api.IFundingAccountApi.
ApiResponse< FundingAccountsResponse > Orbipay.PaymentsApi.Client.Api.FundingAccountApi.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.
Orbipay.PaymentsApi.Client.Client.ApiException | Thrown when fails to make API call |
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) |
Implements Orbipay.PaymentsApi.Client.Api.IFundingAccountApi.
ApiResponse< FundingAccountsResponse > Orbipay.PaymentsApi.Client.Api.FundingAccountApi.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.
Orbipay.PaymentsApi.Client.Client.ApiException | Thrown when fails to make API call |
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) |
Implements Orbipay.PaymentsApi.Client.Api.IFundingAccountApi.
void Orbipay.PaymentsApi.Client.Api.FundingAccountApi.SetBasePath | ( | String | basePath | ) |
Sets the base path of the API client.
The base path
ApiResponse<FundingAccountResponse> Orbipay.PaymentsApi.Client.Api.FundingAccountApi.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> |
Orbipay.PaymentsApi.Client.Client.ApiException | Thrown when fails to make API call |
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) |
Implements Orbipay.PaymentsApi.Client.Api.IFundingAccountApi.
async System.Threading.Tasks.Task<FundingAccountResponse> Orbipay.PaymentsApi.Client.Api.FundingAccountApi.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> |
Orbipay.PaymentsApi.Client.Client.ApiException | Thrown when fails to make API call |
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) |
Implements Orbipay.PaymentsApi.Client.Api.IFundingAccountApi.
async System.Threading.Tasks.Task<ApiResponse<FundingAccountResponse> > Orbipay.PaymentsApi.Client.Api.FundingAccountApi.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> |
Orbipay.PaymentsApi.Client.Client.ApiException | Thrown when fails to make API call |
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) |
Implements Orbipay.PaymentsApi.Client.Api.IFundingAccountApi.
ApiResponse< FundingAccountResponse > Orbipay.PaymentsApi.Client.Api.FundingAccountApi.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> |
Orbipay.PaymentsApi.Client.Client.ApiException | Thrown when fails to make API call |
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) |
Implements Orbipay.PaymentsApi.Client.Api.IFundingAccountApi.
|
getset |
Gets or sets the configuration object
An instance of the Configuration
|
getset |
Provides a factory method hook for the creation of exceptions.