logo

Retrieve custom cashier properties sets

Retrieves a list of custom cashier property sets.

SecuritySecretApiKey or JWT
Request
query Parameters
limit
integer [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offset
integer >= 0

Specifies the starting point within the collection of items to be returned.

filter
string

Filters the collection items. This field requires a special format. Use , for multiple allowed values. Use ; for multiple fields.

For more information, see Using filter with collections.

sort
Array of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -.

Responses
200

List of custom cashier property sets retrieved.

Response Headers
Pagination-Total
integer

Total number of items.

Example: 332
Pagination-Limit
integer

Maximum number of items per page.

Example: 100
Pagination-Offset
integer

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example: 2
Response Schema: application/json
Array
name
required
string

Name of the custom property set.

properties
required
object

Defines properties the user can complete when they use the hosted cashier form. This field accepts JSON-schema drafts 4, 6, and 7. Accepted properties types are: string, number, integer, array, and enum. For more information, see Configure custom hosted cashier properties.

id
string <= 50 characters

Unique resource ID. Defaults to UUID v4.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

get/cashier-custom-property-sets
Request samples 
Response samples 
application/json
[
  • {
    }
]
➔ Next to Retrieve a custom cashier property set