Skip to content

API documentation

The extension provides a new CiviCRM API 3 entity TwingleDonation with API actions to record a new donation, end a previously submitted recurring donation and cancel previously submitted donation.

Submit donation

This API action processes submitted Twingle donations and donor information.

  • Entity: TwingleDonation
  • Action: Submit

The action accepts the following parameters:

Parameter Type Description Values/Format Required
project_id String The Twingle project ID Yes
trx_id String The unique transaction ID of the donation A unique transaction ID for the donation. Yes
confirmed_at String The date when the donation was issued A string representing a date in the format YmdHis Yes
purpose String The purpose of the donation
amount Integer The donation amount in minor currency unit Yes
currency String The ISO-4217 currency code of the donation A valid ISO-4217 currency code Yes
newsletter Boolean Whether to subscribe the contact to the newsletter group defined in the profile
postinfo Boolean Whether to subscribe the contact to the postal mailing group defined in the profile
donation_receipt Boolean Whether the contact requested a donation receipt
payment_method String The Twingle payment method used for the donation One of:
  • banktransfer
  • debit_manual
  • debit_automatic
  • creditcard
  • mobilephone_germany
  • paypal
  • sofortueberweisung
  • amazonpay
  • paydirekt
  • applepay
  • googlepay
 Yes
donation_rhythm String The interval which the donation is recurring in One of:
  • 'one_time',
  • 'halfyearly',
  • 'quarterly',
  • 'yearly',
  • 'monthly'
 Yes
debit_iban String The IBAN for SEPA Direct Debit payments A valid ISO 13616-1:2007 IBAN Yes, if payment_method is debit_manual and CiviSEPA is used
debit_bic String The BIC for SEPA Direct Debit payments A valid ISO 9362 BIC Yes, if payment_method is debit_manual and CiviSEPA is used
debit_mandate_reference String The mandate reference for SEPA Direct Debit payments
debit_account_holder String The account holder for SEPA Direct Debit payments
is_anonymous Boolean Whether the donation is submitted anonymously
user_gender String The gender of the contact
user_birthdate String The date of birth of the contact A string representing a date in the format Ymd
user_title String The formal title of the contact
user_email String The e-mail address of the contact A valid e-mail address
user_firstname String The first name of the contact
user_lastname String The last name of the contact
user_street String The street address of the contact
user_postal_code String The postal code of the contact
user_city String The city of the contact
user_country String The country of the contact A ISO 3166-1 Alpha-2 country code
user_telephone String The telephone number of the contact
user_company String The company of the contact
user_extrafield String Additional information of the contact
user_language String The preferred language of the contact. A ISO-639-1 2-digit language code
campaign_id Integer The CiviCRM ID of a campaign to assign the contribution A valid CiviCRM Campaign ID. This overrides the campaign ID configured within the profile.

You may also refer to the code for more insight into this API action.

End recurring donation

  • Entity: TwingleDonation
  • Action: Endrecurring

The action accepts the following parameters:

Parameter Type Description Values/Format Required
project_id String The Twingle project ID Yes
trx_id String The unique transaction ID of the donation A unique transaction ID for the donation. Yes
ended_at Integer The date when the recurring donation was ended A string representing a date in the format YmdHis Yes

You may also refer to the code for more insight into this API action.

Cancel donation

  • Entity: TwingleDonation
  • Action: Cancel

The action accepts the following parameters:

Parameter Type Description Values/Format Required
project_id String The Twingle project ID Yes
trx_id String The unique transaction ID of the donation A unique transaction ID for the donation. Yes
cancelled_at String The date when the recurring donation was cancelled A string representing a date in the format YmdHis Yes
cancel_reason String The reason for the donation being cancelled Yes

You may also refer to the code for more insight into this API action.