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.

recurrent-direct-debits

  1. recurrent-direct-debit-representation
  2. recurrent-direct-debits-representation
  3. cancel-recurrent-direct-debit
  4. create-recurrent-direct-debits
  5. get-recurrent-direct-debit
  6. get-recurrent-direct-debits
  7. patch-recurrent-direct-debit
  8. search-recurrent-direct-debits

1. recurrent-direct-debit-representation

Description: A representation of a recurrent direct debit resource. A recurrent direct debit is a payment plan where direct debits are withdrawn from a debtor’s bank account at regular intervals of time (after authorisation by a signed mandate).

Properties
id
The recurrent direct debit id. Constraints: 36 characters or less, Read-Only.
reference
The recurrent direct debit reference. Constraints: 35 characters or less, Read-Write.
amount
The amount of each recurrent direct debit that will be created. Constraints: Number, 22 characters or less, Read-Write.
currency
The currency of the transaction. Constraints: Text, an ISO 4217 standard currency code, set to EUR, Read-Write.
label
Information provided by the user to specify a label for the created direct debits. Constraints: 140 characters or less, Read-Write.
frequency
The frequency of the direct debit transactions. Constraints: Text, set to daily, weekly, monthly, bimonthly, trimonthly, semiyearly, yearly or biyearly, Read-Write.
maxSddNumber
The maximum number of direct debits that should be created with this payment plan. If not provided, the payment plan will have no limit until cancelled. Constraints: Integer, Read-Write.
sddNumber
The current number of direct debits that this payment plan has created. Constraints: Integer, Read-Only.
activated
Flag indicating if the recurrent direct debit plan is activated. Constraints: Boolean, Read-Write.
dateCreated
The date the resource was created. Constraints: DateTime, formatted to ISO 8601 standard, Read-Only.
dateFrom
The date of the first direct debit creation. Constraints: DateTime, formatted to ISO 8601 standard, Read-Write.
dateNext
The date of the next direct debit creation. Constraints: DateTime, formatted to ISO 8601 standard, Read-Only.
dateDisabled
The date when this recurrent direct debit plan was disabled. Constraints: DateTime, formatted to ISO 8601 standard, Read-Only.

2. recurrent-direct-debits-representation

Description: A collection of recurrent direct debit representations.

3. cancel-recurrent-direct-debit (relation)

Description: Cancel a recurrent direct debit plan, whose activated property is set to true.

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!

4. create-recurrent-direct-debits (relation)

Description: Create a recurrent direct debit.

