Documentation

__construct()


    public
                __construct([ClientInterface $client = null ][, Configuration $config = null ][, HeaderSelector $selector = null ]) : mixed

Parameters

$client : ClientInterface = null
$config : Configuration = null
$selector : HeaderSelector = null

Return values

mixed —

addFundingAccount()

Operation addFundingAccount


    public
                addFundingAccount(string $channel, string $client_key, string $product, string $timestamp, string $idempotent_request_key, string $requestor_type, string $id_customer, AddFundingAccountRequest $add_funding_account_request[, string $requestor = null ][, string $x_opay_headers = null ][, string $trace_id = null ]) : array<string|int, mixed>

Add Funding Account

Parameters

$channel : string: The channel through which the API is invoked. (required)
$client_key : string: The unique identifier assigned by EBPP to the client. (required)
$product : string: The product identifier corresponding to the API. (required)
$timestamp : string: The timestamp for the moment when the API request is created. (required)
$idempotent_request_key : string: The unique token that clients can generate and maintain in order to identify an API request. (required)
$requestor_type : string: Type of the requestor of the API. (required)
$id_customer : string: The unique identifier assigned by EBPP to the customer. (required)
$add_funding_account_request : AddFundingAccountRequest: JSON containing all the attributes of the Funding account to be added to customer. (required)
$requestor : string = null: The identifier for the requestor of the API. If the requestor_type is system, requestor is optional. (optional)
$x_opay_headers : string = null: Intended for the future use. (optional)
$trace_id : string = null: The unique reference that can be used for tracing and debugging an API call. (optional)

Tags

Return values

array<string|int, mixed> —

of \Orbipay\PaymentsApi\Client\Model\FundingAccountResponse, HTTP status code, HTTP response headers (array of strings)

addFundingAccountWithHttpInfo()

Operation addFundingAccountWithHttpInfo


    public
                addFundingAccountWithHttpInfo(string $channel, string $client_key, string $product, string $timestamp, string $idempotent_request_key, string $requestor_type, string $id_customer, AddFundingAccountRequest $add_funding_account_request[, string $requestor = null ][, string $x_opay_headers = null ][, string $trace_id = null ]) : array<string|int, mixed>

Add Funding Account

Parameters

$channel : string: The channel through which the API is invoked. (required)
$client_key : string: The unique identifier assigned by EBPP to the client. (required)
$product : string: The product identifier corresponding to the API. (required)
$timestamp : string: The timestamp for the moment when the API request is created. (required)
$idempotent_request_key : string: The unique token that clients can generate and maintain in order to identify an API request. (required)
$requestor_type : string: Type of the requestor of the API. (required)
$id_customer : string: The unique identifier assigned by EBPP to the customer. (required)
$add_funding_account_request : AddFundingAccountRequest: JSON containing all the attributes of the Funding account to be added to customer. (required)
$requestor : string = null: The identifier for the requestor of the API. If the requestor_type is system, requestor is optional. (optional)
$x_opay_headers : string = null: Intended for the future use. (optional)
$trace_id : string = null: The unique reference that can be used for tracing and debugging an API call. (optional)

Tags

Return values

array<string|int, mixed> —

of \Orbipay\PaymentsApi\Client\Model\FundingAccountResponse, HTTP status code, HTTP response headers (array of strings)

deleteFundingAccount()

Operation deleteFundingAccount


    public
                deleteFundingAccount(string $channel, string $client_key, string $product, string $timestamp, string $idempotent_request_key, string $requestor_type, string $id_funding_account, string $id_customer, DeleteFundingAccountRequest $delete_funding_account_request[, string $requestor = null ][, string $x_opay_headers = null ][, string $trace_id = null ]) : array<string|int, mixed>

Delete Funding Account

Parameters

$channel : string: The channel through which the API is invoked. (required)
$client_key : string: The unique identifier assigned by EBPP to the client. (required)
$product : string: The product identifier corresponding to the API. (required)
$timestamp : string: The timestamp for the moment when the API request is created. (required)
$idempotent_request_key : string: The unique token that clients can generate and maintain in order to identify an API request. (required)
$requestor_type : string: Type of the requestor of the API. (required)
$id_funding_account : string: The unique identifier assigned by EBPP to the Funding Account. (required)
$id_customer : string: The unique identifier assigned by EBPP to the customer. (required)
$delete_funding_account_request : DeleteFundingAccountRequest: Details of account to be deleted. (required)
$requestor : string = null: The identifier for the requestor of the API. If the requestor_type is system, requestor is optional. (optional)
$x_opay_headers : string = null: Intended for the future use. (optional)
$trace_id : string = null: The unique reference that can be used for tracing and debugging an API call. (optional)

