TextRequestClient.GetPaymentsAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Gets all payments
public virtual System.Threading.Tasks.Task<Azure.Connectors.Sdk.TextRequest.Models.GetPaymentsResponse> GetPaymentsAsync(int idOfTheDashboardToMakeThisCallOn, int numberPageToGet, int amountOfEachEntityToGetPerPage, string referenceStringOfThePayment = default, string paymentPhoneNumber = default, string sortBy = default, string sortDirection = default, System.Threading.CancellationToken cancellationToken = default);abstract member GetPaymentsAsync : int * int * int * string * string * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Connectors.Sdk.TextRequest.Models.GetPaymentsResponse>
override this.GetPaymentsAsync : int * int * int * string * string * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Connectors.Sdk.TextRequest.Models.GetPaymentsResponse>Public Overridable Function GetPaymentsAsync (idOfTheDashboardToMakeThisCallOn As Integer, numberPageToGet As Integer, amountOfEachEntityToGetPerPage As Integer, Optional referenceStringOfThePayment As String = Nothing, Optional paymentPhoneNumber As String = Nothing, Optional sortBy As String = Nothing, Optional sortDirection As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of GetPaymentsResponse)Parameters
- idOfTheDashboardToMakeThisCallOn
- Int32
Id of the dashboard to make this call on
- numberPageToGet
- Int32
Number page to get
- amountOfEachEntityToGetPerPage
- Int32
Amount of each entity to get per page
- referenceStringOfThePayment
- String
Reference string of the payment
- paymentPhoneNumber
- String
Payment phone number
- sortBy
- String
Sort-by
- sortDirection
- String
Sort direction
- cancellationToken
- CancellationToken
Cancellation token.
Returns
The Gets all payments response.
Remarks
Gets all payments, including canceled and paid payments. These can be filtered using the query parameters.
