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.

subscribers

  1. subscriber-representation
  2. subscribers-representation
  3. get-subscriber
  4. search-subscribers

1. subscriber-representation

Description: A subscriber representation. A subscriber is a consumer of a merchant and has a contract with him. A subscriber is identified by the merchant by its reference.

Properties
reference
The subscriber reference, also known as client reference. Constraints: Text, 35 characters or less, Read-Write.

2. subscribers-representation

Description: A collection of subscribers.

3. get-subscriber (relation)

Description: Get one subscriber.

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!

Example: Get one subscriber
Request
GET follow(https://api.slimpay.net/alps#get-subscriber) 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: 550

{
    "reference": "subscriber01",
    "_links": {
        "https://api.slimpay.net/alps#get-mandate": {
            "href": "https://api-sandbox.slimpay.net/mandates/4615706e-ff2d-11e6-b663-000000000000"
        },
        "https://api.slimpay.net/alps#get-creditor": {
            "href": "https://api-sandbox.slimpay.net/creditors/democreditor"
        },
        "self": {
            "href": "https://api-sandbox.slimpay.net/creditors/democreditor/subscribers/subscriber01"
        },
        "profile": {
            "href": "https://api-sandbox.slimpay.net/alps/v1/subscribers"
        }
    }
}

4. search-subscribers (relation)

Description: Search subscribers. 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.
reference
The subscriber reference, also known as client reference. Constraints: Text, 35 characters or less, Read-Write.
Example: Search subscribers
Request
GET follow(https://api.slimpay.net/alps#search-subscribers) 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: 6761

{
    "_embedded": {
        "subscribers": [
            {
                "_links": {
                    "https://api.slimpay.net/alps#get-mandate": {
                        "href": "https://api-sandbox.slimpay.net/mandates/b512b06f-ff56-11e6-b663-000000000000"
                    },
                    "https://api.slimpay.net/alps#get-creditor": {
                        "href": "https://api-sandbox.slimpay.net/creditors/democreditor"
                    },
                    "self": {
                        "href": "https://api-sandbox.slimpay.net/creditors/democreditor/subscribers/MonClient001svuzgdf"
                    },
                    "profile": {
                        "href": "https://api-sandbox.slimpay.net/alps/v1/subscribers"
                    }
                },
                "reference": "MonClient001svuzgdf"
            },
            {
                "_links": {
                    "https://api.slimpay.net/alps#get-mandate": {
                        "href": "https://api-sandbox.slimpay.net/mandates/4615706e-ff2d-11e6-b663-000000000000"
                    },
                    "https://api.slimpay.net/alps#get-creditor": {
                        "href": "https://api-sandbox.slimpay.net/creditors/democreditor"
                    },
                    "self": {
                        "href": "https://api-sandbox.slimpay.net/creditors/democreditor/subscribers/73"
                    },
                    "profile": {
                        "href": "https://api-sandbox.slimpay.net/alps/v1/subscribers"
                    }
                },
                "reference": "73"
            },
            {
                "_links": {
                    "https://api.slimpay.net/alps#get-mandate": {
                        "href": "https://api-sandbox.slimpay.net/mandates/4615706e-ff2d-11e6-b663-000000000000"
                    },
                    "https://api.slimpay.net/alps#get-creditor": {
                        "href": "https://api-sandbox.slimpay.net/creditors/democreditor"
                    },
                    "self": {
                        "href": "https://api-sandbox.slimpay.net/creditors/democreditor/subscribers/hbotsk30e4enbkuv"
                    },
                    "profile": {
                        "href": "https://api-sandbox.slimpay.net/alps/v1/subscribers"
                    }
                },
                "reference": "hbotsk30e4enbkuv"
            },
            {
                "_links": {
                    "https://api.slimpay.net/alps#get-mandate": {
                        "href": "https://api-sandbox.slimpay.net/mandates/4615706e-ff2d-11e6-b663-000000000000"
                    },
                    "https://api.slimpay.net/alps#get-creditor": {
                        "href": "https://api-sandbox.slimpay.net/creditors/democreditor"
                    },
                    "self": {
                        "href": "https://api-sandbox.slimpay.net/creditors/democreditor/subscribers/78"
                    },
                    "profile": {
                        "href": "https://api-sandbox.slimpay.net/alps/v1/subscribers"
                    }
                },
                "reference": "78"
            },
            {
                "_links": {
                    "https://api.slimpay.net/alps#get-mandate": {
                        "href": "https://api-sandbox.slimpay.net/mandates/4615706e-ff2d-11e6-b663-000000000000"
                    },
                    "https://api.slimpay.net/alps#get-creditor": {
                        "href": "https://api-sandbox.slimpay.net/creditors/democreditor"
                    },
                    "self": {
                        "href": "https://api-sandbox.slimpay.net/creditors/democreditor/subscribers/76"
                    },
                    "profile": {
                        "href": "https://api-sandbox.slimpay.net/alps/v1/subscribers"
                    }
                },
                "reference": "76"
            },
            {
                "_links": {
                    "https://api.slimpay.net/alps#get-mandate": {
                        "href": "https://api-sandbox.slimpay.net/mandates/fda976a2-fcf4-11e6-84e7-000000000000"
                    },
                    "https://api.slimpay.net/alps#get-creditor": {
                        "href": "https://api-sandbox.slimpay.net/creditors/democreditor"
                    },
                    "self": {
                        "href": "https://api-sandbox.slimpay.net/creditors/democreditor/subscribers/subscriber0000"
                    },
                    "profile": {
                        "href": "https://api-sandbox.slimpay.net/alps/v1/subscribers"
                    }
                },
                "reference": "subscriber0000"
            },
            {
                "_links": {
                    "https://api.slimpay.net/alps#get-mandate": {
                        "href": "https://api-sandbox.slimpay.net/mandates/4615706e-ff2d-11e6-b663-000000000000"
                    },
                    "https://api.slimpay.net/alps#get-creditor": {
                        "href": "https://api-sandbox.slimpay.net/creditors/democreditor"
                    },
                    "self": {
                        "href": "https://api-sandbox.slimpay.net/creditors/democreditor/subscribers/72"
                    },
                    "profile": {
                        "href": "https://api-sandbox.slimpay.net/alps/v1/subscribers"
                    }
                },
                "reference": "72"
            },
            {
                "_links": {
                    "https://api.slimpay.net/alps#get-mandate": {
                        "href": "https://api-sandbox.slimpay.net/mandates/4615706e-ff2d-11e6-b663-000000000000"
                    },
                    "https://api.slimpay.net/alps#get-creditor": {
                        "href": "https://api-sandbox.slimpay.net/creditors/democreditor"
                    },
                    "self": {
                        "href": "https://api-sandbox.slimpay.net/creditors/democreditor/subscribers/71"
                    },
                    "profile": {
                        "href": "https://api-sandbox.slimpay.net/alps/v1/subscribers"
                    }
                },
                "reference": "71"
            },
            {
                "_links": {
                    "https://api.slimpay.net/alps#get-mandate": {
                        "href": "https://api-sandbox.slimpay.net/mandates/4615706e-ff2d-11e6-b663-000000000000"
                    },
                    "https://api.slimpay.net/alps#get-creditor": {
                        "href": "https://api-sandbox.slimpay.net/creditors/democreditor"
                    },
                    "self": {
                        "href": "https://api-sandbox.slimpay.net/creditors/democreditor/subscribers/70"
                    },
                    "profile": {
                        "href": "https://api-sandbox.slimpay.net/alps/v1/subscribers"
                    }
                },
                "reference": "70"
            },
            {
                "_links": {
                    "https://api.slimpay.net/alps#get-mandate": {
                        "href": "https://api-sandbox.slimpay.net/mandates/4615706e-ff2d-11e6-b663-000000000000"
                    },
                    "https://api.slimpay.net/alps#get-creditor": {
                        "href": "https://api-sandbox.slimpay.net/creditors/democreditor"
                    },
                    "self": {
                        "href": "https://api-sandbox.slimpay.net/creditors/democreditor/subscribers/69"
                    },
                    "profile": {
                        "href": "https://api-sandbox.slimpay.net/alps/v1/subscribers"
                    }
                },
                "reference": "69"
            }
        ]
    },
    "page": {
        "totalPages": 21,
        "totalElements": 204,
        "size": 10,
        "number": 0
    },
    "_links": {
        "last": {
            "href": "https://api-sandbox.slimpay.net/subscribers?page=20&size=10"
        },
        "search": {
            "href": "https://api-sandbox.slimpay.net/subscribers{?creditorReference,entityReference,reference,page,size}",
            "templated": true
        },
        "self": {
            "href": "https://api-sandbox.slimpay.net/subscribers"
        },
        "next": {
            "href": "https://api-sandbox.slimpay.net/subscribers?page=1&size=10"
        },
        "first": {
            "href": "https://api-sandbox.slimpay.net/subscribers?page=0&size=10"
        }
    }
}