Tags

Return values

array<string|int, mixed> —

of \Orbipay\PaymentsApi\Client\Model\DeleteResponse, HTTP status code, HTTP response headers (array of strings)

deleteFundingAccountWithHttpInfo()

Operation deleteFundingAccountWithHttpInfo


    public
                deleteFundingAccountWithHttpInfo(string $channel, string $client_key, string $product, string $timestamp, string $idempotent_request_key, string $requestor_type, string $id_funding_account, string $id_customer, DeleteFundingAccountRequest $delete_funding_account_request[, string $requestor = null ][, string $x_opay_headers = null ][, string $trace_id = null ]) : array<string|int, mixed>

Delete Funding Account

Parameters

$channel : string: The channel through which the API is invoked. (required)
$client_key : string: The unique identifier assigned by EBPP to the client. (required)
$product : string: The product identifier corresponding to the API. (required)
$timestamp : string: The timestamp for the moment when the API request is created. (required)
$idempotent_request_key : string: The unique token that clients can generate and maintain in order to identify an API request. (required)
$requestor_type : string: Type of the requestor of the API. (required)
$id_funding_account : string: The unique identifier assigned by EBPP to the Funding Account. (required)
$id_customer : string: The unique identifier assigned by EBPP to the customer. (required)
$delete_funding_account_request : DeleteFundingAccountRequest: Details of account to be deleted. (required)
$requestor : string = null: The identifier for the requestor of the API. If the requestor_type is system, requestor is optional. (optional)
$x_opay_headers : string = null: Intended for the future use. (optional)
$trace_id : string = null: The unique reference that can be used for tracing and debugging an API call. (optional)

Tags

Return values

array<string|int, mixed> —

of \Orbipay\PaymentsApi\Client\Model\DeleteResponse, HTTP status code, HTTP response headers (array of strings)

getConfig()


    public
                getConfig() : Configuration

Return values

Configuration —

getFundingAccount()

Operation getFundingAccount


    public
                getFundingAccount(string $channel, string $client_key, string $product, string $timestamp, string $idempotent_request_key, string $requestor_type, string $id_funding_account, string $id_customer[, string $requestor = null ][, string $x_opay_headers = null ][, string $trace_id = null ]) : array<string|int, mixed>

Get Funding Account

Parameters

$channel : string: The channel through which the API is invoked. (required)
$client_key : string: The unique identifier assigned by EBPP to the client. (required)
$product : string: The product identifier corresponding to the API. (required)
$timestamp : string: The timestamp for the moment when the API request is created. (required)
$idempotent_request_key : string: The unique token that clients can generate and maintain in order to identify an API request. (required)
$requestor_type : string: Type of the requestor of the API. (required)
$id_funding_account : string: The unique identifier assigned by EBPP to the Funding Account. (required)
$id_customer : string: The unique identifier assigned by EBPP to the customer. (required)
$requestor : string = null: The identifier for the requestor of the API. If the requestor_type is system, requestor is optional. (optional)
$x_opay_headers : string = null: Intended for the future use. (optional)
$trace_id : string = null: The unique reference that can be used for tracing and debugging an API call. (optional)

Tags

Return values

array<string|int, mixed> —

of \Orbipay\PaymentsApi\Client\Model\FundingAccountResponse, HTTP status code, HTTP response headers (array of strings)

getFundingAccountWithHttpInfo()

Operation getFundingAccountWithHttpInfo


    public
                getFundingAccountWithHttpInfo(string $channel, string $client_key, string $product, string $timestamp, string $idempotent_request_key, string $requestor_type, string $id_funding_account, string $id_customer[, string $requestor = null ][, string $x_opay_headers = null ][, string $trace_id = null ]) : array<string|int, mixed>

Get Funding Account

Parameters

$channel : string: The channel through which the API is invoked. (required)
$client_key : string: The unique identifier assigned by EBPP to the client. (required)
$product : string: The product identifier corresponding to the API. (required)
$timestamp : string: The timestamp for the moment when the API request is created. (required)
$idempotent_request_key : string: The unique token that clients can generate and maintain in order to identify an API request. (required)
$requestor_type : string: Type of the requestor of the API. (required)
$id_funding_account : string: The unique identifier assigned by EBPP to the Funding Account. (required)
$id_customer : string: The unique identifier assigned by EBPP to the customer. (required)
$requestor : string = null: The identifier for the requestor of the API. If the requestor_type is system, requestor is optional. (optional)
$x_opay_headers : string = null: Intended for the future use. (optional)
$trace_id : string = null: The unique reference that can be used for tracing and debugging an API call. (optional)

