lib/velopayments/api/funding_manager_api.rb in velopayments-2.18.113 vs lib/velopayments/api/funding_manager_api.rb in velopayments-2.19.40.beta1
- old
+ new
@@ -1,14 +1,14 @@
=begin
#Velo Payments APIs
### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
-The version of the OpenAPI document: 2.18.113
+The version of the OpenAPI document: 2.19.40
Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.2.1-SNAPSHOT
+OpenAPI Generator version: 4.2.3-SNAPSHOT
=end
require 'cgi'
@@ -495,11 +495,11 @@
# @param [Hash] opts the optional parameters
# @option opts [String] :physical_account_name Physical Account Name
# @option opts [String] :payor_id The account owner Payor ID
# @option opts [Integer] :page Page number. Default is 1. (default to 1)
# @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100. (default to 25)
- # @option opts [String] :sort Sort String
+ # @option opts [String] :sort List of sort fields e.g. ?sort=name:asc Default is name:asc The supported sort fields are - fundingRef (default to 'fundingRef:asc')
# @return [ListSourceAccountResponse]
def get_source_accounts(opts = {})
data, _status_code, _headers = get_source_accounts_with_http_info(opts)
data
end
@@ -509,16 +509,21 @@
# @param [Hash] opts the optional parameters
# @option opts [String] :physical_account_name Physical Account Name
# @option opts [String] :payor_id The account owner Payor ID
# @option opts [Integer] :page Page number. Default is 1.
# @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100.
- # @option opts [String] :sort Sort String
+ # @option opts [String] :sort List of sort fields e.g. ?sort=name:asc Default is name:asc The supported sort fields are - fundingRef
# @return [Array<(ListSourceAccountResponse, Integer, Hash)>] ListSourceAccountResponse data, response status code and response headers
def get_source_accounts_with_http_info(opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: FundingManagerApi.get_source_accounts ...'
end
+ pattern = Regexp.new(/[fundingRef]+[:desc|:asc]/)
+ if @api_client.config.client_side_validation && !opts[:'sort'].nil? && opts[:'sort'] !~ pattern
+ fail ArgumentError, "invalid value for 'opts[:\"sort\"]' when calling FundingManagerApi.get_source_accounts, must conform to the pattern #{pattern}."
+ end
+
# resource path
local_var_path = '/v1/sourceAccounts'
# query parameters
query_params = opts[:query_params] || {}
@@ -563,39 +568,50 @@
# Get list of source accounts
# List source accounts.
# @param [Hash] opts the optional parameters
# @option opts [String] :physical_account_name Physical Account Name
+ # @option opts [String] :physical_account_id The physical account ID
# @option opts [String] :payor_id The account owner Payor ID
+ # @option opts [String] :funding_account_id The funding account ID
# @option opts [Integer] :page Page number. Default is 1. (default to 1)
# @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100. (default to 25)
- # @option opts [String] :sort Sort String
+ # @option opts [String] :sort List of sort fields e.g. ?sort=name:asc Default is name:asc The supported sort fields are - fundingRef, name, balance (default to 'fundingRef:asc')
# @return [ListSourceAccountResponseV2]
def get_source_accounts_v2(opts = {})
data, _status_code, _headers = get_source_accounts_v2_with_http_info(opts)
data
end
# Get list of source accounts
# List source accounts.
# @param [Hash] opts the optional parameters
# @option opts [String] :physical_account_name Physical Account Name
+ # @option opts [String] :physical_account_id The physical account ID
# @option opts [String] :payor_id The account owner Payor ID
+ # @option opts [String] :funding_account_id The funding account ID
# @option opts [Integer] :page Page number. Default is 1.
# @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100.
- # @option opts [String] :sort Sort String
+ # @option opts [String] :sort List of sort fields e.g. ?sort=name:asc Default is name:asc The supported sort fields are - fundingRef, name, balance
# @return [Array<(ListSourceAccountResponseV2, Integer, Hash)>] ListSourceAccountResponseV2 data, response status code and response headers
def get_source_accounts_v2_with_http_info(opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: FundingManagerApi.get_source_accounts_v2 ...'
end
+ pattern = Regexp.new(/[fundingRef|name|balance]+[:desc|:asc]/)
+ if @api_client.config.client_side_validation && !opts[:'sort'].nil? && opts[:'sort'] !~ pattern
+ fail ArgumentError, "invalid value for 'opts[:\"sort\"]' when calling FundingManagerApi.get_source_accounts_v2, must conform to the pattern #{pattern}."
+ end
+
# resource path
local_var_path = '/v2/sourceAccounts'
# query parameters
query_params = opts[:query_params] || {}
query_params[:'physicalAccountName'] = opts[:'physical_account_name'] if !opts[:'physical_account_name'].nil?
+ query_params[:'physicalAccountId'] = opts[:'physical_account_id'] if !opts[:'physical_account_id'].nil?
query_params[:'payorId'] = opts[:'payor_id'] if !opts[:'payor_id'].nil?
+ query_params[:'fundingAccountId'] = opts[:'funding_account_id'] if !opts[:'funding_account_id'].nil?
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
# header parameters