Contents

# SyncteraRubySdk::IncomingWiresApi

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

| Method | HTTP request | Description |
| ------ | ------------ | ----------- |
| [**get_incoming_wire**](IncomingWiresApi.md#get_incoming_wire) | **GET** /wires/incoming/{wire_id} | Get incoming wire by id |


## get_incoming_wire

> <IncomingWire> get_incoming_wire(wire_id)

Get incoming wire by id

Get an incoming wire by id

### Examples

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

begin
  # Get incoming wire by id
  result = api_instance.get_incoming_wire(wire_id)
  p result
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling IncomingWiresApi->get_incoming_wire: #{e}"
end
```

#### Using the get_incoming_wire_with_http_info variant

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

> <Array(<IncomingWire>, Integer, Hash)> get_incoming_wire_with_http_info(wire_id)

```ruby
begin
  # Get incoming wire by id
  data, status_code, headers = api_instance.get_incoming_wire_with_http_info(wire_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <IncomingWire>
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling IncomingWiresApi->get_incoming_wire_with_http_info: #{e}"
end
```

### Parameters

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

### Return type

[**IncomingWire**](IncomingWire.md)

### Authorization

[bearerAuth](../README.md#bearerAuth)

### HTTP request headers

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

Version data entries

4 entries across 4 versions & 1 rubygems

Version	Path
synctera_ruby_sdk-1.1.3	docs/IncomingWiresApi.md
synctera_ruby_sdk-1.1.2	docs/IncomingWiresApi.md
synctera_ruby_sdk-1.1.1	docs/IncomingWiresApi.md
synctera_ruby_sdk-1.0.0	docs/IncomingWiresApi.md