Skip to content

Latest commit

 

History

History
315 lines (228 loc) · 9.72 KB

WiresApi.md

File metadata and controls

315 lines (228 loc) · 9.72 KB

Synctera::WiresApi

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

Method HTTP request Description
cancel_wire PATCH /wires/{wire_id} Cancel an outgoing wire
create_wire POST /wires Send a wire
get_wire GET /wires/{wire_id} Get an outgoing wire by id
list_wires GET /wires List outgoing wires

cancel_wire

cancel_wire(wire_id, update_transfer, opts)

Cancel an outgoing wire

Cancel an outgoing tranfer

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::WiresApi.new
wire_id = 'b01db9c7-78f2-4a99-8aca-1231d32f9b96' # String | The unique identifier of a wire transfer.
update_transfer = Synctera::UpdateTransfer.new({status: 'CANCELED'}) # UpdateTransfer | wire to update
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
  # Cancel an outgoing wire
  result = api_instance.cancel_wire(wire_id, update_transfer, opts)
  p result
rescue Synctera::ApiError => e
  puts "Error when calling WiresApi->cancel_wire: #{e}"
end

Using the cancel_wire_with_http_info variant

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

<Array(, Integer, Hash)> cancel_wire_with_http_info(wire_id, update_transfer, opts)

begin
  # Cancel an outgoing wire
  data, status_code, headers = api_instance.cancel_wire_with_http_info(wire_id, update_transfer, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Wire>
rescue Synctera::ApiError => e
  puts "Error when calling WiresApi->cancel_wire_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
wire_id String The unique identifier of a wire transfer.
update_transfer UpdateTransfer wire to update
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

Wire

Authorization

bearerAuth

HTTP request headers

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

create_wire

create_wire(wire_request, opts)

Send a wire

Create an outgoing wire transfer

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::WiresApi.new
wire_request = Synctera::WireRequest.new({amount: 10000, currency: 'USD', customer_id: 'b01db9c7-78f2-4a99-8aca-1231d32f9b96', originating_account_id: 'b01db9c7-78f2-4a99-8aca-1231d32f9b96', receiving_account_id: 'b01db9c7-78f2-4a99-8aca-1231d32f9b96', recipient_message: 'recipient_message_example'}) # WireRequest | Wire transfer 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 a wire
  result = api_instance.create_wire(wire_request, opts)
  p result
rescue Synctera::ApiError => e
  puts "Error when calling WiresApi->create_wire: #{e}"
end

Using the create_wire_with_http_info variant

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

<Array(, Integer, Hash)> create_wire_with_http_info(wire_request, opts)

begin
  # Send a wire
  data, status_code, headers = api_instance.create_wire_with_http_info(wire_request, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Wire>
rescue Synctera::ApiError => e
  puts "Error when calling WiresApi->create_wire_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
wire_request WireRequest Wire transfer 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

Wire

Authorization

bearerAuth

HTTP request headers

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

get_wire

get_wire(wire_id)

Get an outgoing wire by id

Get a wire by id

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::WiresApi.new
wire_id = 'b01db9c7-78f2-4a99-8aca-1231d32f9b96' # String | The unique identifier of a wire transfer.

begin
  # Get an outgoing wire by id
  result = api_instance.get_wire(wire_id)
  p result
rescue Synctera::ApiError => e
  puts "Error when calling WiresApi->get_wire: #{e}"
end

Using the get_wire_with_http_info variant

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

<Array(, Integer, Hash)> get_wire_with_http_info(wire_id)

begin
  # Get an outgoing wire by id
  data, status_code, headers = api_instance.get_wire_with_http_info(wire_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Wire>
rescue Synctera::ApiError => e
  puts "Error when calling WiresApi->get_wire_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
wire_id String The unique identifier of a wire transfer.

Return type

Wire

Authorization

bearerAuth

HTTP request headers

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

list_wires

list_wires(opts)

List outgoing wires

Get paginated list of wires

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::WiresApi.new
opts = {
  originating_account_id: 'b01db9c7-78f2-4a99-8aca-1231d32f9b96', # String | The unique identifier of the originating account.
  to_date: Date.parse('2013-10-20'), # Date | Only display transactions with an effective date less than or equal to to_date
  from_date: Date.parse('2013-10-20'), # Date | Only display transactions with an effective date greater than from_date
  customer_id: 'b01db9c7-78f2-4a99-8aca-1231d32f9b96', # String | The unique identifier of a customer.
  status: 'BLOCKED', # String | 
  receiving_account_id: 'b01db9c7-78f2-4a99-8aca-1231d32f9b96', # String | The unique identifier of the receiving account.
  page_token: 'a8937a0d', # String | 
  id: ['7d943c51-e4ff-4e57-9558-08cab6b963c7'], # Array<String> | Unique resource identifier
  limit: 100 # Integer | 
}

begin
  # List outgoing wires
  result = api_instance.list_wires(opts)
  p result
rescue Synctera::ApiError => e
  puts "Error when calling WiresApi->list_wires: #{e}"
end

Using the list_wires_with_http_info variant

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

<Array(, Integer, Hash)> list_wires_with_http_info(opts)

begin
  # List outgoing wires
  data, status_code, headers = api_instance.list_wires_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <WireList>
rescue Synctera::ApiError => e
  puts "Error when calling WiresApi->list_wires_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
originating_account_id String The unique identifier of the originating account. [optional]
to_date Date Only display transactions with an effective date less than or equal to to_date [optional]
from_date Date Only display transactions with an effective date greater than from_date [optional]
customer_id String The unique identifier of a customer. [optional]
status String [optional]
receiving_account_id String The unique identifier of the receiving account. [optional]
page_token String [optional]
id Array<String> Unique resource identifier [optional]
limit Integer [optional][default to 100]

Return type

WireList

Authorization

bearerAuth

HTTP request headers

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