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 —

deleteRecordPayment()

Operation deleteRecordPayment


    public
                deleteRecordPayment(string $channel, string $client_key, string $product, string $timestamp, string $idempotent_request_key, string $requestor_type, string $id_payment, DeleteRecordedPaymentRequest $delete_recorded_payment_request[, string $requestor = null ][, string $x_opay_headers = null ]) : array<string|int, mixed>

Delete Recorded Payment

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)
$delete_recorded_payment_request : DeleteRecordedPaymentRequest: Details of payment to be deleted/cancelled (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)

Tags

Return values

array<string|int, mixed> —

of void, HTTP status code, HTTP response headers (array of strings)

deleteRecordPaymentWithHttpInfo()

Operation deleteRecordPaymentWithHttpInfo


    public
                deleteRecordPaymentWithHttpInfo(string $channel, string $client_key, string $product, string $timestamp, string $idempotent_request_key, string $requestor_type, string $id_payment, DeleteRecordedPaymentRequest $delete_recorded_payment_request[, string $requestor = null ][, string $x_opay_headers = null ]) : array<string|int, mixed>

Delete Recorded Payment

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)
$delete_recorded_payment_request : DeleteRecordedPaymentRequest: Details of payment to be deleted/cancelled (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)

Tags

Return values

array<string|int, mixed> —

of null, HTTP status code, HTTP response headers (array of strings)

getConfig()


    public
                getConfig() : Configuration

Return values

Configuration —

getRecordPayment()

Operation getRecordPayment


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

Get Recorded Payment

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)
$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)

Tags

Return values

array<string|int, mixed> —

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

getRecordPaymentWithHttpInfo()

Operation getRecordPaymentWithHttpInfo


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

Get Recorded Payment

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)
$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)

Tags

Return values

array<string|int, mixed> —

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

recordPayment()

Operation recordPayment


    public
                recordPayment(string $channel, string $client_key, string $product, string $timestamp, string $idempotent_request_key, string $requestor_type, RecordPaymentRequest $record_payment_request[, string $requestor = null ][, string $x_opay_headers = null ]) : array<string|int, mixed>

Record Payment

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)
$record_payment_request : RecordPaymentRequest: JSON containing all the fields required to record 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)

Tags

Return values

array<string|int, mixed> —

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

recordPaymentWithHttpInfo()

Operation recordPaymentWithHttpInfo


    public
                recordPaymentWithHttpInfo(string $channel, string $client_key, string $product, string $timestamp, string $idempotent_request_key, string $requestor_type, RecordPaymentRequest $record_payment_request[, string $requestor = null ][, string $x_opay_headers = null ]) : array<string|int, mixed>

Record Payment

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)
$record_payment_request : RecordPaymentRequest: JSON containing all the fields required to record 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)

Tags

Return values

array<string|int, mixed> —

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

retrieveRecordPayments()

Operation retrieveRecordPayments


    public
                retrieveRecordPayments(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 $id_customer_account = null ][, string $confirmation_number = null ][, array<string|int, string> $payment_method = 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 Recorded Payments

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)
$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)
$payment_method : array<string|int, string> = null: The non fulfillment method for the payment. This can take multiple values in the format key=value1&key=value2.... (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)
$from_date : string = null: The date from which payments, matching the criteria specified, need to be retrieved. (optional)
$to_date : string = null: The date upto which payments, 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 Payments 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\RecordedPaymentsResponse, HTTP status code, HTTP response headers (array of strings)

retrieveRecordPaymentsWithHttpInfo()

Operation retrieveRecordPaymentsWithHttpInfo


    public
                retrieveRecordPaymentsWithHttpInfo(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 $id_customer_account = null ][, string $confirmation_number = null ][, array<string|int, string> $payment_method = 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 Recorded Payments

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)
$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)
$payment_method : array<string|int, string> = null: The non fulfillment method for the payment. This can take multiple values in the format key=value1&key=value2.... (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)
$from_date : string = null: The date from which payments, matching the criteria specified, need to be retrieved. (optional)
$to_date : string = null: The date upto which payments, 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 Payments 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\RecordedPaymentsResponse, 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

deleteRecordPaymentRequest()

Create request for operation 'deleteRecordPayment'


    protected
                deleteRecordPaymentRequest(string $channel, string $client_key, string $product, string $timestamp, string $idempotent_request_key, string $requestor_type, string $id_payment, DeleteRecordedPaymentRequest $delete_recorded_payment_request[, string $requestor = null ][, string $x_opay_headers = 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)
$delete_recorded_payment_request : DeleteRecordedPaymentRequest: Details of payment to be deleted/cancelled (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)

Tags

Return values

array<string|int, mixed> —

getRecordPaymentRequest()

Create request for operation 'getRecordPayment'


    protected
                getRecordPaymentRequest(string $channel, string $client_key, string $product, string $timestamp, string $idempotent_request_key, string $requestor_type, string $id_payment[, string $requestor = null ][, string $x_opay_headers = 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)
$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)

Tags

Return values

array<string|int, mixed> —

recordPaymentRequest()

Create request for operation 'recordPayment'


    protected
                recordPaymentRequest(string $channel, string $client_key, string $product, string $timestamp, string $idempotent_request_key, string $requestor_type, RecordPaymentRequest $record_payment_request[, string $requestor = null ][, string $x_opay_headers = 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)
$record_payment_request : RecordPaymentRequest: JSON containing all the fields required to record 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)

Tags

Return values

array<string|int, mixed> —

retrieveRecordPaymentsRequest()

Create request for operation 'retrieveRecordPayments'


    protected
                retrieveRecordPaymentsRequest(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 $id_customer_account = null ][, string $confirmation_number = null ][, array<string|int, string> $payment_method = 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)
$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)
$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)
$payment_method : array<string|int, string> = null: The non fulfillment method for the payment. This can take multiple values in the format key=value1&key=value2.... (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)
$from_date : string = null: The date from which payments, matching the criteria specified, need to be retrieved. (optional)
$to_date : string = null: The date upto which payments, 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 Payments 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> —

RecordedPaymentApi in package Orbipay PaymentsApi Client Api

Tags

Table of Contents

Properties

$client

$config

$headerSelector

Methods

__construct()

Parameters

Return values

deleteRecordPayment()

Parameters

Tags

Return values

deleteRecordPaymentWithHttpInfo()

Parameters

Tags

Return values

getConfig()

Return values

getRecordPayment()

Parameters

Tags

Return values

getRecordPaymentWithHttpInfo()

Parameters

Tags

Return values

recordPayment()

Parameters

Tags

Return values

recordPaymentWithHttpInfo()

Parameters

Tags

Return values

retrieveRecordPayments()

Parameters

Tags

Return values

retrieveRecordPaymentsWithHttpInfo()

Parameters

Tags

Return values

createHttpClientOption()

Tags

Return values

deleteRecordPaymentRequest()

Parameters

Tags

Return values

getRecordPaymentRequest()

Parameters

Tags

Return values

recordPaymentRequest()

Parameters

Tags

Return values

retrieveRecordPaymentsRequest()

Parameters

Tags

Return values

RecordedPaymentApi
in package

Orbipay

PaymentsApi

Client

Api