Tags

Return values

array<string|int, mixed> —

of \Orbipay\PaymentsApi\Client\Model\FundingAccountResponse, HTTP status code, HTTP response headers (array of strings)

replaceFundingAccount()

Operation replaceFundingAccount


    public
                replaceFundingAccount(string $channel, string $client_key, string $product, string $timestamp, string $idempotent_request_key, string $requestor_type, string $id_funding_account, string $id_customer, ReplaceFundingAccountRequest $replace_funding_account_request[, string $requestor = null ][, string $x_opay_headers = null ][, string $trace_id = null ]) : array<string|int, mixed>

Replace Funding Account

Parameters

$channel : string: The channel through which the API is invoked. (required)
$client_key : string: The unique identifier assigned by EBPP to the client. (required)
$product : string: The product identifier corresponding to the API. (required)
$timestamp : string: The timestamp for the moment when the API request is created. (required)
$idempotent_request_key : string: The unique token that clients can generate and maintain in order to identify an API request. (required)
$requestor_type : string: Type of the requestor of the API. (required)
$id_funding_account : string: The unique identifier assigned by EBPP to the Funding Account. (required)
$id_customer : string: The unique identifier assigned by EBPP to the customer. (required)
$replace_funding_account_request : ReplaceFundingAccountRequest: JSON containing all the attributes of the Funding account to be replaced. (required)
$requestor : string = null: The identifier for the requestor of the API. If the requestor_type is system, requestor is optional. (optional)
$x_opay_headers : string = null: Intended for the future use. (optional)
$trace_id : string = null: The unique reference that can be used for tracing and debugging an API call. (optional)

Tags

Return values

array<string|int, mixed> —

of \Orbipay\PaymentsApi\Client\Model\FundingAccountResponse, HTTP status code, HTTP response headers (array of strings)

replaceFundingAccountWithHttpInfo()

Operation replaceFundingAccountWithHttpInfo


    public
                replaceFundingAccountWithHttpInfo(string $channel, string $client_key, string $product, string $timestamp, string $idempotent_request_key, string $requestor_type, string $id_funding_account, string $id_customer, ReplaceFundingAccountRequest $replace_funding_account_request[, string $requestor = null ][, string $x_opay_headers = null ][, string $trace_id = null ]) : array<string|int, mixed>

Replace Funding Account

Parameters

$channel : string: The channel through which the API is invoked. (required)
$client_key : string: The unique identifier assigned by EBPP to the client. (required)
$product : string: The product identifier corresponding to the API. (required)
$timestamp : string: The timestamp for the moment when the API request is created. (required)
$idempotent_request_key : string: The unique token that clients can generate and maintain in order to identify an API request. (required)
$requestor_type : string: Type of the requestor of the API. (required)
$id_funding_account : string: The unique identifier assigned by EBPP to the Funding Account. (required)
$id_customer : string: The unique identifier assigned by EBPP to the customer. (required)
$replace_funding_account_request : ReplaceFundingAccountRequest: JSON containing all the attributes of the Funding account to be replaced. (required)
$requestor : string = null: The identifier for the requestor of the API. If the requestor_type is system, requestor is optional. (optional)
$x_opay_headers : string = null: Intended for the future use. (optional)
$trace_id : string = null: The unique reference that can be used for tracing and debugging an API call. (optional)

Tags

Return values

array<string|int, mixed> —

of \Orbipay\PaymentsApi\Client\Model\FundingAccountResponse, HTTP status code, HTTP response headers (array of strings)

retrieveFundingAccounts()

Operation retrieveFundingAccounts


    public
                retrieveFundingAccounts(string $channel, string $client_key, string $product, string $timestamp, string $idempotent_request_key, string $requestor_type, string $id_customer[, string $requestor = null ][, string $x_opay_headers = null ][, string $trace_id = null ][, string $page_size = null ][, string $account_number = null ][, array<string|int, string> $status = null ][, string $aba_routing_number = null ][, array<string|int, string> $account_type = null ][, string $account_subtype = null ]) : array<string|int, mixed>

Retrieve Funding Accounts

Parameters

