Skip to content

Latest commit

 

History

History
345 lines (273 loc) · 12.5 KB

CurrencyInfoApi.md

File metadata and controls

345 lines (273 loc) · 12.5 KB

TransferZero.Sdk.Api.CurrencyInfoApi

All URIs are relative to https://api-sandbox.transferzero.com/v1

Method HTTP request Description
InfoCurrencies GET /info/currencies Getting a list of possible requested currencies
InfoCurrenciesIn GET /info/currencies/in Getting a list of possible input currencies
InfoCurrenciesOut GET /info/currencies/out Getting a list of possible output currencies

InfoCurrencies

CurrencyListResponse InfoCurrencies ()

Getting a list of possible requested currencies

Fetches a list of currencies available to use in other API requests. Usually the 3-character alpha ISO 4217 currency code (eg. USD) is used as the identifier.

Example

C#

using System;
using System.Diagnostics;
using TransferZero.Sdk.Api;
using TransferZero.Sdk.Client;
using TransferZero.Sdk.Model;

namespace Example
{
    public class InfoCurrenciesExample
    {
        public void main()
        {
            Configuration configuration = new Configuration();
            configuration.ApiKey = "<key>";
            configuration.ApiSecret = "<secret>";
            configuration.BasePath = "https://api-sandbox.transferzero.com/v1";

            var apiInstance = new CurrencyInfoApi(configuration);

            try {
                // Getting a list of possible requested currencies
                CurrencyListResponse result = apiInstance.InfoCurrencies();
                Debug.WriteLine(result);
            } catch (ApiException e)
            {
                if (e.IsValidationError) {
                    // In case there was a validation error, obtain the object
                    CurrencyListResponse result = e.ParseObject<CurrencyListResponse>();
                    Debug.WriteLing("There was a validation error while processing!");
                    Debug.WriteLine(result);
                } else {
                    Debug.Print("Exception when calling CurrencyInfoApi.InfoCurrencies: " + e.Message );
                }
            }
        }
    }
}

VB.NET

Imports TransferZero.Sdk.Api;
Imports TransferZero.Sdk.Client;
Imports TransferZero.Sdk.Model;
Imports System
Imports System.Collections.Generic
Imports System.Linq
Imports System.Text
Imports System.Threading.Tasks

Module Example
    Sub Main(ByVal args As String())
        Dim configuration As Configuration = New Configuration()
        configuration.ApiKey = "KEY"
        configuration.ApiSecret = "SECRET"
        configuration.BasePath = "https://api-sandbox.transferzero.com/v1"

        Dim debitsApi As AccountDebitsApi = New AccountDebitsApi(configuration)

        Dim apiInstance = new CurrencyInfoApi(configuration)


        Try
            REM Getting a list of possible requested currencies
            Dim result As CurrencyListResponse = apiInstance.InfoCurrencies()
            Debug.WriteLine(result)
        Catch e as ApiException
            If e.IsValidationError Then
                REM In case there was a validation error, obtain the object
                Dim result as CurrencyListResponse = e.ParseObject(Of CurrencyListResponse)()
                Debug.WriteLine("There was a validation error while processing!")
                Debug.WriteLine(result)
            Else
                Debug.Print("Exception when calling CurrencyInfoApi.InfoCurrencies: " + e.Message )
            End If
        End Try
    End Sub
End Module

Parameters

This endpoint does not need any parameter.

Return type

CurrencyListResponse

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

InfoCurrenciesIn

CurrencyExchangeListResponse InfoCurrenciesIn (Guid? senderId = null)

Getting a list of possible input currencies

Fetches a list of currencies available to use as the input currency in other API requests. Usually the 3-character alpha ISO 4217 currency code (eg. USD) is used as the identifier. Use this endpoint to determine the current exchange rate from a specific input currency to any output currency that's available.

Example

C#

using System;
using System.Diagnostics;
using TransferZero.Sdk.Api;
using TransferZero.Sdk.Client;
using TransferZero.Sdk.Model;

namespace Example
{
    public class InfoCurrenciesInExample
    {
        public void main()
        {
            Configuration configuration = new Configuration();
            configuration.ApiKey = "<key>";
            configuration.ApiSecret = "<secret>";
            configuration.BasePath = "https://api-sandbox.transferzero.com/v1";

            var apiInstance = new CurrencyInfoApi(configuration);
            var senderId = new Guid?(); // Guid? | Allows the scoping of the results by `sender_id` (optional).  Example: `/v1/info/currencies/in?sender_id=26ec8517-2f0d-48c0-b74f-0bccb9ab3a87` (optional) 

            try {
                // Getting a list of possible input currencies
                CurrencyExchangeListResponse result = apiInstance.InfoCurrenciesIn(senderId);
                Debug.WriteLine(result);
            } catch (ApiException e)
            {
                if (e.IsValidationError) {
                    // In case there was a validation error, obtain the object
                    CurrencyExchangeListResponse result = e.ParseObject<CurrencyExchangeListResponse>();
                    Debug.WriteLing("There was a validation error while processing!");
                    Debug.WriteLine(result);
                } else {
                    Debug.Print("Exception when calling CurrencyInfoApi.InfoCurrenciesIn: " + e.Message );
                }
            }
        }
    }
}

VB.NET

Imports TransferZero.Sdk.Api;
Imports TransferZero.Sdk.Client;
Imports TransferZero.Sdk.Model;
Imports System
Imports System.Collections.Generic
Imports System.Linq
Imports System.Text
Imports System.Threading.Tasks

