Skip to content

Latest commit

 

History

History
214 lines (155 loc) · 8.16 KB

QuickpaySubscriptionApi.md

File metadata and controls

214 lines (155 loc) · 8.16 KB
Raw

Membercare\Client\QuickpaySubscriptionApi

All URIs are relative to /

Method HTTP request Description
deleteQuickpaySubscription DELETE /api/v1/quickpaysubscriptions/{quickpaySubscriptionIdentification} Method to delete a Quickpay subscription and it's payment gateway subscription
getQuickpaySubscriptionsByDebtorAccountNumber GET /api/v1/quickpaysubscriptions/{debtorAccountNumber} Get saved quickpay subscription by debtor account number
postQuickpaySubscription POST /api/v1/quickpaysubscriptions/{debtorAccountNumber} Method to save a quickpay subscription which may be a credit card or mobilepay subscription
updateQuickpaySubscription PATCH /api/v1/quickpaysubscriptions/{quickpayIdentification} Method to patch a Quickpay subscription information

deleteQuickpaySubscription

deleteQuickpaySubscription($quickpay_subscription_identification, $token)

Method to delete a Quickpay subscription and it's payment gateway subscription

Example

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

$apiInstance = new Membercare\Client\Api\QuickpaySubscriptionApi(
    // 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()
);
$quickpay_subscription_identification = "quickpay_subscription_identification_example"; // string | 
$token = "token_example"; // string | access token

try {
    $apiInstance->deleteQuickpaySubscription($quickpay_subscription_identification, $token);
} catch (Exception $e) {
    echo 'Exception when calling QuickpaySubscriptionApi->deleteQuickpaySubscription: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
quickpay_subscription_identification string
token string access token

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

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

getQuickpaySubscriptionsByDebtorAccountNumber

\Membercare\Client\Model\QuickpaySubscriptionPagedResult getQuickpaySubscriptionsByDebtorAccountNumber($debtor_account_number, $token, $page, $page_size)

Get saved quickpay subscription by debtor account number

Example

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

$apiInstance = new Membercare\Client\Api\QuickpaySubscriptionApi(
    // 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()
);
$debtor_account_number = "debtor_account_number_example"; // string | 
$token = "token_example"; // string | access token
$page = 1; // int | 
$page_size = 50; // int | 

try {
    $result = $apiInstance->getQuickpaySubscriptionsByDebtorAccountNumber($debtor_account_number, $token, $page, $page_size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling QuickpaySubscriptionApi->getQuickpaySubscriptionsByDebtorAccountNumber: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
debtor_account_number string
token string access token
page int [optional] [default to 1]
page_size int [optional] [default to 50]

Return type

\Membercare\Client\Model\QuickpaySubscriptionPagedResult

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

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

postQuickpaySubscription

\Membercare\Client\Model\QuickpaySubscription postQuickpaySubscription($token, $debtor_account_number, $body)

Method to save a quickpay subscription which may be a credit card or mobilepay subscription

Example

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

$apiInstance = new Membercare\Client\Api\QuickpaySubscriptionApi(
    // 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()
);
$token = "token_example"; // string | access token
$debtor_account_number = "debtor_account_number_example"; // string | 
$body = new \Membercare\Client\Model\PostQuickpaySubscription(); // \Membercare\Client\Model\PostQuickpaySubscription | 

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

Parameters

Name Type Description Notes
token string access token
debtor_account_number string
body \Membercare\Client\Model\PostQuickpaySubscription [optional]

Return type

\Membercare\Client\Model\QuickpaySubscription

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json, text/json, application/_*+json
  • Accept: text/plain, application/json, text/json

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

updateQuickpaySubscription

\Membercare\Client\Model\QuickpaySubscription updateQuickpaySubscription($token, $quickpay_identification, $body)

Method to patch a Quickpay subscription information

Example

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

$apiInstance = new Membercare\Client\Api\QuickpaySubscriptionApi(
    // 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()
);
$token = "token_example"; // string | access token
$quickpay_identification = "quickpay_identification_example"; // string | 
$body = new \Membercare\Client\Model\PatchQuickpaySubscription(); // \Membercare\Client\Model\PatchQuickpaySubscription | 

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

Parameters

Name Type Description Notes
token string access token
quickpay_identification string
body \Membercare\Client\Model\PatchQuickpaySubscription [optional]

Return type

\Membercare\Client\Model\QuickpaySubscription

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json, text/json, application/_*+json
  • Accept: text/plain, application/json, text/json

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