The cash up object

The cash up API allows you to mark the end of your transaction period on our system. Once a transaction period has been marked you will be able to query all payments that were completed within the associated period. You can use the period's reference with the get cash up payments endpoint to retrieve the payments.


The object parameters

DescriptionTypeDescription
dateStringThe UTC date of when the transaction period was ended. The date is ISO8601 formatted, eg: 1999-12-31T23:00:00Z
referenceStringA hexadecimal string with a maximum length of 32.

An example of a cash up object:

{
  "date": "1999-12-31T23:00:00Z",
  "reference": "ab34Def78"
}