PaymentProcessor.php
This api exposes CiviCRM PaymentProcessor.
Table of Contents
Functions
- civicrm_api3_payment_processor_create() : array<string|int, mixed>
- Add/Update a PaymentProcessor.
- _civicrm_api3_payment_processor_create_spec() : mixed
- Adjust Metadata for Create action.
- civicrm_api3_payment_processor_delete() : array<string|int, mixed>
- Deletes an existing PaymentProcessor.
- civicrm_api3_payment_processor_get() : array<string|int, mixed>
- Retrieve one or more PaymentProcessor.
- _civicrm_api3_payment_processor_getlist_defaults() : array<string|int, mixed>
- Set default getlist parameters.
- civicrm_api3_payment_processor_pay() : array<string|int, mixed>
- Action payment.
- _civicrm_api3_payment_processor_pay_spec() : mixed
- Action payment.
- civicrm_api3_payment_processor_refund() : array<string|int, mixed>
- Action refund.
- _civicrm_api3_payment_processor_refund_spec() : mixed
- Action Refund.
Functions
civicrm_api3_payment_processor_create()
Add/Update a PaymentProcessor.
civicrm_api3_payment_processor_create(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Return values
array<string|int, mixed> —API result array
_civicrm_api3_payment_processor_create_spec()
Adjust Metadata for Create action.
_civicrm_api3_payment_processor_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_payment_processor_delete()
Deletes an existing PaymentProcessor.
civicrm_api3_payment_processor_delete(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Return values
array<string|int, mixed> —API result array
civicrm_api3_payment_processor_get()
Retrieve one or more PaymentProcessor.
civicrm_api3_payment_processor_get(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
-
Array of name/value pairs.
Return values
array<string|int, mixed> —API result array
_civicrm_api3_payment_processor_getlist_defaults()
Set default getlist parameters.
_civicrm_api3_payment_processor_getlist_defaults(array<string|int, mixed> &$request) : array<string|int, mixed>
Parameters
- $request : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>civicrm_api3_payment_processor_pay()
Action payment.
civicrm_api3_payment_processor_pay(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —API result array.
_civicrm_api3_payment_processor_pay_spec()
Action payment.
_civicrm_api3_payment_processor_pay_spec(array<string|int, mixed> &$params) : mixed
Parameters
- $params : array<string|int, mixed>
civicrm_api3_payment_processor_refund()
Action refund.
civicrm_api3_payment_processor_refund(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —API result array.
_civicrm_api3_payment_processor_refund_spec()
Action Refund.
_civicrm_api3_payment_processor_refund_spec(array<string|int, mixed> &$params) : mixed
Parameters
- $params : array<string|int, mixed>