Payment.php
This api exposes CiviCRM Contribution Payment records.
Table of Contents
Functions
- civicrm_api3_payment_get() : array<string|int, mixed>
- Retrieve a set of financial transactions which are payments.
- civicrm_api3_payment_delete() : array<string|int, mixed>
- Delete a payment.
- civicrm_api3_payment_cancel() : array<string|int, mixed>
- Cancel/Refund a payment for a Contribution.
- civicrm_api3_payment_create() : array<string|int, mixed>
- Add a payment for a Contribution.
- _civicrm_api3_payment_create_spec() : mixed
- Adjust Metadata for Create action.
- _civicrm_api3_payment_get_spec() : mixed
- Adjust Metadata for Get action.
- _civicrm_api3_payment_delete_spec() : mixed
- Adjust Metadata for Delete action.
- _civicrm_api3_payment_cancel_spec() : mixed
- Adjust Metadata for Cancel action.
- civicrm_api3_payment_sendconfirmation() : array<string|int, mixed>
- Send a payment confirmation.
- _civicrm_api3_payment_sendconfirmation_spec() : mixed
- Adjust Metadata for sendconfirmation action.
Functions
civicrm_api3_payment_get()
Retrieve a set of financial transactions which are payments.
civicrm_api3_payment_get(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
-
Input parameters.
Tags
Return values
array<string|int, mixed> —Array of financial transactions which are payments, if error an array with an error id and error message
civicrm_api3_payment_delete()
Delete a payment.
civicrm_api3_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 array
civicrm_api3_payment_cancel()
Cancel/Refund a payment for a Contribution.
civicrm_api3_payment_cancel(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 array
civicrm_api3_payment_create()
Add a payment for a Contribution.
civicrm_api3_payment_create(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 array
_civicrm_api3_payment_create_spec()
Adjust Metadata for Create action.
_civicrm_api3_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.
_civicrm_api3_payment_get_spec()
Adjust Metadata for Get action.
_civicrm_api3_payment_get_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_payment_delete_spec()
Adjust Metadata for Delete action.
_civicrm_api3_payment_delete_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.
_civicrm_api3_payment_cancel_spec()
Adjust Metadata for Cancel action.
_civicrm_api3_payment_cancel_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.
civicrm_api3_payment_sendconfirmation()
Send a payment confirmation.
civicrm_api3_payment_sendconfirmation(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
-
Input parameters.
Tags
Return values
array<string|int, mixed>_civicrm_api3_payment_sendconfirmation_spec()
Adjust Metadata for sendconfirmation action.
_civicrm_api3_payment_sendconfirmation_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.