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 —

createPayment()

Operation createPayment


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

Create 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_customer : string: The unique identifier assigned by EBPP to the customer. (required)
$create_payment_request : CreatePaymentRequest: 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\PaymentResponse, HTTP status code, HTTP response headers (array of strings)

createPaymentWithHttpInfo()

Operation createPaymentWithHttpInfo


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

Create 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_customer : string: The unique identifier assigned by EBPP to the customer. (required)
$create_payment_request : CreatePaymentRequest: 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\PaymentResponse, HTTP status code, HTTP response headers (array of strings)

deletePayment()

Operation deletePayment


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

Delete 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)
$id_customer : string: The unique identifier assigned by EBPP to the customer. (required)
$delete_payment_request : DeletePaymentRequest: Details of payment to be deleted/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 \Orbipay\PaymentsApi\Client\Model\DeleteResponse, HTTP status code, HTTP response headers (array of strings)

deletePaymentWithHttpInfo()

Operation deletePaymentWithHttpInfo


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

Delete 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)
$id_customer : string: The unique identifier assigned by EBPP to the customer. (required)
$delete_payment_request : DeletePaymentRequest: Details of payment to be deleted/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 \Orbipay\PaymentsApi\Client\Model\DeleteResponse, HTTP status code, HTTP response headers (array of strings)

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 ][, string $trace_id = 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. (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)

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 ][, string $trace_id = 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. (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)

getConfig()


    public
                getConfig() : Configuration

Return values

Configuration —

getPayment()

Operation getPayment


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

Get 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)
$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\PaymentResponse, HTTP status code, HTTP response headers (array of strings)

getPaymentWithHttpInfo()

Operation getPaymentWithHttpInfo


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

Get 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)
$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\PaymentResponse, 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 ][, string $trace_id = 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. (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\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 ][, string $trace_id = 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. (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\RecordedPaymentResponse, HTTP status code, HTTP response headers (array of strings)

retrieveFeePayment()

Operation retrieveFeePayment


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

Get Fee Payment

Parameters

$channel : string: The channel through which the API is invoked. (required)
$client_key : string: The unique identifier assigned by OrbiPay 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_fee : string: The unique identifier assigned by OrbiPay to the FeePayment. (required)
$id_customer : string: The unique identifier assigned by OrbiPay 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\PaymentResponse, HTTP status code, HTTP response headers (array of strings)

retrieveFeePaymentWithHttpInfo()

Operation retrieveFeePaymentWithHttpInfo


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

Get Fee Payment

Parameters

$channel : string: The channel through which the API is invoked. (required)
$client_key : string: The unique identifier assigned by OrbiPay 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_fee : string: The unique identifier assigned by OrbiPay to the FeePayment. (required)
$id_customer : string: The unique identifier assigned by OrbiPay 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\PaymentResponse, HTTP status code, HTTP response headers (array of strings)

retrievePayments()

Operation retrievePayments


    public
                retrievePayments(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_schedule_type = null ][, array<string|int, string> $payment_method = 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 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)
$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_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)
$payment_method : array<string|int, string> = null: The fulfillment method for the payment. (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 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\PaymentsResponse, HTTP status code, HTTP response headers (array of strings)

retrievePaymentsWithHttpInfo()

Operation retrievePaymentsWithHttpInfo


    public
                retrievePaymentsWithHttpInfo(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_schedule_type = null ][, array<string|int, string> $payment_method = 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 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)
$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_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)
$payment_method : array<string|int, string> = null: The fulfillment method for the payment. (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 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\PaymentsResponse, HTTP status code, HTTP response headers (array of strings)

simplePayment()

Operation simplePayment


    public
                simplePayment(string $channel, string $client_key, string $product, string $timestamp, string $idempotent_request_key, string $requestor_type, SimplePaymentRequest $simple_payment_request[, string $requestor = null ][, string $x_opay_headers = null ][, string $trace_id = null ][, string $save_funding_account = null ]) : array<string|int, mixed>

Simple 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)
$simple_payment_request : SimplePaymentRequest: 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)
$save_funding_account : string = null: query param (optional)

Tags

Return values

array<string|int, mixed> —

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

simplePaymentWithHttpInfo()

Operation simplePaymentWithHttpInfo


    public
                simplePaymentWithHttpInfo(string $channel, string $client_key, string $product, string $timestamp, string $idempotent_request_key, string $requestor_type, SimplePaymentRequest $simple_payment_request[, string $requestor = null ][, string $x_opay_headers = null ][, string $trace_id = null ][, string $save_funding_account = null ]) : array<string|int, mixed>

Simple 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)
$simple_payment_request : SimplePaymentRequest: 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)
$save_funding_account : string = null: query param (optional)

