# Cyclos4102Api.PaymentsApi All URIs are relative to *https://demo.cyclos.org/api* Method | HTTP request | Description ------------- | ------------- | ------------- [**calculatePerformPaymentInstallments**](PaymentsApi.md#calculatePerformPaymentInstallments) | **GET** /{owner}/payments/installments | Calculates the default installments for a scheduled payment [**dataForPerformPayment**](PaymentsApi.md#dataForPerformPayment) | **GET** /{owner}/payments/data-for-perform | Returns configuration data for performing a payment [**getPaymentQrCode**](PaymentsApi.md#getPaymentQrCode) | **GET** /payments/qr-code | Returns the QR-code image for the given payment's parameters [**performPayment**](PaymentsApi.md#performPayment) | **POST** /{owner}/payments | Performs a payment from the given owner [**previewPayment**](PaymentsApi.md#previewPayment) | **POST** /{owner}/payments/preview | Previews a payment before performing it # **calculatePerformPaymentInstallments** > [PerformScheduledPaymentInstallment] calculatePerformPaymentInstallments(owner, to, count, amount, opts) Calculates the default installments for a scheduled payment Used to calculate installments for a scheduled payment. Will return an installment every month. When later performing the payment, these can be (optionally) customized (such as changing some due dates or amounts) and used on the payment installments. ### Example ```javascript var Cyclos4102Api = require('cyclos_4102_api'); var defaultClient = Cyclos4102Api.ApiClient.instance; // Configure API key authorization: accessClient var accessClient = defaultClient.authentications['accessClient']; accessClient.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //accessClient.apiKeyPrefix = 'Token'; // Configure HTTP basic authorization: basic var basic = defaultClient.authentications['basic']; basic.username = 'YOUR USERNAME'; basic.password = 'YOUR PASSWORD'; // Configure API key authorization: session var session = defaultClient.authentications['session']; session.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //session.apiKeyPrefix = 'Token'; var apiInstance = new Cyclos4102Api.PaymentsApi(); var owner = "owner_example"; // String | Can be one of: * a user identification value, such as id, username, e-mail, phone, etc. Id is always allowed, others depend on Cyclos configuration. Note that a valid numeric value is always considered as id. For example, when using another identification method that can be numeric only, prefix the value with a single quote (like in Excel spreadsheets), for example, `'1234567890`; * `self` for the currently authenticated user; * `system` for data that belongs to the system. var to = "to_example"; // String | The payment destination var count = 56; // Number | The number of installments var amount = new Cyclos4102Api.BigDecimal(); // BigDecimal | The total scheduled payment amount var opts = { 'fields': ["fields_example"], // [String] | Select which fields to include on returned data. If nothing is set, all object fields are returned. Unprefixed field names will be handled like a whitelist (only listed fields will be included), while names starting with a minus (-) or exclamation mark (!) will be handled as blacklist (listed fields will not be included). This works for nesting as well. For example: `a,b.b1,c.-c1,c.-c2` will return the fields `a`, `b` (containing only the `b1` field) and `c` (containing all its fields except for `c1` or `c2`). 'currency': "currency_example", // String | The payment currency. Used when no `type` is not provided, to narrow the possible payment types by currency. 'type': "type_example", // String | The payment type id or qualified internal name (in the form `fromAccountType.paymentType`). If not provided, will use the first possible type (possibly narrowed by the `currency` parameter). However, if more than one type is available, a validation error will be raised. 'firstDate': new Date("2013-10-20T19:20:30+01:00") // Date | The due date of the first installment. If none is provided, it is assumed that the first installment is paid immediately, and others will be with regular 1 month interval }; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; apiInstance.calculatePerformPaymentInstallments(owner, to, count, amount, opts, callback); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| Can be one of: * a user identification value, such as id, username, e-mail, phone, etc. Id is always allowed, others depend on Cyclos configuration. Note that a valid numeric value is always considered as id. For example, when using another identification method that can be numeric only, prefix the value with a single quote (like in Excel spreadsheets), for example, `'1234567890`; * `self` for the currently authenticated user; * `system` for data that belongs to the system. | **to** | **String**| The payment destination | **count** | **Number**| The number of installments | **amount** | **BigDecimal**| The total scheduled payment amount | **fields** | [**[String]**](String.md)| Select which fields to include on returned data. If nothing is set, all object fields are returned. Unprefixed field names will be handled like a whitelist (only listed fields will be included), while names starting with a minus (-) or exclamation mark (!) will be handled as blacklist (listed fields will not be included). This works for nesting as well. For example: `a,b.b1,c.-c1,c.-c2` will return the fields `a`, `b` (containing only the `b1` field) and `c` (containing all its fields except for `c1` or `c2`). | [optional] **currency** | **String**| The payment currency. Used when no `type` is not provided, to narrow the possible payment types by currency. | [optional] **type** | **String**| The payment type id or qualified internal name (in the form `fromAccountType.paymentType`). If not provided, will use the first possible type (possibly narrowed by the `currency` parameter). However, if more than one type is available, a validation error will be raised. | [optional] **firstDate** | **Date**| The due date of the first installment. If none is provided, it is assumed that the first installment is paid immediately, and others will be with regular 1 month interval | [optional] ### Return type [**[PerformScheduledPaymentInstallment]**](PerformScheduledPaymentInstallment.md) ### Authorization [accessClient](../README.md#accessClient), [basic](../README.md#basic), [session](../README.md#session) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **dataForPerformPayment** > DataForTransaction dataForPerformPayment(owner, opts) Returns configuration data for performing a payment Returns configuration data for performing a payment ### Example ```javascript var Cyclos4102Api = require('cyclos_4102_api'); var defaultClient = Cyclos4102Api.ApiClient.instance; // Configure API key authorization: accessClient var accessClient = defaultClient.authentications['accessClient']; accessClient.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //accessClient.apiKeyPrefix = 'Token'; // Configure HTTP basic authorization: basic var basic = defaultClient.authentications['basic']; basic.username = 'YOUR USERNAME'; basic.password = 'YOUR PASSWORD'; // Configure API key authorization: session var session = defaultClient.authentications['session']; session.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //session.apiKeyPrefix = 'Token'; var apiInstance = new Cyclos4102Api.PaymentsApi(); var owner = "owner_example"; // String | Can be one of: * a user identification value, such as id, username, e-mail, phone, etc. Id is always allowed, others depend on Cyclos configuration. Note that a valid numeric value is always considered as id. For example, when using another identification method that can be numeric only, prefix the value with a single quote (like in Excel spreadsheets), for example, `'1234567890`; * `self` for the currently authenticated user; * `system` for data that belongs to the system. var opts = { 'fields': ["fields_example"], // [String] | Select which fields to include on returned data. If nothing is set, all object fields are returned. Unprefixed field names will be handled like a whitelist (only listed fields will be included), while names starting with a minus (-) or exclamation mark (!) will be handled as blacklist (listed fields will not be included). This works for nesting as well. For example: `a,b.b1,c.-c1,c.-c2` will return the fields `a`, `b` (containing only the `b1` field) and `c` (containing all its fields except for `c1` or `c2`). 'to': "to_example", // String | The payment destination. Either the string `system` for a payment to system or a user identification. 'type': "type_example" // String | The payment type id or qualified internal name (in the form `fromAccountType.paymentType`). If no payment type is provided, the possible types will be returned, so the payer can choose. }; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; apiInstance.dataForPerformPayment(owner, opts, callback); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| Can be one of: * a user identification value, such as id, username, e-mail, phone, etc. Id is always allowed, others depend on Cyclos configuration. Note that a valid numeric value is always considered as id. For example, when using another identification method that can be numeric only, prefix the value with a single quote (like in Excel spreadsheets), for example, `'1234567890`; * `self` for the currently authenticated user; * `system` for data that belongs to the system. | **fields** | [**[String]**](String.md)| Select which fields to include on returned data. If nothing is set, all object fields are returned. Unprefixed field names will be handled like a whitelist (only listed fields will be included), while names starting with a minus (-) or exclamation mark (!) will be handled as blacklist (listed fields will not be included). This works for nesting as well. For example: `a,b.b1,c.-c1,c.-c2` will return the fields `a`, `b` (containing only the `b1` field) and `c` (containing all its fields except for `c1` or `c2`). | [optional] **to** | **String**| The payment destination. Either the string `system` for a payment to system or a user identification. | [optional] **type** | **String**| The payment type id or qualified internal name (in the form `fromAccountType.paymentType`). If no payment type is provided, the possible types will be returned, so the payer can choose. | [optional] ### Return type [**DataForTransaction**](DataForTransaction.md) ### Authorization [accessClient](../README.md#accessClient), [basic](../README.md#basic), [session](../README.md#session) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **getPaymentQrCode** > File getPaymentQrCode(to, opts) Returns the QR-code image for the given payment's parameters The generated image could be scanned (e.g by the mobile application) to create a payment ready to be confirmed. ### Example ```javascript var Cyclos4102Api = require('cyclos_4102_api'); var defaultClient = Cyclos4102Api.ApiClient.instance; // Configure API key authorization: accessClient var accessClient = defaultClient.authentications['accessClient']; accessClient.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //accessClient.apiKeyPrefix = 'Token'; // Configure HTTP basic authorization: basic var basic = defaultClient.authentications['basic']; basic.username = 'YOUR USERNAME'; basic.password = 'YOUR PASSWORD'; // Configure API key authorization: session var session = defaultClient.authentications['session']; session.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //session.apiKeyPrefix = 'Token'; var apiInstance = new Cyclos4102Api.PaymentsApi(); var to = "to_example"; // String | The payment receiver var opts = { 'amount': new Cyclos4102Api.BigDecimal(), // BigDecimal | The payment amount 'description': "description_example", // String | The payment description 'type': "type_example", // String | The payment type, either the id or qualified internal name (in the form `fromAccountType.paymentType`). 'customFields': ["customFields_example"], // [String] | Custom field values. Is a comma-separated array, where each part consists in two parts: the internal name (or custom field id) of the field, and a value, both separated by : (colon). For example, `customFields=field1:value1,field2:value2`. Sometimes multiple values are accepted. In this case, the multiple values are separated by pipes. For example, profileFields=field1:valueA|valueB. Enumerated fields accept multiple values, while numeric and date fields also accept ranges, which are two values, pipe-separated. For example, `customFields=rank:bronze|silver,birthDate:2000-01-01|2001-12-31` would match results whose custom field with internal name `rank` is either bronze or silver, and whose `birthDate` is between January 1, 2000 and December 31, 2001. To specify a single bound in ranges (like birth dates before December 31, 2001), use a pipe in one of the values, like `customFields=birthDate:|2001-12-31`. 'size': "size_example" // String | The possible sizes of images. The actual pixel size depends on the configuration in Cyclos Possible values are: * large: Full image size * medium: Medium thumbnail * small: Small thumbnail }; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; apiInstance.getPaymentQrCode(to, opts, callback); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **to** | **String**| The payment receiver | **amount** | **BigDecimal**| The payment amount | [optional] **description** | **String**| The payment description | [optional] **type** | **String**| The payment type, either the id or qualified internal name (in the form `fromAccountType.paymentType`). | [optional] **customFields** | [**[String]**](String.md)| Custom field values. Is a comma-separated array, where each part consists in two parts: the internal name (or custom field id) of the field, and a value, both separated by : (colon). For example, `customFields=field1:value1,field2:value2`. Sometimes multiple values are accepted. In this case, the multiple values are separated by pipes. For example, profileFields=field1:valueA|valueB. Enumerated fields accept multiple values, while numeric and date fields also accept ranges, which are two values, pipe-separated. For example, `customFields=rank:bronze|silver,birthDate:2000-01-01|2001-12-31` would match results whose custom field with internal name `rank` is either bronze or silver, and whose `birthDate` is between January 1, 2000 and December 31, 2001. To specify a single bound in ranges (like birth dates before December 31, 2001), use a pipe in one of the values, like `customFields=birthDate:|2001-12-31`. | [optional] **size** | **String**| The possible sizes of images. The actual pixel size depends on the configuration in Cyclos Possible values are: * large: Full image size * medium: Medium thumbnail * small: Small thumbnail | [optional] ### Return type **File** ### Authorization [accessClient](../README.md#accessClient), [basic](../README.md#basic), [session](../README.md#session) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json, image/jpeg, image/gif, image/png # **performPayment** > Transaction performPayment(owner, payment, opts) Performs a payment from the given owner Performs either a direct or scheduled payment from the owner indicated on the path to the owner specified on the body. The destination user should be informed in the `subject` parameter. If the `subject` is `system`, it will be a payment to a system account. The payment id is returned on the response, and a link to the transaction details is returned on the `Location` header. ### Example ```javascript var Cyclos4102Api = require('cyclos_4102_api'); var defaultClient = Cyclos4102Api.ApiClient.instance; // Configure API key authorization: accessClient var accessClient = defaultClient.authentications['accessClient']; accessClient.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //accessClient.apiKeyPrefix = 'Token'; // Configure HTTP basic authorization: basic var basic = defaultClient.authentications['basic']; basic.username = 'YOUR USERNAME'; basic.password = 'YOUR PASSWORD'; // Configure API key authorization: session var session = defaultClient.authentications['session']; session.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //session.apiKeyPrefix = 'Token'; var apiInstance = new Cyclos4102Api.PaymentsApi(); var owner = "owner_example"; // String | Can be one of: * a user identification value, such as id, username, e-mail, phone, etc. Id is always allowed, others depend on Cyclos configuration. Note that a valid numeric value is always considered as id. For example, when using another identification method that can be numeric only, prefix the value with a single quote (like in Excel spreadsheets), for example, `'1234567890`; * `self` for the currently authenticated user; * `system` for data that belongs to the system. var payment = new Cyclos4102Api.PerformPayment(); // PerformPayment | The perform payment parameters var opts = { 'fields': ["fields_example"], // [String] | Select which fields to include on returned data. If nothing is set, all object fields are returned. Unprefixed field names will be handled like a whitelist (only listed fields will be included), while names starting with a minus (-) or exclamation mark (!) will be handled as blacklist (listed fields will not be included). This works for nesting as well. For example: `a,b.b1,c.-c1,c.-c2` will return the fields `a`, `b` (containing only the `b1` field) and `c` (containing all its fields except for `c1` or `c2`). 'confirmationPassword': "confirmationPassword_example" // String | The password used to confirm this action, if needed. The actual password type, if any, depends on the Cyclos configuration for the current channel. }; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; apiInstance.performPayment(owner, payment, opts, callback); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| Can be one of: * a user identification value, such as id, username, e-mail, phone, etc. Id is always allowed, others depend on Cyclos configuration. Note that a valid numeric value is always considered as id. For example, when using another identification method that can be numeric only, prefix the value with a single quote (like in Excel spreadsheets), for example, `'1234567890`; * `self` for the currently authenticated user; * `system` for data that belongs to the system. | **payment** | [**PerformPayment**](PerformPayment.md)| The perform payment parameters | **fields** | [**[String]**](String.md)| Select which fields to include on returned data. If nothing is set, all object fields are returned. Unprefixed field names will be handled like a whitelist (only listed fields will be included), while names starting with a minus (-) or exclamation mark (!) will be handled as blacklist (listed fields will not be included). This works for nesting as well. For example: `a,b.b1,c.-c1,c.-c2` will return the fields `a`, `b` (containing only the `b1` field) and `c` (containing all its fields except for `c1` or `c2`). | [optional] **confirmationPassword** | **String**| The password used to confirm this action, if needed. The actual password type, if any, depends on the Cyclos configuration for the current channel. | [optional] ### Return type [**Transaction**](Transaction.md) ### Authorization [accessClient](../README.md#accessClient), [basic](../README.md#basic), [session](../README.md#session) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **previewPayment** > PaymentPreview previewPayment(owner, payment, opts) Previews a payment before performing it Previews a payment or scheduled payment. The actual balance checking is not performed in the preview. ### Example ```javascript var Cyclos4102Api = require('cyclos_4102_api'); var defaultClient = Cyclos4102Api.ApiClient.instance; // Configure API key authorization: accessClient var accessClient = defaultClient.authentications['accessClient']; accessClient.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //accessClient.apiKeyPrefix = 'Token'; // Configure HTTP basic authorization: basic var basic = defaultClient.authentications['basic']; basic.username = 'YOUR USERNAME'; basic.password = 'YOUR PASSWORD'; // Configure API key authorization: session var session = defaultClient.authentications['session']; session.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //session.apiKeyPrefix = 'Token'; var apiInstance = new Cyclos4102Api.PaymentsApi(); var owner = "owner_example"; // String | Can be one of: * a user identification value, such as id, username, e-mail, phone, etc. Id is always allowed, others depend on Cyclos configuration. Note that a valid numeric value is always considered as id. For example, when using another identification method that can be numeric only, prefix the value with a single quote (like in Excel spreadsheets), for example, `'1234567890`; * `self` for the currently authenticated user; * `system` for data that belongs to the system. var payment = new Cyclos4102Api.PerformPayment(); // PerformPayment | The perform payment parameters var opts = { 'fields': ["fields_example"] // [String] | Select which fields to include on returned data. If nothing is set, all object fields are returned. Unprefixed field names will be handled like a whitelist (only listed fields will be included), while names starting with a minus (-) or exclamation mark (!) will be handled as blacklist (listed fields will not be included). This works for nesting as well. For example: `a,b.b1,c.-c1,c.-c2` will return the fields `a`, `b` (containing only the `b1` field) and `c` (containing all its fields except for `c1` or `c2`). }; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; apiInstance.previewPayment(owner, payment, opts, callback); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| Can be one of: * a user identification value, such as id, username, e-mail, phone, etc. Id is always allowed, others depend on Cyclos configuration. Note that a valid numeric value is always considered as id. For example, when using another identification method that can be numeric only, prefix the value with a single quote (like in Excel spreadsheets), for example, `'1234567890`; * `self` for the currently authenticated user; * `system` for data that belongs to the system. | **payment** | [**PerformPayment**](PerformPayment.md)| The perform payment parameters | **fields** | [**[String]**](String.md)| Select which fields to include on returned data. If nothing is set, all object fields are returned. Unprefixed field names will be handled like a whitelist (only listed fields will be included), while names starting with a minus (-) or exclamation mark (!) will be handled as blacklist (listed fields will not be included). This works for nesting as well. For example: `a,b.b1,c.-c1,c.-c2` will return the fields `a`, `b` (containing only the `b1` field) and `c` (containing all its fields except for `c1` or `c2`). | [optional] ### Return type [**PaymentPreview**](PaymentPreview.md) ### Authorization [accessClient](../README.md#accessClient), [basic](../README.md#basic), [session](../README.md#session) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json