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
- card-alias-representation
- card-aliases-representation
- get-card-alias
- get-card-aliases
- 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, set to activated or 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: Retrieve a card alias representation
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"
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJhcGkiXSwiZXhwIjoxNTMwNjMzNTk0LCJqdGkiOiI2ODNmNGE1Ni1kZjQ3LTQ0ZWYtYmIxYy02MDJhYmFlNGYwYjgiLCJjbGllbnRfaWQiOiJkZW1vY3JlZGl0b3IwMSJ9.VSmbmu4upmKj5_lTiBlqtbqSH42yx83AB1IFXJs08Tw
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: Retrieve a card alias representation 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.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: 701
{
"expirationDate": "2018-02-27T23:00:00.000+0000",
"id": "bb78f52e-5881-11e5-949f-bbda0eef6d56",
"reference": "129#democreditor#subscriber01",
"status": "deleted",
"_links": {
"self": {
"href": "https://api.preprod.slimpay.com/card-aliases/bb78f52e-5881-11e5-949f-bbda0eef6d56"
},
"profile": {
"href": "https://api.preprod.slimpay.com/alps/v1/card-aliases"
},
"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"
}
}
}
5. search-card-aliases (relation)
Description: Search card aliases. They will be 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 card alias reference. Constraints: Text, 250 characters or less, Read-Write.
- status
- The card alias status. Text, set to activated or 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.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: 3766
{
"_embedded": {
"cardAliases": [
{
"_links": {
"self": {
"href": "https://api.preprod.slimpay.com/card-aliases/f92de813-7eac-11e8-abe5-000000000000"
},
"profile": {
"href": "https://api.preprod.slimpay.com/alps/v1/card-aliases"
},
"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/subscriber5b3b51840a15a"
},
"https://api.slimpay.net/alps#get-card": {
"href": "https://api.preprod.slimpay.com/cards/160afae4-9f5e-11e7-aeca-000000000000"
}
},
"id": "f92de813-7eac-11e8-abe5-000000000000",
"reference": "11433#democreditor#subscriber5b3b51840a15a",
"status": "activated",
"expirationDate": "2018-11-29T23:00:00.000+0000"
},
{
"_links": {
"self": {
"href": "https://api.preprod.slimpay.com/card-aliases/e305a7a4-7e97-11e8-abe5-000000000000"
},
"profile": {
"href": "https://api.preprod.slimpay.com/alps/v1/card-aliases"
},
"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/subscriber5b3b2e0048bb1"
},
"https://api.slimpay.net/alps#get-card": {
"href": "https://api.preprod.slimpay.com/cards/160afae4-9f5e-11e7-aeca-000000000000"
}
},
"id": "e305a7a4-7e97-11e8-abe5-000000000000",
"reference": "11429#democreditor#subscriber5b3b2e0048bb1",
"status": "activated",
"expirationDate": "2018-11-29T23:00:00.000+0000"
},
{
"_links": {
"self": {
"href": "https://api.preprod.slimpay.com/card-aliases/8c49fb02-7e97-11e8-abe5-000000000000"
},
"profile": {
"href": "https://api.preprod.slimpay.com/alps/v1/card-aliases"
},
"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/subscriber5b3b2d2c4b505"
},
"https://api.slimpay.net/alps#get-card": {
"href": "https://api.preprod.slimpay.com/cards/160afae4-9f5e-11e7-aeca-000000000000"
}
},
"id": "8c49fb02-7e97-11e8-abe5-000000000000",
"reference": "11428#democreditor#subscriber5b3b2d2c4b505",
"status": "activated",
"expirationDate": "2018-11-29T23:00:00.000+0000"
}
]
},
"page": {
"size": 3,
"totalElements": 200,
"totalPages": 67,
"number": 0
},
"_links": {
"first": {
"href": "https://api.preprod.slimpay.com/card-aliases?creditorReference=democreditor&page=0&size=3"
},
"self": {
"href": "https://api.preprod.slimpay.com/card-aliases?creditorReference=democreditor&size=3"
},
"next": {
"href": "https://api.preprod.slimpay.com/card-aliases?creditorReference=democreditor&page=1&size=3"
},
"last": {
"href": "https://api.preprod.slimpay.com/card-aliases?creditorReference=democreditor&page=66&size=3"
},
"search": {
"href": "https://api.preprod.slimpay.com/card-aliases{?creditorReference,entityReference,subscriberReference,reference,status,page,size}",
"templated": true
}
}
}