Struct GetTransfersRequest

Namespace

Vonage.SubAccounts.GetTransfers

Assembly

Vonage.dll

Represents a request to retrieve balance or credit transfers for a primary account within a specified time period.

[Builder(new string[] { })]
public readonly struct GetTransfersRequest : IVonageRequest

Implements

IVonageRequest

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Properties

EndDate

Sets the end of the retrieval period. If not specified, all transfers until now are returned.

public Maybe<DateTimeOffset> EndDate { get; }

Property Value

Maybe<DateTimeOffset>

Examples

.WithEndDate(DateTimeOffset.UtcNow)

StartDate

Sets the start of the retrieval period.

[Mandatory(0)]
public DateTimeOffset StartDate { get; }

Property Value

DateTimeOffset

Examples

.WithStartDate(DateTimeOffset.UtcNow.AddDays(-30))

SubAccountKey

Sets a subaccount API key to filter results. Only transfers involving this subaccount will be returned.

public Maybe<string> SubAccountKey { get; }

Property Value

Maybe<string>

Examples

.WithSubAccountKey("bbe6222f")

Methods

Build()

public static IBuilderForStartDate Build()

Returns

IBuilderForStartDate

BuildRequestMessage()

Converts the request to a HttpRequest.

public HttpRequestMessage BuildRequestMessage()

Returns

HttpRequestMessage

The Http request.

GetEndpointPath()

public string GetEndpointPath()

Returns

string