Skip to content

Latest commit

 

History

History
163 lines (115 loc) · 6.01 KB

LaunchpadApi.md

File metadata and controls

163 lines (115 loc) · 6.01 KB
Raw

Swagger\Client\LaunchpadApi

All URIs are relative to https://rest.paycomet.com

Method HTTP request Description
launchAuthorization POST /v1/launchpad/authorization Creates a payment link and sends it to customer
launchPreauthorization POST /v1/launchpad/preauthorization Executes a preauthorization link and sends it to customer
launchSubscription POST /v1/launchpad/subscription Creates a subscription link and sends it to customer

launchAuthorization

\Swagger\Client\Model\InlineResponse20022 launchAuthorization($body, $paycomet_api_token)

Creates a payment link and sends it to customer

Generate a authorization link. It will send a challenge URL to the client.

Example

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

$apiInstance = new Swagger\Client\Api\LaunchpadApi(
    // 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()
);
$body = new \Swagger\Client\Model\LaunchpadAuthorizationBody(); // \Swagger\Client\Model\LaunchpadAuthorizationBody | 
$paycomet_api_token = "paycomet_api_token_example"; // string | PAYCOMET API key (Authorization privilege required)

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

Parameters

Name Type Description Notes
body \Swagger\Client\Model\LaunchpadAuthorizationBody [optional]
paycomet_api_token string PAYCOMET API key (Authorization privilege required) [optional]

Return type

\Swagger\Client\Model\InlineResponse20022

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]

launchPreauthorization

\Swagger\Client\Model\InlineResponse20022 launchPreauthorization($body, $paycomet_api_token)

Executes a preauthorization link and sends it to customer

Generate a preauthorization link. It will send a challenge URL to the client.

Example

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

$apiInstance = new Swagger\Client\Api\LaunchpadApi(
    // 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()
);
$body = new \Swagger\Client\Model\LaunchpadPreauthorizationBody(); // \Swagger\Client\Model\LaunchpadPreauthorizationBody | 
$paycomet_api_token = "paycomet_api_token_example"; // string | PAYCOMET API key (Authorization privilege required)

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

Parameters

Name Type Description Notes
body \Swagger\Client\Model\LaunchpadPreauthorizationBody [optional]
paycomet_api_token string PAYCOMET API key (Authorization privilege required) [optional]

Return type

\Swagger\Client\Model\InlineResponse20022

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]

launchSubscription

\Swagger\Client\Model\InlineResponse20022 launchSubscription($body, $paycomet_api_token)

Creates a subscription link and sends it to customer

Generate a subscription link. It will send a challenge URL to the client.

Example

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

$apiInstance = new Swagger\Client\Api\LaunchpadApi(
    // 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()
);
$body = new \Swagger\Client\Model\LaunchpadSubscriptionBody(); // \Swagger\Client\Model\LaunchpadSubscriptionBody | 
$paycomet_api_token = "paycomet_api_token_example"; // string | PAYCOMET API key (Authorization privilege required)

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

Parameters

Name Type Description Notes
body \Swagger\Client\Model\LaunchpadSubscriptionBody [optional]
paycomet_api_token string PAYCOMET API key (Authorization privilege required) [optional]

Return type

\Swagger\Client\Model\InlineResponse20022

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]