$channel : string: The channel through which the API is invoked. (required)
$client_key : string: The unique identifier assigned by EBPP to the client. (required)
$product : string: The product identifier corresponding to the API. (required)
$timestamp : string: The timestamp for the moment when the API request is created. (required)
$idempotent_request_key : string: The unique token that clients can generate and maintain in order to identify an API request. (required)
$requestor_type : string: Type of the requestor of the API. (required)
$id_customer : string: The unique identifier assigned by EBPP to the customer. (required)
$requestor : string = null: The identifier for the requestor of the API. If the requestor_type is system, requestor is optional. (optional)
$x_opay_headers : string = null: Intended for the future use. (optional)
$trace_id : string = null: The unique reference that can be used for tracing and debugging an API call. (optional)
$page_size : string = null: The maximum number of objects returned in the query. (optional)
$account_number : string = null: The Account Number to get details of. (optional)
$status : array<string|int, string> = null: The status of the funding account in EBPP. This can take multiple values in the format key=value1&key=value2.... (optional)
$aba_routing_number : string = null: The ABA/Routing number for the bank account. (optional)
$account_type : array<string|int, string> = null: The type of the funding account. This can take multiple values in the format key=value1&key=value2.... (optional)
$account_subtype : string = null: The sub type of the funding account. This is derived by EBPP in the case of card funding accounts. It needs to be passed when adding or editing a DDA/bank account. (optional)

Tags

Return values

array<string|int, mixed> —

of \Orbipay\PaymentsApi\Client\Model\FundingAccountsResponse, HTTP status code, HTTP response headers (array of strings)

retrieveFundingAccountsPage()

Operation retrieveFundingAccountsPage


    public
                retrieveFundingAccountsPage(string $channel, string $client_key, string $product, string $timestamp, string $idempotent_request_key, string $requestor_type, string $id_customer, string $query_id[, string $requestor = null ][, string $x_opay_headers = null ][, string $trace_id = null ][, string $page_size = null ][, string $from_index = null ][, string $to_index = null ]) : array<string|int, mixed>

Retrieve Funding Accounts Pagination

Parameters

$channel : string: The channel through which the API is invoked. (required)
$client_key : string: The unique identifier assigned by EBPP to the client. (required)
$product : string: The product identifier corresponding to the API. (required)
$timestamp : string: The timestamp for the moment when the API request is created. (required)
$idempotent_request_key : string: The unique token that clients can generate and maintain in order to identify an API request. (required)
$requestor_type : string: Type of the requestor of the API. (required)
$id_customer : string: The unique identifier assigned by EBPP to the customer. (required)
$query_id : string: query id of the Retrieve/Search Accounts lookup. (required)
$requestor : string = null: The identifier for the requestor of the API. If the requestor_type is system, requestor is optional. (optional)
$x_opay_headers : string = null: Intended for the future use. (optional)
$trace_id : string = null: The unique reference that can be used for tracing and debugging an API call. (optional)
$page_size : string = null: The maximum number of objects returned in the query. (optional)
$from_index : string = null: To fetch the next set of objects that start after this object (optional)
$to_index : string = null: To fetch the previous set of objects that end at this object (optional)

Tags

Return values

array<string|int, mixed> —

of \Orbipay\PaymentsApi\Client\Model\FundingAccountsResponse, HTTP status code, HTTP response headers (array of strings)

retrieveFundingAccountsPageWithHttpInfo()

Operation retrieveFundingAccountsPageWithHttpInfo


    public
                retrieveFundingAccountsPageWithHttpInfo(string $channel, string $client_key, string $product, string $timestamp, string $idempotent_request_key, string $requestor_type, string $id_customer, string $query_id[, string $requestor = null ][, string $x_opay_headers = null ][, string $trace_id = null ][, string $page_size = null ][, string $from_index = null ][, string $to_index = null ]) : array<string|int, mixed>

Retrieve Funding Accounts Pagination

Parameters

$channel : string: The channel through which the API is invoked. (required)
$client_key : string: The unique identifier assigned by EBPP to the client. (required)
$product : string: The product identifier corresponding to the API. (required)
$timestamp : string: The timestamp for the moment when the API request is created. (required)
$idempotent_request_key : string: The unique token that clients can generate and maintain in order to identify an API request. (required)
$requestor_type : string: Type of the requestor of the API. (required)
$id_customer : string: The unique identifier assigned by EBPP to the customer. (required)
$query_id : string: query id of the Retrieve/Search Accounts lookup. (required)
$requestor : string = null: The identifier for the requestor of the API. If the requestor_type is system, requestor is optional. (optional)
$x_opay_headers : string = null: Intended for the future use. (optional)
$trace_id : string = null: The unique reference that can be used for tracing and debugging an API call. (optional)
$page_size : string = null: The maximum number of objects returned in the query. (optional)
$from_index : string = null: To fetch the next set of objects that start after this object (optional)
$to_index : string = null: To fetch the previous set of objects that end at this object (optional)

