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.

reports

  1. base-statistic
  2. directed-payment-issue-statistic
  3. directed-payment-statistic
  4. report-representation
  5. reports-representation
  6. get-report
  7. search-report

1. base-statistic

Description:

Properties
totalAmount
The total amount of something. Constraints: Number, Read-Only.
totalNumber
The total number of something. Constraints: Number, Read-Only.

2. directed-payment-issue-statistic

Description:

Properties
directDebitIssues » rejects » totalAmount
The total amount of something. Constraints: Number, Read-Only.
directDebitIssues » rejects » totalNumber
The total number of something. Constraints: Number, Read-Only.
directDebitIssues » returns » totalAmount
The total amount of something. Constraints: Number, Read-Only.
directDebitIssues » returns » totalNumber
The total number of something. Constraints: Number, Read-Only.
directDebitIssues » totalAmount
The total amount of something. Constraints: Number, Read-Only.
directDebitIssues » totalNumber
The total number of something. Constraints: Number, Read-Only.
creditTransferIssues » fundsTransfers » totalAmount
The total amount of something. Constraints: Number, Read-Only.
creditTransferIssues » fundsTransfers » totalNumber
The total number of something. Constraints: Number, Read-Only.
creditTransferIssues » refunds » totalAmount
The total amount of something. Constraints: Number, Read-Only.
creditTransferIssues » refunds » totalNumber
The total number of something. Constraints: Number, Read-Only.
creditTransferIssues » totalAmount
The total amount of something. Constraints: Number, Read-Only.
creditTransferIssues » totalNumber
The total number of something. Constraints: Number, Read-Only.
cardIssues » totalAmount
The total amount of something. Constraints: Number, Read-Only.
cardIssues » totalNumber
The total number of something. Constraints: Number, Read-Only.
totalAmount
The total amount of something. Constraints: Number, Read-Only.
totalNumber
The total number of something. Constraints: Number, Read-Only.

3. directed-payment-statistic

Description:

Properties
directDebits » ok » totalAmount
The total amount of something. Constraints: Number, Read-Only.
directDebits » ok » totalNumber
The total number of something. Constraints: Number, Read-Only.
directDebits » totalAmount
The total amount of something. Constraints: Number, Read-Only.
directDebits » totalNumber
The total number of something. Constraints: Number, Read-Only.
creditTransfers » totalAmount
The total amount of something. Constraints: Number, Read-Only.
creditTransfers » totalNumber
The total number of something. Constraints: Number, Read-Only.
cards » totalAmount
The total amount of something. Constraints: Number, Read-Only.
cards » totalNumber
The total number of something. Constraints: Number, Read-Only.
totalAmount
The total amount of something. Constraints: Number, Read-Only.
totalNumber
The total number of something. Constraints: Number, Read-Only.

4. report-representation

Description: A report representation.

