logo

Retrieve a custom deposit property set

Retrieves a custom deposit 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 deposit 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 deposit 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 deposit properties.

id
string <= 50 characters

ID of the deposit property set.

createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

Array of objects (SelfLink)

Related links.

Array
href
string

Link URL.

rel
string

Type of link.

Value: "self"
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

404

Resource not found.

get/deposit-custom-property-sets/{id}
Request samples 
Response samples 
application/json
{
  • "id": "dep_prop_0YVJ640MB4CXVB8KXBRW3B79R9",
  • "name": "string",
  • "properties": {
    },
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "_links": [
    ]
}
➔ Next to Upsert a custom deposit property set