Skip to content

Latest commit

 

History

History
124 lines (86 loc) · 4.25 KB

PaymentsApi.md

File metadata and controls

124 lines (86 loc) · 4.25 KB
Raw

Swagger\Client\PaymentsApi

All URIs are relative to https://api.facestore.pt/v1

Method HTTP request Description
getPaymentById GET /payments/{id}/
getPayments GET /payments

getPaymentById

\Swagger\Client\Model\InlineResponse2007 getPaymentById($id)

Returns all payments from the system that the user has access to

Example

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

// Configure API key authorization: APIKeyHeader
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('APIToken', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('APIToken', 'Bearer');

$apiInstance = new Swagger\Client\Api\PaymentsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 789; // int | ID of payment

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

Parameters

Name Type Description Notes
id int ID of payment

Return type

\Swagger\Client\Model\InlineResponse2007

Authorization

APIKeyHeader

HTTP request headers

  • Content-Type: application/json, multipart/form-data
  • Accept: application/json

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

getPayments

\Swagger\Client\Model\InlineResponse2006 getPayments($includes, $limit, $order_by)

Returns all payments from the system that the user has access to

Example

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

// Configure API key authorization: APIKeyHeader
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('APIToken', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('APIToken', 'Bearer');

$apiInstance = new Swagger\Client\Api\PaymentsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$includes = array("includes_example"); // string[] | Include associated objects within response
$limit = 56; // int | max records to return
$order_by = array("order_by_example"); // string[] | Specify the field to be sorted, examples:  - `?order_by=id|desc` - `?order_by=updated_at|desc,position|asc`

try {
    $result = $apiInstance->getPayments($includes, $limit, $order_by);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentsApi->getPayments: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
includes string[] Include associated objects within response [optional]
limit int max records to return [optional]
order_by string[] Specify the field to be sorted, examples: - `?order_by=id desc` - `?order_by=updated_at

Return type

\Swagger\Client\Model\InlineResponse2006

Authorization

APIKeyHeader

HTTP request headers

  • Content-Type: application/json, multipart/form-data
  • Accept: application/json

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