TransferZero.Sdk.Api.SendersApi

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

Method	HTTP request	Description
DeleteSender	DELETE /senders/{Sender ID}	Deleting a sender
GetSender	GET /senders/{Sender ID}	Fetching a sender
GetSenders	GET /senders	Listing senders
PatchSender	PATCH /senders/{Sender ID}	Updating a sender
PostSenders	POST /senders	Creating a sender

DeleteSender

SenderResponse DeleteSender (Guid? senderID)

Deleting a sender

Deletes a single sender by the Sender ID

Example

C#

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

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

            var apiInstance = new SendersApi(configuration);
            var senderID = new Guid?(); // Guid? | ID of the sender to delete.  Example: `/v1/senders/bf9ff782-e182-45ac-abea-5bce83ad6670`

            try {
                // Deleting a sender
                SenderResponse result = apiInstance.DeleteSender(senderID);
                Debug.WriteLine(result);
            } catch (ApiException e)
            {
                if (e.IsValidationError) {
                    // In case there was a validation error, obtain the object
                    SenderResponse result = e.ParseObject<SenderResponse>();
                    Debug.WriteLing("There was a validation error while processing!");
                    Debug.WriteLine(result);
                } else {
                    Debug.Print("Exception when calling SendersApi.DeleteSender: " + 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 SendersApi(configuration)
        Dim senderID = new Guid?() REM Guid? | ID of the sender to delete.  Example: `/v1/senders/bf9ff782-e182-45ac-abea-5bce83ad6670`


        Try
            REM Deleting a sender
            Dim result As SenderResponse = apiInstance.DeleteSender(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 SenderResponse = e.ParseObject(Of SenderResponse)()
                Debug.WriteLine("There was a validation error while processing!")
                Debug.WriteLine(result)
            Else
                Debug.Print("Exception when calling SendersApi.DeleteSender: " + e.Message )
            End If
        End Try
    End Sub
End Module

Parameters

Name	Type	Description	Notes
senderID	Guid?	ID of the sender to delete. Example: `/v1/senders/bf9ff782-e182-45ac-abea-5bce83ad6670`

Return type

SenderResponse

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

GetSender

SenderResponse GetSender (Guid? senderID)

Fetching a sender

Returns a single sender by the Sender ID

Example

C#

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

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

            var apiInstance = new SendersApi(configuration);
            var senderID = new Guid?(); // Guid? | ID of the sender to get.  Example: `/v1/senders/bf9ff782-e182-45ac-abea-5bce83ad6670`

            try {
                // Fetching a sender
                SenderResponse result = apiInstance.GetSender(senderID);
                Debug.WriteLine(result);
            } catch (ApiException e)
            {
                if (e.IsValidationError) {
                    // In case there was a validation error, obtain the object
                    SenderResponse result = e.ParseObject<SenderResponse>();
                    Debug.WriteLing("There was a validation error while processing!");
                    Debug.WriteLine(result);
                } else {
                    Debug.Print("Exception when calling SendersApi.GetSender: " + 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 SendersApi(configuration)
        Dim senderID = new Guid?() REM Guid? | ID of the sender to get.  Example: `/v1/senders/bf9ff782-e182-45ac-abea-5bce83ad6670`


        Try
            REM Fetching a sender
            Dim result As SenderResponse = apiInstance.GetSender(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 SenderResponse = e.ParseObject(Of SenderResponse)()
                Debug.WriteLine("There was a validation error while processing!")
                Debug.WriteLine(result)
            Else
                Debug.Print("Exception when calling SendersApi.GetSender: " + e.Message )
            End If
        End Try
    End Sub
End Module

Parameters

Name	Type	Description	Notes
senderID	Guid?	ID of the sender to get. Example: `/v1/senders/bf9ff782-e182-45ac-abea-5bce83ad6670`

Return type

SenderResponse

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

GetSenders

SenderListResponse GetSenders (int? page = null, int? per = null, string createdAtFrom = null, string createdAtTo = null, string externalId = null)

Listing senders

Get a list of available senders

Example

C#

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

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

            var apiInstance = new SendersApi(configuration);
            var page = 1;  // int? | The page number to request (defaults to 1) (optional) 
            var per = 10;  // int? | The number of results to load per page (defaults to 10) (optional) 
            var createdAtFrom = createdAtFrom_example;  // string | Start date to filter recipients by created_at range Allows filtering results by the specified `created_at` timeframe.  Example: `/v1/recipients?created_at_from=2018-06-06&created_at_to=2018-06-08` (optional) 
            var createdAtTo = createdAtTo_example;  // string | End date to filter recipients by created_at range Allows filtering results by the specified `created_at` timeframe.  Example: `/v1/recipients?created_at_from=2018-06-06&created_at_to=2018-06-08` (optional) 
            var externalId = externalId_example;  // string | Allows filtering results by `external_id`.  Example: `/v1/senders?external_id=26ec8517-2f0d-48c0-b74f-0bccb9ab3a87` (optional) 

            try {
                // Listing senders
                SenderListResponse result = apiInstance.GetSenders(page, per, createdAtFrom, createdAtTo, externalId);
                Debug.WriteLine(result);
            } catch (ApiException e)
            {
                if (e.IsValidationError) {
                    // In case there was a validation error, obtain the object
                    SenderListResponse result = e.ParseObject<SenderListResponse>();
                    Debug.WriteLing("There was a validation error while processing!");
                    Debug.WriteLine(result);
                } else {
                    Debug.Print("Exception when calling SendersApi.GetSenders: " + 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 SendersApi(configuration)
        Dim page = 1 REM int? | The page number to request (defaults to 1) (optional) 
        Dim per = 10 REM int? | The number of results to load per page (defaults to 10) (optional) 
        Dim createdAtFrom = createdAtFrom_example REM string | Start date to filter recipients by created_at range Allows filtering results by the specified `created_at` timeframe.  Example: `/v1/recipients?created_at_from=2018-06-06&created_at_to=2018-06-08` (optional) 
        Dim createdAtTo = createdAtTo_example REM string | End date to filter recipients by created_at range Allows filtering results by the specified `created_at` timeframe.  Example: `/v1/recipients?created_at_from=2018-06-06&created_at_to=2018-06-08` (optional) 
        Dim externalId = externalId_example REM string | Allows filtering results by `external_id`.  Example: `/v1/senders?external_id=26ec8517-2f0d-48c0-b74f-0bccb9ab3a87` (optional) 


        Try
            REM Listing senders
            Dim result As SenderListResponse = apiInstance.GetSenders(page, per, createdAtFrom, createdAtTo, externalId)
            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 SenderListResponse = e.ParseObject(Of SenderListResponse)()
                Debug.WriteLine("There was a validation error while processing!")
                Debug.WriteLine(result)
            Else
                Debug.Print("Exception when calling SendersApi.GetSenders: " + e.Message )
            End If
        End Try
    End Sub
End Module

Parameters

Name	Type	Description	Notes
page	int?	The page number to request (defaults to 1)	[optional]
per	int?	The number of results to load per page (defaults to 10)	[optional]
createdAtFrom	string	Start date to filter recipients by created_at range Allows filtering results by the specified `created_at` timeframe. Example: `/v1/recipients?created_at_from=2018-06-06&created_at_to=2018-06-08`	[optional]
createdAtTo	string	End date to filter recipients by created_at range Allows filtering results by the specified `created_at` timeframe. Example: `/v1/recipients?created_at_from=2018-06-06&created_at_to=2018-06-08`	[optional]
externalId	string	Allows filtering results by `external_id`. Example: `/v1/senders?external_id=26ec8517-2f0d-48c0-b74f-0bccb9ab3a87`	[optional]

Return type

SenderListResponse

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

PatchSender

SenderResponse PatchSender (Guid? senderID, SenderRequest senderRequest)

Updating a sender

Updates a single sender by the Sender ID

Example

C#

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

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

            var apiInstance = new SendersApi(configuration);
            var senderID = new Guid?(); // Guid? | ID of the sender to get.  Example: `/v1/senders/bf9ff782-e182-45ac-abea-5bce83ad6670`
            var senderRequest = new SenderRequest(); // SenderRequest | 

            try {
                // Updating a sender
                SenderResponse result = apiInstance.PatchSender(senderID, senderRequest);
                Debug.WriteLine(result);
            } catch (ApiException e)
            {
                if (e.IsValidationError) {
                    // In case there was a validation error, obtain the object
                    SenderResponse result = e.ParseObject<SenderResponse>();
                    Debug.WriteLing("There was a validation error while processing!");
                    Debug.WriteLine(result);
                } else {
                    Debug.Print("Exception when calling SendersApi.PatchSender: " + 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 SendersApi(configuration)
        Dim senderID = new Guid?() REM Guid? | ID of the sender to get.  Example: `/v1/senders/bf9ff782-e182-45ac-abea-5bce83ad6670`
        Dim senderRequest = new SenderRequest() REM SenderRequest | 


        Try
            REM Updating a sender
            Dim result As SenderResponse = apiInstance.PatchSender(senderID, senderRequest)
            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 SenderResponse = e.ParseObject(Of SenderResponse)()
                Debug.WriteLine("There was a validation error while processing!")
                Debug.WriteLine(result)
            Else
                Debug.Print("Exception when calling SendersApi.PatchSender: " + e.Message )
            End If
        End Try
    End Sub
End Module

Parameters

Name	Type	Description	Notes
senderID	Guid?	ID of the sender to get. Example: `/v1/senders/bf9ff782-e182-45ac-abea-5bce83ad6670`
senderRequest	SenderRequest

Return type

SenderResponse

HTTP request headers

Content-Type: application/json
Accept: application/json

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

PostSenders

SenderResponse PostSenders (SenderRequest senderRequest)

Creating a sender

Creates a new sender in our system.

Example

C#

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

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

            var apiInstance = new SendersApi(configuration);
            var senderRequest = new SenderRequest(); // SenderRequest | 

            try {
                // Creating a sender
                SenderResponse result = apiInstance.PostSenders(senderRequest);
                Debug.WriteLine(result);
            } catch (ApiException e)
            {
                if (e.IsValidationError) {
                    // In case there was a validation error, obtain the object
                    SenderResponse result = e.ParseObject<SenderResponse>();
                    Debug.WriteLing("There was a validation error while processing!");
                    Debug.WriteLine(result);
                } else {
                    Debug.Print("Exception when calling SendersApi.PostSenders: " + 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 SendersApi(configuration)
        Dim senderRequest = new SenderRequest() REM SenderRequest | 


        Try
            REM Creating a sender
            Dim result As SenderResponse = apiInstance.PostSenders(senderRequest)
            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 SenderResponse = e.ParseObject(Of SenderResponse)()
                Debug.WriteLine("There was a validation error while processing!")
                Debug.WriteLine(result)
            Else
                Debug.Print("Exception when calling SendersApi.PostSenders: " + e.Message )
            End If
        End Try
    End Sub
End Module

Parameters

Name	Type	Description	Notes
senderRequest	SenderRequest

Return type

SenderResponse

HTTP request headers

Content-Type: application/json
Accept: application/json

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

Files

SendersApi.md

Latest commit

History

SendersApi.md

File metadata and controls

TransferZero.Sdk.Api.SendersApi

DeleteSender

Example

C#

VB.NET

Parameters

Return type

HTTP request headers

GetSender

Example

C#

VB.NET

Parameters

Return type

HTTP request headers

GetSenders

Example

C#

VB.NET

Parameters

Return type

HTTP request headers

PatchSender

Example

C#

VB.NET

Parameters

Return type

HTTP request headers

PostSenders

Example

C#

VB.NET

Parameters

Return type

HTTP request headers