RefundsApi.md

Ageras\Api\RefundsApi

All URIs are relative to https://api.ageras.com/v2

Method	HTTP request	Description
refundsGet	GET /refunds/{refund_id}
refundsIndex	GET /refunds

refundsGet

\Ageras\Api\RefundResource refundsGet($refund_id )

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\RefundsApi();
$refund_id = "refund_id_example"; // string | 

try {
    $result = $api_instance->refundsGet($refund_id );
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RefundsApi->refundsGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
refund_id	string

Return type

\Ageras\Api\RefundResource

Authorization

jwt, login

HTTP request headers

• Content-Type: application/json
• Accept: application/json

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

refundsIndex

\Ageras\Api\RefundResult refundsIndex($criteria)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\RefundsApi();
$criteria = [
        'partner_id' => "partner_id_example"; // string | Partner ID. @var int
        'sort' => "created_at"; // string | Sort resource by. @var string
        'limit' => 56; // int | The number of resources to be returned.
        'page' => 56; // int | The page position in the result.
        'query' => "query_example"; // string | The search wildcard.
    ];

try {
    $result = $api_instance->refundsIndex($criteria);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RefundsApi->refundsIndex: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
partner_id	string	Partner ID. @var int	[optional]
sort	string	Sort resource by. @var string	[optional] [default to created_at]
limit	int	The number of resources to be returned.	[optional]
page	int	The page position in the result.	[optional]
query	string	The search wildcard.	[optional]

Return type

\Ageras\Api\RefundResult

Authorization

jwt, login

HTTP request headers

• Content-Type: application/json
• Accept: application/json

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