Properties
reference
The recurrent direct debit reference. Constraints: 35 characters or less, Read-Write.
amount
The amount of each recurrent direct debit that will be created. Constraints: Number, 22 characters or less, Read-Write.
currency
The currency of the transaction. Constraints: Text, an ISO 4217 standard currency code, set to EUR, Read-Write.
label
Information provided by the user to specify a label for the created direct debits. Constraints: 140 characters or less, Read-Write.
frequency
The frequency of the direct debit transactions. Constraints: Text, set to daily, weekly, monthly, bimonthly, trimonthly, semiyearly, yearly or biyearly, Read-Write.
maxSddNumber
The maximum number of direct debits that should be created with this payment plan. If not provided, the payment plan will have no limit until cancelled. Constraints: Integer, Read-Write.
activated
Flag indicating if the recurrent direct debit plan is activated. Constraints: Boolean, Read-Write.
dateFrom
The date of the first direct debit creation. Constraints: DateTime, formatted to ISO 8601 standard, Read-Write.
creditor » reference
The unique identifier of a SlimPay account, allocated by SlimPay. Constraints: Text, 35 characters or less, Read-Write.
creditor » entity » reference
The entity reference of the creditor, allocated by SlimPay. Constraints: Text, 35 characters or less, Read-Only.
subscriber » reference
The subscriber reference, also known as client reference. Constraints: Text, 35 characters or less, Read-Write.
Example: Create a recurrent direct debit
Request
POST follow(https://api.slimpay.net/alps#create-recurrent-direct-debits) HTTP/1.1
Accept: application/hal+json; profile="https://api.slimpay.net/alps/v1"
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJhcGkiXSwiZXhwIjoxNTMwNjMzNTk0LCJqdGkiOiI2ODNmNGE1Ni1kZjQ3LTQ0ZWYtYmIxYy02MDJhYmFlNGYwYjgiLCJjbGllbnRfaWQiOiJkZW1vY3JlZGl0b3IwMSJ9.VSmbmu4upmKj5_lTiBlqtbqSH42yx83AB1IFXJs08Tw

{
    "creditor": {
        "reference": "democreditor"
    },
    "subscriber": {
        "reference": "subscriber01"
    },
    "amount": 100,
    "label": "Your merchant.com subscription",
    "reference": "RDD-01",
    "frequency": "monthly",
    "maxSddNumber": 12,
    "activated": true
}
Response
HTTP/1.1 201 Created
Content-Type: application/hal+json; profile="https://api.slimpay.net/alps/v1";charset=UTF-8
Content-Length: 1267

{
    "activated": true,
    "amount": "100.00",
    "currency": "EUR",
    "dateCreated": "2018-07-03T15:43:15.451+0000",
    "dateFrom": "2018-07-03T15:43:15.342+0000",
    "frequency": "monthly",
    "id": "ccc8a5a4-7ed7-11e8-bf72-000000000000",
    "label": "Your merchant.com subscription",
    "maxSddNumber": 12,
    "reference": "RDD-01",
    "_links": {
        "self": {
            "href": "https://api.preprod.slimpay.com/recurrent-direct-debits/ccc8a5a4-7ed7-11e8-bf72-000000000000"
        },
        "profile": {
            "href": "https://api.preprod.slimpay.com/alps/v1/recurrent-direct-debits"
        },
        "https://api.slimpay.net/alps#get-creditor": {
            "href": "https://api.preprod.slimpay.com/creditors/democreditor"
        },
        "https://api.slimpay.net/alps#get-subscriber": {
            "href": "https://api.preprod.slimpay.com/creditors/democreditor/subscribers/subscriber01"
        },
        "https://api.slimpay.net/alps#cancel-recurrent-direct-debit": {
            "href": "https://api.preprod.slimpay.com/recurrent-direct-debits/ccc8a5a4-7ed7-11e8-bf72-000000000000/cancellation"
        },
        "https://api.slimpay.net/alps#patch-recurrent-direct-debit": {
            "href": "https://api.preprod.slimpay.com/recurrent-direct-debits/ccc8a5a4-7ed7-11e8-bf72-000000000000"
        }
    }
}

5. get-recurrent-direct-debit (relation)

Description: Retrieve the representation of a recurrent direct debit resource.

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!

6. get-recurrent-direct-debits (relation)

Description: Retrieve the representation of a specific recurrent direct debit resource, using its id parameter.

Properties
id
The recurrent direct debit id. Constraints: 36 characters or less, Read-Only.

7. patch-recurrent-direct-debit (relation)

Description: Patch the amount or label of a recurrent direct debit plan, whose activated property is set to true.

Properties
amount
The amount of each recurrent direct debit that will be created. Constraints: Number, 22 characters or less, Read-Write.
label
Information provided by the user to specify a label for the created direct debits. Constraints: 140 characters or less, Read-Write.

8. search-recurrent-direct-debits (relation)

Description: Search recurrent direct debits. Representations will be returned in a collection of resources, 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.
subscriberReference
The subscriber reference, also known as client reference. Constraints: Text, 35 characters or less, Read-Write.
reference
The recurrent direct debit reference. Constraints: 35 characters or less, Read-Write.
activated
Flag indicating if the recurrent direct debit plan is activated. Constraints: Boolean, Read-Write.
currency
The currency of the transaction. Constraints: Text, an ISO 4217 standard currency code, set to EUR, Read-Write.
dateFromBefore
Search recurrent direct debits that have a dateFrom before this date. Constraints: DateTime, formatted to ISO 8601 standard (optional).
dateFromAfter
Search recurrent direct debits that have a dateFrom after this date. Constraints: DateTime, formatted to ISO 8601 standard (optional).
frequency
The frequency of the direct debit transactions. Constraints: Text, set to daily, weekly, monthly, bimonthly, trimonthly, semiyearly, yearly or biyearly, Read-Write.
Example: Search recurrent direct debit
Request
GET follow(https://api.slimpay.net/alps#search-recurrent-direct-debits) 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: 3176

{
    "_embedded": {
        "recurrentDirectDebits": [
            {
                "_links": {
                    "self": {
                        "href": "https://api.preprod.slimpay.com/recurrent-direct-debits/ccc8a5a4-7ed7-11e8-bf72-000000000000"
                    },
                    "profile": {
                        "href": "https://api.preprod.slimpay.com/alps/v1/recurrent-direct-debits"
                    }
                },
                "id": "ccc8a5a4-7ed7-11e8-bf72-000000000000",
                "amount": "101.00",
                "currency": "EUR",
                "frequency": "monthly",
                "reference": "RDD-01",
                "label": "You new merchant subscription",
                "maxSddNumber": 12,
                "activated": false,
                "dateCreated": "2018-07-03T15:43:15.000+0000",
                "dateDisabled": "2018-07-03T15:43:16.000+0000",
                "dateFrom": "2018-07-03T15:43:15.000+0000"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.preprod.slimpay.com/recurrent-direct-debits/0f562362-7ed4-11e8-bf72-000000000000"
                    },
                    "profile": {
                        "href": "https://api.preprod.slimpay.com/alps/v1/recurrent-direct-debits"
                    }
                },
                "id": "0f562362-7ed4-11e8-bf72-000000000000",
                "amount": "101.00",
                "currency": "EUR",
                "frequency": "monthly",
                "reference": "RDD-01",
                "label": "You new merchant subscription",
                "maxSddNumber": 12,
                "activated": false,
                "dateCreated": "2018-07-03T15:16:29.000+0000",
                "dateDisabled": "2018-07-03T15:16:29.000+0000",
                "dateFrom": "2018-07-03T15:16:29.000+0000"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.preprod.slimpay.com/recurrent-direct-debits/bf4cf1ab-7ed3-11e8-bf72-000000000000"
                    },
                    "profile": {
                        "href": "https://api.preprod.slimpay.com/alps/v1/recurrent-direct-debits"
                    }
                },
                "id": "bf4cf1ab-7ed3-11e8-bf72-000000000000",
                "amount": "101.00",
                "currency": "EUR",
                "frequency": "monthly",
                "reference": "RDD-01",
                "label": "You new merchant subscription",
                "maxSddNumber": 12,
                "activated": false,
                "dateCreated": "2018-07-03T15:14:15.000+0000",
                "dateDisabled": "2018-07-03T15:14:15.000+0000",
                "dateFrom": "2018-07-03T15:14:15.000+0000"
            }
        ]
    },
    "page": {
        "size": 3,
        "totalElements": 3593,
        "totalPages": 1198,
        "number": 0
    },
    "_links": {
        "first": {
            "href": "https://api.preprod.slimpay.com/recurrent-direct-debits?creditorReference=democreditor&page=0&size=3"
        },
        "self": {
            "href": "https://api.preprod.slimpay.com/recurrent-direct-debits?creditorReference=democreditor&size=3"
        },
        "next": {
            "href": "https://api.preprod.slimpay.com/recurrent-direct-debits?creditorReference=democreditor&page=1&size=3"
        },
        "last": {
            "href": "https://api.preprod.slimpay.com/recurrent-direct-debits?creditorReference=democreditor&page=1197&size=3"
        },
        "search": {
            "href": "https://api.preprod.slimpay.com/recurrent-direct-debits{?creditorReference,entityReference,subscriberReference,reference,currency,activated,frequency,dateFromBefore,dateFromAfter,page,size}",
            "templated": true
        }
    }
}