|
| 1 | +# CyberSource\BillingAgreementsApi |
| 2 | + |
| 3 | +All URIs are relative to *https://apitest.cybersource.com* |
| 4 | + |
| 5 | +Method | HTTP request | Description |
| 6 | +------------- | ------------- | ------------- |
| 7 | +[**billingAgreementsDeRegistration**](BillingAgreementsApi.md#billingAgreementsDeRegistration) | **PATCH** /pts/v2/billing-agreements/{id} | Standing Instruction Cancellation or Modification |
| 8 | +[**billingAgreementsIntimation**](BillingAgreementsApi.md#billingAgreementsIntimation) | **POST** /pts/v2/billing-agreements/{id}/intimations | Standing Instruction intimation |
| 9 | +[**billingAgreementsRegistration**](BillingAgreementsApi.md#billingAgreementsRegistration) | **POST** /pts/v2/billing-agreements | Standing Instruction completion registration |
| 10 | + |
| 11 | + |
| 12 | +# **billingAgreementsDeRegistration** |
| 13 | +> \CyberSource\Model\PtsV2CreditsPost201Response1 billingAgreementsDeRegistration($modifyBillingAgreement, $id) |
| 14 | +
|
| 15 | +Standing Instruction Cancellation or Modification |
| 16 | + |
| 17 | +Standing Instruction with or without Token |
| 18 | + |
| 19 | +### Example |
| 20 | +```php |
| 21 | +<?php |
| 22 | +require_once(__DIR__ . '/vendor/autoload.php'); |
| 23 | + |
| 24 | +$api_instance = new CyberSource\Api\BillingAgreementsApi(); |
| 25 | +$modifyBillingAgreement = new \CyberSource\Model\ModifyBillingAgreement(); // \CyberSource\Model\ModifyBillingAgreement | |
| 26 | +$id = "id_example"; // string | ID for de-registration or cancellation of Billing Agreement |
| 27 | + |
| 28 | +try { |
| 29 | + $result = $api_instance->billingAgreementsDeRegistration($modifyBillingAgreement, $id); |
| 30 | + print_r($result); |
| 31 | +} catch (Exception $e) { |
| 32 | + echo 'Exception when calling BillingAgreementsApi->billingAgreementsDeRegistration: ', $e->getMessage(), PHP_EOL; |
| 33 | +} |
| 34 | +?> |
| 35 | +``` |
| 36 | + |
| 37 | +### Parameters |
| 38 | + |
| 39 | +Name | Type | Description | Notes |
| 40 | +------------- | ------------- | ------------- | ------------- |
| 41 | + **modifyBillingAgreement** | [**\CyberSource\Model\ModifyBillingAgreement**](../Model/ModifyBillingAgreement.md)| | |
| 42 | + **id** | **string**| ID for de-registration or cancellation of Billing Agreement | |
| 43 | + |
| 44 | +### Return type |
| 45 | + |
| 46 | +[**\CyberSource\Model\PtsV2CreditsPost201Response1**](../Model/PtsV2CreditsPost201Response1.md) |
| 47 | + |
| 48 | +### Authorization |
| 49 | + |
| 50 | +No authorization required |
| 51 | + |
| 52 | +### HTTP request headers |
| 53 | + |
| 54 | + - **Content-Type**: application/json;charset=utf-8 |
| 55 | + - **Accept**: application/hal+json;charset=utf-8 |
| 56 | + |
| 57 | +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) |
| 58 | + |
| 59 | +# **billingAgreementsIntimation** |
| 60 | +> \CyberSource\Model\PtsV2CreditsPost201Response1 billingAgreementsIntimation($intimateBillingAgreement, $id) |
| 61 | +
|
| 62 | +Standing Instruction intimation |
| 63 | + |
| 64 | +Standing Instruction with or without Token. |
| 65 | + |
| 66 | +### Example |
| 67 | +```php |
| 68 | +<?php |
| 69 | +require_once(__DIR__ . '/vendor/autoload.php'); |
| 70 | + |
| 71 | +$api_instance = new CyberSource\Api\BillingAgreementsApi(); |
| 72 | +$intimateBillingAgreement = new \CyberSource\Model\IntimateBillingAgreement(); // \CyberSource\Model\IntimateBillingAgreement | |
| 73 | +$id = "id_example"; // string | ID for intimation of Billing Agreement |
| 74 | + |
| 75 | +try { |
| 76 | + $result = $api_instance->billingAgreementsIntimation($intimateBillingAgreement, $id); |
| 77 | + print_r($result); |
| 78 | +} catch (Exception $e) { |
| 79 | + echo 'Exception when calling BillingAgreementsApi->billingAgreementsIntimation: ', $e->getMessage(), PHP_EOL; |
| 80 | +} |
| 81 | +?> |
| 82 | +``` |
| 83 | + |
| 84 | +### Parameters |
| 85 | + |
| 86 | +Name | Type | Description | Notes |
| 87 | +------------- | ------------- | ------------- | ------------- |
| 88 | + **intimateBillingAgreement** | [**\CyberSource\Model\IntimateBillingAgreement**](../Model/IntimateBillingAgreement.md)| | |
| 89 | + **id** | **string**| ID for intimation of Billing Agreement | |
| 90 | + |
| 91 | +### Return type |
| 92 | + |
| 93 | +[**\CyberSource\Model\PtsV2CreditsPost201Response1**](../Model/PtsV2CreditsPost201Response1.md) |
| 94 | + |
| 95 | +### Authorization |
| 96 | + |
| 97 | +No authorization required |
| 98 | + |
| 99 | +### HTTP request headers |
| 100 | + |
| 101 | + - **Content-Type**: application/json;charset=utf-8 |
| 102 | + - **Accept**: application/hal+json;charset=utf-8 |
| 103 | + |
| 104 | +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) |
| 105 | + |
| 106 | +# **billingAgreementsRegistration** |
| 107 | +> \CyberSource\Model\PtsV2CreditsPost201Response1 billingAgreementsRegistration($createBillingAgreement) |
| 108 | +
|
| 109 | +Standing Instruction completion registration |
| 110 | + |
| 111 | +Standing Instruction with or without Token. Transaction amount in case First payment is coming along with registration. Only 2 decimal places allowed |
| 112 | + |
| 113 | +### Example |
| 114 | +```php |
| 115 | +<?php |
| 116 | +require_once(__DIR__ . '/vendor/autoload.php'); |
| 117 | + |
| 118 | +$api_instance = new CyberSource\Api\BillingAgreementsApi(); |
| 119 | +$createBillingAgreement = new \CyberSource\Model\CreateBillingAgreement(); // \CyberSource\Model\CreateBillingAgreement | |
| 120 | + |
| 121 | +try { |
| 122 | + $result = $api_instance->billingAgreementsRegistration($createBillingAgreement); |
| 123 | + print_r($result); |
| 124 | +} catch (Exception $e) { |
| 125 | + echo 'Exception when calling BillingAgreementsApi->billingAgreementsRegistration: ', $e->getMessage(), PHP_EOL; |
| 126 | +} |
| 127 | +?> |
| 128 | +``` |
| 129 | + |
| 130 | +### Parameters |
| 131 | + |
| 132 | +Name | Type | Description | Notes |
| 133 | +------------- | ------------- | ------------- | ------------- |
| 134 | + **createBillingAgreement** | [**\CyberSource\Model\CreateBillingAgreement**](../Model/CreateBillingAgreement.md)| | |
| 135 | + |
| 136 | +### Return type |
| 137 | + |
| 138 | +[**\CyberSource\Model\PtsV2CreditsPost201Response1**](../Model/PtsV2CreditsPost201Response1.md) |
| 139 | + |
| 140 | +### Authorization |
| 141 | + |
| 142 | +No authorization required |
| 143 | + |
| 144 | +### HTTP request headers |
| 145 | + |
| 146 | + - **Content-Type**: application/json;charset=utf-8 |
| 147 | + - **Accept**: application/hal+json;charset=utf-8 |
| 148 | + |
| 149 | +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) |
| 150 | + |
0 commit comments