lib/plaid/api/plaid_api.rb
# Create a transfer authorization
# Use the &#x60;/transfer/authorization/create&#x60; endpoint to determine transfer failure risk.  In Plaid&#39;s sandbox environment the decisions will be returned as follows:    - To approve a transfer, make an authorization request with an &#x60;amount&#x60; less than the available balance in the account.    - To decline a transfer with the rationale code &#x60;NSF&#x60;, the available balance on the account must be less than the authorization &#x60;amount&#x60;. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox.    - To decline a transfer with the rationale code &#x60;RISK&#x60;, the available balance on the account must be exactly $0. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox.    - To permit a transfer with the rationale code &#x60;MANUALLY_VERIFIED_ITEM&#x60;, create an Item in Link through the [Same Day Micro-deposits flow](https://plaid.com/docs/auth/coverage/testing/#testing-same-day-micro-deposits).    - To permit a transfer with the rationale code &#x60;LOGIN_REQUIRED&#x60;, [reset the login for an Item](https://plaid.com/docs/sandbox/#item_login_required).  All username/password combinations other than the ones listed above will result in a decision of permitted and rationale code &#x60;ERROR&#x60;.
# @param transfer_authorization_create_request [TransferAuthorizationCreateRequest] 
# @param [Hash] opts the optional parameters
# @return [Array<(TransferAuthorizationCreateResponse, Integer, Hash)>] TransferAuthorizationCreateResponse data, response status code and response headers
Create a transfer authorization
Use the `/transfer/authorization/create` endpoint to determine transfer failure risk.  In Plaid's sandbox environment the decisions will be returned as follows:    - To approve a transfer, make an authorization request with an `amount` less than the available balance in the account.    - To decline a transfer with the rationale code `NSF`, the available balance on the account must be less than the authorization `amount`. See [Create Sandbox test data] for details on how to customize data in Sandbox.    - To decline a transfer with the rationale code `RISK`, the available balance on the account must be exactly $0. See [Create Sandbox test data] for details on how to customize data in Sandbox.    - To permit a transfer with the rationale code `MANUALLY_VERIFIED_ITEM`, create an Item in Link through the [Same Day Micro-deposits flow].    - To permit a transfer with the rationale code `LOGIN_REQUIRED`, [reset the login for an Item].  All username/password combinations other than the ones listed above will result in a decision of permitted and rationale code `ERROR`.
Create a transfer authorization Use the ` / transfer / authorization / create ` endpoint to determine transfer failure risk . In Plaid ' s sandbox environment the decisions will be returned as follows : - To approve a transfer make an authorization request with an ` amount ` less than the available balance in the account . - To decline a transfer with the rationale code ` NSF ` the available balance on the account must be less than the authorization ` amount ` . See [ Create Sandbox test data ] for details on how to customize data in Sandbox . - To decline a transfer with the rationale code ` RISK ` the available balance on the account must be exactly $0 . See [ Create Sandbox test data ] for details on how to customize data in Sandbox . - To permit a transfer with the rationale code ` MANUALLY_VERIFIED_ITEM ` create an Item in Link through the [ Same Day Micro - deposits flow ] . - To permit a transfer with the rationale code ` LOGIN_REQUIRED ` [ reset the login for an Item ] . All username / password combinations other than the ones listed above will result in a decision of permitted and rationale code ` ERROR ` .
def transfer_authorization_create_with_http_info(transfer_authorization_create_request, opts = {})
      if @api_client.config.debugging
        @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_authorization_create ...'
      end
      if @api_client.config.client_side_validation && transfer_authorization_create_request.nil?
        fail ArgumentError, "Missing the required parameter 'transfer_authorization_create_request' when calling PlaidApi.transfer_authorization_create"
      end
      local_var_path = '/transfer/authorization/create'
      query_params = opts[:query_params] || {}
      header_params = opts[:header_params] || {}
      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
      form_params = opts[:form_params] || {}
      post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_authorization_create_request)
      return_type = opts[:debug_return_type] || 'TransferAuthorizationCreateResponse'
      auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
      new_options = opts.merge(
        :operation => :"PlaidApi.transfer_authorization_create",
        :header_params => header_params,
        :query_params => query_params,
        :form_params => form_params,
        :body => post_body,
        :auth_names => auth_names,
        :return_type => return_type
      )
      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
      if @api_client.config.debugging
        @api_client.config.logger.debug "API called: PlaidApi#transfer_authorization_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
      end
      return data, status_code, headers
    end
def transfer_authorization_create_with_http_info ( transfer_authorization_create_request , opts = { } ) if @api_client . config . debugging @api_client . config . logger . debug 'Calling API: PlaidApi.transfer_authorization_create ...' end if @api_client . config . client_side_validation && transfer_authorization_create_request . nil? fail ArgumentError , "Missing the required parameter 'transfer_authorization_create_request' when calling PlaidApi.transfer_authorization_create" end local_var_path = '/transfer/authorization/create' query_params = opts [ :query_params ] || { } header_params = opts [ :header_params ] || { } header_params [ 'Accept' ] = @api_client . select_header_accept ( [ 'application/json' ] ) header_params [ 'Content-Type' ] = @api_client . select_header_content_type ( [ 'application/json' ] ) form_params = opts [ :form_params ] || { } post_body = opts [ :debug_body ] || @api_client . object_to_http_body ( transfer_authorization_create_request ) return_type = opts [ :debug_return_type ] || 'TransferAuthorizationCreateResponse' auth_names = opts [ :debug_auth_names ] || [ 'clientId' , 'plaidVersion' , 'secret' ] new_options = opts . merge ( :operation => :" PlaidApi.transfer_authorization_create " , :header_params => header_params , :query_params => query_params , :form_params => form_params , :body => post_body , :auth_names => auth_names , :return_type => return_type ) data , status_code , headers = @api_client . call_api ( :POST , local_var_path , new_options ) if @api_client . config . debugging @api_client . config . logger . debug "API called: PlaidApi#transfer_authorization_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data , status_code , headers end
Create a transfer authorization
Use the &#x60;/transfer/authorization/create&#x60; endpoint to determine transfer failure risk.
Create a transfer authorization Use the &#x60 ; / transfer / authorization / create&#x60 ; endpoint to determine transfer failure risk .
# verify the required parameter 'transfer_authorization_create_request' is set # resource path # query parameters # header parameters # HTTP header 'Accept' (if needed) # HTTP header 'Content-Type' # form parameters # http body (model) # return_type # auth_names
TransferAuthorizationCreateResponse data, response status code and response headers
TransferAuthorizationCreateResponse data response status code and response headers
Array<(TransferAuthorizationCreateResponse, Integer, Hash)>
transfer_authorization_create_request
opts
None
opts the optional parameters
opts the optional parameters