ReferencePayments

List Payments

This endpoint retrieves a collection of payments along with their order details. **Connection Timeouts** | Timeout | Time (Seconds) | |---------|----------------| | Open | 10 | | Read | 20 |

Authentication

AuthorizationBasic

Basic authentication of the form Basic <username:password>.

Headers

User-AgentstringRequired
AcceptstringOptionalDefaults to application/json

Query parameters

toCreatedDatestringOptionalDefaults to 2020-12-30
An inclusive end date and time to search, in [ISO 8601](http://www.iso.org/iso/home/standards/iso8601.htm) format.
fromCreatedDatestringOptionalDefaults to 2020-01-01
An inclusive start date and time to search, in [ISO 8601](http://www.iso.org/iso/home/standards/iso8601.htm) format.
tokenslist of stringsOptional
One or more order tokens to search for.
idslist of stringsOptional
One or more Cash App Afterpay Order IDs to search for.
merchantReferenceslist of stringsOptional
One or more Merchant Reference IDs to search for.
statuseslist of stringsOptional
One or more Cash App Afterpay Order Statuses to search for. Possible values include "APPROVED" and "DECLINED".
orderBystringOptionalDefaults to createdAt
A field to order results by. If provided, must be one of "createdAt", "id", "totalAmount", "merchantReference" or "email".
ascendingbooleanOptionalDefaults to false

true to order results in ascending order, or false for descending order.

Response

Returns the matching Payment objects, enclosed in a Pagination object.
totalResultsinteger or null
Total number of results
offsetinteger or null
The offer of the pagination
limitinteger or null
The number of payments to include in the results
resultslist of objects or null

Errors