Skip to content

Latest commit

 

History

History
277 lines (204 loc) · 10.2 KB

PaymentProfileApi.md

File metadata and controls

277 lines (204 loc) · 10.2 KB
Raw

VereTech\SyncroMSP_PHPclient\Client\PaymentProfileApi

All URIs are relative to https://{subdomain}.syncromsp.com/api/v1

Method HTTP request Description
customersCustomerIdPaymentProfilesGet GET /customers/{customer_id}/payment_profiles Returns a paginated list of Payment Profiles
customersCustomerIdPaymentProfilesIdDelete DELETE /customers/{customer_id}/payment_profiles/{id} Deletes a Payment Profile
customersCustomerIdPaymentProfilesIdGet GET /customers/{customer_id}/payment_profiles/{id} Retrieves a Payment Profile by ID
customersCustomerIdPaymentProfilesIdPut PUT /customers/{customer_id}/payment_profiles/{id} Updates a Payment Profile
customersCustomerIdPaymentProfilesPost POST /customers/{customer_id}/payment_profiles Creates a Payment Profile

customersCustomerIdPaymentProfilesGet

customersCustomerIdPaymentProfilesGet($customer_id)

Returns a paginated list of Payment Profiles

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: bearerAuth
$config = VereTech\SyncroMSP_PHPclient\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = VereTech\SyncroMSP_PHPclient\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new VereTech\SyncroMSP_PHPclient\Client\Api\PaymentProfileApi(
    // 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
);
$customer_id = 56; // int | 

try {
    $apiInstance->customersCustomerIdPaymentProfilesGet($customer_id);
} catch (Exception $e) {
    echo 'Exception when calling PaymentProfileApi->customersCustomerIdPaymentProfilesGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
customer_id int

Return type

void (empty response body)

Authorization

bearerAuth

HTTP request headers

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

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

customersCustomerIdPaymentProfilesIdDelete

customersCustomerIdPaymentProfilesIdDelete($customer_id, $id)

Deletes a Payment Profile

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: bearerAuth
$config = VereTech\SyncroMSP_PHPclient\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = VereTech\SyncroMSP_PHPclient\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new VereTech\SyncroMSP_PHPclient\Client\Api\PaymentProfileApi(
    // 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
);
$customer_id = 56; // int | 
$id = 56; // int | 

try {
    $apiInstance->customersCustomerIdPaymentProfilesIdDelete($customer_id, $id);
} catch (Exception $e) {
    echo 'Exception when calling PaymentProfileApi->customersCustomerIdPaymentProfilesIdDelete: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
customer_id int
id int

Return type

void (empty response body)

Authorization

bearerAuth

HTTP request headers

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

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

customersCustomerIdPaymentProfilesIdGet

customersCustomerIdPaymentProfilesIdGet($customer_id, $id)

Retrieves a Payment Profile by ID

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: bearerAuth
$config = VereTech\SyncroMSP_PHPclient\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = VereTech\SyncroMSP_PHPclient\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new VereTech\SyncroMSP_PHPclient\Client\Api\PaymentProfileApi(
    // 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
);
$customer_id = 56; // int | 
$id = 56; // int | 

try {
    $apiInstance->customersCustomerIdPaymentProfilesIdGet($customer_id, $id);
} catch (Exception $e) {
    echo 'Exception when calling PaymentProfileApi->customersCustomerIdPaymentProfilesIdGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
customer_id int
id int

Return type

void (empty response body)

Authorization

bearerAuth

HTTP request headers

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

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

customersCustomerIdPaymentProfilesIdPut

customersCustomerIdPaymentProfilesIdPut($customer_id, $id, $body)

Updates a Payment Profile

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: bearerAuth
$config = VereTech\SyncroMSP_PHPclient\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = VereTech\SyncroMSP_PHPclient\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new VereTech\SyncroMSP_PHPclient\Client\Api\PaymentProfileApi(
    // 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
);
$customer_id = 56; // int | 
$id = 56; // int | 
$body = new \VereTech\SyncroMSP_PHPclient\Client\Model\PaymentProfilesIdBody(); // \VereTech\SyncroMSP_PHPclient\Client\Model\PaymentProfilesIdBody | 

try {
    $apiInstance->customersCustomerIdPaymentProfilesIdPut($customer_id, $id, $body);
} catch (Exception $e) {
    echo 'Exception when calling PaymentProfileApi->customersCustomerIdPaymentProfilesIdPut: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
customer_id int
id int
body \VereTech\SyncroMSP_PHPclient\Client\Model\PaymentProfilesIdBody [optional]

Return type

void (empty response body)

Authorization

bearerAuth

HTTP request headers

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

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

customersCustomerIdPaymentProfilesPost

customersCustomerIdPaymentProfilesPost($customer_id, $body)

Creates a Payment Profile

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: bearerAuth
$config = VereTech\SyncroMSP_PHPclient\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = VereTech\SyncroMSP_PHPclient\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new VereTech\SyncroMSP_PHPclient\Client\Api\PaymentProfileApi(
    // 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
);
$customer_id = 56; // int | 
$body = new \VereTech\SyncroMSP_PHPclient\Client\Model\CustomerIdPaymentProfilesBody(); // \VereTech\SyncroMSP_PHPclient\Client\Model\CustomerIdPaymentProfilesBody | 

try {
    $apiInstance->customersCustomerIdPaymentProfilesPost($customer_id, $body);
} catch (Exception $e) {
    echo 'Exception when calling PaymentProfileApi->customersCustomerIdPaymentProfilesPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
customer_id int
body \VereTech\SyncroMSP_PHPclient\Client\Model\CustomerIdPaymentProfilesBody [optional]

Return type

void (empty response body)

Authorization

bearerAuth

HTTP request headers

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

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