|
| 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 | +<a name="billingAgreementsDeRegistration"></a> |
| 13 | +# **billingAgreementsDeRegistration** |
| 14 | +> PtsV2CreditsPost201Response1 billingAgreementsDeRegistration(modifyBillingAgreement, id) |
| 15 | +
|
| 16 | +Standing Instruction Cancellation or Modification |
| 17 | + |
| 18 | +Standing Instruction with or without Token |
| 19 | + |
| 20 | +### Example |
| 21 | +```javascript |
| 22 | +var CyberSource = require('CyberSource'); |
| 23 | + |
| 24 | +var apiInstance = new CyberSource.BillingAgreementsApi(); |
| 25 | + |
| 26 | +var modifyBillingAgreement = new CyberSource.ModifyBillingAgreement(); // ModifyBillingAgreement | |
| 27 | + |
| 28 | +var id = "id_example"; // String | ID for de-registration or cancellation of Billing Agreement |
| 29 | + |
| 30 | + |
| 31 | +var callback = function(error, data, response) { |
| 32 | + if (error) { |
| 33 | + console.error(error); |
| 34 | + } else { |
| 35 | + console.log('API called successfully. Returned data: ' + data); |
| 36 | + } |
| 37 | +}; |
| 38 | +apiInstance.billingAgreementsDeRegistration(modifyBillingAgreement, id, callback); |
| 39 | +``` |
| 40 | + |
| 41 | +### Parameters |
| 42 | + |
| 43 | +Name | Type | Description | Notes |
| 44 | +------------- | ------------- | ------------- | ------------- |
| 45 | + **modifyBillingAgreement** | [**ModifyBillingAgreement**](ModifyBillingAgreement.md)| | |
| 46 | + **id** | **String**| ID for de-registration or cancellation of Billing Agreement | |
| 47 | + |
| 48 | +### Return type |
| 49 | + |
| 50 | +[**PtsV2CreditsPost201Response1**](PtsV2CreditsPost201Response1.md) |
| 51 | + |
| 52 | +### Authorization |
| 53 | + |
| 54 | +No authorization required |
| 55 | + |
| 56 | +### HTTP request headers |
| 57 | + |
| 58 | + - **Content-Type**: application/json;charset=utf-8 |
| 59 | + - **Accept**: application/hal+json;charset=utf-8 |
| 60 | + |
| 61 | +<a name="billingAgreementsIntimation"></a> |
| 62 | +# **billingAgreementsIntimation** |
| 63 | +> PtsV2CreditsPost201Response1 billingAgreementsIntimation(intimateBillingAgreement, id) |
| 64 | +
|
| 65 | +Standing Instruction intimation |
| 66 | + |
| 67 | +Standing Instruction with or without Token. |
| 68 | + |
| 69 | +### Example |
| 70 | +```javascript |
| 71 | +var CyberSource = require('CyberSource'); |
| 72 | + |
| 73 | +var apiInstance = new CyberSource.BillingAgreementsApi(); |
| 74 | + |
| 75 | +var intimateBillingAgreement = new CyberSource.IntimateBillingAgreement(); // IntimateBillingAgreement | |
| 76 | + |
| 77 | +var id = "id_example"; // String | ID for intimation of Billing Agreement |
| 78 | + |
| 79 | + |
| 80 | +var callback = function(error, data, response) { |
| 81 | + if (error) { |
| 82 | + console.error(error); |
| 83 | + } else { |
| 84 | + console.log('API called successfully. Returned data: ' + data); |
| 85 | + } |
| 86 | +}; |
| 87 | +apiInstance.billingAgreementsIntimation(intimateBillingAgreement, id, callback); |
| 88 | +``` |
| 89 | + |
| 90 | +### Parameters |
| 91 | + |
| 92 | +Name | Type | Description | Notes |
| 93 | +------------- | ------------- | ------------- | ------------- |
| 94 | + **intimateBillingAgreement** | [**IntimateBillingAgreement**](IntimateBillingAgreement.md)| | |
| 95 | + **id** | **String**| ID for intimation of Billing Agreement | |
| 96 | + |
| 97 | +### Return type |
| 98 | + |
| 99 | +[**PtsV2CreditsPost201Response1**](PtsV2CreditsPost201Response1.md) |
| 100 | + |
| 101 | +### Authorization |
| 102 | + |
| 103 | +No authorization required |
| 104 | + |
| 105 | +### HTTP request headers |
| 106 | + |
| 107 | + - **Content-Type**: application/json;charset=utf-8 |
| 108 | + - **Accept**: application/hal+json;charset=utf-8 |
| 109 | + |
| 110 | +<a name="billingAgreementsRegistration"></a> |
| 111 | +# **billingAgreementsRegistration** |
| 112 | +> PtsV2CreditsPost201Response1 billingAgreementsRegistration(createBillingAgreement) |
| 113 | +
|
| 114 | +Standing Instruction completion registration |
| 115 | + |
| 116 | +Standing Instruction with or without Token. Transaction amount in case First payment is coming along with registration. Only 2 decimal places allowed |
| 117 | + |
| 118 | +### Example |
| 119 | +```javascript |
| 120 | +var CyberSource = require('CyberSource'); |
| 121 | + |
| 122 | +var apiInstance = new CyberSource.BillingAgreementsApi(); |
| 123 | + |
| 124 | +var createBillingAgreement = new CyberSource.CreateBillingAgreement(); // CreateBillingAgreement | |
| 125 | + |
| 126 | + |
| 127 | +var callback = function(error, data, response) { |
| 128 | + if (error) { |
| 129 | + console.error(error); |
| 130 | + } else { |
| 131 | + console.log('API called successfully. Returned data: ' + data); |
| 132 | + } |
| 133 | +}; |
| 134 | +apiInstance.billingAgreementsRegistration(createBillingAgreement, callback); |
| 135 | +``` |
| 136 | + |
| 137 | +### Parameters |
| 138 | + |
| 139 | +Name | Type | Description | Notes |
| 140 | +------------- | ------------- | ------------- | ------------- |
| 141 | + **createBillingAgreement** | [**CreateBillingAgreement**](CreateBillingAgreement.md)| | |
| 142 | + |
| 143 | +### Return type |
| 144 | + |
| 145 | +[**PtsV2CreditsPost201Response1**](PtsV2CreditsPost201Response1.md) |
| 146 | + |
| 147 | +### Authorization |
| 148 | + |
| 149 | +No authorization required |
| 150 | + |
| 151 | +### HTTP request headers |
| 152 | + |
| 153 | + - **Content-Type**: application/json;charset=utf-8 |
| 154 | + - **Accept**: application/hal+json;charset=utf-8 |
| 155 | + |
0 commit comments