Skip to content

SecureTokenLinksApi.md

Latest commit

 

History

History
355 lines (262 loc) · 13.3 KB

SecureTokenLinksApi.md

File metadata and controls

355 lines (262 loc) · 13.3 KB
Raw

OpenAPI\Client\SecureTokenLinksApi

All URIs are relative to https://api.anddone.com, except if the operation defines another base path.

Method HTTP request Description
secureTokenlinksDetailsPost() POST /secure/tokenlinks/details This API is used for getting Token Links by TokenLink ID
secureTokenlinksExpirationsPost() POST /secure/tokenlinks/expirations This API expires the token link.
secureTokenlinksListPost() POST /secure/tokenlinks/list This API is used for getting all Token Links for Merchant
secureTokenlinksPost() POST /secure/tokenlinks This API is use to create Secure Token Links
secureTokenlinksPut() PUT /secure/tokenlinks This API will update the expireIn and paymentType of Token Link.

secureTokenlinksDetailsPost()

secureTokenlinksDetailsPost($xApiKey, $xAppKey, $xVersion, $origin, $secureTokenLinkRequest): \OpenAPI\Client\Model\SecureTokenLinkByIdResponse

This API is used for getting Token Links by TokenLink ID

Example

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



$apiInstance = new OpenAPI\Client\Api\SecureTokenLinksApi(
    // 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()
);
$xApiKey = 'xApiKey_example'; // string | an authorization header
$xAppKey = 'xAppKey_example'; // string | an authorization header
$xVersion = 3.4; // float | x-version
$origin = 'origin_example'; // string | origin
$secureTokenLinkRequest = new \OpenAPI\Client\Model\SecureTokenLinkRequest(); // \OpenAPI\Client\Model\SecureTokenLinkRequest | Secure Token Link Id Request

