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 balance contains information about the funds currently available in the creditor's account.

Properties
valueBalance
The amount on value date. Constraints: Number, 22 characters or less, Read-Only.
bookBalance
The amount 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.
currency
The currency. Constraints: Text among EUR|GBP, Read-Only.

2. balances-representation

Description: A collection of balances.

3. get-balance (relation)

Description: Get a single balance. The parameter entityReference should be given if creditor is configured with branches. Otherwise, it should not be given.

Properties
entityReference
The entity reference within the SlimPay referential. It is is given by SlimPay. Constraints: Text, 35 characters or less, Read-Only.
Example: Get one balance
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.eyJzY29wZSI6WyJhcGkiXSwiZXhwIjoxNDg4NDc0NzI1LCJqdGkiOiI3OThhNGEyYy1hOGE4LTQwNmItOGY0YS1mMjE3ZmNhMTM5YjciLCJjbGllbnRfaWQiOiJkZW1vY3JlZGl0b3IwMSJ9.VoN5FoWOoPfLkJU15ZIcYp2iRam4WJoVfMBw_35XCkw
Response
HTTP/1.1 200 OK
Content-Type: application/hal+json; profile="https://api.slimpay.net/alps/v1";charset=UTF-8
Content-Length: 432

{
    "bookBalance": "9078.04",
    "currency": "EUR",
    "ongoingFeesTotalAmount": "36.09",
    "ongoingPayoutsTotalAmount": "325.00",
    "rollingReserve": "0.00",
    "valueBalance": "9078.04",
    "_links": {
        "self": {
            "href": "https://api-sandbox.slimpay.net/bank-accounts/1724b704-a503-11e6-97cb-000000000001/balance"
        },
        "profile": {
            "href": "https://api-sandbox.slimpay.net/alps/v1/balances"
        }
    }
}

4. search-balances (relation)

Description: Search balances. Either creditorReference or entityReference should be given. They will be in DESCENDING order.

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.
currency
The currency. Constraints: Text among EUR|GBP, Read-Only.
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.eyJzY29wZSI6WyJhcGkiXSwiZXhwIjoxNDg4NDc0NzI1LCJqdGkiOiI3OThhNGEyYy1hOGE4LTQwNmItOGY0YS1mMjE3ZmNhMTM5YjciLCJjbGllbnRfaWQiOiJkZW1vY3JlZGl0b3IwMSJ9.VoN5FoWOoPfLkJU15ZIcYp2iRam4WJoVfMBw_35XCkw
Response
HTTP/1.1 200 OK
Content-Type: application/hal+json; profile="https://api.slimpay.net/alps/v1";charset=UTF-8
Content-Length: 937

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