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.

files

  1. file-representation
  2. files-representation
  3. get-binary-content
  4. get-file
  5. import-file
  6. search-files

1. file-representation

Description: A representation of a file resource, containing information about the flow, the type and other detail of the file.

Properties
id
The file id. Constraints: UUID.
name
The name of the file.
dateCreated
The creation date of the file. Constraints: DateTime, ISO8601.
dateAcknowledge
The acknowledge date of the file. Constraints: DateTime, ISO8601.
flow
The flow of the file. Constraints: Text, set to: INJECT, EXECUTE, RTRANS or NOTIFY.
status
The status of the file. Constraints: Text, set to: CREATED, VALIDATED, SENT, RECEIVED, REJECTED, SUSPEND or PARTIALLY_REJECTED.
schema
The schema of the file. Constraints: Text, set to: SEPA_DIRECT_DEBIT_CORE, SEPA_DIRECT_DEBIT_B2B, SEPA_CREDIT_TRANSFER, BACS_DIRECT_DEBIT or CARD.
type
The type of the file. Constraints: Text.
paymentNumber
The payments number contained in the file.

2. files-representation

Description: A collection of files.

3. get-binary-content (relation)

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

Properties
id
The file id. Constraints: UUID.

4. get-file (relation)

Description: Get one file.

Properties

No dynamic property needed. This usually means that the server already took the liberty to build the full URL for you depending on the context. Less code for you!

5. import-file (relation)

Description: Import a file.

Properties
creditorReference
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 name of the file.

6. search-files (relation)

Description: Search files by filters

Properties
creditorReference
The unique identifier of a SlimPay account, allocated by SlimPay. Constraints: Text, 35 characters or less, Read-Write.
name
The name of wanted files.
creationDateBefore
Search files created before this date. Constraints: DateTime, ISO8601, Optional.
creationDateAfter
Search files created after this date. Constraints: DateTime, ISO8601, Optional.
flows
A comma separated list of files flow. Constraints: Text, set to: INJECT, EXECUTE, RTRANS or NOTIFY. Optional.
categories
A comma separated list of files category. Constraints: Text, set to: ORG, ACK or ERR. Optional.
status
A comma separated list of files status. Constraints: Text, set to: CREATED, VALIDATED, SENT, RECEIVED, REJECTED, SUSPEND or PARTIALLY_REJECTED. Optional.
state
The state of the wanted files, the ones have been processed or the ones waiting for processing. Constraints: Text, set to: INJECTED or PENDING. Mandatory.