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-card-transactions

  1. recurrent-card-transaction-representation
  2. recurrent-card-transactions-representation
  3. cancel-recurrent-card-transaction
  4. create-recurrent-card-transactions
  5. get-recurrent-card-transaction
  6. get-recurrent-card-transactions
  7. search-recurrent-card-transactions

1. recurrent-card-transaction-representation

Description: A recurrent card transaction representation. A recurrent card transaction is a payment plan to schedule the execution of card transactions at regular intervals of time.

Properties
id
The recurrent card transaction id. Constraints: 36 characters or less, Read-Only.
reference
The recurrent card transaction reference. Constraints: 35 characters or less, Read-Write.
amount
The amount of card transactions that will be created. Constraints: Number, 22 characters or less, Read-Write.
currency
The currency. Constraints: Text among EUR|GBP, Read-Write.
label
Value provided by the user to specify a label for created card transaction. Constraints: 35 characters or less, Read-Write.
frequency
The frequency of card transaction creation. Constraints: Text among daily|weekly|monthly|bimonthly|trimonthly|semiyearly|yearly|biyearly, Read-Write.
maxTxNumber
The maximum number of card transactions that should be created with this recurrent card transaction. Constraints: Integer, Read-Write.
generatedTxNumber
The current of card transactions that this recurrent card transaction has created. Constraints: Integer, Read-Only.
activated
Flag indicating if the card transaction is activated. Constraints: Boolean, Read-Write.
dateFrom
The date of the first card transaction creation. Constraints: DateTime, ISO8601, Read-Write.
dateNext
The date of the next card transaction creation. Constraints: DateTime, ISO8601, Read-Only.
dateDisabled
The date when this recurrent card transaction has been disabled. Constraints: DateTime, ISO8601, Read-Only.

2. recurrent-card-transactions-representation

Description: A collection of recurrent card transactions.

3. cancel-recurrent-card-transaction (relation)

Description: Cancel a recurrent card transaction of which the activated property is 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-card-transactions (relation)

Description: Create a recurrent card transaction.

