Retrieves payment history on a recurring gift for the given calendar year.
Client Servlet | Server Servlet | HTTP Methods Supported | Requires Authentication |
---|---|---|---|
CRRecurringAPI | SRRecurringAPI | GET, POST | Yes. |
This method returns the history of payments credited against a recurring gift.
You may use the following methods to allow a logged-in user to manage their recurring gifts themselves via the Client API or to manage recurring gifts as an administrator via the Server API:
See topic Common Parameters.
Required. Specifies the ID of the recurring gift to retrieve.
Type xsd:nonNegativeInteger.
Required. The year for which the recurring gift history should be retrieved.
Type xsd:int.
See topic Common Parameters.
Required. Specifies the ID of the recurring gift to retrieve.
Type xsd:nonNegativeInteger.
Required. The year for which the recurring gift history should be retrieved.
Type xsd:int.
Required. Specifies the ID of the constituent.
Type xsd:nonNegativeInteger.
See topic HTTP Status Codes.
XML responseJSON response<?xml version="1.0" encoding="UTF-8"?> <getRecurringHistoryResponse xsi:schemaLocation="http://convio.com/crm/v1.0 http://service.convio.net/xmlschema/crm.public.v1.xsd" xmlns="http://convio.com/crm/v1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <recurringHistory> <amount> <decimal>1200</decimal> <formatted>12.00</formatted> </amount> <date>2016-02-01-06:00</date> <tenderType>CREDIT_CARD</tenderType> <maskedCreditCardNumber>************1111</maskedCreditCardNumber> <status>COMPLETED</status> </recurringHistory> </getRecurringHistoryResponse>
{"getRecurringHistoryResponse":{"recurringHistory":{"amount":{"formatted":"12.00","decimal":"1200"},"status":"COMPLETED","maskedCreditCardNumber":"************1111","tenderType":"CREDIT_CARD","date":"2016-02-01-06:00"}}}