Create a value list
Creates a new ValueList object, which can then be referenced in rules.
Parameters
- aliasstringRequired
The name of the value list for use in rules.
- namestringRequired
The human-readable name of the value list.
- item_
typestring Type of the items in the value list. One of
card_fingerprint,us_bank_account_fingerprint,sepa_debit_fingerprint,card_bin,email,ip_address,country,string,case_sensitive_string, orcustomer_id. Usestringif the item type is unknown or mixed. - metadataobject
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata.
Returns
Returns a ValueList object if creation succeeds.
Update a value list
Updates a ValueList object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Note that item_type is immutable.
Parameters
- aliasstring
The name of the value list for use in rules.
- metadataobject
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata. - namestring
The human-readable name of the value list.
Returns
Returns an updated ValueList object if a valid identifier was provided.
Retrieve a value list
Retrieves a ValueList object.
Parameters
No parameters.
Returns
Returns a ValueList object if a valid identifier was provided.
List all value lists
Returns a list of ValueList objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
Parameters
- aliasstring
The alias used to reference the value list when writing rules.
More parameters
- containsstring
- createdobject
- ending_
beforestring - limitinteger
- starting_
afterstring
Returns
A dictionary with a data property that contains an array of up to limit lists, starting after list starting_after. Each entry in the array is a separate ValueList object. If no more lists are available, the resulting array will be empty.
Delete a value list
Deletes a ValueList object, also deleting any items contained within the value list. To be deleted, a value list must not be referenced in any rules.
Parameters
No parameters.
Returns
Returns an object with the deleted ValueList object’s ID and a deleted parameter on success. Otherwise, this call raises an error.