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 representation of a subscriber resource. A subscriber is a consumer, a merchant’s customer who has a contract with them for one off or recurring payments. A subscriber is identified by the merchant using a unique reference.

Properties
reference
The subscriber reference, also known as client reference. Constraints: Text, 35 characters or less, Read-Write.
givenName
The given name of the customer. Also known as firstName. Constraints: Text, 32 characters or less, Read-Write (optional).
familyName
The family name of the customer. Also known as lastName. Constraints: Text, 70 characters or less, Read-Write (optional).
email
The email address of the customer. Constraints: Text, 70 characters or less, Read-Write (optional).
telephone
The telephone number of the customer. Constraints: Text, 16 characters or less, must start with a +, Read-Write (optional).
shippingAddress » street1
The first line of the street address. Optional, but if set, then city, postalCode and country must also be provided. Constraints: Text, 70 characters or less, Read-Write.
shippingAddress » city
The city of the address. Optional, but if set, then street1, postalCode and country must also be provided. Constraints: Text, 35 characters or less, Read-Write.
shippingAddress » postalCode
The postal code of the address. Optional, but if set, then street1, city and country must also be provided. Constraints: Text, 15 characters or less, Read-Write.
shippingAddress » country
The country of the address. Optional, but if set, then street1, city and postalCode must also be provided. Constraints: Text, an ISO-3166-1 standard alpha-2 country code (e.g. FR for France), Read-Write.
billingAddress » street1
The first line of the street address. Optional, but if set, then city, postalCode and country must also be provided. Constraints: Text, 70 characters or less, Read-Write.
billingAddress » city
The city of the address. Optional, but if set, then street1, postalCode and country must also be provided. Constraints: Text, 35 characters or less, Read-Write.
billingAddress » postalCode
The postal code of the address. Optional, but if set, then street1, city and country must also be provided. Constraints: Text, 15 characters or less, Read-Write.
billingAddress » country
The country of the address. Optional, but if set, then street1, city and postalCode must also be provided. Constraints: Text, an ISO-3166-1 standard alpha-2 country code (e.g. FR for France), Read-Write.

2. subscribers-representation

Description: A collection of subscriber representations.

3. get-subscriber (relation)

Description: Retrieve the representation of one subscriber 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!

Example: Retrieve a subscriber representation
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.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: 550

{
    "reference": "subscriber01",
    "_links": {
        "self": {
            "href": "https://api.preprod.slimpay.com/creditors/democreditor/subscribers/subscriber01"
        },
        "profile": {
            "href": "https://api.preprod.slimpay.com/alps/v1/subscribers"
        },
        "https://api.slimpay.net/alps#get-creditor": {
            "href": "https://api.preprod.slimpay.com/creditors/democreditor"
        },
        "https://api.slimpay.net/alps#get-mandate": {
            "href": "https://api.preprod.slimpay.com/mandates/753be6b5-7e0b-11e8-abe5-000000000000"
        }
    }
}

4. search-subscribers (relation)

Description: Search subscribers. 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.
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.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: 6724

