ParticipantPayment.php
This api exposes CiviCRM participant payments.
Table of Contents
Functions
- civicrm_api3_participant_payment_create() : array<string|int, mixed>
- Create a Event Participant Payment.
- _civicrm_api3_participant_payment_create_spec() : mixed
- Adjust Metadata for Create action.
- civicrm_api3_participant_payment_delete() : array<string|int, mixed>
- Deletes an existing Participant Payment.
- civicrm_api3_participant_payment_get() : array<string|int, mixed>
- Retrieve one or more participant payment records.
Functions
civicrm_api3_participant_payment_create()
Create a Event Participant Payment.
civicrm_api3_participant_payment_create(array<string|int, mixed> $params) : array<string|int, mixed>
This API is used for creating a Participant Payment of Event. Required parameters: participant_id, contribution_id.
Parameters
- $params : array<string|int, mixed>
-
An associative array of name/value property values of civicrm_participant_payment.
Return values
array<string|int, mixed>_civicrm_api3_participant_payment_create_spec()
Adjust Metadata for Create action.
_civicrm_api3_participant_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_participant_payment_delete()
Deletes an existing Participant Payment.
civicrm_api3_participant_payment_delete(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Return values
array<string|int, mixed> —API result
civicrm_api3_participant_payment_get()
Retrieve one or more participant payment records.
civicrm_api3_participant_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 properties, if error an array with an error id and error message