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 —

getConfig()


    public
                getConfig() : Configuration

Return values

Configuration —

managePBTEnrollment()

Operation managePBTEnrollment


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

Manage PBT Enrollment

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: The identifier for the requestor of the API. (required)
$manage_pbt_request : ManagePBTRequest: JSON containing all the fields required to manage a customer for PBT enrollment. (required)
$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\PBTEnrollmentResponse, HTTP status code, HTTP response headers (array of strings)

managePBTEnrollmentWithHttpInfo()

Operation managePBTEnrollmentWithHttpInfo


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

Manage PBT Enrollment

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: The identifier for the requestor of the API. (required)
$manage_pbt_request : ManagePBTRequest: JSON containing all the fields required to manage a customer for PBT enrollment. (required)
$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\PBTEnrollmentResponse, HTTP status code, HTTP response headers (array of strings)

retrievePBTs()

Operation retrievePBTs


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

Retrieve PBT Enrollments

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: The identifier for the requestor of the API. (required)
$id_customer : string: The unique identifier assigned by EBPP to the customer. (required)
$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_account : string = null: The unique identifier assigned by EBPP to the customer account (optional)

Tags

Return values

array<string|int, mixed> —

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

retrievePBTsWithHttpInfo()

Operation retrievePBTsWithHttpInfo


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

Retrieve PBT Enrollments

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: The identifier for the requestor of the API. (required)
$id_customer : string: The unique identifier assigned by EBPP to the customer. (required)
$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_account : string = null: The unique identifier assigned by EBPP to the customer account (optional)

Tags

Return values

array<string|int, mixed> —

of \Orbipay\PaymentsApi\Client\Model\PBTEnrollmentsResponse, 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

managePBTEnrollmentRequest()

Create request for operation 'managePBTEnrollment'


    protected
                managePBTEnrollmentRequest(string $channel, string $client_key, string $product, string $timestamp, string $idempotent_request_key, string $requestor_type, string $requestor, ManagePBTRequest $manage_pbt_request[, 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)
$requestor : string: The identifier for the requestor of the API. (required)
$manage_pbt_request : ManagePBTRequest: JSON containing all the fields required to manage a customer for PBT enrollment. (required)
$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> —

retrievePBTsRequest()

Create request for operation 'retrievePBTs'


    protected
                retrievePBTsRequest(string $channel, string $client_key, string $product, string $timestamp, string $idempotent_request_key, string $requestor_type, string $requestor, string $id_customer[, string $x_opay_headers = null ][, string $trace_id = null ][, string $id_customer_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)
$requestor : string: The identifier for the requestor of the API. (required)
$id_customer : string: The unique identifier assigned by EBPP to the customer. (required)
$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_account : string = null: The unique identifier assigned by EBPP to the customer account (optional)

Tags

Return values

array<string|int, mixed> —

PaymentEnrollmentApi in package Orbipay PaymentsApi Client Api

Tags

Table of Contents

Properties

$client

$config

$headerSelector

Methods

__construct()

Parameters

Return values

getConfig()

Return values

managePBTEnrollment()

Parameters

Tags

Return values

managePBTEnrollmentWithHttpInfo()

Parameters

Tags

Return values

retrievePBTs()

Parameters

Tags

Return values

retrievePBTsWithHttpInfo()

Parameters

Tags

Return values

createHttpClientOption()

Tags

Return values

managePBTEnrollmentRequest()

Parameters

Tags

Return values

retrievePBTsRequest()

Parameters

Tags

Return values

PaymentEnrollmentApi
in package

Orbipay

PaymentsApi

Client

Api