Properties
currency
The bank account currenc. Constraints: Text among EUR|GBP, Read-Write, Optional.
dateFrom
The date where this report begins. Constraints: DateTime, Read-Write, ISO8601, Optional.
dateTo
The date where this report ends. Constraints: DateTime, Read-Write, ISO8601, Optional.
payouts » directDebits » ok » totalAmount
The total amount of something. Constraints: Number, Read-Only.
payouts » directDebits » ok » totalNumber
The total number of something. Constraints: Number, Read-Only.
payouts » directDebits » totalAmount
The total amount of something. Constraints: Number, Read-Only.
payouts » directDebits » totalNumber
The total number of something. Constraints: Number, Read-Only.
payouts » creditTransfers » totalAmount
The total amount of something. Constraints: Number, Read-Only.
payouts » creditTransfers » totalNumber
The total number of something. Constraints: Number, Read-Only.
payouts » cards » totalAmount
The total amount of something. Constraints: Number, Read-Only.
payouts » cards » totalNumber
The total number of something. Constraints: Number, Read-Only.
payouts » totalAmount
The total amount of something. Constraints: Number, Read-Only.
payouts » totalNumber
The total number of something. Constraints: Number, Read-Only.
payoutFees » directDebits » ok » totalAmount
The total amount of something. Constraints: Number, Read-Only.
payoutFees » directDebits » ok » totalNumber
The total number of something. Constraints: Number, Read-Only.
payoutFees » directDebits » totalAmount
The total amount of something. Constraints: Number, Read-Only.
payoutFees » directDebits » totalNumber
The total number of something. Constraints: Number, Read-Only.
payoutFees » creditTransfers » totalAmount
The total amount of something. Constraints: Number, Read-Only.
payoutFees » creditTransfers » totalNumber
The total number of something. Constraints: Number, Read-Only.
payoutFees » cards » totalAmount
The total amount of something. Constraints: Number, Read-Only.
payoutFees » cards » totalNumber
The total number of something. Constraints: Number, Read-Only.
payoutFees » totalAmount
The total amount of something. Constraints: Number, Read-Only.
payoutFees » totalNumber
The total number of something. Constraints: Number, Read-Only.
payoutIssues » directDebitIssues » rejects » totalAmount
The total amount of something. Constraints: Number, Read-Only.
payoutIssues » directDebitIssues » rejects » totalNumber
The total number of something. Constraints: Number, Read-Only.
payoutIssues » directDebitIssues » returns » totalAmount
The total amount of something. Constraints: Number, Read-Only.
payoutIssues » directDebitIssues » returns » totalNumber
The total number of something. Constraints: Number, Read-Only.
payoutIssues » directDebitIssues » totalAmount
The total amount of something. Constraints: Number, Read-Only.
payoutIssues » directDebitIssues » totalNumber
The total number of something. Constraints: Number, Read-Only.
payoutIssues » creditTransferIssues » fundsTransfers » totalAmount
The total amount of something. Constraints: Number, Read-Only.
payoutIssues » creditTransferIssues » fundsTransfers » totalNumber
The total number of something. Constraints: Number, Read-Only.
payoutIssues » creditTransferIssues » refunds » totalAmount
The total amount of something. Constraints: Number, Read-Only.
payoutIssues » creditTransferIssues » refunds » totalNumber
The total number of something. Constraints: Number, Read-Only.
payoutIssues » creditTransferIssues » totalAmount
The total amount of something. Constraints: Number, Read-Only.
payoutIssues » creditTransferIssues » totalNumber
The total number of something. Constraints: Number, Read-Only.
payoutIssues » cardIssues » totalAmount
The total amount of something. Constraints: Number, Read-Only.
payoutIssues » cardIssues » totalNumber
The total number of something. Constraints: Number, Read-Only.
payoutIssues » totalAmount
The total amount of something. Constraints: Number, Read-Only.
payoutIssues » totalNumber
The total number of something. Constraints: Number, Read-Only.
payoutIssueFees » directDebitIssues » rejects » totalAmount
The total amount of something. Constraints: Number, Read-Only.
payoutIssueFees » directDebitIssues » rejects » totalNumber
The total number of something. Constraints: Number, Read-Only.
payoutIssueFees » directDebitIssues » returns » totalAmount
The total amount of something. Constraints: Number, Read-Only.
payoutIssueFees » directDebitIssues » returns » totalNumber
The total number of something. Constraints: Number, Read-Only.
payoutIssueFees » directDebitIssues » totalAmount
The total amount of something. Constraints: Number, Read-Only.
payoutIssueFees » directDebitIssues » totalNumber
The total number of something. Constraints: Number, Read-Only.
payoutIssueFees » creditTransferIssues » fundsTransfers » totalAmount
The total amount of something. Constraints: Number, Read-Only.
payoutIssueFees » creditTransferIssues » fundsTransfers » totalNumber
The total number of something. Constraints: Number, Read-Only.
payoutIssueFees » creditTransferIssues » refunds » totalAmount
The total amount of something. Constraints: Number, Read-Only.
payoutIssueFees » creditTransferIssues » refunds » totalNumber
The total number of something. Constraints: Number, Read-Only.
payoutIssueFees » creditTransferIssues » totalAmount
The total amount of something. Constraints: Number, Read-Only.
payoutIssueFees » creditTransferIssues » totalNumber
The total number of something. Constraints: Number, Read-Only.
payoutIssueFees » cardIssues » totalAmount
The total amount of something. Constraints: Number, Read-Only.
payoutIssueFees » cardIssues » totalNumber
The total number of something. Constraints: Number, Read-Only.
payoutIssueFees » totalAmount
The total amount of something. Constraints: Number, Read-Only.
payoutIssueFees » totalNumber
The total number of something. Constraints: Number, Read-Only.
payins » directDebits » ok » totalAmount
The total amount of something. Constraints: Number, Read-Only.
payins » directDebits » ok » totalNumber
The total number of something. Constraints: Number, Read-Only.
payins » directDebits » totalAmount
The total amount of something. Constraints: Number, Read-Only.
payins » directDebits » totalNumber
The total number of something. Constraints: Number, Read-Only.
payins » creditTransfers » totalAmount
The total amount of something. Constraints: Number, Read-Only.
payins » creditTransfers » totalNumber
The total number of something. Constraints: Number, Read-Only.
payins » cards » totalAmount
The total amount of something. Constraints: Number, Read-Only.
payins » cards » totalNumber
The total number of something. Constraints: Number, Read-Only.
payins » totalAmount
The total amount of something. Constraints: Number, Read-Only.
payins » totalNumber
The total number of something. Constraints: Number, Read-Only.
payinFees » directDebits » ok » totalAmount
The total amount of something. Constraints: Number, Read-Only.
payinFees » directDebits » ok » totalNumber
The total number of something. Constraints: Number, Read-Only.
payinFees » directDebits » totalAmount
The total amount of something. Constraints: Number, Read-Only.
payinFees » directDebits » totalNumber
The total number of something. Constraints: Number, Read-Only.
payinFees » creditTransfers » totalAmount
The total amount of something. Constraints: Number, Read-Only.
payinFees » creditTransfers » totalNumber
The total number of something. Constraints: Number, Read-Only.
payinFees » cards » totalAmount
The total amount of something. Constraints: Number, Read-Only.
payinFees » cards » totalNumber
The total number of something. Constraints: Number, Read-Only.
payinFees » totalAmount
The total amount of something. Constraints: Number, Read-Only.
payinFees » totalNumber
The total number of something. Constraints: Number, Read-Only.
payinIssues » directDebitIssues » rejects » totalAmount
The total amount of something. Constraints: Number, Read-Only.
payinIssues » directDebitIssues » rejects » totalNumber
The total number of something. Constraints: Number, Read-Only.
payinIssues » directDebitIssues » returns » totalAmount
The total amount of something. Constraints: Number, Read-Only.
payinIssues » directDebitIssues » returns » totalNumber
The total number of something. Constraints: Number, Read-Only.
payinIssues » directDebitIssues » totalAmount
The total amount of something. Constraints: Number, Read-Only.
payinIssues » directDebitIssues » totalNumber
The total number of something. Constraints: Number, Read-Only.
payinIssues » creditTransferIssues » fundsTransfers » totalAmount
The total amount of something. Constraints: Number, Read-Only.
payinIssues » creditTransferIssues » fundsTransfers » totalNumber
The total number of something. Constraints: Number, Read-Only.
payinIssues » creditTransferIssues » refunds » totalAmount
The total amount of something. Constraints: Number, Read-Only.
payinIssues » creditTransferIssues » refunds » totalNumber
The total number of something. Constraints: Number, Read-Only.
payinIssues » creditTransferIssues » totalAmount
The total amount of something. Constraints: Number, Read-Only.
payinIssues » creditTransferIssues » totalNumber
The total number of something. Constraints: Number, Read-Only.
payinIssues » cardIssues » totalAmount
The total amount of something. Constraints: Number, Read-Only.
payinIssues » cardIssues » totalNumber
The total number of something. Constraints: Number, Read-Only.
payinIssues » totalAmount
The total amount of something. Constraints: Number, Read-Only.
payinIssues » totalNumber
The total number of something. Constraints: Number, Read-Only.
payinIssueFees » directDebitIssues » rejects » totalAmount
The total amount of something. Constraints: Number, Read-Only.
payinIssueFees » directDebitIssues » rejects » totalNumber
The total number of something. Constraints: Number, Read-Only.
payinIssueFees » directDebitIssues » returns » totalAmount
The total amount of something. Constraints: Number, Read-Only.
payinIssueFees » directDebitIssues » returns » totalNumber
The total number of something. Constraints: Number, Read-Only.
payinIssueFees » directDebitIssues » totalAmount
The total amount of something. Constraints: Number, Read-Only.
payinIssueFees » directDebitIssues » totalNumber
The total number of something. Constraints: Number, Read-Only.
payinIssueFees » creditTransferIssues » fundsTransfers » totalAmount
The total amount of something. Constraints: Number, Read-Only.
payinIssueFees » creditTransferIssues » fundsTransfers » totalNumber
The total number of something. Constraints: Number, Read-Only.
payinIssueFees » creditTransferIssues » refunds » totalAmount
The total amount of something. Constraints: Number, Read-Only.
payinIssueFees » creditTransferIssues » refunds » totalNumber
The total number of something. Constraints: Number, Read-Only.
payinIssueFees » creditTransferIssues » totalAmount
The total amount of something. Constraints: Number, Read-Only.
payinIssueFees » creditTransferIssues » totalNumber
The total number of something. Constraints: Number, Read-Only.
payinIssueFees » cardIssues » totalAmount
The total amount of something. Constraints: Number, Read-Only.
payinIssueFees » cardIssues » totalNumber
The total number of something. Constraints: Number, Read-Only.
payinIssueFees » totalAmount
The total amount of something. Constraints: Number, Read-Only.
payinIssueFees » totalNumber
The total number of something. Constraints: Number, Read-Only.
balanceFrom » valueBalance
The amount on value date. Constraints: Number, 22 characters or less, Read-Only.
balanceFrom » bookBalance
The amount on book date. Constraints: Number, 22 characters or less, Read-Only.
balanceFrom » rollingReserve
The minimum amount required in the bank account. Constraints: Number, 22 characters or less, Read-Only.
balanceFrom » ongoingPayoutsTotalAmount
Total amount of the ongoing payouts. Constraints: Number, 22 characters or less, Read-Only.
balanceFrom » ongoingFeesTotalAmount
Total amount of the ongoing fees. Constraints: Number, 22 characters or less, Read-Only.
balanceFrom » currency
The currency. Constraints: Text among EUR|GBP, Read-Only.
balanceTo » valueBalance
The amount on value date. Constraints: Number, 22 characters or less, Read-Only.
balanceTo » bookBalance
The amount on book date. Constraints: Number, 22 characters or less, Read-Only.
balanceTo » rollingReserve
The minimum amount required in the bank account. Constraints: Number, 22 characters or less, Read-Only.
balanceTo » ongoingPayoutsTotalAmount
Total amount of the ongoing payouts. Constraints: Number, 22 characters or less, Read-Only.
balanceTo » ongoingFeesTotalAmount
Total amount of the ongoing fees. Constraints: Number, 22 characters or less, Read-Only.
balanceTo » currency
The currency. Constraints: Text among EUR|GBP, Read-Only.

5. reports-representation

Description: A collection of reports.

6. get-report (relation)

Description: Get a single report

Properties
entityReference
The entity reference within the SlimPay referential. It is is given by SlimPay. Constraints: Text, 35 characters or less, Read-Only.
dateFrom
The date where this report begins. Constraints: DateTime, Read-Write, ISO8601, Optional.
dateTo
The date where this report ends. Constraints: DateTime, Read-Write, ISO8601, Optional.

7. search-report (relation)

Description: Search a single report

Properties
creditorReference
The creditor reference within the SlimPay referential. This reference is given by SlimPay. Constraints: Text, 35 characters or less, Read-Write.
entityReference
The entity reference within the SlimPay referential. It is is given by SlimPay. Constraints: Text, 35 characters or less, Read-Only.
dateFrom
The date where this report begins. Constraints: DateTime, Read-Write, ISO8601, Optional.
dateTo
The date where this report ends. Constraints: DateTime, Read-Write, ISO8601, Optional.