{
    "_embedded": {
        "subscribers": [
            {
                "_links": {
                    "self": {
                        "href": "https://api.preprod.slimpay.com/creditors/democreditor/subscribers/subscriber5b3b94c9737ee"
                    },
                    "profile": {
                        "href": "https://api.preprod.slimpay.com/alps/v1/subscribers"
                    },
                    "https://api.slimpay.net/alps#get-creditor": {
                        "href": "https://api.preprod.slimpay.com/creditors/democreditor"
                    },
                    "https://api.slimpay.net/alps#get-mandate": {
                        "href": "https://api.preprod.slimpay.com/mandates/fe5770cc-7ed4-11e8-9238-000000000000"
                    }
                },
                "reference": "subscriber5b3b94c9737ee"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.preprod.slimpay.com/creditors/democreditor/subscribers/subscriber5b3b51840a15a"
                    },
                    "profile": {
                        "href": "https://api.preprod.slimpay.com/alps/v1/subscribers"
                    },
                    "https://api.slimpay.net/alps#get-creditor": {
                        "href": "https://api.preprod.slimpay.com/creditors/democreditor"
                    }
                },
                "reference": "subscriber5b3b51840a15a"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.preprod.slimpay.com/creditors/democreditor/subscribers/subscriber5b3b513402305"
                    },
                    "profile": {
                        "href": "https://api.preprod.slimpay.com/alps/v1/subscribers"
                    },
                    "https://api.slimpay.net/alps#get-creditor": {
                        "href": "https://api.preprod.slimpay.com/creditors/democreditor"
                    },
                    "https://api.slimpay.net/alps#get-mandate": {
                        "href": "https://api.preprod.slimpay.com/mandates/baefea82-7eac-11e8-abe5-000000000000"
                    }
                },
                "reference": "subscriber5b3b513402305"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.preprod.slimpay.com/creditors/democreditor/subscribers/subscriber5b3b4da39ff28"
                    },
                    "profile": {
                        "href": "https://api.preprod.slimpay.com/alps/v1/subscribers"
                    },
                    "https://api.slimpay.net/alps#get-creditor": {
                        "href": "https://api.preprod.slimpay.com/creditors/democreditor"
                    },
                    "https://api.slimpay.net/alps#get-mandate": {
                        "href": "https://api.preprod.slimpay.com/mandates/9199f25f-7eac-11e8-9238-000000000000"
                    }
                },
                "reference": "subscriber5b3b4da39ff28"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.preprod.slimpay.com/creditors/democreditor/subscribers/subscriber5b3b4b72ee66e"
                    },
                    "profile": {
                        "href": "https://api.preprod.slimpay.com/alps/v1/subscribers"
                    },
                    "https://api.slimpay.net/alps#get-creditor": {
                        "href": "https://api.preprod.slimpay.com/creditors/democreditor"
                    },
                    "https://api.slimpay.net/alps#get-mandate": {
                        "href": "https://api.preprod.slimpay.com/mandates/5ed38dab-7eab-11e8-9238-000000000000"
                    }
                },
                "reference": "subscriber5b3b4b72ee66e"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.preprod.slimpay.com/creditors/democreditor/subscribers/subscriber5b3b314e42967"
                    },
                    "profile": {
                        "href": "https://api.preprod.slimpay.com/alps/v1/subscribers"
                    },
                    "https://api.slimpay.net/alps#get-creditor": {
                        "href": "https://api.preprod.slimpay.com/creditors/democreditor"
                    },
                    "https://api.slimpay.net/alps#get-mandate": {
                        "href": "https://api.preprod.slimpay.com/mandates/bde6414c-7e99-11e8-9238-000000000000"
                    }
                },
                "reference": "subscriber5b3b314e42967"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.preprod.slimpay.com/creditors/democreditor/subscribers/subscriber5b3b2e0048bb1"
                    },
                    "profile": {
                        "href": "https://api.preprod.slimpay.com/alps/v1/subscribers"
                    },
                    "https://api.slimpay.net/alps#get-creditor": {
                        "href": "https://api.preprod.slimpay.com/creditors/democreditor"
                    }
                },
                "reference": "subscriber5b3b2e0048bb1"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.preprod.slimpay.com/creditors/democreditor/subscribers/subscriber5b3b2d2c4b505"
                    },
                    "profile": {
                        "href": "https://api.preprod.slimpay.com/alps/v1/subscribers"
                    },
                    "https://api.slimpay.net/alps#get-creditor": {
                        "href": "https://api.preprod.slimpay.com/creditors/democreditor"
                    }
                },
                "reference": "subscriber5b3b2d2c4b505"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.preprod.slimpay.com/creditors/democreditor/subscribers/subscriber5b3a41c3b0ddf"
                    },
                    "profile": {
                        "href": "https://api.preprod.slimpay.com/alps/v1/subscribers"
                    },
                    "https://api.slimpay.net/alps#get-creditor": {
                        "href": "https://api.preprod.slimpay.com/creditors/democreditor"
                    },
                    "https://api.slimpay.net/alps#get-mandate": {
                        "href": "https://api.preprod.slimpay.com/mandates/753be6b5-7e0b-11e8-abe5-000000000000"
                    }
                },
                "reference": "subscriber5b3a41c3b0ddf"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.preprod.slimpay.com/creditors/democreditor/subscribers/subscriber5b3a41a4e949c"
                    },
                    "profile": {
                        "href": "https://api.preprod.slimpay.com/alps/v1/subscribers"
                    },
                    "https://api.slimpay.net/alps#get-creditor": {
                        "href": "https://api.preprod.slimpay.com/creditors/democreditor"
                    },
                    "https://api.slimpay.net/alps#get-mandate": {
                        "href": "https://api.preprod.slimpay.com/mandates/de2d3f03-7e0a-11e8-9238-000000000000"
                    }
                },
                "reference": "subscriber5b3a41a4e949c"
            }
        ]
    },
    "page": {
        "size": 10,
        "totalElements": 582,
        "totalPages": 59,
        "number": 0
    },
    "_links": {
        "first": {
            "href": "https://api.preprod.slimpay.com/subscribers?creditorReference=democreditor&page=0&size=10"
        },
        "self": {
            "href": "https://api.preprod.slimpay.com/subscribers?creditorReference=democreditor"
        },
        "next": {
            "href": "https://api.preprod.slimpay.com/subscribers?creditorReference=democreditor&page=1&size=10"
        },
        "last": {
            "href": "https://api.preprod.slimpay.com/subscribers?creditorReference=democreditor&page=58&size=10"
        },
        "search": {
            "href": "https://api.preprod.slimpay.com/subscribers{?creditorReference,entityReference,reference,page,size}",
            "templated": true
        }
    }
}