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.

card-aliases

  1. card-alias-representation
  2. card-aliases-representation
  3. get-card-alias
  4. get-card-aliases
  5. search-card-aliases

1. card-alias-representation

Description: A card alias representation. A card alias is issued from a real card and can be used for payments instead of the real card.

Properties
id
The card alias id. Constraints: 36 characters or less, Read-Only.
reference
The card alias reference. Constraints: Text, 250 characters or less, Read-Write.
status
The card alias status. Text among activated|deleted, Read-Only.
cardExpirationDate
The card expiration date. Constraints: DateTime, ISO8601, Read-Only.

2. card-aliases-representation

Description: A collection of card aliases.

3. get-card-alias (relation)

Description: Get one card alias.

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 card alias
Request
GET follow(https://api.slimpay.net/alps#get-card-alias) HTTP/1.1
Accept: application/hal+json; profile="https://api.slimpay.net/alps/v1"

4. get-card-aliases (relation)

Description: Get one card alias by id.

Properties
id
The card alias id. Constraints: 36 characters or less, Read-Only.
Example: Get one card alias by id
Request
GET follow(https://api.slimpay.net/alps#get-card-aliases) 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: 703

{
    "expirationDate": "2018-02-27T23:00:00.000+0000",
    "id": "bb78f52e-5881-11e5-949f-bbda0eef6d56",
    "reference": "129#democreditor#subscriber01",
    "status": "activated",
    "_links": {
        "https://api.slimpay.net/alps#get-subscriber": {
            "href": "https://api-sandbox.slimpay.net/creditors/democreditor/subscribers/subscriber01"
        },
        "https://api.slimpay.net/alps#get-creditor": {
            "href": "https://api-sandbox.slimpay.net/creditors/democreditor"
        },
        "self": {
            "href": "https://api-sandbox.slimpay.net/card-aliases/bb78f52e-5881-11e5-949f-bbda0eef6d56"
        },
        "profile": {
            "href": "https://api-sandbox.slimpay.net/alps/v1/card-aliases"
        }
    }
}

5. search-card-aliases (relation)

Description: Search card aliases. 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 card alias reference. Constraints: Text, 250 characters or less, Read-Write.
status
The card alias status. Text among activated|deleted, Read-Only.
Example: Search card aliases
Request
GET follow(https://api.slimpay.net/alps#search-card-aliases) 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: 3219

{
    "_embedded": {
        "cardAliases": [
            {
                "status": "activated",
                "expirationDate": "2018-01-30T23:00:00.000+0000",
                "id": "faffe0cb-f83f-11e6-84e7-000000000000",
                "_links": {
                    "https://api.slimpay.net/alps#get-subscriber": {
                        "href": "https://api-sandbox.slimpay.net/creditors/democreditor/subscribers/subscriber01"
                    },
                    "https://api.slimpay.net/alps#get-creditor": {
                        "href": "https://api-sandbox.slimpay.net/creditors/democreditor"
                    },
                    "self": {
                        "href": "https://api-sandbox.slimpay.net/card-aliases/faffe0cb-f83f-11e6-84e7-000000000000"
                    },
                    "profile": {
                        "href": "https://api-sandbox.slimpay.net/alps/v1/card-aliases"
                    }
                },
                "reference": "2176#democreditor#subscriber01"
            },
            {
                "status": "activated",
                "expirationDate": "2018-01-30T23:00:00.000+0000",
                "id": "e35f9968-f83f-11e6-84e7-000000000000",
                "_links": {
                    "https://api.slimpay.net/alps#get-subscriber": {
                        "href": "https://api-sandbox.slimpay.net/creditors/democreditor/subscribers/subscriber01"
                    },
                    "https://api.slimpay.net/alps#get-creditor": {
                        "href": "https://api-sandbox.slimpay.net/creditors/democreditor"
                    },
                    "self": {
                        "href": "https://api-sandbox.slimpay.net/card-aliases/e35f9968-f83f-11e6-84e7-000000000000"
                    },
                    "profile": {
                        "href": "https://api-sandbox.slimpay.net/alps/v1/card-aliases"
                    }
                },
                "reference": "2175#democreditor#subscriber01"
            },
            {
                "status": "activated",
                "expirationDate": "2018-01-30T23:00:00.000+0000",
                "id": "ad74cdc3-f83f-11e6-84e7-000000000000",
                "_links": {
                    "https://api.slimpay.net/alps#get-subscriber": {
                        "href": "https://api-sandbox.slimpay.net/creditors/democreditor/subscribers/subscriber01"
                    },
                    "https://api.slimpay.net/alps#get-creditor": {
                        "href": "https://api-sandbox.slimpay.net/creditors/democreditor"
                    },
                    "self": {
                        "href": "https://api-sandbox.slimpay.net/card-aliases/ad74cdc3-f83f-11e6-84e7-000000000000"
                    },
                    "profile": {
                        "href": "https://api-sandbox.slimpay.net/alps/v1/card-aliases"
                    }
                },
                "reference": "2173#democreditor#subscriber01"
            }
        ]
    },
    "page": {
        "totalPages": 14,
        "totalElements": 40,
        "size": 3,
        "number": 0
    },
    "_links": {
        "last": {
            "href": "https://api-sandbox.slimpay.net/card-aliases?creditorReference=democreditor&page=13&size=3"
        },
        "search": {
            "href": "https://api-sandbox.slimpay.net/card-aliases{?creditorReference,entityReference,subscriberReference,reference,status,page,size}",
            "templated": true
        },
        "self": {
            "href": "https://api-sandbox.slimpay.net/card-aliases?creditorReference=democreditor&size=3"
        },
        "next": {
            "href": "https://api-sandbox.slimpay.net/card-aliases?creditorReference=democreditor&page=1&size=3"
        },
        "first": {
            "href": "https://api-sandbox.slimpay.net/card-aliases?creditorReference=democreditor&page=0&size=3"
        }
    }
}