API: Register recurring agreement

How to get started with API to register recurring agreeements in Cornerstone


All requests to our API need authentication. Fort this, you need a username and pw for a CS user with proper access to use our API. See general API documentation for details.

Server to server
All communication with our API has to be from your server. Username and pw can not be used on client side. If we find that requests are made directly from client side, we will have to delete this user.

Register agreement

See API documentation for details. When agreement is registrered, you will receive the KID for the agreement and the URL for signing the agreement (Nets).

You can find the target cause id from the fundraising module pages. Cause id is found as parameter in URL: https://mycornerstonewebsite.com/_module/fundraising/causes/all/view/fundraising_cause/17685/

The API documenation has an PHP example to register an agreement.

For testing, we recommend testing towards a separate room.


General description of our API: https://docs.google.com/document/d/1BqhXLI1CHMonWL3j1-fF1JWWSRuCgtKOPQKqFpvJqTw/edit?usp=sharing
Documentation on how to register recurring agreement: https://docs.google.com/document/d/14nIaVhtYmUO4QJSgg07OcgxBSuQ6JC2bwtCK9u58d6U/edit#heading=h.f9q30ydjeu8i

API: Register recurring agreement