Skip to content

Latest commit

 

History

History
159 lines (114 loc) · 5.03 KB

DisclosuresDeprecatedApi.md

File metadata and controls

159 lines (114 loc) · 5.03 KB
Raw

Synctera::DisclosuresDeprecatedApi

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

Method HTTP request Description
create_disclosure1 POST /customers/{customer_id}/disclosures Create a Disclosure
list_disclosures1 GET /customers/{customer_id}/disclosures List Disclosures

create_disclosure1

create_disclosure1(customer_id, disclosure1, opts)

Create a Disclosure

Disclosures to be made to customers

Examples

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

api_instance = Synctera::DisclosuresDeprecatedApi.new
customer_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The customer's unique identifier
disclosure1 = Synctera::Disclosure1.new({event_type: 'ACKNOWLEDGED', timestamp: Time.parse('2010-05-06T12:23:34.321Z'), type: 'ACH_AUTHORIZATION', version: 'v1.1'}) # Disclosure1 | Disclosure to create
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
  # Create a Disclosure
  result = api_instance.create_disclosure1(customer_id, disclosure1, opts)
  p result
rescue Synctera::ApiError => e
  puts "Error when calling DisclosuresDeprecatedApi->create_disclosure1: #{e}"
end

Using the create_disclosure1_with_http_info variant

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

<Array(, Integer, Hash)> create_disclosure1_with_http_info(customer_id, disclosure1, opts)

begin
  # Create a Disclosure
  data, status_code, headers = api_instance.create_disclosure1_with_http_info(customer_id, disclosure1, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Disclosure1>
rescue Synctera::ApiError => e
  puts "Error when calling DisclosuresDeprecatedApi->create_disclosure1_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
customer_id String The customer's unique identifier
disclosure1 Disclosure1 Disclosure to create
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

Disclosure1

Authorization

bearerAuth

HTTP request headers

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

list_disclosures1

list_disclosures1(customer_id, opts)

List Disclosures

Retrieves paginated list of disclosures associated with the authorized requester

Examples

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

api_instance = Synctera::DisclosuresDeprecatedApi.new
customer_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The customer's unique identifier
opts = {
  page_token: 'a8937a0d', # String | 
  limit: 100 # Integer | 
}

begin
  # List Disclosures
  result = api_instance.list_disclosures1(customer_id, opts)
  p result
rescue Synctera::ApiError => e
  puts "Error when calling DisclosuresDeprecatedApi->list_disclosures1: #{e}"
end

Using the list_disclosures1_with_http_info variant

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

<Array(, Integer, Hash)> list_disclosures1_with_http_info(customer_id, opts)

begin
  # List Disclosures
  data, status_code, headers = api_instance.list_disclosures1_with_http_info(customer_id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <DisclosureResponse>
rescue Synctera::ApiError => e
  puts "Error when calling DisclosuresDeprecatedApi->list_disclosures1_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
customer_id String The customer's unique identifier
page_token String [optional]
limit Integer [optional][default to 100]

Return type

DisclosureResponse

Authorization

bearerAuth

HTTP request headers

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