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 —

createCustomer()

Operation createCustomer


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

Create Customer

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)
$create_customer_request : CreateCustomerRequest: The JSON that contains all the attributes of customer to be created. (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\CustomerResponse, HTTP status code, HTTP response headers (array of strings)

createCustomerWithHttpInfo()

Operation createCustomerWithHttpInfo


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

Create Customer

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)
$create_customer_request : CreateCustomerRequest: The JSON that contains all the attributes of customer to be created. (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\CustomerResponse, HTTP status code, HTTP response headers (array of strings)

getConfig()


    public
                getConfig() : Configuration

Return values

Configuration —

getCustomer()

Operation getCustomer


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

Get Customer

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)

Tags

Return values

array<string|int, mixed> —

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

getCustomerWithHttpInfo()

Operation getCustomerWithHttpInfo


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

Get Customer

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)

Tags

Return values

array<string|int, mixed> —

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

retrieveCustomers()

Operation retrieveCustomers


    public
                retrieveCustomers(string $channel, string $client_key, string $product, string $timestamp, string $idempotent_request_key, string $requestor_type[, string $requestor = null ][, string $x_opay_headers = null ][, string $trace_id = null ][, string $page_size = null ][, string $customer_reference = null ][, string $ssn = null ][, string $email = null ][, string $account_number = null ]) : array<string|int, mixed>

Retrieve Customers

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)
$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)
$customer_reference : string = null: Unique ID assigned by the biller/client system for a given customer. (optional)
$ssn : string = null: The SSN of the customer if the account holder is an individual or the tax ID, if the customer is a business. (optional)
$email : string = null: This field contains the customer’s email address within EBPP. (optional)
$account_number : string = null: Customer Account Number of the customer to get details of. (optional)

Tags

Return values

array<string|int, mixed> —

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

retrieveCustomersPage()

Operation retrieveCustomersPage


    public
                retrieveCustomersPage(string $channel, string $client_key, string $product, string $timestamp, string $idempotent_request_key, string $requestor_type, 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 Customers 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)
$query_id : string: query id of the Retrieve/Search Customers 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\CustomersResponse, HTTP status code, HTTP response headers (array of strings)

retrieveCustomersPageWithHttpInfo()

Operation retrieveCustomersPageWithHttpInfo


    public
                retrieveCustomersPageWithHttpInfo(string $channel, string $client_key, string $product, string $timestamp, string $idempotent_request_key, string $requestor_type, 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 Customers 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)
$query_id : string: query id of the Retrieve/Search Customers 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\CustomersResponse, HTTP status code, HTTP response headers (array of strings)

retrieveCustomersWithHttpInfo()

Operation retrieveCustomersWithHttpInfo


    public
                retrieveCustomersWithHttpInfo(string $channel, string $client_key, string $product, string $timestamp, string $idempotent_request_key, string $requestor_type[, string $requestor = null ][, string $x_opay_headers = null ][, string $trace_id = null ][, string $page_size = null ][, string $customer_reference = null ][, string $ssn = null ][, string $email = null ][, string $account_number = null ]) : array<string|int, mixed>

Retrieve Customers

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)
$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)
$customer_reference : string = null: Unique ID assigned by the biller/client system for a given customer. (optional)
$ssn : string = null: The SSN of the customer if the account holder is an individual or the tax ID, if the customer is a business. (optional)
$email : string = null: This field contains the customer’s email address within EBPP. (optional)
$account_number : string = null: Customer Account Number of the customer to get details of. (optional)

Tags

Return values

array<string|int, mixed> —

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

updateCustomer()

Operation updateCustomer


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

Update Customer

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)
$update_customer_request : UpdateCustomerRequest: JSON containing all the attributes of the customer 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\CustomerResponse, HTTP status code, HTTP response headers (array of strings)

updateCustomerWithHttpInfo()

Operation updateCustomerWithHttpInfo


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

Update Customer

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)
$update_customer_request : UpdateCustomerRequest: JSON containing all the attributes of the customer 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\CustomerResponse, HTTP status code, HTTP response headers (array of strings)

createCustomerRequest()

Create request for operation 'createCustomer'


    protected
                createCustomerRequest(string $channel, string $client_key, string $product, string $timestamp, string $idempotent_request_key, string $requestor_type, CreateCustomerRequest $create_customer_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)
$create_customer_request : CreateCustomerRequest: The JSON that contains all the attributes of customer to be created. (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

getCustomerRequest()

Create request for operation 'getCustomer'


    protected
                getCustomerRequest(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 ]) : 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)

Tags

Return values

array<string|int, mixed> —

retrieveCustomersPageRequest()

Create request for operation 'retrieveCustomersPage'


    protected
                retrieveCustomersPageRequest(string $channel, string $client_key, string $product, string $timestamp, string $idempotent_request_key, string $requestor_type, 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)
$query_id : string: query id of the Retrieve/Search Customers 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> —

retrieveCustomersRequest()

Create request for operation 'retrieveCustomers'


    protected
                retrieveCustomersRequest(string $channel, string $client_key, string $product, string $timestamp, string $idempotent_request_key, string $requestor_type[, string $requestor = null ][, string $x_opay_headers = null ][, string $trace_id = null ][, string $page_size = null ][, string $customer_reference = null ][, string $ssn = null ][, string $email = null ][, string $account_number = 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)
$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)
$customer_reference : string = null: Unique ID assigned by the biller/client system for a given customer. (optional)
$ssn : string = null: The SSN of the customer if the account holder is an individual or the tax ID, if the customer is a business. (optional)
$email : string = null: This field contains the customer’s email address within EBPP. (optional)
$account_number : string = null: Customer Account Number of the customer to get details of. (optional)

Tags

Return values

array<string|int, mixed> —

updateCustomerRequest()

Create request for operation 'updateCustomer'


    protected
                updateCustomerRequest(string $channel, string $client_key, string $product, string $timestamp, string $idempotent_request_key, string $requestor_type, string $id_customer, UpdateCustomerRequest $update_customer_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)
$update_customer_request : UpdateCustomerRequest: JSON containing all the attributes of the customer 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> —

CustomerApi in package Orbipay PaymentsApi Client Api

Tags

Table of Contents

Properties

$client

$config

$headerSelector

Methods

__construct()

Parameters

Return values

createCustomer()

Parameters

Tags

Return values

createCustomerWithHttpInfo()

Parameters

Tags

Return values

getConfig()

Return values

getCustomer()

Parameters

Tags

Return values

getCustomerWithHttpInfo()

Parameters

Tags

Return values

retrieveCustomers()

Parameters

Tags

Return values

retrieveCustomersPage()

Parameters

Tags

Return values

retrieveCustomersPageWithHttpInfo()

Parameters

Tags

Return values

retrieveCustomersWithHttpInfo()

Parameters

Tags

Return values

updateCustomer()

Parameters

Tags

Return values

updateCustomerWithHttpInfo()

Parameters

Tags

Return values

createCustomerRequest()

Parameters

Tags

Return values

createHttpClientOption()

Tags

Return values

getCustomerRequest()

Parameters

Tags

Return values

retrieveCustomersPageRequest()

Parameters

Tags

Return values

retrieveCustomersRequest()

Parameters

Tags

Return values

updateCustomerRequest()

Parameters

Tags

Return values

CustomerApi
in package

Orbipay

PaymentsApi

Client

Api