Reference

This is a flat view of all the representations and relations. If you would rather explore our API starting from the Entry Point, please use the Browser.

Quick reminder:
  • Representation: a set of name-value pairs representing the state of a resource.
  • Relation: the identifier of a link between two resources.

mandate-templates

  1. mandate-template-representation
  2. create-mandate-template
  3. delete-mandate-template
  4. get-binary-content
  5. patch-mandate-template
  6. search-mandate-template-by-id
  7. search-mandate-templates

1. mandate-template-representation

Description: A mandate template representation. A mandate template is a mandate containing place holders which will be filled dynamically when using the template in order to produce a final, maybe signed, mandate.

Properties
id
The mandate template id. Constraints: 36 characters or less, Read-Only.
reference
The mandate template reference. Constraints: Text, Read-Write, 35 characters or less.
name
The mandate template unique name. Constraints: Text, Mandatory, Read-Write, 35 characters or less.
fileName
The mandate template file name. Constraints: Text, Mandatory, Read-Write, 255 characters or less.
defaultTemplate
Define if the concerned mandate template will be the default one or not. Constraints: Boolean.

2. create-mandate-template (relation)

Description: Creates a new mandate template in the database and its file in the files system.

Properties
reference
The unique identifier of a SlimPay account, allocated by SlimPay. Constraints: Text, 35 characters or less, Read-Write.
creditor » reference
The unique identifier of a SlimPay account, allocated by SlimPay. Constraints: Text, 35 characters or less, Read-Write.
binaryContent » content
The actual binary content. Constraints: Text, Read-Write.
name
The mandate template unique name. Constraints: Text, Mandatory, Read-Write, 35 characters or less.
fileName
The mandate template file name. Constraints: Text, Mandatory, Read-Write, 255 characters or less.

3. delete-mandate-template (relation)

Description: Delete a mandate template by id.

Properties
id
The mandate template id. Constraints: 36 characters or less, Read-Only.

4. get-binary-content (relation)

Description: Download a mandate template by id. Returns the mandate template in a binary content resource.

Properties
id
The mandate template id. Constraints: 36 characters or less, Read-Only.

5. patch-mandate-template (relation)

Description: Patch a mandate template. Updates the property defaultTemplate.

Properties
id
The mandate template id. Constraints: 36 characters or less, Read-Only.
creditor » reference
The unique identifier of a SlimPay account, allocated by SlimPay. Constraints: Text, 35 characters or less, Read-Write.
defaultTemplate
Define if the concerned mandate template will be the default one or not. Constraints: Boolean.

6. search-mandate-template-by-id (relation)

Description: Search a mandate templates by mandatory id.

Properties
id
The mandate template id. Constraints: 36 characters or less, Read-Only.

7. search-mandate-templates (relation)

Description: Search a list of mandate templates by mandatory creditorReference.

Properties
creditorReference
The unique identifier of a SlimPay account, allocated by SlimPay. Constraints: Text, 35 characters or less, Read-Write.