Tags

Return values

array<string|int, mixed> —

of \Orbipay\PaymentsApi\Client\Model\FundingAccountsResponse, HTTP status code, HTTP response headers (array of strings)

retrieveFundingAccountsWithHttpInfo()

Operation retrieveFundingAccountsWithHttpInfo


    public
                retrieveFundingAccountsWithHttpInfo(string $channel, string $client_key, string $product, string $timestamp, string $idempotent_request_key, string $requestor_type, string $id_customer[, string $requestor = null ][, string $x_opay_headers = null ][, string $trace_id = null ][, string $page_size = null ][, string $account_number = null ][, array<string|int, string> $status = null ][, string $aba_routing_number = null ][, array<string|int, string> $account_type = null ][, string $account_subtype = null ]) : array<string|int, mixed>

Retrieve Funding Accounts

Parameters

$channel : string: The channel through which the API is invoked. (required)
$client_key : string: The unique identifier assigned by EBPP to the client. (required)
$product : string: The product identifier corresponding to the API. (required)
$timestamp : string: The timestamp for the moment when the API request is created. (required)
$idempotent_request_key : string: The unique token that clients can generate and maintain in order to identify an API request. (required)
$requestor_type : string: Type of the requestor of the API. (required)
$id_customer : string: The unique identifier assigned by EBPP to the customer. (required)
$requestor : string = null: The identifier for the requestor of the API. If the requestor_type is system, requestor is optional. (optional)
$x_opay_headers : string = null: Intended for the future use. (optional)
$trace_id : string = null: The unique reference that can be used for tracing and debugging an API call. (optional)
$page_size : string = null: The maximum number of objects returned in the query. (optional)
$account_number : string = null: The Account Number to get details of. (optional)
$status : array<string|int, string> = null: The status of the funding account in EBPP. This can take multiple values in the format key=value1&key=value2.... (optional)
$aba_routing_number : string = null: The ABA/Routing number for the bank account. (optional)
$account_type : array<string|int, string> = null: The type of the funding account. This can take multiple values in the format key=value1&key=value2.... (optional)
$account_subtype : string = null: The sub type of the funding account. This is derived by EBPP in the case of card funding accounts. It needs to be passed when adding or editing a DDA/bank account. (optional)

Tags

Return values

array<string|int, mixed> —

of \Orbipay\PaymentsApi\Client\Model\FundingAccountsResponse, HTTP status code, HTTP response headers (array of strings)

updateFundingAccount()

Operation updateFundingAccount


    public
                updateFundingAccount(string $channel, string $client_key, string $product, string $timestamp, string $idempotent_request_key, string $requestor_type, string $id_funding_account, string $id_customer, UpdateFundingAccountRequest $update_funding_account_request[, string $requestor = null ][, string $x_opay_headers = null ][, string $trace_id = null ]) : array<string|int, mixed>

Update Funding Account

Parameters

$channel : string: The channel through which the API is invoked. (required)
$client_key : string: The unique identifier assigned by EBPP to the client. (required)
$product : string: The product identifier corresponding to the API. (required)
$timestamp : string: The timestamp for the moment when the API request is created. (required)
$idempotent_request_key : string: The unique token that clients can generate and maintain in order to identify an API request. (required)
$requestor_type : string: Type of the requestor of the API. (required)
$id_funding_account : string: The unique identifier assigned by EBPP to the Funding Account. (required)
$id_customer : string: The unique identifier assigned by EBPP to the customer. (required)
$update_funding_account_request : UpdateFundingAccountRequest: JSON containing all the attributes of the Funding account to be updated. (required)
$requestor : string = null: The identifier for the requestor of the API. If the requestor_type is system, requestor is optional. (optional)
$x_opay_headers : string = null: Intended for the future use. (optional)
$trace_id : string = null: The unique reference that can be used for tracing and debugging an API call. (optional)

Tags

Return values

array<string|int, mixed> —

of \Orbipay\PaymentsApi\Client\Model\FundingAccountResponse, HTTP status code, HTTP response headers (array of strings)

updateFundingAccountWithHttpInfo()

Operation updateFundingAccountWithHttpInfo


    public
                updateFundingAccountWithHttpInfo(string $channel, string $client_key, string $product, string $timestamp, string $idempotent_request_key, string $requestor_type, string $id_funding_account, string $id_customer, UpdateFundingAccountRequest $update_funding_account_request[, string $requestor = null ][, string $x_opay_headers = null ][, string $trace_id = null ]) : array<string|int, mixed>

