endpoints

This page gives a high-level overview of each API endpoint. More information about each endpoint and request/response details are provided in the detailed API documentation.

The two highest level kinds of data in the ZimpleMoney system are contracts (loans) and members (users). Each of these has subsidiary data associated with them, which may be accessed via the various endpoints.

An overview of all of the endpoints supported by the API is given below:

/login

Login as a user to the Zimple Money system (POST) and receive an authorization token.

/contracts

Contracts are loans in the Zimple Money system. They have an owner, one or mode lenders, one or more borrowers, and could have guests (observers).

This endpoint allows an array of all contracts' summary information to be returned (GET), and enables creation of new contracts (POST).

/contracts/{contractId}

Specific contracts are identified by a {contractId}.

This endpoint enables retrieval of all information for a contract (GET), enables that information to be updated (PUT), and enables a contract to be cancelled (DELETE).

/contracts/{contractId}/ledger

Contracts have a ledger (loan history), a record of all transactions and adjustments performed for the loan.

This endpoint enables retrieval of an array of transactions (GET), and creation of new transactions via manual entries into the ledger (POST).

/contracts/{contractId}/ledger/{entryId}

Specific transactions in a contract ledger are identified by an {entryId}.

This endpoint enables retrieval of a specific transaction (GET), updating a transaction (PUT), and deleting a transaction (DELETE).

/contracts/{contractId}/schedule

Contracts have a payment schedule, which shows all the payments to be made for a loan.

This endpoint enables retrieval of a contract's payment schedule (GET).

/contracts/{contractId}/payments

This endpoint enables retrieval of all payments made for a contract (GET), and making a new payment (POST).

/contracts/{contractId}/pastpayments

This endpoint enables retrieval of all payments (and fees) which are/were due for a contract (GET), and enables updating whether each is now due (PUT).

/contracts/{contractId}/posts

Contracts can have one or more "posts", which are memos associated with the contract.

This endpoint enables retrieval of all posts for a contract (GET), and adding new posts (POST).

/contracts/{contractId}/posts/{postId}

Contract posts are identified by a {postId}.

This endpoint enables retrieval of an array of all posts for a contract (GET), updating a post (PUT), adding a new post for a contract (POST), and deleting a post (DELETE).

/contracts/{contractId}/documents

Contracts can have one or more documents associated with them.

This endpoint enables retrieval of a summary of all documents for a contract (GET), and adding new documents (POST).

/contracts/{contractId}/documents/{documentId}

Contract documents are identified by a {documentId}.

This endpoint enables retrieval of a contract document (GET), updating the information associated with a document (PUT), and deleteing a document (DELETE).

/members

Members are users in the Zimple Money system. They can initiate contracts (become the owner), and/or participate in contracts as a lender or borrower, or as a guest (observer).

This endpoint allows an array of all members' summary information to be returned (GET), and enables creation (registration) of new members (POST).

/members/{memberId}

Specific members are identified by a {memberId}.

This endpoint enables retrieval of all information for a member (GET), enables that informationo be updated (PUT), and enables a member to be marked inactive (DELETE).

/members/{memberId}/account

This endpoint allows a member's account status with Zimple Money to be retrieved (GET), and updated (PUT).

/members/{memberId}/portfolio

Members have a portfolio of contracts in which they are a participant, either as a lender, borrower, or guest (observer).

This endpoint allows a member's portfolio (summary of all contracts) to be retrieved (GET), along with summary information across all contracts.

/members/{memberId}/transactions

This endpoint allows all of a member's transactions to be accessed, payments to contracts, transaction fees (ACH and CC), money in and out, across their entire portfolio.

/members/{memberId}/clients

Members may have one or more other members as "clients", on whose behalf they are able to access information.

This endpoint enables a summary of all a member's clients to be retrieved (GET).

/members/{memberId}/linkedaccounts

Members have one or more linked bank and/or credit card accounts, used to receive and make payments.

This endpoint allows a summary of all accounts for a member to be retrieved (GET), and for new accounts to be linked (POST).

/members/{memberId}/accounts/{accountId}

Bank or credit card accounts linked to a member are identified by an {accountId}.

This endpoint enables retrieval of information for a linked account (GET), updating information for an account (PUT), and removing a linked account from a member (DELETE).

/members/{memberId}/security

Members have security information in the Zimple Money system. This endpoint enables retrieval of a member's security information (GET), and updating that information (PUT).

/members/{memberId}/loginhistory

This endpoint enables a member's login history to be retrieved.

/members/{memberId}/addresshistory

This endpoint enables a member's credit card addresses' change history to be retrieved (GET).

/members/{memberId}/profilehistory

This endpoint enables a member's address (and phone number) change history to be retrieved (GET).

/members/{memberId}/messages

Members receive messages from the Zimple Money system, typically via email and/or SMS, and they can be displayed in the online system.

This endpoint enables retrieval of all current messages for a member (GET), and updating their status to shown they have been read and should be deleted (PUT).

/worldinfo

This endpoint is only accessible for administrators, and enables summary information to be retrieved for a given Zimple Money world, including numbers of members, subscriptions, contracts, etc. These data can also be retrieved via other endpoints such as /contracts and /members, but it provides a useful way to retrieve this informmation.