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 —

getConfig()


    public
                getConfig() : Configuration

Return values

Configuration —

getCustomerAccount()

Operation getCustomerAccount


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

Get Customer 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_account : string: The unique identifier assigned by EBPP to the Customer 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\CustomerAccountResponse, HTTP status code, HTTP response headers (array of strings)

getCustomerAccountWithHttpInfo()

Operation getCustomerAccountWithHttpInfo


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

Get Customer 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_account : string: The unique identifier assigned by EBPP to the Customer 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\CustomerAccountResponse, HTTP status code, HTTP response headers (array of strings)

renewCustomerAccount()

Operation renewCustomerAccount


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

Renew Customer 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_account : string: The unique identifier assigned by EBPP to the Customer Account. (required)
$id_customer : string: The unique identifier assigned by EBPP to the customer. (required)
$renew_customer_account_request : RenewCustomerAccountRequest: JSON containing all the attributes of the Customer account to be renewed. (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\CustomerAccountResponse, HTTP status code, HTTP response headers (array of strings)

renewCustomerAccountWithHttpInfo()

Operation renewCustomerAccountWithHttpInfo


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

Renew Customer 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_account : string: The unique identifier assigned by EBPP to the Customer Account. (required)
$id_customer : string: The unique identifier assigned by EBPP to the customer. (required)
$renew_customer_account_request : RenewCustomerAccountRequest: JSON containing all the attributes of the Customer account to be renewed. (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\CustomerAccountResponse, HTTP status code, HTTP response headers (array of strings)

retrieveCustomerAccounts()

Operation retrieveCustomerAccounts


    public
                retrieveCustomerAccounts(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 ]) : array<string|int, mixed>

Retrieve Customer 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 customer's account in EBPP. This can take multiple values in the format key=value1&key=value2.... (optional)

Tags

Return values

array<string|int, mixed> —

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

retrieveCustomerAccountsPage()

Operation retrieveCustomerAccountsPage


    public
                retrieveCustomerAccountsPage(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 Customer 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\CustomerAccountsResponse, HTTP status code, HTTP response headers (array of strings)

retrieveCustomerAccountsPageWithHttpInfo()

Operation retrieveCustomerAccountsPageWithHttpInfo


    public
                retrieveCustomerAccountsPageWithHttpInfo(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 Customer 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\CustomerAccountsResponse, HTTP status code, HTTP response headers (array of strings)

retrieveCustomerAccountsWithHttpInfo()

Operation retrieveCustomerAccountsWithHttpInfo


    public
                retrieveCustomerAccountsWithHttpInfo(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 ]) : array<string|int, mixed>

Retrieve Customer 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 customer's account in EBPP. This can take multiple values in the format key=value1&key=value2.... (optional)

Tags

Return values

array<string|int, mixed> —

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

createHttpClientOption()

Create http client option


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

Tags

Return values

array<string|int, mixed> —

of http client options

getCustomerAccountRequest()

Create request for operation 'getCustomerAccount'


    protected
                getCustomerAccountRequest(string $channel, string $client_key, string $product, string $timestamp, string $idempotent_request_key, string $requestor_type, string $id_customer_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_customer_account : string: The unique identifier assigned by EBPP to the Customer 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> —

renewCustomerAccountRequest()

Create request for operation 'renewCustomerAccount'


    protected
                renewCustomerAccountRequest(string $channel, string $client_key, string $product, string $timestamp, string $idempotent_request_key, string $requestor_type, string $id_customer_account, string $id_customer, RenewCustomerAccountRequest $renew_customer_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_account : string: The unique identifier assigned by EBPP to the Customer Account. (required)
$id_customer : string: The unique identifier assigned by EBPP to the customer. (required)
$renew_customer_account_request : RenewCustomerAccountRequest: JSON containing all the attributes of the Customer account to be renewed. (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> —

retrieveCustomerAccountsPageRequest()

Create request for operation 'retrieveCustomerAccountsPage'


    protected
                retrieveCustomerAccountsPageRequest(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> —

retrieveCustomerAccountsRequest()

Create request for operation 'retrieveCustomerAccounts'


    protected
                retrieveCustomerAccountsRequest(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 ]) : 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 customer's account in EBPP. This can take multiple values in the format key=value1&key=value2.... (optional)

Tags

Return values

array<string|int, mixed> —

CustomerAccountApi in package Orbipay PaymentsApi Client Api

Tags

Table of Contents

Properties

$client

$config

$headerSelector

Methods

__construct()

Parameters

Return values

getConfig()

Return values

getCustomerAccount()

Parameters

Tags

Return values

getCustomerAccountWithHttpInfo()

Parameters

Tags

Return values

renewCustomerAccount()

Parameters

Tags

Return values

renewCustomerAccountWithHttpInfo()

Parameters

Tags

Return values

retrieveCustomerAccounts()

Parameters

Tags

Return values

retrieveCustomerAccountsPage()

Parameters

Tags

Return values

retrieveCustomerAccountsPageWithHttpInfo()

Parameters

Tags

Return values

retrieveCustomerAccountsWithHttpInfo()

Parameters

Tags

Return values

createHttpClientOption()

Tags

Return values

getCustomerAccountRequest()

Parameters

Tags

Return values

renewCustomerAccountRequest()

Parameters

Tags

Return values

retrieveCustomerAccountsPageRequest()

Parameters

Tags

Return values

retrieveCustomerAccountsRequest()

Parameters

Tags

Return values

CustomerAccountApi
in package

Orbipay

PaymentsApi

Client

Api