Update Funding Account

Parameters

$channel : string: The channel through which the API is invoked. (required)
$client_key : string: The unique identifier assigned by EBPP to the client. (required)
$product : string: The product identifier corresponding to the API. (required)
$timestamp : string: The timestamp for the moment when the API request is created. (required)
$idempotent_request_key : string: The unique token that clients can generate and maintain in order to identify an API request. (required)
$requestor_type : string: Type of the requestor of the API. (required)
$id_funding_account : string: The unique identifier assigned by EBPP to the Funding Account. (required)
$id_customer : string: The unique identifier assigned by EBPP to the customer. (required)
$update_funding_account_request : UpdateFundingAccountRequest: JSON containing all the attributes of the Funding account to be updated. (required)
$requestor : string = null: The identifier for the requestor of the API. If the requestor_type is system, requestor is optional. (optional)
$x_opay_headers : string = null: Intended for the future use. (optional)
$trace_id : string = null: The unique reference that can be used for tracing and debugging an API call. (optional)

Tags

Return values

array<string|int, mixed> —

of \Orbipay\PaymentsApi\Client\Model\FundingAccountResponse, HTTP status code, HTTP response headers (array of strings)

addFundingAccountRequest()

Create request for operation 'addFundingAccount'


    protected
                addFundingAccountRequest(string $channel, string $client_key, string $product, string $timestamp, string $idempotent_request_key, string $requestor_type, string $id_customer, AddFundingAccountRequest $add_funding_account_request[, string $requestor = null ][, string $x_opay_headers = null ][, string $trace_id = null ]) : array<string|int, mixed>

Parameters

$channel : string: The channel through which the API is invoked. (required)
$client_key : string: The unique identifier assigned by EBPP to the client. (required)
$product : string: The product identifier corresponding to the API. (required)
$timestamp : string: The timestamp for the moment when the API request is created. (required)
$idempotent_request_key : string: The unique token that clients can generate and maintain in order to identify an API request. (required)
$requestor_type : string: Type of the requestor of the API. (required)
$id_customer : string: The unique identifier assigned by EBPP to the customer. (required)
$add_funding_account_request : AddFundingAccountRequest: JSON containing all the attributes of the Funding account to be added to customer. (required)
$requestor : string = null: The identifier for the requestor of the API. If the requestor_type is system, requestor is optional. (optional)
$x_opay_headers : string = null: Intended for the future use. (optional)
$trace_id : string = null: The unique reference that can be used for tracing and debugging an API call. (optional)

Tags

Return values

array<string|int, mixed> —

createHttpClientOption()

Create http client option


    protected
                createHttpClientOption() : array<string|int, mixed>

Tags

Return values

array<string|int, mixed> —

of http client options

deleteFundingAccountRequest()

Create request for operation 'deleteFundingAccount'


    protected
                deleteFundingAccountRequest(string $channel, string $client_key, string $product, string $timestamp, string $idempotent_request_key, string $requestor_type, string $id_funding_account, string $id_customer, DeleteFundingAccountRequest $delete_funding_account_request[, string $requestor = null ][, string $x_opay_headers = null ][, string $trace_id = null ]) : array<string|int, mixed>

Parameters

$channel : string: The channel through which the API is invoked. (required)
$client_key : string: The unique identifier assigned by EBPP to the client. (required)
$product : string: The product identifier corresponding to the API. (required)
$timestamp : string: The timestamp for the moment when the API request is created. (required)
$idempotent_request_key : string: The unique token that clients can generate and maintain in order to identify an API request. (required)
$requestor_type : string: Type of the requestor of the API. (required)
$id_funding_account : string: The unique identifier assigned by EBPP to the Funding Account. (required)
$id_customer : string: The unique identifier assigned by EBPP to the customer. (required)
$delete_funding_account_request : DeleteFundingAccountRequest: Details of account to be deleted. (required)
$requestor : string = null: The identifier for the requestor of the API. If the requestor_type is system, requestor is optional. (optional)
$x_opay_headers : string = null: Intended for the future use. (optional)
$trace_id : string = null: The unique reference that can be used for tracing and debugging an API call. (optional)

Tags

Return values

array<string|int, mixed> —

getFundingAccountRequest()

Create request for operation 'getFundingAccount'


    protected
                getFundingAccountRequest(string $channel, string $client_key, string $product, string $timestamp, string $idempotent_request_key, string $requestor_type, string $id_funding_account, string $id_customer[, string $requestor = null ][, string $x_opay_headers = null ][, string $trace_id = null ]) : array<string|int, mixed>

