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 —

createRefund()

Operation createRefund


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

Create Refund

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 : string: The unique identifier assigned by EBPP to the payment. (required)
$id_customer : string: The unique identifier assigned by EBPP to the customer. (required)
$create_refund_request : CreateRefundRequest: JSON containing all the fields required to refund a payment. (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\RefundResponse, HTTP status code, HTTP response headers (array of strings)

createRefundWithHttpInfo()

Operation createRefundWithHttpInfo


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

Create Refund

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 : string: The unique identifier assigned by EBPP to the payment. (required)
$id_customer : string: The unique identifier assigned by EBPP to the customer. (required)
$create_refund_request : CreateRefundRequest: JSON containing all the fields required to refund a payment. (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\RefundResponse, HTTP status code, HTTP response headers (array of strings)

getConfig()


    public
                getConfig() : Configuration

Return values

Configuration —

getRefund()

Operation getRefund


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

Get Refund

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

getRefundWithHttpInfo()

Operation getRefundWithHttpInfo


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

Get Refund

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

retrieveRefunds()

Operation retrieveRefunds


    public
                retrieveRefunds(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 $confirmation_number = null ][, array<string|int, string> $status = 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 Refunds

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)
$id_customer : string = null: The unique identifier assigned by EBPP to the customer. (optional)
$confirmation_number : string = null: The confirmation number provided to the customer for the refund or for the corresponding successful payment. (optional)
$status : array<string|int, string> = null: The status of the refund. This can take multiple values in the format key=value1&key=value2.... (optional)
$from_date : string = null: The date from which refunds, matching the criteria specified, need to be retrieved. (optional)
$to_date : string = null: The date upto which refunds, 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\RefundsResponse, HTTP status code, HTTP response headers (array of strings)

retrieveRefundsWithHttpInfo()

Operation retrieveRefundsWithHttpInfo


    public
                retrieveRefundsWithHttpInfo(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 $confirmation_number = null ][, array<string|int, string> $status = 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 Refunds

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)
$id_customer : string = null: The unique identifier assigned by EBPP to the customer. (optional)
$confirmation_number : string = null: The confirmation number provided to the customer for the refund or for the corresponding successful payment. (optional)
$status : array<string|int, string> = null: The status of the refund. This can take multiple values in the format key=value1&key=value2.... (optional)
$from_date : string = null: The date from which refunds, matching the criteria specified, need to be retrieved. (optional)
$to_date : string = null: The date upto which refunds, 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\RefundsResponse, 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

createRefundRequest()

Create request for operation 'createRefund'


    protected
                createRefundRequest(string $channel, string $client_key, string $product, string $timestamp, string $idempotent_request_key, string $requestor_type, string $id_payment, string $id_customer, CreateRefundRequest $create_refund_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 : string: The unique identifier assigned by EBPP to the payment. (required)
$id_customer : string: The unique identifier assigned by EBPP to the customer. (required)
$create_refund_request : CreateRefundRequest: JSON containing all the fields required to refund a payment. (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> —

getRefundRequest()

Create request for operation 'getRefund'


    protected
                getRefundRequest(string $channel, string $client_key, string $product, string $timestamp, string $idempotent_request_key, string $requestor_type, string $id_refund, 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_refund : string: The unique identifier assigned by EBPP to the refund. (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> —

retrieveRefundsRequest()

Create request for operation 'retrieveRefunds'


    protected
                retrieveRefundsRequest(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 $confirmation_number = null ][, array<string|int, string> $status = 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. 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)
$id_customer : string = null: The unique identifier assigned by EBPP to the customer. (optional)
$confirmation_number : string = null: The confirmation number provided to the customer for the refund or for the corresponding successful payment. (optional)
$status : array<string|int, string> = null: The status of the refund. This can take multiple values in the format key=value1&key=value2.... (optional)
$from_date : string = null: The date from which refunds, matching the criteria specified, need to be retrieved. (optional)
$to_date : string = null: The date upto which refunds, 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> —

RefundApi in package Orbipay PaymentsApi Client Api

Tags

Table of Contents

Properties

$client

$config

$headerSelector

Methods

__construct()

Parameters

Return values

createRefund()

Parameters

Tags

Return values

createRefundWithHttpInfo()

Parameters

Tags

Return values

getConfig()

Return values

getRefund()

Parameters

Tags

Return values

getRefundWithHttpInfo()

Parameters

Tags

Return values

retrieveRefunds()

Parameters

Tags

Return values

retrieveRefundsWithHttpInfo()

Parameters

Tags

Return values

createHttpClientOption()

Tags

Return values

createRefundRequest()

Parameters

Tags

Return values

getRefundRequest()

Parameters

Tags

Return values

retrieveRefundsRequest()

Parameters

Tags

Return values

RefundApi
in package

Orbipay

PaymentsApi

Client

Api