ListPaymentsRequest

May 28, 2020 ยท View on GitHub

Description

Retrieves a list of payments taken by the account making the request. Max results per page: 100

Properties

NameGetterSetterTypeDescriptionNotes
begin_timegetBeginTime()setBeginTime($value)stringTimestamp for the beginning of the reporting period, in RFC 3339 format. Inclusive. Default: The current time minus one year.[optional]
end_timegetEndTime()setEndTime($value)stringTimestamp for the end of the requested reporting period, in RFC 3339 format. Default: The current time.[optional]
sort_ordergetSortOrder()setSortOrder($value)stringThe order in which results are listed. - `ASC` - oldest to newest - `DESC` - newest to oldest (default).[optional]
cursorgetCursor()setCursor($value)stringA pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See Pagination for more information.[optional]
location_idgetLocationId()setLocationId($value)stringLimit results to the location supplied. By default, results are returned for all locations associated with the merchant.[optional]
totalgetTotal()setTotal($value)intThe exact amount in the total_money for a `Payment`.[optional]
last_4getLast4()setLast4($value)stringThe last 4 digits of `Payment` card.[optional]
card_brandgetCardBrand()setCardBrand($value)stringThe brand of `Payment` card. For example, `VISA`[optional]

Note: All properties are protected and only accessed via getters and setters.

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