Parameters

$channel : string: The channel through which the API is invoked. (required)
$client_key : string: The unique identifier assigned by EBPP to the client. (required)
$product : string: The product identifier corresponding to the API. (required)
$timestamp : string: The timestamp for the moment when the API request is created. (required)
$idempotent_request_key : string: The unique token that clients can generate and maintain in order to identify an API request. (required)
$requestor_type : string: Type of the requestor of the API. (required)
$id_funding_account : string: The unique identifier assigned by EBPP to the Funding Account. (required)
$id_customer : string: The unique identifier assigned by EBPP to the customer. (required)
$requestor : string = null: The identifier for the requestor of the API. If the requestor_type is system, requestor is optional. (optional)
$x_opay_headers : string = null: Intended for the future use. (optional)
$trace_id : string = null: The unique reference that can be used for tracing and debugging an API call. (optional)

Tags

Return values

array<string|int, mixed> —

replaceFundingAccountRequest()

Create request for operation 'replaceFundingAccount'


    protected
                replaceFundingAccountRequest(string $channel, string $client_key, string $product, string $timestamp, string $idempotent_request_key, string $requestor_type, string $id_funding_account, string $id_customer, ReplaceFundingAccountRequest $replace_funding_account_request[, string $requestor = null ][, string $x_opay_headers = null ][, string $trace_id = null ]) : array<string|int, mixed>

Parameters

$channel : string: The channel through which the API is invoked. (required)
$client_key : string: The unique identifier assigned by EBPP to the client. (required)
$product : string: The product identifier corresponding to the API. (required)
$timestamp : string: The timestamp for the moment when the API request is created. (required)
$idempotent_request_key : string: The unique token that clients can generate and maintain in order to identify an API request. (required)
$requestor_type : string: Type of the requestor of the API. (required)
$id_funding_account : string: The unique identifier assigned by EBPP to the Funding Account. (required)
$id_customer : string: The unique identifier assigned by EBPP to the customer. (required)
$replace_funding_account_request : ReplaceFundingAccountRequest: JSON containing all the attributes of the Funding account to be replaced. (required)
$requestor : string = null: The identifier for the requestor of the API. If the requestor_type is system, requestor is optional. (optional)
$x_opay_headers : string = null: Intended for the future use. (optional)
$trace_id : string = null: The unique reference that can be used for tracing and debugging an API call. (optional)

Tags

Return values

array<string|int, mixed> —

retrieveFundingAccountsPageRequest()

Create request for operation 'retrieveFundingAccountsPage'


    protected
                retrieveFundingAccountsPageRequest(string $channel, string $client_key, string $product, string $timestamp, string $idempotent_request_key, string $requestor_type, string $id_customer, string $query_id[, string $requestor = null ][, string $x_opay_headers = null ][, string $trace_id = null ][, string $page_size = null ][, string $from_index = null ][, string $to_index = null ]) : array<string|int, mixed>

Parameters

$channel : string: The channel through which the API is invoked. (required)
$client_key : string: The unique identifier assigned by EBPP to the client. (required)
$product : string: The product identifier corresponding to the API. (required)
$timestamp : string: The timestamp for the moment when the API request is created. (required)
$idempotent_request_key : string: The unique token that clients can generate and maintain in order to identify an API request. (required)
$requestor_type : string: Type of the requestor of the API. (required)
$id_customer : string: The unique identifier assigned by EBPP to the customer. (required)
$query_id : string: query id of the Retrieve/Search Accounts lookup. (required)
$requestor : string = null: The identifier for the requestor of the API. If the requestor_type is system, requestor is optional. (optional)
$x_opay_headers : string = null: Intended for the future use. (optional)
$trace_id : string = null: The unique reference that can be used for tracing and debugging an API call. (optional)
$page_size : string = null: The maximum number of objects returned in the query. (optional)
$from_index : string = null: To fetch the next set of objects that start after this object (optional)
$to_index : string = null: To fetch the previous set of objects that end at this object (optional)

Tags

Return values

array<string|int, mixed> —

retrieveFundingAccountsRequest()

Create request for operation 'retrieveFundingAccounts'


    protected
                retrieveFundingAccountsRequest(string $channel, string $client_key, string $product, string $timestamp, string $idempotent_request_key, string $requestor_type, string $id_customer[, string $requestor = null ][, string $x_opay_headers = null ][, string $trace_id = null ][, string $page_size = null ][, string $account_number = null ][, array<string|int, string> $status = null ][, string $aba_routing_number = null ][, array<string|int, string> $account_type = null ][, string $account_subtype = null ]) : array<string|int, mixed>