Properties
reference
The recurrent card transaction reference. Constraints: 35 characters or less, Read-Write.
amount
The amount of card transactions that will be created. Constraints: Number, 22 characters or less, Read-Write.
label
Value provided by the user to specify a label for created card transaction. Constraints: 35 characters or less, Read-Write.
frequency
The frequency of card transaction creation. Constraints: Text among daily|weekly|monthly|bimonthly|trimonthly|semiyearly|yearly|biyearly, Read-Write.
maxTxNumber
The maximum number of card transactions that should be created with this recurrent card transaction. Constraints: Integer, Read-Write.
activated
Flag indicating if the card transaction is activated. Constraints: Boolean, Read-Write.
dateFrom
The date of the first card transaction creation. Constraints: DateTime, ISO8601, Read-Write.
creditor » reference
The creditor reference within the SlimPay referential. This reference is given by SlimPay. Constraints: Text, 35 characters or less, Read-Write.
creditor » entity » reference
The entity reference within the SlimPay referential. It is is given by SlimPay. Constraints: Text, 35 characters or less, Read-Only.
cardAlias » reference
The card alias reference. Constraints: Text, 250 characters or less, Read-Write.
subscriber » reference
The subscriber reference, also known as client reference. Constraints: Text, 35 characters or less, Read-Write.
Example: Create one recurrent direct -debit
Request
POST follow(https://api.slimpay.net/alps#create-recurrent-card-transactions) 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": "RCT-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: 1025

{
    "activated": true,
    "amount": "100.00",
    "currency": "EUR",
    "dateFrom": "2018-07-03T15:44:20.426+0000",
    "frequency": "monthly",
    "id": "f3949710-7ed7-11e8-bf72-000000000000",
    "label": "Your merchant.com subscription",
    "reference": "RCT-01",
    "_links": {
        "self": {
            "href": "https://api.preprod.slimpay.com/recurrent-card-transactions/f3949710-7ed7-11e8-bf72-000000000000"
        },
        "profile": {
            "href": "https://api.preprod.slimpay.com/alps/v1/recurrent-card-transactions"
        },
        "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-card-transaction": {
            "href": "https://api.preprod.slimpay.com/recurrent-card-transactions/f3949710-7ed7-11e8-bf72-000000000000/cancellation"
        }
    }
}

5. get-recurrent-card-transaction (relation)

Description: Get one recurrent card transaction.

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-card-transactions (relation)

Description: Get one recurrent card transaction.

Properties
id
The recurrent card transaction id. Constraints: 36 characters or less, Read-Only.

7. search-recurrent-card-transactions (relation)

Description: Search recurrent card transactions. 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.
subscriberReference
The subscriber reference, also known as client reference. Constraints: Text, 35 characters or less, Read-Write.
reference
The recurrent card transaction reference. Constraints: 35 characters or less, Read-Write.
activated
Flag indicating if the card transaction is activated. Constraints: Boolean, Read-Write.
currency
The currency. Constraints: Text among EUR|GBP, Read-Write.
dateFromBefore
Search recurrent card transactions that have a dateFrom before this date. Constraints: DateTime, ISO8601, Optional.
dateFromAfter
Search recurrent card transactions that have a dateFrom after this date. Constraints: DateTime, ISO8601, Optional.
frequency
A comma separated list of frequency.
Example: Search recurrent direct debit
Request
GET follow(https://api.slimpay.net/alps#search-recurrent-card-transactions) 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: 3917

{
    "_embedded": {
        "recurrentCardTransactions": [
            {
                "_links": {
                    "self": {
                        "href": "https://api.preprod.slimpay.com/recurrent-card-transactions/f3949710-7ed7-11e8-bf72-000000000000"
                    },
                    "profile": {
                        "href": "https://api.preprod.slimpay.com/alps/v1/recurrent-card-transactions"
                    },
                    "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"
                    }
                },
                "id": "f3949710-7ed7-11e8-bf72-000000000000",
                "reference": "RCT-01",
                "amount": "100.00",
                "currency": "EUR",
                "frequency": "monthly",
                "label": "Your merchant.com subscription",
                "activated": false,
                "dateFrom": "2018-07-03T15:44:20.000+0000",
                "dateDisabled": "2018-07-03T15:44:21.000+0000"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.preprod.slimpay.com/recurrent-card-transactions/e6cb6a37-7ed3-11e8-bf72-000000000000"
                    },
                    "profile": {
                        "href": "https://api.preprod.slimpay.com/alps/v1/recurrent-card-transactions"
                    },
                    "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"
                    }
                },
                "id": "e6cb6a37-7ed3-11e8-bf72-000000000000",
                "reference": "RCT-01",
                "amount": "100.00",
                "currency": "EUR",
                "frequency": "monthly",
                "label": "Your merchant.com subscription",
                "activated": false,
                "dateFrom": "2018-07-03T15:15:21.000+0000",
                "dateDisabled": "2018-07-03T15:15:21.000+0000"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.preprod.slimpay.com/recurrent-card-transactions/24a9550b-7ece-11e8-bf72-000000000000"
                    },
                    "profile": {
                        "href": "https://api.preprod.slimpay.com/alps/v1/recurrent-card-transactions"
                    },
                    "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"
                    }
                },
                "id": "24a9550b-7ece-11e8-bf72-000000000000",
                "reference": "RCT-01",
                "amount": "100.00",
                "currency": "EUR",
                "frequency": "monthly",
                "label": "Your merchant.com subscription",
                "activated": false,
                "dateFrom": "2018-07-03T14:34:08.000+0000",
                "dateDisabled": "2018-07-03T14:34:08.000+0000"
            }
        ]
    },
    "page": {
        "size": 3,
        "totalElements": 41,
        "totalPages": 14,
        "number": 0
    },
    "_links": {
        "first": {
            "href": "https://api.preprod.slimpay.com/recurrent-card-transactions?creditorReference=democreditor&page=0&size=3"
        },
        "self": {
            "href": "https://api.preprod.slimpay.com/recurrent-card-transactions?creditorReference=democreditor&size=3"
        },
        "next": {
            "href": "https://api.preprod.slimpay.com/recurrent-card-transactions?creditorReference=democreditor&page=1&size=3"
        },
        "last": {
            "href": "https://api.preprod.slimpay.com/recurrent-card-transactions?creditorReference=democreditor&page=13&size=3"
        },
        "search": {
            "href": "https://api.preprod.slimpay.com/recurrent-card-transactions{?creditorReference,entityReference,subscriberReference,reference,currency,activated,frequency,dateFromBefore,dateFromAfter,page,size}",
            "templated": true
        }
    }
}