PledgePayment.php
This api exposes CiviCRM Pledge payment.
Table of Contents
Functions
- civicrm_api3_pledge_payment_create() : array<string|int, mixed>
- Add or update a pledge payment.
- _civicrm_api3_pledge_payment_create_spec() : mixed
- Adjust Metadata for Create action.
- civicrm_api3_pledge_payment_delete() : array<string|int, mixed>
- Delete a pledge Payment - Note this deletes the contribution not just the link.
- civicrm_api3_pledge_payment_get() : array<string|int, mixed>
- Retrieve a set of pledges, given a set of input params.
Functions
civicrm_api3_pledge_payment_create()
Add or update a pledge payment.
civicrm_api3_pledge_payment_create(array<string|int, mixed> $params) : array<string|int, mixed>
Pledge Payment API doesn't actually add a pledge. If the request is to 'create' and 'id' is not passed in the oldest pledge with no associated contribution is updated.
Parameters
- $params : array<string|int, mixed>
-
Input parameters.
Tags
Return values
array<string|int, mixed> —API Result
_civicrm_api3_pledge_payment_create_spec()
Adjust Metadata for Create action.
_civicrm_api3_pledge_payment_create_spec(array<string|int, mixed> &$params) : mixed
The metadata is used for setting defaults, documentation & validation.
Parameters
- $params : array<string|int, mixed>
-
Array of parameters determined by getfields.
civicrm_api3_pledge_payment_delete()
Delete a pledge Payment - Note this deletes the contribution not just the link.
civicrm_api3_pledge_payment_delete(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
-
Input parameters.
Tags
Return values
array<string|int, mixed> —API result
civicrm_api3_pledge_payment_get()
Retrieve a set of pledges, given a set of input params.
civicrm_api3_pledge_payment_get(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
-
Input parameters.
Return values
array<string|int, mixed> —array of pledges, if error an array with an error id and error message