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 namevalue pairs representing the state of a resource.
 Relation: the identifier of a link between two resources.
reports
 basestatistic
 directedpaymentissuestatistic
 directedpaymentstatistic
 reportrepresentation
 reportsrepresentation
 getreport
 searchreport
1. basestatistic
Description:
Properties
 totalAmount
 The total amount of something. Constraints: Number, ReadOnly.
 totalNumber
 The total number of something. Constraints: Number, ReadOnly.
2. directedpaymentissuestatistic
Description:
Properties
 directDebitIssues » rejects » totalAmount
 The total amount of something. Constraints: Number, ReadOnly.
 directDebitIssues » rejects » totalNumber
 The total number of something. Constraints: Number, ReadOnly.
 directDebitIssues » returns » totalAmount
 The total amount of something. Constraints: Number, ReadOnly.
 directDebitIssues » returns » totalNumber
 The total number of something. Constraints: Number, ReadOnly.
 directDebitIssues » totalAmount
 The total amount of something. Constraints: Number, ReadOnly.
 directDebitIssues » totalNumber
 The total number of something. Constraints: Number, ReadOnly.
 creditTransferIssues » fundsTransfers » totalAmount
 The total amount of something. Constraints: Number, ReadOnly.
 creditTransferIssues » fundsTransfers » totalNumber
 The total number of something. Constraints: Number, ReadOnly.
 creditTransferIssues » refunds » totalAmount
 The total amount of something. Constraints: Number, ReadOnly.
 creditTransferIssues » refunds » totalNumber
 The total number of something. Constraints: Number, ReadOnly.
 creditTransferIssues » totalAmount
 The total amount of something. Constraints: Number, ReadOnly.
 creditTransferIssues » totalNumber
 The total number of something. Constraints: Number, ReadOnly.
 cardIssues » totalAmount
 The total amount of something. Constraints: Number, ReadOnly.
 cardIssues » totalNumber
 The total number of something. Constraints: Number, ReadOnly.
 totalAmount
 The total amount of something. Constraints: Number, ReadOnly.
 totalNumber
 The total number of something. Constraints: Number, ReadOnly.
3. directedpaymentstatistic
Description:
Properties
 directDebits » ok » totalAmount
 The total amount of something. Constraints: Number, ReadOnly.
 directDebits » ok » totalNumber
 The total number of something. Constraints: Number, ReadOnly.
 directDebits » totalAmount
 The total amount of something. Constraints: Number, ReadOnly.
 directDebits » totalNumber
 The total number of something. Constraints: Number, ReadOnly.
 creditTransfers » totalAmount
 The total amount of something. Constraints: Number, ReadOnly.
 creditTransfers » totalNumber
 The total number of something. Constraints: Number, ReadOnly.
 cards » totalAmount
 The total amount of something. Constraints: Number, ReadOnly.
 cards » totalNumber
 The total number of something. Constraints: Number, ReadOnly.
 totalAmount
 The total amount of something. Constraints: Number, ReadOnly.
 totalNumber
 The total number of something. Constraints: Number, ReadOnly.
