Communication API

The Communication API aims to contain all needed communication with the end user during the lifetime of a given Payment or (Personal and Shared) Agreement, from initiation over charges and failures to cancellation.

The Communication API contains of Collections, Templates and Events however this documentation will only cover Collections as they will be needed when engaging our Payment Session or setting up new Agreements with our API.

Properties

Name

Type

Description

Name

Type

Description

communicationCollectionGuid

STRING

Unique guid

collectionName

STRING

Name of collection

createdTs

TIMESTAMP

Time of creation

parentGuid

STRING

Optional collection guid from which templates will be inherited

defaultCollection

BOOLEAN

Defines whether it’s an OnlineFundraising standard

 

GET /communicationCollections

Get a list of communicationCollections

Response

HTTP

Description

HTTP

Description

200

OK

HTTP 200 Example

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 [ { "communicationCollectionGuid": "18c281b2-2efe-4765-8dc0-xxxxxxxxxxxx", "collectionName": "Thank you", "createdTs": "2019-07-10 14:53:54 +0200", "parentGuid": "65b97165-0fe0-4161-ba16-xxxxxxxxxxxx", "defaultCollection": false }, { "communicationCollectionGuid": "18c281b2-2efe-4765-8dc0-xxxxxxxxxxxx", "collectionName": "Thank you very much!", "createdTs": "2019-07-10 14:53:54 +0200", "parentGuid": "65b97165-0fe0-4161-ba16-xxxxxxxxxxxx", "defaultCollection": false } ]

 

GET /communicationCollection/{communicationCollectionGuid}

Get a single communicationCollection

Response

HTTP

Description

HTTP

Description

200

OK

HTTP 200 Example

1 2 3 4 5 6 7 { "communicationCollectionGuid": "18c281b2-2efe-4765-8dc0-xxxxxxxxxxxx", "collectionName": "Thank you", "createdTs": "2019-07-10 14:53:54 +0200", "parentGuid": "65b97165-0fe0-4161-ba16-xxxxxxxxxxxx", "defaultCollection": false }

 

Communication Events

We categories events into the following three areas:

SignUp

Al communication related to successful form submissions:

  • Non-transactional form

  • Single payment

  • Subscription

  • Subscription and single payment

Retention

Al communication related to recurring charges and lapses:

  • Recurring payment charging

  • Recurring payment charged

  • Recurring payment failed

  • Payment method was cancelled

  • Subscription fail to charge repeatedly

Management

Al communication related to administrative management of subscriptions and payments:

  • Payment method require renewal

  • Payment refunded

  • Subscription deactivated

  • Subscription on hold

  • Subscription restarted

  • Subscription updated

  • Agreement updated