SyncteraRubySdk::RemoteCheckDepositBetaApi

All URIs are relative to https://api.synctera.com/v0

Method	HTTP request	Description
create_rdc_deposit	POST /rdc/deposits	Create a Remote Check Deposit
get_rdc_deposit	GET /rdc/deposits/deposit_id	Get Remote Check Deposit
list_rdc_deposits	GET /rdc/deposits	List Remote Check Deposits

create_rdc_deposit

create_rdc_deposit(opts)

Create a Remote Check Deposit

Create a new deposit using remote deposit capture to an account

Examples

require 'time'
require 'synctera_ruby_sdk'
# setup authorization
SyncteraRubySdk.configure do |config|
  # Configure Bearer authorization (api_key): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = SyncteraRubySdk::RemoteCheckDepositBetaApi.new
opts = {
  deposit_post: SyncteraRubySdk::DepositPost.new({account_id: 'b01db9c7-78f2-4a99-8aca-1231d32f9b96', back_image_id: 'b01db9c7-78f2-4a99-8aca-1231d32f9b96', check_amount: 12345, deposit_currency: 'USD', front_image_id: 'b01db9c7-78f2-4a99-8aca-1231d32f9b96'}) # DepositPost | Attributes of the Remote Check Deposit to create
}

begin
  # Create a Remote Check Deposit
  result = api_instance.create_rdc_deposit(opts)
  p result
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling RemoteCheckDepositBetaApi->create_rdc_deposit: #{e}"
end

Using the create_rdc_deposit_with_http_info variant

This returns an Array which contains the response data, status code and headers.

, Integer, Hash)> create_rdc_deposit_with_http_info(opts)

begin
  # Create a Remote Check Deposit
  data, status_code, headers = api_instance.create_rdc_deposit_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <DepositGet>
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling RemoteCheckDepositBetaApi->create_rdc_deposit_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
deposit_post	DepositPost	Attributes of the Remote Check Deposit to create	[optional]

Return type

DepositGet

Authorization

bearerAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json, application/problem+json

get_rdc_deposit

get_rdc_deposit(deposit_id)

Get Remote Check Deposit

Retrieves one deposit made using remote deposit capture associated with an account

Examples

require 'time'
require 'synctera_ruby_sdk'
# setup authorization
SyncteraRubySdk.configure do |config|
  # Configure Bearer authorization (api_key): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = SyncteraRubySdk::RemoteCheckDepositBetaApi.new
deposit_id = 'b01db9c7-78f2-4a99-8aca-1231d32f9b96' # String | ID of a deposit for a remote deposit capture

begin
  # Get Remote Check Deposit
  result = api_instance.get_rdc_deposit(deposit_id)
  p result
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling RemoteCheckDepositBetaApi->get_rdc_deposit: #{e}"
end

Using the get_rdc_deposit_with_http_info variant

This returns an Array which contains the response data, status code and headers.

, Integer, Hash)> get_rdc_deposit_with_http_info(deposit_id)

begin
  # Get Remote Check Deposit
  data, status_code, headers = api_instance.get_rdc_deposit_with_http_info(deposit_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <DepositGet>
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling RemoteCheckDepositBetaApi->get_rdc_deposit_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
deposit_id	String	ID of a deposit for a remote deposit capture

Return type

DepositGet

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/problem+json

list_rdc_deposits

list_rdc_deposits(opts)

List Remote Check Deposits

Retrieves a paginated list of the deposits made using remote deposit capture associated with an account

Examples

require 'time'
require 'synctera_ruby_sdk'
# setup authorization
SyncteraRubySdk.configure do |config|
  # Configure Bearer authorization (api_key): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = SyncteraRubySdk::RemoteCheckDepositBetaApi.new
opts = {
  account_id: 'b01db9c7-78f2-4a99-8aca-1231d32f9b96', # String | Unique identifier for the account.
  limit: 100, # Integer | 
  page_token: 'a8937a0d' # String | 
}

begin
  # List Remote Check Deposits
  result = api_instance.list_rdc_deposits(opts)
  p result
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling RemoteCheckDepositBetaApi->list_rdc_deposits: #{e}"
end

Using the list_rdc_deposits_with_http_info variant

This returns an Array which contains the response data, status code and headers.

, Integer, Hash)> list_rdc_deposits_with_http_info(opts)

begin
  # List Remote Check Deposits
  data, status_code, headers = api_instance.list_rdc_deposits_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <DepositList>
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling RemoteCheckDepositBetaApi->list_rdc_deposits_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
account_id	String	Unique identifier for the account.	[optional]
limit	Integer		[optional][default to 100]
page_token	String		[optional]

Return type

DepositList

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/problem+json