logo

Create a custom cashier property set

Creates a custom cashier property set. A custom property set is a JSON-schema to extend the hosted cashier deposit request form with extra form fields. The collected information is stored at the cashier deposit request.

SecuritySecretApiKey or JWT
Request
Request Body schema: application/json

Custom cashier property set resource.

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.

Responses
201

Custom cashier property set created.

Response Headers
Location
string <uri>

Location of the related resource.

Example: "https://api.rebilly.com/example"
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

Unique resource ID. Defaults to UUID v4.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

422

Invalid data sent.

post/cashier-custom-property-sets
Request samples
application/json
{
  • "name": "string",
  • "properties": {
    }
}
Response samples
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "name": "string",
  • "properties": {
    }
}
➔ Next to Retrieve custom cashier properties sets