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 —

createRecurringPaymentSetup()

Operation createRecurringPaymentSetup


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

Create Payment Setup

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)
$create_payment_setup_request : CreatePaymentSetupRequest: JSON containing all the fields required to create a recurring payment setup. (required)
$requestor : string = null: The identifier for the requestor of the API. (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\PaymentSetupResponse, HTTP status code, HTTP response headers (array of strings)

createRecurringPaymentSetupWithHttpInfo()

Operation createRecurringPaymentSetupWithHttpInfo


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

Create Payment Setup

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)
$create_payment_setup_request : CreatePaymentSetupRequest: JSON containing all the fields required to create a recurring payment setup. (required)
$requestor : string = null: The identifier for the requestor of the API. (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\PaymentSetupResponse, HTTP status code, HTTP response headers (array of strings)

deletePaymentSetup()

Operation deletePaymentSetup


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

Delete Payment Setup

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_payment_setup : string: The unique identifier assigned by EBPP to the payment setup. (required)
$id_customer : string: The unique identifier assigned by EBPP to the customer. (required)
$delete_payment_setup_request : DeletePaymentSetupRequest: JSON containing all the fields required to delete a payment. Setup. (required)
$requestor : string = null: The identifier for the requestor of the API. (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)

deletePaymentSetupWithHttpInfo()

Operation deletePaymentSetupWithHttpInfo


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

Delete Payment Setup

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_payment_setup : string: The unique identifier assigned by EBPP to the payment setup. (required)
$id_customer : string: The unique identifier assigned by EBPP to the customer. (required)
$delete_payment_setup_request : DeletePaymentSetupRequest: JSON containing all the fields required to delete a payment. Setup. (required)
$requestor : string = null: The identifier for the requestor of the API. (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 —

getPaymentSetup()

Operation getPaymentSetup


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

Get Payment Setup

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_payment_setup : string: The unique identifier assigned by EBPP to the payment setup. (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. (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\PaymentSetupResponse, HTTP status code, HTTP response headers (array of strings)

getPaymentSetupWithHttpInfo()

Operation getPaymentSetupWithHttpInfo


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

Get Payment Setup

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_payment_setup : string: The unique identifier assigned by EBPP to the payment setup. (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. (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\PaymentSetupResponse, HTTP status code, HTTP response headers (array of strings)

retrievePaymentSetups()

Operation retrievePaymentSetups


    public
                retrievePaymentSetups(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 $id_customer = null ][, string $id_funding_account = null ][, string $id_customer_account = null ][, string $confirmation_number = null ][, array<string|int, string> $status = null ][, array<string|int, string> $payment_setup_schedule_type = null ][, string $from_date = null ][, string $to_date = null ][, string $page_size = null ][, string $query_id = null ][, string $from_index = null ][, string $to_index = null ]) : array<string|int, mixed>

Retrieve Payment Setups

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. (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)
$id_customer : string = null: The unique identifier assigned by EBPP to the customer. (optional)
$id_funding_account : string = null: The unique identifier assigned by EBPP to the funding account (optional)
$id_customer_account : string = null: The unique identifier assigned by EBPP to the customer account (optional)
$confirmation_number : string = null: The confirmation number or reference provided to the customer for the successful payment. (optional)
$status : array<string|int, string> = null: The status of the payment. This can take multiple values in the format key=value1&key=value2.... (optional)
$payment_setup_schedule_type : array<string|int, string> = null: The schedule type for the payment setup. This can take multiple values in the format key=value1&key=value2.... (optional)
$from_date : string = null: The date from which recurring payments setup, matching the criteria specified, need to be retrieved. (optional)
$to_date : string = null: The date upto which recurring payments setup, matching the criteria specified, need to be retrieved. (optional)
$page_size : string = null: The maximum number of objects returned in the query. (optional)
$query_id : string = null: query id of the Retrieve/Search Customers lookup. (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\PaymentSetupsResponse, HTTP status code, HTTP response headers (array of strings)

retrievePaymentSetupsWithHttpInfo()

Operation retrievePaymentSetupsWithHttpInfo


    public
                retrievePaymentSetupsWithHttpInfo(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 $id_customer = null ][, string $id_funding_account = null ][, string $id_customer_account = null ][, string $confirmation_number = null ][, array<string|int, string> $status = null ][, array<string|int, string> $payment_setup_schedule_type = null ][, string $from_date = null ][, string $to_date = null ][, string $page_size = null ][, string $query_id = null ][, string $from_index = null ][, string $to_index = null ]) : array<string|int, mixed>

Retrieve Payment Setups

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. (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)
$id_customer : string = null: The unique identifier assigned by EBPP to the customer. (optional)
$id_funding_account : string = null: The unique identifier assigned by EBPP to the funding account (optional)
$id_customer_account : string = null: The unique identifier assigned by EBPP to the customer account (optional)
$confirmation_number : string = null: The confirmation number or reference provided to the customer for the successful payment. (optional)
$status : array<string|int, string> = null: The status of the payment. This can take multiple values in the format key=value1&key=value2.... (optional)
$payment_setup_schedule_type : array<string|int, string> = null: The schedule type for the payment setup. This can take multiple values in the format key=value1&key=value2.... (optional)
$from_date : string = null: The date from which recurring payments setup, matching the criteria specified, need to be retrieved. (optional)
$to_date : string = null: The date upto which recurring payments setup, matching the criteria specified, need to be retrieved. (optional)
$page_size : string = null: The maximum number of objects returned in the query. (optional)
$query_id : string = null: query id of the Retrieve/Search Customers lookup. (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\PaymentSetupsResponse, HTTP status code, HTTP response headers (array of strings)

updatePaymentSetup()

Operation updatePaymentSetup


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

Update Payment Setup

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_payment_setup : string: The unique identifier assigned by EBPP to the payment setup. (required)
$id_customer : string: The unique identifier assigned by EBPP to the customer. (required)
$update_payment_setup_request : UpdatePaymentSetupRequest: Details of the Payment Setup to be updated. (required)
$requestor : string = null: The identifier for the requestor of the API. (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\PaymentSetupResponse, HTTP status code, HTTP response headers (array of strings)

updatePaymentSetupWithHttpInfo()

Operation updatePaymentSetupWithHttpInfo


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

Update Payment Setup

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_payment_setup : string: The unique identifier assigned by EBPP to the payment setup. (required)
$id_customer : string: The unique identifier assigned by EBPP to the customer. (required)
$update_payment_setup_request : UpdatePaymentSetupRequest: Details of the Payment Setup to be updated. (required)
$requestor : string = null: The identifier for the requestor of the API. (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\PaymentSetupResponse, 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

createRecurringPaymentSetupRequest()

Create request for operation 'createRecurringPaymentSetup'


    protected
                createRecurringPaymentSetupRequest(string $channel, string $client_key, string $product, string $timestamp, string $idempotent_request_key, string $requestor_type, string $id_customer, CreatePaymentSetupRequest $create_payment_setup_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)
$create_payment_setup_request : CreatePaymentSetupRequest: JSON containing all the fields required to create a recurring payment setup. (required)
$requestor : string = null: The identifier for the requestor of the API. (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> —

deletePaymentSetupRequest()

Create request for operation 'deletePaymentSetup'


    protected
                deletePaymentSetupRequest(string $channel, string $client_key, string $product, string $timestamp, string $idempotent_request_key, string $requestor_type, string $id_payment_setup, string $id_customer, DeletePaymentSetupRequest $delete_payment_setup_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_payment_setup : string: The unique identifier assigned by EBPP to the payment setup. (required)
$id_customer : string: The unique identifier assigned by EBPP to the customer. (required)
$delete_payment_setup_request : DeletePaymentSetupRequest: JSON containing all the fields required to delete a payment. Setup. (required)
$requestor : string = null: The identifier for the requestor of the API. (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> —

getPaymentSetupRequest()

Create request for operation 'getPaymentSetup'


    protected
                getPaymentSetupRequest(string $channel, string $client_key, string $product, string $timestamp, string $idempotent_request_key, string $requestor_type, string $id_payment_setup, 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_payment_setup : string: The unique identifier assigned by EBPP to the payment setup. (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. (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> —

retrievePaymentSetupsRequest()

Create request for operation 'retrievePaymentSetups'


    protected
                retrievePaymentSetupsRequest(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 $id_customer = null ][, string $id_funding_account = null ][, string $id_customer_account = null ][, string $confirmation_number = null ][, array<string|int, string> $status = null ][, array<string|int, string> $payment_setup_schedule_type = null ][, string $from_date = null ][, string $to_date = null ][, string $page_size = null ][, string $query_id = 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)
$requestor : string = null: The identifier for the requestor of the API. (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)
$id_customer : string = null: The unique identifier assigned by EBPP to the customer. (optional)
$id_funding_account : string = null: The unique identifier assigned by EBPP to the funding account (optional)
$id_customer_account : string = null: The unique identifier assigned by EBPP to the customer account (optional)
$confirmation_number : string = null: The confirmation number or reference provided to the customer for the successful payment. (optional)
$status : array<string|int, string> = null: The status of the payment. This can take multiple values in the format key=value1&key=value2.... (optional)
$payment_setup_schedule_type : array<string|int, string> = null: The schedule type for the payment setup. This can take multiple values in the format key=value1&key=value2.... (optional)
$from_date : string = null: The date from which recurring payments setup, matching the criteria specified, need to be retrieved. (optional)
$to_date : string = null: The date upto which recurring payments setup, matching the criteria specified, need to be retrieved. (optional)
$page_size : string = null: The maximum number of objects returned in the query. (optional)
$query_id : string = null: query id of the Retrieve/Search Customers lookup. (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> —

updatePaymentSetupRequest()

Create request for operation 'updatePaymentSetup'


    protected
                updatePaymentSetupRequest(string $channel, string $client_key, string $product, string $timestamp, string $idempotent_request_key, string $requestor_type, string $id_payment_setup, string $id_customer, UpdatePaymentSetupRequest $update_payment_setup_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_payment_setup : string: The unique identifier assigned by EBPP to the payment setup. (required)
$id_customer : string: The unique identifier assigned by EBPP to the customer. (required)
$update_payment_setup_request : UpdatePaymentSetupRequest: Details of the Payment Setup to be updated. (required)
$requestor : string = null: The identifier for the requestor of the API. (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> —

PaymentSetupApi in package Orbipay PaymentsApi Client Api

Tags

Table of Contents

Properties

$client

$config

$headerSelector

Methods

__construct()

Parameters

Return values

createRecurringPaymentSetup()

Parameters

Tags

Return values

createRecurringPaymentSetupWithHttpInfo()

Parameters

Tags

Return values

deletePaymentSetup()

Parameters

Tags

Return values

deletePaymentSetupWithHttpInfo()

Parameters

Tags

Return values

getConfig()

Return values

getPaymentSetup()

Parameters

Tags

Return values

getPaymentSetupWithHttpInfo()

Parameters

Tags

Return values

retrievePaymentSetups()

Parameters

Tags

Return values

retrievePaymentSetupsWithHttpInfo()

Parameters

Tags

Return values

updatePaymentSetup()

Parameters

Tags

Return values

updatePaymentSetupWithHttpInfo()

Parameters

Tags

Return values

createHttpClientOption()

Tags

Return values

createRecurringPaymentSetupRequest()

Parameters

Tags

Return values

deletePaymentSetupRequest()

Parameters

Tags

Return values

getPaymentSetupRequest()

Parameters

Tags

Return values

retrievePaymentSetupsRequest()

Parameters

Tags

Return values

updatePaymentSetupRequest()

Parameters

Tags

Return values

PaymentSetupApi
in package

Orbipay

PaymentsApi

Client

Api