Skip to content

Latest commit

 

History

History
215 lines (152 loc) · 7.1 KB

SepaApi.md

File metadata and controls

215 lines (152 loc) · 7.1 KB
Raw

Swagger\Client\SepaApi

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

Method HTTP request Description
addDocument POST /v1/sepa/add-document Adds a SEPA document
checkCustomer POST /v1/sepa/check-customer Check a customers SEPA documentation
checkDocument POST /v1/sepa/check-document Check a SEPA document
sepaOperations POST /v1/sepa/operations Send SEPA operations

addDocument

\Swagger\Client\Model\InlineResponse20027 addDocument($paycomet_api_token, $body)

Adds a SEPA document

add_document

Example

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

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

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

Parameters

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

Return type

\Swagger\Client\Model\InlineResponse20027

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]

checkCustomer

\Swagger\Client\Model\InlineResponse20028 checkCustomer($paycomet_api_token, $body)

Check a customers SEPA documentation

check_customer

Example

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

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

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

Parameters

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

Return type

\Swagger\Client\Model\InlineResponse20028

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]

checkDocument

\Swagger\Client\Model\InlineResponse20027 checkDocument($paycomet_api_token, $body)

Check a SEPA document

check_document

Example

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

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

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

Parameters

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

Return type

\Swagger\Client\Model\InlineResponse20027

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]

sepaOperations

\Swagger\Client\Model\InlineResponse20029 sepaOperations($paycomet_api_token, $body)

Send SEPA operations

sepa_operations

Example

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

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

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

Parameters

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

Return type

\Swagger\Client\Model\InlineResponse20029

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]