PaymentToken.php
This api exposes CiviCRM Payment Token records.
Tags
Table of Contents
Functions
- civicrm_api3_payment_token_create() : array<string|int, mixed>
- Create/update Payment Token.
- _civicrm_api3_payment_token_create_spec() : mixed
- Adjust Metadata for Create action.
- civicrm_api3_payment_token_get() : array<string|int, mixed>
- Returns array of campaigns matching a set of one or more properties.
- civicrm_api3_payment_token_delete() : array<string|int, mixed>
- Delete an existing payment token.
Functions
civicrm_api3_payment_token_create()
Create/update Payment Token.
civicrm_api3_payment_token_create(array<string|int, mixed> $params) : array<string|int, mixed>
This API is used to create new campaign or update any of the existing In case of updating existing campaign, id of that particular campaign must be in $params array.
Parameters
- $params : array<string|int, mixed>
Return values
array<string|int, mixed>_civicrm_api3_payment_token_create_spec()
Adjust Metadata for Create action.
_civicrm_api3_payment_token_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_token_get()
Returns array of campaigns matching a set of one or more properties.
civicrm_api3_payment_token_get(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
-
Array per getfields
Return values
array<string|int, mixed> —Array of matching campaigns
civicrm_api3_payment_token_delete()
Delete an existing payment token.
civicrm_api3_payment_token_delete(array<string|int, mixed> $params) : array<string|int, mixed>
This method is used to delete any existing payment token. Id of the payment token to be deleted is required field in $params array
Parameters
- $params : array<string|int, mixed>
-
array containing id of the group to be deleted