logo

Retrieve a custom cashier property set

Retrieves a custom cashier property set with a specified ID.

SecuritySecretApiKey or JWT
Request
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

ID of the resource.

Responses
200

Custom cashier property set retrieved.

Response Schema: application/json
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

ID of the cashier property set.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

404

Resource not found.

get/cashier-custom-property-sets/{id}
Request samples 
Response samples 
application/json
{
  • "id": "cash_prop_0YVJ640MB4CXVB8KXBRW3B79R9",
  • "name": "string",
  • "properties": {
    }
}
➔ Next to Upsert a custom cashier property set