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 representation of a recurrent card transaction resource. A recurrent card transaction is a payment plan where card transactions are scheduled to take place 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 each recurrent card transaction that will be created. Constraints: Number, 22 characters or less, Read-Write.
currency
The currency of the transactions. 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 card transactions. Constraints: 140 characters or less, Read-Write.
frequency
The frequency of the recurrent card transactions. Constraints: Text, set to daily, weekly, monthly, bimonthly, trimonthly, semiyearly, yearly or biyearly, Read-Write.
maxTxNumber
The maximum number of recurrent card transactions that should be created with this payment plan. If not provided, the payment plan will have no limit until cancelled. Constraints: Integer, Read-Write.
generatedTxNumber
The current number of card transactions that this payment plan has created. Constraints: Integer, Read-Only.
activated
Flag indicating if the recurrent card transaction plan is activated. Constraints: Boolean, Read-Write.
dateFrom
The date of the first card transaction creation. Constraints: DateTime, formatted to ISO 8601 standard, Read-Write.
dateNext
The date of the next card transaction creation. Constraints: DateTime, formatted to ISO 8601 standard, Read-Only.
dateDisabled
The date when this recurrent card transaction plan was disabled. Constraints: DateTime, formatted to ISO 8601 standard, Read-Only.

2. recurrent-card-transactions-representation

Description: A collection of recurrent card transaction representations.

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

Description: Cancel a recurrent card transaction 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-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 each recurrent card transaction 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 card transactions. Constraints: 140 characters or less, Read-Write.
frequency
The frequency of the recurrent card transactions. Constraints: Text, set to daily, weekly, monthly, bimonthly, trimonthly, semiyearly, yearly or biyearly, Read-Write.
maxTxNumber
The maximum number of recurrent card transactions 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 card transaction plan is activated. Constraints: Boolean, Read-Write.
dateFrom
The date of the first card transaction 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.
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 a recurrent card transaction
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: Retrieve the representation of a recurrent card transaction 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-card-transactions (relation)

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

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. 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 card transaction reference. Constraints: 35 characters or less, Read-Write.
activated
Flag indicating if the recurrent card transaction plan is activated. Constraints: Boolean, Read-Write.
currency
The currency of the transactions. Constraints: Text, an ISO 4217 standard currency code, set to EUR, Read-Write.
dateFromBefore
Search recurrent card transactions that have a dateFrom before this date. Constraints: DateTime, formatted to ISO 8601 standard (optional).
dateFromAfter
Search recurrent card transactions that have a dateFrom after this date. Constraints: DateTime, formatted to ISO 8601 standard, (optional).
frequency
The frequency of the recurrent card transactions. Constraints: Text, set to daily, weekly, monthly, bimonthly, trimonthly, semiyearly, yearly or biyearly, Read-Write.
Example: Search recurrent card transactions
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
        }
    }
}