try {
    $result = $apiInstance->secureTokenlinksDetailsPost($xApiKey, $xAppKey, $xVersion, $origin, $secureTokenLinkRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SecureTokenLinksApi->secureTokenlinksDetailsPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
xApiKey string an authorization header
xAppKey string an authorization header
xVersion float x-version
origin string origin
secureTokenLinkRequest \OpenAPI\Client\Model\SecureTokenLinkRequest Secure Token Link Id Request

Return type

\OpenAPI\Client\Model\SecureTokenLinkByIdResponse

Authorization

No authorization required

HTTP request headers

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

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

secureTokenlinksExpirationsPost()

secureTokenlinksExpirationsPost($xApiKey, $xAppKey, $xVersion, $origin, $secureTokenLinkRequest): \OpenAPI\Client\Model\SecureTokenLinkExpiredResponse

This API expires the token link.

Example

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



$apiInstance = new OpenAPI\Client\Api\SecureTokenLinksApi(
    // 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()
);
$xApiKey = 'xApiKey_example'; // string | an authorization header
$xAppKey = 'xAppKey_example'; // string | an authorization header
$xVersion = 3.4; // float | x-version
$origin = 'origin_example'; // string | origin
$secureTokenLinkRequest = new \OpenAPI\Client\Model\SecureTokenLinkRequest(); // \OpenAPI\Client\Model\SecureTokenLinkRequest | Secure Token Link Id Request

try {
    $result = $apiInstance->secureTokenlinksExpirationsPost($xApiKey, $xAppKey, $xVersion, $origin, $secureTokenLinkRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SecureTokenLinksApi->secureTokenlinksExpirationsPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
xApiKey string an authorization header
xAppKey string an authorization header
xVersion float x-version
origin string origin
secureTokenLinkRequest \OpenAPI\Client\Model\SecureTokenLinkRequest Secure Token Link Id Request

Return type

\OpenAPI\Client\Model\SecureTokenLinkExpiredResponse

Authorization

No authorization required

HTTP request headers

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

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

secureTokenlinksListPost()

secureTokenlinksListPost($xApiKey, $xAppKey, $xVersion, $origin, $email, $status, $phone, $statuses, $title, $paymentDescription, $invoiceNumber, $expiryDate, $fromExpiryDate, $freeTextSearch, $tokenLinkId, $toExpiryDate, $fromDate, $toDate, $startRow, $pageSize, $sortField, $asc): \OpenAPI\Client\Model\TokenLinkResponse

This API is used for getting all Token Links for Merchant

Example

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



$apiInstance = new OpenAPI\Client\Api\SecureTokenLinksApi(
    // 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()
);
$xApiKey = 'xApiKey_example'; // string | an authorization header
$xAppKey = 'xAppKey_example'; // string | an authorization header
$xVersion = 3.4; // float | x-version
$origin = 'origin_example'; // string | origin
$email = 'email_example'; // string | email
$status = 'status_example'; // string | status
$phone = 'phone_example'; // string | phone
$statuses = 'statuses_example'; // string | statuses
$title = 'title_example'; // string | title
$paymentDescription = 'paymentDescription_example'; // string | paymentDescription
$invoiceNumber = 'invoiceNumber_example'; // string | invoiceNumber
$expiryDate = 'expiryDate_example'; // string | expiryDate
$fromExpiryDate = 'fromExpiryDate_example'; // string | fromExpiryDate
$freeTextSearch = 'freeTextSearch_example'; // string | freeTextSearch
$tokenLinkId = 'tokenLinkId_example'; // string | tokenLinkId
$toExpiryDate = 'toExpiryDate_example'; // string | toExpiryDate
$fromDate = 'fromDate_example'; // string | fromDate
$toDate = 'toDate_example'; // string | toDate
$startRow = 56; // int | Set StartRow
$pageSize = 56; // int | Set PageSize
$sortField = 'sortField_example'; // string | Set SortField
$asc = True; // bool | Set Asc

try {
    $result = $apiInstance->secureTokenlinksListPost($xApiKey, $xAppKey, $xVersion, $origin, $email, $status, $phone, $statuses, $title, $paymentDescription, $invoiceNumber, $expiryDate, $fromExpiryDate, $freeTextSearch, $tokenLinkId, $toExpiryDate, $fromDate, $toDate, $startRow, $pageSize, $sortField, $asc);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SecureTokenLinksApi->secureTokenlinksListPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
xApiKey string an authorization header
xAppKey string an authorization header
xVersion float x-version
origin string origin
email string email [optional]
status string status [optional]
phone string phone [optional]
statuses string statuses [optional]
title string title [optional]
paymentDescription string paymentDescription [optional]
invoiceNumber string invoiceNumber [optional]
expiryDate string expiryDate [optional]
fromExpiryDate string fromExpiryDate [optional]
freeTextSearch string freeTextSearch [optional]
tokenLinkId string tokenLinkId [optional]
toExpiryDate string toExpiryDate [optional]
fromDate string fromDate [optional]
toDate string toDate [optional]
startRow int Set StartRow [optional]
pageSize int Set PageSize [optional]
sortField string Set SortField [optional]
asc bool Set Asc [optional]

Return type

\OpenAPI\Client\Model\TokenLinkResponse

Authorization

No authorization required

HTTP request headers

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

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

secureTokenlinksPost()

secureTokenlinksPost($xApiKey, $xAppKey, $xVersion, $origin, $tokenLinkSecureRequest): \OpenAPI\Client\Model\SecureTokenLinkResponse

This API is use to create Secure Token Links

Example

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



$apiInstance = new OpenAPI\Client\Api\SecureTokenLinksApi(
    // 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()
);
$xApiKey = 'xApiKey_example'; // string | an authorization header
$xAppKey = 'xAppKey_example'; // string | an authorization header
$xVersion = 3.4; // float | x-version
$origin = 'origin_example'; // string | origin
$tokenLinkSecureRequest = new \OpenAPI\Client\Model\TokenLinkSecureRequest(); // \OpenAPI\Client\Model\TokenLinkSecureRequest | Secure Token Link Request

try {
    $result = $apiInstance->secureTokenlinksPost($xApiKey, $xAppKey, $xVersion, $origin, $tokenLinkSecureRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SecureTokenLinksApi->secureTokenlinksPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
xApiKey string an authorization header
xAppKey string an authorization header
xVersion float x-version
origin string origin
tokenLinkSecureRequest \OpenAPI\Client\Model\TokenLinkSecureRequest Secure Token Link Request

Return type

\OpenAPI\Client\Model\SecureTokenLinkResponse

Authorization

No authorization required

HTTP request headers

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

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

secureTokenlinksPut()

secureTokenlinksPut($xApiKey, $xAppKey, $xVersion, $origin, $secureTokenLinkUpdateRequest)

This API will update the expireIn and paymentType of Token Link.

Example

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



$apiInstance = new OpenAPI\Client\Api\SecureTokenLinksApi(
    // 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()
);
$xApiKey = 'xApiKey_example'; // string | an authorization header
$xAppKey = 'xAppKey_example'; // string | an authorization header
$xVersion = 3.4; // float | x-version
$origin = 'origin_example'; // string | origin
$secureTokenLinkUpdateRequest = new \OpenAPI\Client\Model\SecureTokenLinkUpdateRequest(); // \OpenAPI\Client\Model\SecureTokenLinkUpdateRequest | Secure Token Link Update Request

try {
    $apiInstance->secureTokenlinksPut($xApiKey, $xAppKey, $xVersion, $origin, $secureTokenLinkUpdateRequest);
} catch (Exception $e) {
    echo 'Exception when calling SecureTokenLinksApi->secureTokenlinksPut: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
xApiKey string an authorization header
xAppKey string an authorization header
xVersion float x-version
origin string origin
secureTokenLinkUpdateRequest \OpenAPI\Client\Model\SecureTokenLinkUpdateRequest Secure Token Link Update Request

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

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