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 —

cancelPaymentAuthorization()

Operation cancelPaymentAuthorization


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

Cancel Payment Authorization

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)
$id_authorization : string: The unique identifier assigned by EBPP to the payment authorization. (required)
$cancel_payment_authorization_request : CancelPaymentAuthorizationRequest: Details of payment authorization to be cancelled (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 void, HTTP status code, HTTP response headers (array of strings)

cancelPaymentAuthorizationWithHttpInfo()

Operation cancelPaymentAuthorizationWithHttpInfo


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

Cancel Payment Authorization

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)
$id_authorization : string: The unique identifier assigned by EBPP to the payment authorization. (required)
$cancel_payment_authorization_request : CancelPaymentAuthorizationRequest: Details of payment authorization to be cancelled (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 null, HTTP status code, HTTP response headers (array of strings)

createPaymentAuthorization()

Operation createPaymentAuthorization


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

Create Payment Authorization

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_payment_authorization_request : CreatePaymentAuthorizationRequest: JSON containing all the fields required to make a payment. (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\PaymentAuthorizationResponse, HTTP status code, HTTP response headers (array of strings)

createPaymentAuthorizationWithHttpInfo()

Operation createPaymentAuthorizationWithHttpInfo


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

Create Payment Authorization

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_payment_authorization_request : CreatePaymentAuthorizationRequest: JSON containing all the fields required to make a payment. (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\PaymentAuthorizationResponse, HTTP status code, HTTP response headers (array of strings)

getConfig()


    public
                getConfig() : Configuration

Return values

Configuration —

cancelPaymentAuthorizationRequest()

Create request for operation 'cancelPaymentAuthorization'


    protected
                cancelPaymentAuthorizationRequest(string $channel, string $client_key, string $product, string $timestamp, string $idempotent_request_key, string $requestor_type, string $id_customer, string $id_authorization, CancelPaymentAuthorizationRequest $cancel_payment_authorization_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)
$id_authorization : string: The unique identifier assigned by EBPP to the payment authorization. (required)
$cancel_payment_authorization_request : CancelPaymentAuthorizationRequest: Details of payment authorization to be cancelled (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> —

createHttpClientOption()

Create http client option


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

Tags

Return values

array<string|int, mixed> —

of http client options

createPaymentAuthorizationRequest()

Create request for operation 'createPaymentAuthorization'


    protected
                createPaymentAuthorizationRequest(string $channel, string $client_key, string $product, string $timestamp, string $idempotent_request_key, string $requestor_type, CreatePaymentAuthorizationRequest $create_payment_authorization_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_payment_authorization_request : CreatePaymentAuthorizationRequest: JSON containing all the fields required to make a payment. (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> —

PaymentAuthorizationApi in package Orbipay PaymentsApi Client Api

Tags

Table of Contents

Properties

$client

$config

$headerSelector

Methods

__construct()

Parameters

Return values

cancelPaymentAuthorization()

Parameters

Tags

Return values

cancelPaymentAuthorizationWithHttpInfo()

Parameters

Tags

Return values

createPaymentAuthorization()

Parameters

Tags

Return values

createPaymentAuthorizationWithHttpInfo()

Parameters

Tags

Return values

getConfig()

Return values

cancelPaymentAuthorizationRequest()

Parameters

Tags

Return values

createHttpClientOption()

Tags

Return values

createPaymentAuthorizationRequest()

Parameters

Tags

Return values

PaymentAuthorizationApi
in package

Orbipay

PaymentsApi

Client

Api