Parameters

$channel : string: The channel through which the API is invoked. (required)
$client_key : string: The unique identifier assigned by EBPP to the client. (required)
$product : string: The product identifier corresponding to the API. (required)
$timestamp : string: The timestamp for the moment when the API request is created. (required)
$idempotent_request_key : string: The unique token that clients can generate and maintain in order to identify an API request. (required)
$requestor_type : string: Type of the requestor of the API. (required)
$id_customer : string: The unique identifier assigned by EBPP to the customer. (required)
$requestor : string = null: The identifier for the requestor of the API. If the requestor_type is system, requestor is optional. (optional)
$x_opay_headers : string = null: Intended for the future use. (optional)
$trace_id : string = null: The unique reference that can be used for tracing and debugging an API call. (optional)
$page_size : string = null: The maximum number of objects returned in the query. (optional)
$account_number : string = null: The Account Number to get details of. (optional)
$status : array<string|int, string> = null: The status of the funding account in EBPP. This can take multiple values in the format key=value1&key=value2.... (optional)
$aba_routing_number : string = null: The ABA/Routing number for the bank account. (optional)
$account_type : array<string|int, string> = null: The type of the funding account. This can take multiple values in the format key=value1&key=value2.... (optional)
$account_subtype : string = null: The sub type of the funding account. This is derived by EBPP in the case of card funding accounts. It needs to be passed when adding or editing a DDA/bank account. (optional)

Tags

Return values

array<string|int, mixed> —

updateFundingAccountRequest()

Create request for operation 'updateFundingAccount'


    protected
                updateFundingAccountRequest(string $channel, string $client_key, string $product, string $timestamp, string $idempotent_request_key, string $requestor_type, string $id_funding_account, string $id_customer, UpdateFundingAccountRequest $update_funding_account_request[, string $requestor = null ][, string $x_opay_headers = null ][, string $trace_id = null ]) : array<string|int, mixed>

Parameters

$channel : string: The channel through which the API is invoked. (required)
$client_key : string: The unique identifier assigned by EBPP to the client. (required)
$product : string: The product identifier corresponding to the API. (required)
$timestamp : string: The timestamp for the moment when the API request is created. (required)
$idempotent_request_key : string: The unique token that clients can generate and maintain in order to identify an API request. (required)
$requestor_type : string: Type of the requestor of the API. (required)
$id_funding_account : string: The unique identifier assigned by EBPP to the Funding Account. (required)
$id_customer : string: The unique identifier assigned by EBPP to the customer. (required)
$update_funding_account_request : UpdateFundingAccountRequest: JSON containing all the attributes of the Funding account to be updated. (required)
$requestor : string = null: The identifier for the requestor of the API. If the requestor_type is system, requestor is optional. (optional)
$x_opay_headers : string = null: Intended for the future use. (optional)
$trace_id : string = null: The unique reference that can be used for tracing and debugging an API call. (optional)

Tags

Return values

array<string|int, mixed> —

FundingAccountApi in package Orbipay PaymentsApi Client Api

Tags

Table of Contents

Properties

$client

$config

$headerSelector

Methods

__construct()

Parameters

Return values

addFundingAccount()

Parameters

Tags

Return values

addFundingAccountWithHttpInfo()

Parameters

Tags

Return values

deleteFundingAccount()

Parameters

Tags

Return values

deleteFundingAccountWithHttpInfo()

Parameters

Tags

Return values

getConfig()

Return values

getFundingAccount()

Parameters

Tags

Return values

getFundingAccountWithHttpInfo()

Parameters

Tags

Return values

replaceFundingAccount()

Parameters

Tags

Return values

replaceFundingAccountWithHttpInfo()

Parameters

Tags

Return values

retrieveFundingAccounts()

Parameters

Tags

Return values

retrieveFundingAccountsPage()

Parameters

Tags

Return values

retrieveFundingAccountsPageWithHttpInfo()

Parameters

Tags

Return values

retrieveFundingAccountsWithHttpInfo()

Parameters

Tags

Return values

updateFundingAccount()

Parameters

Tags

Return values

updateFundingAccountWithHttpInfo()

Parameters

Tags

Return values

addFundingAccountRequest()

Parameters

Tags

Return values

createHttpClientOption()

Tags

Return values

deleteFundingAccountRequest()

Parameters

Tags

Return values

FundingAccountApi
in package

Orbipay

PaymentsApi

Client

Api