Payment

Retrieves the collection of Payment resources.

Retrieves the collection of Payment resources.

get/payments

Request

  • Base URL: https://api.spash.com
  • URL: https://api.spash.com/payments
  • Auth: one of:
    • API key in header Authorization
    • HTTP bearer

Query parameters

pageinteger

The collection page number

itemsPerPageinteger

The number of items per page

paginationboolean

Enable or disable pagination

createdAt[before]string
createdAt[strictly_before]string
createdAt[after]string
createdAt[strictly_after]string
updatedAt[before]string
updatedAt[strictly_before]string
updatedAt[after]string
updatedAt[strictly_after]string
order[createdAt]'asc' | 'desc'
order[updatedAt]'asc' | 'desc'

Response

Payment collection

idinteger
amountnumber required
status'paid' | 'not_paid' required
createdAtstring date-time
updatedAtstring date-time

Example response

[
  {
    "status": "not_paid",
    "createdAt": "CURRENT_TIMESTAMP",
    "updatedAt": "CURRENT_TIMESTAMP"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.