# Cyclos411Api.PaymentRequestsApi All URIs are relative to *https://138.197.145.149:8080/cyclos/eCloudAtm/api* Method | HTTP request | Description ------------- | ------------- | ------------- [**acceptPaymentRequest**](PaymentRequestsApi.md#acceptPaymentRequest) | **POST** /payment-requests/{key}/accept | Accepts a payment request. [**cancelPaymentRequest**](PaymentRequestsApi.md#cancelPaymentRequest) | **POST** /payment-requests/{key}/cancel | Cancels a payment request. [**changePaymentRequestExpirationDate**](PaymentRequestsApi.md#changePaymentRequestExpirationDate) | **POST** /payment-requests/{key}/change-expiration | Changes the payment request expiration. [**dataForSendPaymentRequest**](PaymentRequestsApi.md#dataForSendPaymentRequest) | **GET** /{owner}/payment-requests/data-for-send | Returns configuration data for sending a payment request [**previewPaymentRequest**](PaymentRequestsApi.md#previewPaymentRequest) | **GET** /payment-requests/{key}/preview | Previews the payment performed when accepting the given payment request. [**rejectPaymentRequest**](PaymentRequestsApi.md#rejectPaymentRequest) | **POST** /payment-requests/{key}/reject | Rejects a payment request. [**reschedulePaymentRequest**](PaymentRequestsApi.md#reschedulePaymentRequest) | **POST** /payment-requests/{key}/reschedule | Reschedules a payment request. [**sendPaymentRequest**](PaymentRequestsApi.md#sendPaymentRequest) | **POST** /{owner}/payment-requests | Sends a payment request from the given owner # **acceptPaymentRequest** > Transaction acceptPaymentRequest(key, params, opts) Accepts a payment request. Accepts a payment request in status `open`. After accepting the payment request its resultant status could be `processed` (and the corresponding sheduled or direct payment was generated) or `scheduled`. This can be done only by managers or the payer (i.e the request's recipient) with permission to accept. ### Example ```javascript var Cyclos411Api = require('cyclos_411_api'); var defaultClient = Cyclos411Api.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 Cyclos411Api.PaymentRequestsApi(); var key = "key_example"; // String | Either the id or transaction number. var params = new Cyclos411Api.AcceptOrReschedulePaymentRequest(); // AcceptOrReschedulePaymentRequest | The parameters to accept a payment request 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.acceptPaymentRequest(key, params, opts, callback); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **key** | **String**| Either the id or transaction number. | **params** | [**AcceptOrReschedulePaymentRequest**](AcceptOrReschedulePaymentRequest.md)| The parameters to accept a payment request | **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 # **cancelPaymentRequest** > cancelPaymentRequest(key, opts) Cancels a payment request. Cancels a payment request in status `open`. This can be done only by managers or the payee with permission to cancel. ### Example ```javascript var Cyclos411Api = require('cyclos_411_api'); var defaultClient = Cyclos411Api.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 Cyclos411Api.PaymentRequestsApi(); var key = "key_example"; // String | Either the id or transaction number var opts = { '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. 'comments': "comments_example" // String | A comment for the cancel action the payee/manager can set. }; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully.'); } }; apiInstance.cancelPaymentRequest(key, opts, callback); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **key** | **String**| Either the id or transaction number | **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] **comments** | **String**| A comment for the cancel action the payee/manager can set. | [optional] ### Return type null (empty response body) ### Authorization [accessClient](../README.md#accessClient), [basic](../README.md#basic), [session](../README.md#session) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **changePaymentRequestExpirationDate** > changePaymentRequestExpirationDate(key, params, opts) Changes the payment request expiration. Change the expiration date of a payment request in status `open` or `expired`. This can be done only by managers or the payee (i.e the request's sender) with permission to change the expiration. ### Example ```javascript var Cyclos411Api = require('cyclos_411_api'); var defaultClient = Cyclos411Api.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 Cyclos411Api.PaymentRequestsApi(); var key = "key_example"; // String | Either the id or transaction number. var params = new Cyclos411Api.ChangePaymentRequestExpirationDate(); // ChangePaymentRequestExpirationDate | The parameters to change the payment request's expiration date 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.'); } }; apiInstance.changePaymentRequestExpirationDate(key, params, opts, callback); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **key** | **String**| Either the id or transaction number. | **params** | [**ChangePaymentRequestExpirationDate**](ChangePaymentRequestExpirationDate.md)| The parameters to change the payment request's expiration date | **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 null (empty response body) ### Authorization [accessClient](../README.md#accessClient), [basic](../README.md#basic), [session](../README.md#session) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **dataForSendPaymentRequest** > DataForTransaction dataForSendPaymentRequest(owner, opts) Returns configuration data for sending a payment request Returns configuration data for sending a payment request ### Example ```javascript var Cyclos411Api = require('cyclos_411_api'); var defaultClient = Cyclos411Api.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 Cyclos411Api.PaymentRequestsApi(); 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 request destination, which is either string `system` for a payment request to system or a user identification. The payment request destination is the one that performs the payment once it is accepted. '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.dataForSendPaymentRequest(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 request destination, which is either string `system` for a payment request to system or a user identification. The payment request destination is the one that performs the payment once it is accepted. | [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 # **previewPaymentRequest** > PaymentPreview previewPaymentRequest(key, opts) Previews the payment performed when accepting the given payment request. Previews the payment ony if the payment request status is `open` or `scheduled`. ### Example ```javascript var Cyclos411Api = require('cyclos_411_api'); var defaultClient = Cyclos411Api.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 Cyclos411Api.PaymentRequestsApi(); var key = "key_example"; // String | Either the id or transaction number. 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.previewPaymentRequest(key, opts, callback); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **key** | **String**| Either the id or transaction number. | **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 # **rejectPaymentRequest** > rejectPaymentRequest(key, opts) Rejects a payment request. Rejects a payment request in status `open`. This can be done only by managers or the payer (i.e the request's recipient) with permission to accept. ### Example ```javascript var Cyclos411Api = require('cyclos_411_api'); var defaultClient = Cyclos411Api.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 Cyclos411Api.PaymentRequestsApi(); var key = "key_example"; // String | Either the id or transaction number var opts = { '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. 'comments': "comments_example" // String | A comment for the reject action the payer can set. }; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully.'); } }; apiInstance.rejectPaymentRequest(key, opts, callback); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **key** | **String**| Either the id or transaction number | **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] **comments** | **String**| A comment for the reject action the payer can set. | [optional] ### Return type null (empty response body) ### Authorization [accessClient](../README.md#accessClient), [basic](../README.md#basic), [session](../README.md#session) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **reschedulePaymentRequest** > Transaction reschedulePaymentRequest(key, params, opts) Reschedules a payment request. Reschedules an already accepted and scheduled payment request (i.e with status `scheduled`). If the new processing date is null then the payment request will be processed immediately generating the corresponding payment. Otherwise it will be scheduled to be processed at the given date. This can be done only by managers or the payer (i.e the request's recipient) with permission to accept. ### Example ```javascript var Cyclos411Api = require('cyclos_411_api'); var defaultClient = Cyclos411Api.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 Cyclos411Api.PaymentRequestsApi(); var key = "key_example"; // String | Either the id or transaction number. var params = new Cyclos411Api.AcceptOrReschedulePaymentRequest(); // AcceptOrReschedulePaymentRequest | The parameters to reschedule a payment request. 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.reschedulePaymentRequest(key, params, opts, callback); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **key** | **String**| Either the id or transaction number. | **params** | [**AcceptOrReschedulePaymentRequest**](AcceptOrReschedulePaymentRequest.md)| The parameters to reschedule a payment request. | **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 # **sendPaymentRequest** > Transaction sendPaymentRequest(owner, paymentRequest, opts) Sends a payment request from the given owner Sends a payment request from the owner indicated on the path (which will receive the payment once the request is accepted) to the owner specified on the body (which will perform the payment once the request is accepted). The destination user should be informed in the `subject` parameter. If the `subject` is `system`, the payment request is sent to a system account, and has to be accepted by an administrator. The payment request id is returned on the response, and a link to the transaction details is returned on the `Location` header. ### Example ```javascript var Cyclos411Api = require('cyclos_411_api'); var defaultClient = Cyclos411Api.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 Cyclos411Api.PaymentRequestsApi(); 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 paymentRequest = new Cyclos411Api.SendPaymentRequest(); // SendPaymentRequest | The send payment request 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.sendPaymentRequest(owner, paymentRequest, 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. | **paymentRequest** | [**SendPaymentRequest**](SendPaymentRequest.md)| The send payment request 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 [**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