|
| 1 | +# CyberSource::BillingAgreementsApi |
| 2 | + |
| 3 | +All URIs are relative to *https://apitest.cybersource.com* |
| 4 | + |
| 5 | +Method | HTTP request | Description |
| 6 | +------------- | ------------- | ------------- |
| 7 | +[**billing_agreements_de_registration**](BillingAgreementsApi.md#billing_agreements_de_registration) | **PATCH** /pts/v2/billing-agreements/{id} | Standing Instruction Cancellation or Modification |
| 8 | +[**billing_agreements_intimation**](BillingAgreementsApi.md#billing_agreements_intimation) | **POST** /pts/v2/billing-agreements/{id}/intimations | Standing Instruction intimation |
| 9 | +[**billing_agreements_registration**](BillingAgreementsApi.md#billing_agreements_registration) | **POST** /pts/v2/billing-agreements | Standing Instruction completion registration |
| 10 | + |
| 11 | + |
| 12 | +# **billing_agreements_de_registration** |
| 13 | +> PtsV2CreditsPost201Response1 billing_agreements_de_registration(modify_billing_agreement, id) |
| 14 | +
|
| 15 | +Standing Instruction Cancellation or Modification |
| 16 | + |
| 17 | +Standing Instruction with or without Token |
| 18 | + |
| 19 | +### Example |
| 20 | +```ruby |
| 21 | +# load the gem |
| 22 | +require 'cybersource_rest_client' |
| 23 | + |
| 24 | +api_instance = CyberSource::BillingAgreementsApi.new |
| 25 | + |
| 26 | +modify_billing_agreement = CyberSource::ModifyBillingAgreement.new # ModifyBillingAgreement | |
| 27 | + |
| 28 | +id = "id_example" # String | ID for de-registration or cancellation of Billing Agreement |
| 29 | + |
| 30 | + |
| 31 | +begin |
| 32 | + #Standing Instruction Cancellation or Modification |
| 33 | + result = api_instance.billing_agreements_de_registration(modify_billing_agreement, id) |
| 34 | + p result |
| 35 | +rescue CyberSource::ApiError => e |
| 36 | + puts "Exception when calling BillingAgreementsApi->billing_agreements_de_registration: #{e}" |
| 37 | +end |
| 38 | +``` |
| 39 | + |
| 40 | +### Parameters |
| 41 | + |
| 42 | +Name | Type | Description | Notes |
| 43 | +------------- | ------------- | ------------- | ------------- |
| 44 | + **modify_billing_agreement** | [**ModifyBillingAgreement**](ModifyBillingAgreement.md)| | |
| 45 | + **id** | **String**| ID for de-registration or cancellation of Billing Agreement | |
| 46 | + |
| 47 | +### Return type |
| 48 | + |
| 49 | +[**PtsV2CreditsPost201Response1**](PtsV2CreditsPost201Response1.md) |
| 50 | + |
| 51 | +### Authorization |
| 52 | + |
| 53 | +No authorization required |
| 54 | + |
| 55 | +### HTTP request headers |
| 56 | + |
| 57 | + - **Content-Type**: application/json;charset=utf-8 |
| 58 | + - **Accept**: application/hal+json;charset=utf-8 |
| 59 | + |
| 60 | + |
| 61 | + |
| 62 | +# **billing_agreements_intimation** |
| 63 | +> PtsV2CreditsPost201Response1 billing_agreements_intimation(intimate_billing_agreement, id) |
| 64 | +
|
| 65 | +Standing Instruction intimation |
| 66 | + |
| 67 | +Standing Instruction with or without Token. |
| 68 | + |
| 69 | +### Example |
| 70 | +```ruby |
| 71 | +# load the gem |
| 72 | +require 'cybersource_rest_client' |
| 73 | + |
| 74 | +api_instance = CyberSource::BillingAgreementsApi.new |
| 75 | + |
| 76 | +intimate_billing_agreement = CyberSource::IntimateBillingAgreement.new # IntimateBillingAgreement | |
| 77 | + |
| 78 | +id = "id_example" # String | ID for intimation of Billing Agreement |
| 79 | + |
| 80 | + |
| 81 | +begin |
| 82 | + #Standing Instruction intimation |
| 83 | + result = api_instance.billing_agreements_intimation(intimate_billing_agreement, id) |
| 84 | + p result |
| 85 | +rescue CyberSource::ApiError => e |
| 86 | + puts "Exception when calling BillingAgreementsApi->billing_agreements_intimation: #{e}" |
| 87 | +end |
| 88 | +``` |
| 89 | + |
| 90 | +### Parameters |
| 91 | + |
| 92 | +Name | Type | Description | Notes |
| 93 | +------------- | ------------- | ------------- | ------------- |
| 94 | + **intimate_billing_agreement** | [**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 | + |
| 111 | + |
| 112 | +# **billing_agreements_registration** |
| 113 | +> PtsV2CreditsPost201Response1 billing_agreements_registration(create_billing_agreement) |
| 114 | +
|
| 115 | +Standing Instruction completion registration |
| 116 | + |
| 117 | +Standing Instruction with or without Token. Transaction amount in case First payment is coming along with registration. Only 2 decimal places allowed |
| 118 | + |
| 119 | +### Example |
| 120 | +```ruby |
| 121 | +# load the gem |
| 122 | +require 'cybersource_rest_client' |
| 123 | + |
| 124 | +api_instance = CyberSource::BillingAgreementsApi.new |
| 125 | + |
| 126 | +create_billing_agreement = CyberSource::CreateBillingAgreement.new # CreateBillingAgreement | |
| 127 | + |
| 128 | + |
| 129 | +begin |
| 130 | + #Standing Instruction completion registration |
| 131 | + result = api_instance.billing_agreements_registration(create_billing_agreement) |
| 132 | + p result |
| 133 | +rescue CyberSource::ApiError => e |
| 134 | + puts "Exception when calling BillingAgreementsApi->billing_agreements_registration: #{e}" |
| 135 | +end |
| 136 | +``` |
| 137 | + |
| 138 | +### Parameters |
| 139 | + |
| 140 | +Name | Type | Description | Notes |
| 141 | +------------- | ------------- | ------------- | ------------- |
| 142 | + **create_billing_agreement** | [**CreateBillingAgreement**](CreateBillingAgreement.md)| | |
| 143 | + |
| 144 | +### Return type |
| 145 | + |
| 146 | +[**PtsV2CreditsPost201Response1**](PtsV2CreditsPost201Response1.md) |
| 147 | + |
| 148 | +### Authorization |
| 149 | + |
| 150 | +No authorization required |
| 151 | + |
| 152 | +### HTTP request headers |
| 153 | + |
| 154 | + - **Content-Type**: application/json;charset=utf-8 |
| 155 | + - **Accept**: application/hal+json;charset=utf-8 |
| 156 | + |
| 157 | + |
| 158 | + |
0 commit comments