SyncteraRubySdk::ACHApi

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

Method	HTTP request	Description
add_transaction_out	POST /ach	Send an ACH
get_transaction_out	GET /ach/transaction_id	Get a sent ACH transaction
list_transactions_out	GET /ach	List sent ACH transactions
patch_transaction_out	PATCH /ach/transaction_id	Update a sent ACH transaction

add_transaction_out

add_transaction_out(outgoing_ach_request, opts)

Send an ACH

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::ACHApi.new
outgoing_ach_request = SyncteraRubySdk::OutgoingAchRequest.new({amount: 607, currency: 'USD', customer_id: 'b01db9c7-78f2-4a99-8aca-1231d32f9b96', dc_sign: 'debit', originating_account_id: 'b01db9c7-78f2-4a99-8aca-1231d32f9b96', receiving_account_id: 'b01db9c7-78f2-4a99-8aca-1231d32f9b96'}) # OutgoingAchRequest | Send ACH request
opts = {
  idempotency_key: '7d943c51-e4ff-4e57-9558-08cab6b963c7' # String | An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry.
}

begin
  # Send an ACH
  result = api_instance.add_transaction_out(outgoing_ach_request, opts)
  p result
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling ACHApi->add_transaction_out: #{e}"
end

Using the add_transaction_out_with_http_info variant

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

, Integer, Hash)> add_transaction_out_with_http_info(outgoing_ach_request, opts)

begin
  # Send an ACH
  data, status_code, headers = api_instance.add_transaction_out_with_http_info(outgoing_ach_request, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <OutgoingAch>
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling ACHApi->add_transaction_out_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
outgoing_ach_request	OutgoingAchRequest	Send ACH request
idempotency_key	String	An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry.	[optional]

Return type

OutgoingAch

Authorization

bearerAuth

HTTP request headers

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

get_transaction_out

get_transaction_out(transaction_id)

Get a sent ACH transaction

Get a single sent ACH transaction

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::ACHApi.new
transaction_id = 'b01db9c7-78f2-4a99-8aca-1231d32f9b96' # String | Transaction ID in the ledger

begin
  # Get a sent ACH transaction
  result = api_instance.get_transaction_out(transaction_id)
  p result
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling ACHApi->get_transaction_out: #{e}"
end

Using the get_transaction_out_with_http_info variant

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

, Integer, Hash)> get_transaction_out_with_http_info(transaction_id)

begin
  # Get a sent ACH transaction
  data, status_code, headers = api_instance.get_transaction_out_with_http_info(transaction_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <OutgoingAch>
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling ACHApi->get_transaction_out_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
transaction_id	String	Transaction ID in the ledger

Return type

OutgoingAch

Authorization

bearerAuth

HTTP request headers

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

list_transactions_out

list_transactions_out(opts)

List sent ACH transactions

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::ACHApi.new
opts = {
  limit: 100, # Integer | 
  page_token: 'a8937a0d' # String | 
}

begin
  # List sent ACH transactions
  result = api_instance.list_transactions_out(opts)
  p result
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling ACHApi->list_transactions_out: #{e}"
end

Using the list_transactions_out_with_http_info variant

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

, Integer, Hash)> list_transactions_out_with_http_info(opts)

begin
  # List sent ACH transactions
  data, status_code, headers = api_instance.list_transactions_out_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <OutgoingAchList>
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling ACHApi->list_transactions_out_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
limit	Integer		[optional][default to 100]
page_token	String		[optional]

Return type

OutgoingAchList

Authorization

bearerAuth

HTTP request headers

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

patch_transaction_out

patch_transaction_out(transaction_id, outgoing_ach_patch, opts)

Update a sent ACH transaction

Update a sent ACH transaction (either status or funds availability)

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::ACHApi.new
transaction_id = 'b01db9c7-78f2-4a99-8aca-1231d32f9b96' # String | Transaction ID in the ledger
outgoing_ach_patch = SyncteraRubySdk::OutgoingAchPatch.new # OutgoingAchPatch | Update sent ach transaction
opts = {
  idempotency_key: '7d943c51-e4ff-4e57-9558-08cab6b963c7' # String | An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry.
}

begin
  # Update a sent ACH transaction
  result = api_instance.patch_transaction_out(transaction_id, outgoing_ach_patch, opts)
  p result
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling ACHApi->patch_transaction_out: #{e}"
end

Using the patch_transaction_out_with_http_info variant

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

, Integer, Hash)> patch_transaction_out_with_http_info(transaction_id, outgoing_ach_patch, opts)

begin
  # Update a sent ACH transaction
  data, status_code, headers = api_instance.patch_transaction_out_with_http_info(transaction_id, outgoing_ach_patch, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <OutgoingAch>
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling ACHApi->patch_transaction_out_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
transaction_id	String	Transaction ID in the ledger
outgoing_ach_patch	OutgoingAchPatch	Update sent ach transaction
idempotency_key	String	An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry.	[optional]

Return type

OutgoingAch

Authorization

bearerAuth

HTTP request headers

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