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.

balances

  1. balance-representation
  2. balances-representation
  3. get-balance
  4. search-balances

1. balance-representation

Description: A representation of a balance resource, containing information about the funds currently available in the creditor's account.

Properties
calculationDate
The balance date. Constraints: DateTime, ISO8601, Read-Only.
valueBalance
The account balance on value date. Constraints: Number, 22 characters or less, Read-Only.
bookBalance
The account balance on book date. Constraints: Number, 22 characters or less, Read-Only.
rollingReserve
The minimum amount required in the bank account. Constraints: Number, 22 characters or less, Read-Only.
ongoingPayoutsTotalAmount
Total amount of the ongoing payouts. Constraints: Number, 22 characters or less, Read-Only.
ongoingFeesTotalAmount
Total amount of the ongoing fees. Constraints: Number, 22 characters or less, Read-Only.
globalCoverage
The global coverage (fixed coverage + variable coverage). Constraints: Number, 22 characters or less, Read-Only.
fixedCoverage
The fixed coverage. Constraints: Number, 22 characters or less, Read-Only.
variableCoverage
The variable coverage. Constraints: Number, 22 characters or less, Read-Only.
availableFunds
The last calculated available funds. Constraints: Number, 22 characters or less, Read-Only.
currency
The currency of the account balance. Constraints: Text, an ISO 4217 standard currency code, set to EUR, Read-Only.

2. balances-representation

Description: A collection of balance representations, each reflecting the balance of an account resource.

3. get-balance (relation)

Description: Retrieve the representation of a single balance resource. If the creditor is configured with entities, the entityReference parameter should be provided. If not, it should not be given.

Properties
entityReference
The entity reference of the creditor, allocated by SlimPay. Constraints: Text, 35 characters or less, Read-Only.
Example: Retrieve a balance representation
Request
GET follow(https://api.slimpay.net/alps#get-balance) HTTP/1.1
Accept: application/hal+json; profile="https://api.slimpay.net/alps/v1"
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJhcGkiXSwiZXhwIjoxNTMwNjMzNTk0LCJqdGkiOiI2ODNmNGE1Ni1kZjQ3LTQ0ZWYtYmIxYy02MDJhYmFlNGYwYjgiLCJjbGllbnRfaWQiOiJkZW1vY3JlZGl0b3IwMSJ9.VSmbmu4upmKj5_lTiBlqtbqSH42yx83AB1IFXJs08Tw
Response
HTTP/1.1 200 OK
Content-Type: application/hal+json; profile="https://api.slimpay.net/alps/v1";charset=UTF-8
Content-Length: 442

{
    "bookBalance": "3422926.16",
    "currency": "EUR",
    "ongoingFeesTotalAmount": "316024.42",
    "ongoingPayoutsTotalAmount": "220.00",
    "rollingReserve": "0.00",
    "valueBalance": "4619134.16",
    "_links": {
        "self": {
            "href": "https://api.preprod.slimpay.com/bank-accounts/1724b704-a503-11e6-97cb-000000000001/balance"
        },
        "profile": {
            "href": "https://api.preprod.slimpay.com/alps/v1/balances"
        }
    }
}

4. search-balances (relation)

Description: Search for balances using creditorReference or entityReference parameters. Balances will be returned in a collection in descending order.

Properties
creditorReference
The unique identifier of a SlimPay account, allocated by SlimPay. Constraints: Text, 35 characters or less, Read-Write.
entityReference
The entity reference of the creditor, allocated by SlimPay. Constraints: Text, 35 characters or less, Read-Only.
currency
The currency of the account balance. Constraints: Text, an ISO 4217 standard currency code, set to EUR, Read-Only.
lastCalculated
A flag to search for the last calculated balance history (by default set to false). Constraint: Boolean, Read-Write.
Example: Search balances
Request
GET follow(https://api.slimpay.net/alps#search-balances) HTTP/1.1
Accept: application/hal+json; profile="https://api.slimpay.net/alps/v1"
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJhcGkiXSwiZXhwIjoxNTMwNjMzNTk0LCJqdGkiOiI2ODNmNGE1Ni1kZjQ3LTQ0ZWYtYmIxYy02MDJhYmFlNGYwYjgiLCJjbGllbnRfaWQiOiJkZW1vY3JlZGl0b3IwMSJ9.VSmbmu4upmKj5_lTiBlqtbqSH42yx83AB1IFXJs08Tw
Response
HTTP/1.1 200 OK
Content-Type: application/hal+json; profile="https://api.slimpay.net/alps/v1";charset=UTF-8
Content-Length: 947

{
    "_embedded": {
        "balances": [
            {
                "_links": {
                    "self": {
                        "href": "https://api.preprod.slimpay.com/bank-accounts/1724b704-a503-11e6-97cb-000000000001/balance"
                    },
                    "profile": {
                        "href": "https://api.preprod.slimpay.com/alps/v1/balances"
                    }
                },
                "valueBalance": "4619134.16",
                "bookBalance": "3422926.16",
                "rollingReserve": "0.00",
                "ongoingPayoutsTotalAmount": "220.00",
                "ongoingFeesTotalAmount": "316024.42",
                "currency": "EUR"
            }
        ]
    },
    "page": {
        "size": 3,
        "totalElements": 1,
        "totalPages": 1,
        "number": 0
    },
    "_links": {
        "self": {
            "href": "https://api.preprod.slimpay.com/balances?creditorReference=democreditor&size=3"
        },
        "search": {
            "href": "https://api.preprod.slimpay.com/balances{?creditorReference,entityReference,currency,page,size}",
            "templated": true
        }
    }
}