Reepay\AgreementApi

All URIs are relative to https://api.reepay.com

Method	HTTP request	Description
createCardGatewayAgreement	POST /v1/agreement/card_gateway	Create card gateway agreement
deleteCardGatewayAgreement	DELETE /v1/agreement/card_gateway/{id}	Delete card gateway agreement
disableCardGatewayAgreement	POST /v1/agreement/card_gateway/{id}/disable	Disable card gateway agreement
enableCardGatewayAgreement	POST /v1/agreement/card_gateway/{id}/enable	Enable card gateway agreement
getCardGatewayAgreement	GET /v1/agreement/card_gateway/{id}	Get card gateway agreement
getCardGatewayAgreements	GET /v1/agreement/card_gateway	Get all card gateway agreements
updateCardGatewayAgreement	PUT /v1/agreement/card_gateway/{id}	Update card gateway agreement

createCardGatewayAgreement

\Reepay\Model\CardGatewayAgreement createCardGatewayAgreement($body)

Create card gateway agreement

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apiKey
Reepay\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Reepay\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
// Configure HTTP basic authorization: basicAuth
Reepay\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Reepay\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$apiInstance = new Reepay\Api\AgreementApi();
$body = new \Reepay\Model\CreateCardGatewayAgreement(); // \Reepay\Model\CreateCardGatewayAgreement |

try {
    $result = $apiInstance->createCardGatewayAgreement($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AgreementApi->createCardGatewayAgreement: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
body	\Reepay\Model\CreateCardGatewayAgreement		[optional]

Return type

\Reepay\Model\CardGatewayAgreement

Authorization

apiKey, basicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteCardGatewayAgreement

\Reepay\Model\CardGatewayAgreement deleteCardGatewayAgreement($id)

Delete card gateway agreement

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apiKey
Reepay\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Reepay\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
// Configure HTTP basic authorization: basicAuth
Reepay\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Reepay\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$apiInstance = new Reepay\Api\AgreementApi();
$id = "id_example"; // string | Agreement id

try {
    $result = $apiInstance->deleteCardGatewayAgreement($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AgreementApi->deleteCardGatewayAgreement: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	string	Agreement id

Return type

\Reepay\Model\CardGatewayAgreement

Authorization

apiKey, basicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

disableCardGatewayAgreement

\Reepay\Model\CardGatewayAgreement disableCardGatewayAgreement($id)

Disable card gateway agreement

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apiKey
Reepay\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Reepay\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
// Configure HTTP basic authorization: basicAuth
Reepay\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Reepay\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$apiInstance = new Reepay\Api\AgreementApi();
$id = "id_example"; // string | Agreement id

try {
    $result = $apiInstance->disableCardGatewayAgreement($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AgreementApi->disableCardGatewayAgreement: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	string	Agreement id

Return type

\Reepay\Model\CardGatewayAgreement

Authorization

apiKey, basicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

enableCardGatewayAgreement

\Reepay\Model\CardGatewayAgreement enableCardGatewayAgreement($id)

Enable card gateway agreement

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apiKey
Reepay\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Reepay\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
// Configure HTTP basic authorization: basicAuth
Reepay\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Reepay\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$apiInstance = new Reepay\Api\AgreementApi();
$id = "id_example"; // string | Agreement id

try {
    $result = $apiInstance->enableCardGatewayAgreement($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AgreementApi->enableCardGatewayAgreement: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	string	Agreement id

Return type

\Reepay\Model\CardGatewayAgreement

Authorization

apiKey, basicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getCardGatewayAgreement

\Reepay\Model\CardGatewayAgreement getCardGatewayAgreement($id)

Get card gateway agreement

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apiKey
Reepay\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Reepay\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
// Configure HTTP basic authorization: basicAuth
Reepay\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Reepay\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$apiInstance = new Reepay\Api\AgreementApi();
$id = "id_example"; // string | Agreement id

try {
    $result = $apiInstance->getCardGatewayAgreement($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AgreementApi->getCardGatewayAgreement: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	string	Agreement id

Return type

\Reepay\Model\CardGatewayAgreement

Authorization

apiKey, basicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getCardGatewayAgreements

\Reepay\Model\CardGatewayAgreement[] getCardGatewayAgreements($only_active, $non_deleted)

Get all card gateway agreements

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apiKey
Reepay\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Reepay\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
// Configure HTTP basic authorization: basicAuth
Reepay\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Reepay\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$apiInstance = new Reepay\Api\AgreementApi();
$only_active = false; // bool | Get only active
$non_deleted = false; // bool | Get only non-deleted

try {
    $result = $apiInstance->getCardGatewayAgreements($only_active, $non_deleted);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AgreementApi->getCardGatewayAgreements: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
only_active	bool	Get only active	[optional] [default to false]
non_deleted	bool	Get only non-deleted	[optional] [default to false]

Return type

\Reepay\Model\CardGatewayAgreement[]

Authorization

apiKey, basicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateCardGatewayAgreement

\Reepay\Model\CardGatewayAgreement updateCardGatewayAgreement($id, $body)

Update card gateway agreement

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apiKey
Reepay\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Reepay\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
// Configure HTTP basic authorization: basicAuth
Reepay\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Reepay\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$apiInstance = new Reepay\Api\AgreementApi();
$id = "id_example"; // string | Agreement id
$body = new \Reepay\Model\UpdateCardGatewayAgreement(); // \Reepay\Model\UpdateCardGatewayAgreement |

try {
    $result = $apiInstance->updateCardGatewayAgreement($id, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AgreementApi->updateCardGatewayAgreement: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	string	Agreement id
body	\Reepay\Model\UpdateCardGatewayAgreement		[optional]

Return type

\Reepay\Model\CardGatewayAgreement

Authorization

apiKey, basicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

AgreementApi.md

Latest commit

History

AgreementApi.md

File metadata and controls

Reepay\AgreementApi

createCardGatewayAgreement

Example

Parameters

Return type

Authorization

HTTP request headers

deleteCardGatewayAgreement

Example

Parameters

Return type

Authorization

HTTP request headers

disableCardGatewayAgreement

Example

Parameters

Return type

Authorization

HTTP request headers

enableCardGatewayAgreement

Example

Parameters

Return type

Authorization

HTTP request headers

getCardGatewayAgreement

Example

Parameters

Return type

Authorization

HTTP request headers

getCardGatewayAgreements

Example

Parameters

Return type

Authorization

HTTP request headers

updateCardGatewayAgreement

Example

Parameters

Return type

Authorization

HTTP request headers