Tags

Return values

array<string|int, mixed> —

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

updatePayment()

Operation updatePayment


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

Update 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)
$id_customer : string: The unique identifier assigned by EBPP to the customer. (required)
$update_payment_request : UpdatePaymentRequest: Details of the Payment 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\PaymentResponse, HTTP status code, HTTP response headers (array of strings)

updatePaymentWithHttpInfo()

Operation updatePaymentWithHttpInfo


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

Update 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)
$id_customer : string: The unique identifier assigned by EBPP to the customer. (required)
$update_payment_request : UpdatePaymentRequest: Details of the Payment 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\PaymentResponse, 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

createPaymentRequest()

Create request for operation 'createPayment'


    protected
                createPaymentRequest(string $channel, string $client_key, string $product, string $timestamp, string $idempotent_request_key, string $requestor_type, string $id_customer, CreatePaymentRequest $create_payment_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_request : CreatePaymentRequest: 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> —

deletePaymentRequest()

Create request for operation 'deletePayment'


    protected
                deletePaymentRequest(string $channel, string $client_key, string $product, string $timestamp, string $idempotent_request_key, string $requestor_type, string $id_payment, string $id_customer, DeletePaymentRequest $delete_payment_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)
$delete_payment_request : DeletePaymentRequest: Details of payment to be deleted/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> —

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 ][, 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)
$delete_recorded_payment_request : DeleteRecordedPaymentRequest: Details of payment to be deleted/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> —

getPaymentRequest()

Create request for operation 'getPayment'


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

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 ][, 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)
$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. (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> —

retrieveFeePaymentRequest()

Create request for operation 'retrieveFeePayment'


    protected
                retrieveFeePaymentRequest(string $channel, string $client_key, string $product, string $timestamp, string $idempotent_request_key, string $requestor_type, string $id_fee, 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 OrbiPay 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_fee : string: The unique identifier assigned by OrbiPay to the FeePayment. (required)
$id_customer : string: The unique identifier assigned by OrbiPay 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> —

retrievePaymentsRequest()

Create request for operation 'retrievePayments'


    protected
                retrievePaymentsRequest(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_schedule_type = null ][, array<string|int, string> $payment_method = 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_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)
$payment_method : array<string|int, string> = null: The fulfillment method for the payment. (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 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> —

simplePaymentRequest()

Create request for operation 'simplePayment'


    protected
                simplePaymentRequest(string $channel, string $client_key, string $product, string $timestamp, string $idempotent_request_key, string $requestor_type, SimplePaymentRequest $simple_payment_request[, string $requestor = null ][, string $x_opay_headers = null ][, string $trace_id = null ][, string $save_funding_account = 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)
$simple_payment_request : SimplePaymentRequest: 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)
$save_funding_account : string = null: query param (optional)

Tags

Return values

array<string|int, mixed> —

updatePaymentRequest()

Create request for operation 'updatePayment'


    protected
                updatePaymentRequest(string $channel, string $client_key, string $product, string $timestamp, string $idempotent_request_key, string $requestor_type, string $id_payment, string $id_customer, UpdatePaymentRequest $update_payment_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)
$update_payment_request : UpdatePaymentRequest: Details of the Payment 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> —

PaymentApi in package Orbipay PaymentsApi Client Api

Tags

Table of Contents

Properties

$client

$config

$headerSelector

Methods

__construct()

Parameters

Return values

createPayment()

Parameters

Tags

Return values

createPaymentWithHttpInfo()

Parameters

Tags

Return values

deletePayment()

Parameters

Tags

Return values

deletePaymentWithHttpInfo()

Parameters

Tags

Return values

deleteRecordPayment()

Parameters

Tags

Return values

deleteRecordPaymentWithHttpInfo()

Parameters

Tags

Return values

getConfig()

Return values

getPayment()

Parameters

Tags

Return values

getPaymentWithHttpInfo()

Parameters

Tags

Return values

recordPayment()

Parameters

Tags

Return values

recordPaymentWithHttpInfo()

Parameters

Tags

Return values

retrieveFeePayment()

Parameters

Tags

Return values

retrieveFeePaymentWithHttpInfo()

Parameters

Tags

Return values

retrievePayments()

Parameters

Tags

Return values

retrievePaymentsWithHttpInfo()

Parameters

Tags

Return values

simplePayment()

Parameters

Tags

Return values

simplePaymentWithHttpInfo()

Parameters

Tags

Return values

updatePayment()

Parameters

Tags

PaymentApi
in package

Orbipay

PaymentsApi

Client

Api