Module Example
    Sub Main(ByVal args As String())
        Dim configuration As Configuration = New Configuration()
        configuration.ApiKey = "KEY"
        configuration.ApiSecret = "SECRET"
        configuration.BasePath = "https://api-sandbox.transferzero.com/v1"

        Dim debitsApi As AccountDebitsApi = New AccountDebitsApi(configuration)

        Dim apiInstance = new CurrencyInfoApi(configuration)
        Dim senderId = new Guid?() REM Guid? | Allows the scoping of the results by `sender_id` (optional).  Example: `/v1/info/currencies/in?sender_id=26ec8517-2f0d-48c0-b74f-0bccb9ab3a87` (optional) 


        Try
            REM Getting a list of possible input currencies
            Dim result As CurrencyExchangeListResponse = apiInstance.InfoCurrenciesIn(senderId)
            Debug.WriteLine(result)
        Catch e as ApiException
            If e.IsValidationError Then
                REM In case there was a validation error, obtain the object
                Dim result as CurrencyExchangeListResponse = e.ParseObject(Of CurrencyExchangeListResponse)()
                Debug.WriteLine("There was a validation error while processing!")
                Debug.WriteLine(result)
            Else
                Debug.Print("Exception when calling CurrencyInfoApi.InfoCurrenciesIn: " + e.Message )
            End If
        End Try
    End Sub
End Module

Parameters

Name Type Description Notes
senderId Guid? Allows the scoping of the results by `sender_id` (optional). Example: `/v1/info/currencies/in?sender_id=26ec8517-2f0d-48c0-b74f-0bccb9ab3a87` [optional]

Return type

CurrencyExchangeListResponse

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

InfoCurrenciesOut

CurrencyExchangeListResponse InfoCurrenciesOut (Guid? senderId = null)

Getting a list of possible output currencies

Fetches a list of currencies available to use as the output currency and their exchange rates against the available input currencies. Usually the 3-character alpha ISO 4217 currency code (eg. USD) is used as the identifier.

Example

C#

using System;
using System.Diagnostics;
using TransferZero.Sdk.Api;
using TransferZero.Sdk.Client;
using TransferZero.Sdk.Model;

namespace Example
{
    public class InfoCurrenciesOutExample
    {
        public void main()
        {
            Configuration configuration = new Configuration();
            configuration.ApiKey = "<key>";
            configuration.ApiSecret = "<secret>";
            configuration.BasePath = "https://api-sandbox.transferzero.com/v1";

            var apiInstance = new CurrencyInfoApi(configuration);
            var senderId = new Guid?(); // Guid? | Allows the scoping of the results by `sender_id` (optional).  Example: `/v1/info/currencies/out?sender_id=26ec8517-2f0d-48c0-b74f-0bccb9ab3a87` (optional) 

            try {
                // Getting a list of possible output currencies
                CurrencyExchangeListResponse result = apiInstance.InfoCurrenciesOut(senderId);
                Debug.WriteLine(result);
            } catch (ApiException e)
            {
                if (e.IsValidationError) {
                    // In case there was a validation error, obtain the object
                    CurrencyExchangeListResponse result = e.ParseObject<CurrencyExchangeListResponse>();
                    Debug.WriteLing("There was a validation error while processing!");
                    Debug.WriteLine(result);
                } else {
                    Debug.Print("Exception when calling CurrencyInfoApi.InfoCurrenciesOut: " + e.Message );
                }
            }
        }
    }
}

VB.NET

Imports TransferZero.Sdk.Api;
Imports TransferZero.Sdk.Client;
Imports TransferZero.Sdk.Model;
Imports System
Imports System.Collections.Generic
Imports System.Linq
Imports System.Text
Imports System.Threading.Tasks

Module Example
    Sub Main(ByVal args As String())
        Dim configuration As Configuration = New Configuration()
        configuration.ApiKey = "KEY"
        configuration.ApiSecret = "SECRET"
        configuration.BasePath = "https://api-sandbox.transferzero.com/v1"

        Dim debitsApi As AccountDebitsApi = New AccountDebitsApi(configuration)

        Dim apiInstance = new CurrencyInfoApi(configuration)
        Dim senderId = new Guid?() REM Guid? | Allows the scoping of the results by `sender_id` (optional).  Example: `/v1/info/currencies/out?sender_id=26ec8517-2f0d-48c0-b74f-0bccb9ab3a87` (optional) 


        Try
            REM Getting a list of possible output currencies
            Dim result As CurrencyExchangeListResponse = apiInstance.InfoCurrenciesOut(senderId)
            Debug.WriteLine(result)
        Catch e as ApiException
            If e.IsValidationError Then
                REM In case there was a validation error, obtain the object
                Dim result as CurrencyExchangeListResponse = e.ParseObject(Of CurrencyExchangeListResponse)()
                Debug.WriteLine("There was a validation error while processing!")
                Debug.WriteLine(result)
            Else
                Debug.Print("Exception when calling CurrencyInfoApi.InfoCurrenciesOut: " + e.Message )
            End If
        End Try
    End Sub
End Module

Parameters

Name Type Description Notes
senderId Guid? Allows the scoping of the results by `sender_id` (optional). Example: `/v1/info/currencies/out?sender_id=26ec8517-2f0d-48c0-b74f-0bccb9ab3a87` [optional]

Return type

CurrencyExchangeListResponse

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]