Skip to main content

Fields

acceptedAt : DateTime

The timestamp at which the customer accepted the deposit agreement.

collectionDate : Date

The date on which a payment is requested for deposit collection (defaults to current date, if not specified in the deposit policy).

currentEligibilityStatus : CurrentEligibilityStatusOutput

The current eligibility status for a deposit return.

depositAmount : Int

The deposit agreement amount.

depositKey : String

The deposit agreement key (unique).

dueDate : Date

The date by which the deposit agreement must be fulfilled (defaults to 31-12-9999 i.e. deposit is never late, if not specified in the deposit policy).

fulfilledAt : DateTime

The timestamp at which the deposit agreement was fulfilled.

returnStrategy : String

The return strategy used to return the deposit.

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Example

{ "acceptedAt": "1994-12-20T02:25:51.814509+00:00", "collectionDate": "2007-02-12", "currentEligibilityStatus": CurrentEligibilityStatusOutput, "depositAmount": 78, "depositKey": "garden-offer-study-provide-world", "dueDate": "1971-01-06", "fulfilledAt": "1987-11-20T11:23:51.411196+00:00", "returnStrategy": "lose-already-appear-happen-next" }