# SyncteraRubySdk::InternationalWiresAlphaApi

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

| Method | HTTP request | Description |
| ------ | ------------ | ----------- |
| [**create_international_wire**](InternationalWiresAlphaApi.md#create_international_wire) | **POST** /international_wires | Create an International Wire |
| [**get_international_wire**](InternationalWiresAlphaApi.md#get_international_wire) | **GET** /international_wires/{wire_id} | Get an international wire by id |
| [**list_international_wires**](InternationalWiresAlphaApi.md#list_international_wires) | **GET** /international_wires | List International Wires |
| [**patch_international_wire**](InternationalWiresAlphaApi.md#patch_international_wire) | **PATCH** /international_wires/{wire_id} | Update an international wire to various statuses |


## create_international_wire

> <InternationalWireResponse> create_international_wire(international_wire_post, opts)

Create an International Wire

Create an international wire transfer. For now these need manual approval and submission to the wire terminal by bank operations team. Created wires will result in an auth, posting only happens when bank operations team confirms the wire. The wire will be subsequently updated with the reference ID and synctera case ID when the wire is submitted via the wire terminal. Wire processing is subject to the bank's processing schedule. Cross currency wires may only be available during certain hours of banking days.

### 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::InternationalWiresAlphaApi.new
international_wire_post = SyncteraRubySdk::InternationalWirePost.new({amount_in_beneficiary_currency: 10000, customer_id: 'b01db9c7-78f2-4a99-8aca-1231d32f9b96', originating_account_id: 'b01db9c7-78f2-4a99-8aca-1231d32f9b96', receiving_account_id: 'b01db9c7-78f2-4a99-8aca-1231d32f9b96', wire_purpose: 'Payment for Receipt #1234'}) # InternationalWirePost | International 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
  # Create an International Wire
  result = api_instance.create_international_wire(international_wire_post, opts)
  p result
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling InternationalWiresAlphaApi->create_international_wire: #{e}"
end
```

#### Using the create_international_wire_with_http_info variant

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

> <Array(<InternationalWireResponse>, Integer, Hash)> create_international_wire_with_http_info(international_wire_post, opts)

```ruby
begin
  # Create an International Wire
  data, status_code, headers = api_instance.create_international_wire_with_http_info(international_wire_post, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <InternationalWireResponse>
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling InternationalWiresAlphaApi->create_international_wire_with_http_info: #{e}"
end
```

### Parameters

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **international_wire_post** | [**InternationalWirePost**](InternationalWirePost.md) | International 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

[**InternationalWireResponse**](InternationalWireResponse.md)

### Authorization

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

### HTTP request headers

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


## get_international_wire

> <InternationalWireResponse> get_international_wire(wire_id)

Get an international wire by id

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

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

#### Using the get_international_wire_with_http_info variant

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

> <Array(<InternationalWireResponse>, Integer, Hash)> get_international_wire_with_http_info(wire_id)

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

### Parameters

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

### Return type

[**InternationalWireResponse**](InternationalWireResponse.md)

### Authorization

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

### HTTP request headers

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


## list_international_wires

> <InternationalWireList> list_international_wires(opts)

List International Wires

Get paginated list of international wires

### 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::InternationalWiresAlphaApi.new
opts = {
  limit: 100, # Integer | 
  page_token: 'a8937a0d', # String | 
  international_wire_status: SyncteraRubySdk::InternationalWireStatus::PENDING, # InternationalWireStatus | The status of the international wire transfer.
  customer_id: 'b01db9c7-78f2-4a99-8aca-1231d32f9b96', # String | The unique identifier of a customer.
  originating_account_id: 'b01db9c7-78f2-4a99-8aca-1231d32f9b96', # String | The unique identifier of the originating account.
  receiving_account_id: 'b01db9c7-78f2-4a99-8aca-1231d32f9b96' # String | The unique identifier of the receiving account.
}

begin
  # List International Wires
  result = api_instance.list_international_wires(opts)
  p result
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling InternationalWiresAlphaApi->list_international_wires: #{e}"
end
```

#### Using the list_international_wires_with_http_info variant

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

> <Array(<InternationalWireList>, Integer, Hash)> list_international_wires_with_http_info(opts)

```ruby
begin
  # List International Wires
  data, status_code, headers = api_instance.list_international_wires_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <InternationalWireList>
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling InternationalWiresAlphaApi->list_international_wires_with_http_info: #{e}"
end
```

### Parameters

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **limit** | **Integer** |  | [optional][default to 100] |
| **page_token** | **String** |  | [optional] |
| **international_wire_status** | [**InternationalWireStatus**](.md) | The status of the international wire transfer. | [optional] |
| **customer_id** | **String** | The unique identifier of a customer. | [optional] |
| **originating_account_id** | **String** | The unique identifier of the originating account. | [optional] |
| **receiving_account_id** | **String** | The unique identifier of the receiving account. | [optional] |

### Return type

[**InternationalWireList**](InternationalWireList.md)

### Authorization

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

### HTTP request headers

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


## patch_international_wire

> <InternationalWireResponse> patch_international_wire(wire_id, international_wire_patch, opts)

Update an international wire to various statuses

Update an outgoing international wire. End customers can only cancel a wire while its status is still PENDING. All other updates must be done by Synctera operations team or bank operations team.

### 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::InternationalWiresAlphaApi.new
wire_id = 'b01db9c7-78f2-4a99-8aca-1231d32f9b96' # String | The unique identifier of a wire transfer.
international_wire_patch = SyncteraRubySdk::InternationalWirePatch.new({status: 'CONFIRMED'}) # InternationalWirePatch | Instruction to update an international wire
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 an international wire to various statuses
  result = api_instance.patch_international_wire(wire_id, international_wire_patch, opts)
  p result
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling InternationalWiresAlphaApi->patch_international_wire: #{e}"
end
```

#### Using the patch_international_wire_with_http_info variant

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

> <Array(<InternationalWireResponse>, Integer, Hash)> patch_international_wire_with_http_info(wire_id, international_wire_patch, opts)

```ruby
begin
  # Update an international wire to various statuses
  data, status_code, headers = api_instance.patch_international_wire_with_http_info(wire_id, international_wire_patch, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <InternationalWireResponse>
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling InternationalWiresAlphaApi->patch_international_wire_with_http_info: #{e}"
end
```

### Parameters

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **wire_id** | **String** | The unique identifier of a wire transfer. |  |
| **international_wire_patch** | [**InternationalWirePatch**](InternationalWirePatch.md) | Instruction to update an international wire |  |
| **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

[**InternationalWireResponse**](InternationalWireResponse.md)

### Authorization

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

### HTTP request headers

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