4. reportrepresentation
Description: A report representation.
Properties
 currency
 The bank account currenc. Constraints: Text among EURGBP, ReadWrite, Optional.
 dateFrom
 The date where this report begins. Constraints: DateTime, ReadWrite, ISO8601, Optional.
 dateTo
 The date where this report ends. Constraints: DateTime, ReadWrite, ISO8601, Optional.
 payouts » directDebits » ok » totalAmount
 The total amount of something. Constraints: Number, ReadOnly.
 payouts » directDebits » ok » totalNumber
 The total number of something. Constraints: Number, ReadOnly.
 payouts » directDebits » totalAmount
 The total amount of something. Constraints: Number, ReadOnly.
 payouts » directDebits » totalNumber
 The total number of something. Constraints: Number, ReadOnly.
 payouts » creditTransfers » totalAmount
 The total amount of something. Constraints: Number, ReadOnly.
 payouts » creditTransfers » totalNumber
 The total number of something. Constraints: Number, ReadOnly.
 payouts » cards » totalAmount
 The total amount of something. Constraints: Number, ReadOnly.
 payouts » cards » totalNumber
 The total number of something. Constraints: Number, ReadOnly.
 payouts » totalAmount
 The total amount of something. Constraints: Number, ReadOnly.
 payouts » totalNumber
 The total number of something. Constraints: Number, ReadOnly.
 payoutFees » directDebits » ok » totalAmount
 The total amount of something. Constraints: Number, ReadOnly.
 payoutFees » directDebits » ok » totalNumber
 The total number of something. Constraints: Number, ReadOnly.
 payoutFees » directDebits » totalAmount
 The total amount of something. Constraints: Number, ReadOnly.
 payoutFees » directDebits » totalNumber
 The total number of something. Constraints: Number, ReadOnly.
 payoutFees » creditTransfers » totalAmount
 The total amount of something. Constraints: Number, ReadOnly.
 payoutFees » creditTransfers » totalNumber
 The total number of something. Constraints: Number, ReadOnly.
 payoutFees » cards » totalAmount
 The total amount of something. Constraints: Number, ReadOnly.
 payoutFees » cards » totalNumber
 The total number of something. Constraints: Number, ReadOnly.
 payoutFees » totalAmount
 The total amount of something. Constraints: Number, ReadOnly.
 payoutFees » totalNumber
 The total number of something. Constraints: Number, ReadOnly.
 payoutIssues » directDebitIssues » rejects » totalAmount
 The total amount of something. Constraints: Number, ReadOnly.
 payoutIssues » directDebitIssues » rejects » totalNumber
 The total number of something. Constraints: Number, ReadOnly.
 payoutIssues » directDebitIssues » returns » totalAmount
 The total amount of something. Constraints: Number, ReadOnly.
 payoutIssues » directDebitIssues » returns » totalNumber
 The total number of something. Constraints: Number, ReadOnly.
 payoutIssues » directDebitIssues » totalAmount
 The total amount of something. Constraints: Number, ReadOnly.
 payoutIssues » directDebitIssues » totalNumber
 The total number of something. Constraints: Number, ReadOnly.
 payoutIssues » creditTransferIssues » fundsTransfers » totalAmount
 The total amount of something. Constraints: Number, ReadOnly.
 payoutIssues » creditTransferIssues » fundsTransfers » totalNumber
 The total number of something. Constraints: Number, ReadOnly.
 payoutIssues » creditTransferIssues » refunds » totalAmount
 The total amount of something. Constraints: Number, ReadOnly.
 payoutIssues » creditTransferIssues » refunds » totalNumber
 The total number of something. Constraints: Number, ReadOnly.
 payoutIssues » creditTransferIssues » totalAmount
 The total amount of something. Constraints: Number, ReadOnly.
 payoutIssues » creditTransferIssues » totalNumber
 The total number of something. Constraints: Number, ReadOnly.
 payoutIssues » cardIssues » totalAmount
 The total amount of something. Constraints: Number, ReadOnly.
 payoutIssues » cardIssues » totalNumber
 The total number of something. Constraints: Number, ReadOnly.
 payoutIssues » totalAmount
 The total amount of something. Constraints: Number, ReadOnly.
 payoutIssues » totalNumber
 The total number of something. Constraints: Number, ReadOnly.
 payoutIssueFees » directDebitIssues » rejects » totalAmount
 The total amount of something. Constraints: Number, ReadOnly.
 payoutIssueFees » directDebitIssues » rejects » totalNumber
 The total number of something. Constraints: Number, ReadOnly.
 payoutIssueFees » directDebitIssues » returns » totalAmount
 The total amount of something. Constraints: Number, ReadOnly.
 payoutIssueFees » directDebitIssues » returns » totalNumber
 The total number of something. Constraints: Number, ReadOnly.
 payoutIssueFees » directDebitIssues » totalAmount
 The total amount of something. Constraints: Number, ReadOnly.
 payoutIssueFees » directDebitIssues » totalNumber
 The total number of something. Constraints: Number, ReadOnly.
 payoutIssueFees » creditTransferIssues » fundsTransfers » totalAmount
 The total amount of something. Constraints: Number, ReadOnly.
 payoutIssueFees » creditTransferIssues » fundsTransfers » totalNumber
 The total number of something. Constraints: Number, ReadOnly.
 payoutIssueFees » creditTransferIssues » refunds » totalAmount
 The total amount of something. Constraints: Number, ReadOnly.
 payoutIssueFees » creditTransferIssues » refunds » totalNumber
 The total number of something. Constraints: Number, ReadOnly.
 payoutIssueFees » creditTransferIssues » totalAmount
 The total amount of something. Constraints: Number, ReadOnly.
 payoutIssueFees » creditTransferIssues » totalNumber
 The total number of something. Constraints: Number, ReadOnly.
 payoutIssueFees » cardIssues » totalAmount
 The total amount of something. Constraints: Number, ReadOnly.
 payoutIssueFees » cardIssues » totalNumber
 The total number of something. Constraints: Number, ReadOnly.
 payoutIssueFees » totalAmount
 The total amount of something. Constraints: Number, ReadOnly.
 payoutIssueFees » totalNumber
 The total number of something. Constraints: Number, ReadOnly.
 payins » directDebits » ok » totalAmount
 The total amount of something. Constraints: Number, ReadOnly.
 payins » directDebits » ok » totalNumber
 The total number of something. Constraints: Number, ReadOnly.
 payins » directDebits » totalAmount
 The total amount of something. Constraints: Number, ReadOnly.
 payins » directDebits » totalNumber
 The total number of something. Constraints: Number, ReadOnly.
 payins » creditTransfers » totalAmount
 The total amount of something. Constraints: Number, ReadOnly.
 payins » creditTransfers » totalNumber
 The total number of something. Constraints: Number, ReadOnly.
 payins » cards » totalAmount
 The total amount of something. Constraints: Number, ReadOnly.
 payins » cards » totalNumber
 The total number of something. Constraints: Number, ReadOnly.
 payins » totalAmount
 The total amount of something. Constraints: Number, ReadOnly.
 payins » totalNumber
 The total number of something. Constraints: Number, ReadOnly.
 payinFees » directDebits » ok » totalAmount
 The total amount of something. Constraints: Number, ReadOnly.
 payinFees » directDebits » ok » totalNumber
 The total number of something. Constraints: Number, ReadOnly.
 payinFees » directDebits » totalAmount
 The total amount of something. Constraints: Number, ReadOnly.
 payinFees » directDebits » totalNumber
 The total number of something. Constraints: Number, ReadOnly.
 payinFees » creditTransfers » totalAmount
 The total amount of something. Constraints: Number, ReadOnly.
 payinFees » creditTransfers » totalNumber
 The total number of something. Constraints: Number, ReadOnly.
 payinFees » cards » totalAmount
 The total amount of something. Constraints: Number, ReadOnly.
 payinFees » cards » totalNumber
 The total number of something. Constraints: Number, ReadOnly.
 payinFees » totalAmount
 The total amount of something. Constraints: Number, ReadOnly.
 payinFees » totalNumber
 The total number of something. Constraints: Number, ReadOnly.
 payinIssues » directDebitIssues » rejects » totalAmount
 The total amount of something. Constraints: Number, ReadOnly.
 payinIssues » directDebitIssues » rejects » totalNumber
 The total number of something. Constraints: Number, ReadOnly.
 payinIssues » directDebitIssues » returns » totalAmount
 The total amount of something. Constraints: Number, ReadOnly.
 payinIssues » directDebitIssues » returns » totalNumber
 The total number of something. Constraints: Number, ReadOnly.
 payinIssues » directDebitIssues » totalAmount
 The total amount of something. Constraints: Number, ReadOnly.
 payinIssues » directDebitIssues » totalNumber
 The total number of something. Constraints: Number, ReadOnly.
 payinIssues » creditTransferIssues » fundsTransfers » totalAmount
 The total amount of something. Constraints: Number, ReadOnly.
 payinIssues » creditTransferIssues » fundsTransfers » totalNumber
 The total number of something. Constraints: Number, ReadOnly.
 payinIssues » creditTransferIssues » refunds » totalAmount
 The total amount of something. Constraints: Number, ReadOnly.
 payinIssues » creditTransferIssues » refunds » totalNumber
 The total number of something. Constraints: Number, ReadOnly.
 payinIssues » creditTransferIssues » totalAmount
 The total amount of something. Constraints: Number, ReadOnly.
 payinIssues » creditTransferIssues » totalNumber
 The total number of something. Constraints: Number, ReadOnly.
 payinIssues » cardIssues » totalAmount
 The total amount of something. Constraints: Number, ReadOnly.
 payinIssues » cardIssues » totalNumber
 The total number of something. Constraints: Number, ReadOnly.
 payinIssues » totalAmount
 The total amount of something. Constraints: Number, ReadOnly.
 payinIssues » totalNumber
 The total number of something. Constraints: Number, ReadOnly.
 payinIssueFees » directDebitIssues » rejects » totalAmount
 The total amount of something. Constraints: Number, ReadOnly.
 payinIssueFees » directDebitIssues » rejects » totalNumber
 The total number of something. Constraints: Number, ReadOnly.
 payinIssueFees » directDebitIssues » returns » totalAmount
 The total amount of something. Constraints: Number, ReadOnly.
 payinIssueFees » directDebitIssues » returns » totalNumber
 The total number of something. Constraints: Number, ReadOnly.
 payinIssueFees » directDebitIssues » totalAmount
 The total amount of something. Constraints: Number, ReadOnly.
 payinIssueFees » directDebitIssues » totalNumber
 The total number of something. Constraints: Number, ReadOnly.
 payinIssueFees » creditTransferIssues » fundsTransfers » totalAmount
 The total amount of something. Constraints: Number, ReadOnly.
 payinIssueFees » creditTransferIssues » fundsTransfers » totalNumber
 The total number of something. Constraints: Number, ReadOnly.
 payinIssueFees » creditTransferIssues » refunds » totalAmount
 The total amount of something. Constraints: Number, ReadOnly.
 payinIssueFees » creditTransferIssues » refunds » totalNumber
 The total number of something. Constraints: Number, ReadOnly.
 payinIssueFees » creditTransferIssues » totalAmount
 The total amount of something. Constraints: Number, ReadOnly.
 payinIssueFees » creditTransferIssues » totalNumber
 The total number of something. Constraints: Number, ReadOnly.
 payinIssueFees » cardIssues » totalAmount
 The total amount of something. Constraints: Number, ReadOnly.
 payinIssueFees » cardIssues » totalNumber
 The total number of something. Constraints: Number, ReadOnly.
 payinIssueFees » totalAmount
 The total amount of something. Constraints: Number, ReadOnly.
 payinIssueFees » totalNumber
 The total number of something. Constraints: Number, ReadOnly.
 balanceFrom » valueBalance
 The amount on value date. Constraints: Number, 22 characters or less, ReadOnly.
 balanceFrom » bookBalance
 The amount on book date. Constraints: Number, 22 characters or less, ReadOnly.
 balanceFrom » rollingReserve
 The minimum amount required in the bank account. Constraints: Number, 22 characters or less, ReadOnly.
 balanceFrom » ongoingPayoutsTotalAmount
 Total amount of the ongoing payouts. Constraints: Number, 22 characters or less, ReadOnly.
 balanceFrom » ongoingFeesTotalAmount
 Total amount of the ongoing fees. Constraints: Number, 22 characters or less, ReadOnly.
 balanceFrom » currency
 The currency. Constraints: Text among EURGBP, ReadOnly.
 balanceTo » valueBalance
 The amount on value date. Constraints: Number, 22 characters or less, ReadOnly.
 balanceTo » bookBalance
 The amount on book date. Constraints: Number, 22 characters or less, ReadOnly.
 balanceTo » rollingReserve
 The minimum amount required in the bank account. Constraints: Number, 22 characters or less, ReadOnly.
 balanceTo » ongoingPayoutsTotalAmount
 Total amount of the ongoing payouts. Constraints: Number, 22 characters or less, ReadOnly.
 balanceTo » ongoingFeesTotalAmount
 Total amount of the ongoing fees. Constraints: Number, 22 characters or less, ReadOnly.
 balanceTo » currency
 The currency. Constraints: Text among EURGBP, ReadOnly.
5. reportsrepresentation
Description: A collection of reports.
6. getreport (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, ReadOnly.
 dateFrom
 The date where this report begins. Constraints: DateTime, ReadWrite, ISO8601, Optional.
 dateTo
 The date where this report ends. Constraints: DateTime, ReadWrite, ISO8601, Optional.
7. searchreport (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, ReadWrite.
 entityReference
 The entity reference within the SlimPay referential. It is is given by SlimPay. Constraints: Text, 35 characters or less, ReadOnly.
 dateFrom
 The date where this report begins. Constraints: DateTime, ReadWrite, ISO8601, Optional.
 dateTo
 The date where this report ends. Constraints: DateTime, ReadWrite, ISO8601, Optional.