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.

user-approvals

  1. extended-user-approval-representation
  2. extended-user-approval
  3. user-approval

1. extended-user-approval-representation

Description: An extended user approval representation. An extended user approval is used for embedding user approvals into iframes instead of redirecting.

Properties
mode
The mode. Constraints: Text among iframeembedded|iframepopin, Read-Only
content
The base64 encoded content to put in an iframe. Constraints: Text, Read-Only

2. extended-user-approval (relation)

Description: Get an extended user approval. A relation to follow in order to gather user approval with an iframe displayed on the merchant site (and without redirection of the end user to SlimPay).

Properties
mode
The mode. Constraints: Text among iframeembedded|iframepopin, Read-Only
Example: Get a user approval parent an order
Request
GET follow(https://api.slimpay.net/alps#extended-user-approval) 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: 692

{
    "content": "PGlmcmFtZSBzcmM9Imh0dHBzOi8vc2xpbXBheS5uZXQvY2hlY2tvdXQvdXNlckFwcHJvdmFsP2FjY2Vzc0NvZGU9c3B6SHVWTUlONmRnUHowMzE4dk1vWlVzVUZNMGM1blhFcVBCQjFKMTlDZmZMc1d6SEhZOTlUVUVyMkJBb0cmYW1wO21vZGU9aWZyYW1lX3BvcGluIiBzdHlsZT0iei1pbmRleDogMTY3NzcyNzE7IHBvc2l0aW9uOiBmaXhlZDsgdG9wOiAwOyBsZWZ0OiAwOyB3aWR0aDogMTAwJTsgaGVpZ2h0OiAxMDAlOyBib3JkZXI6IG5vbmU7Ij48L2lmcmFtZT4K",
    "mode": "iframepopin",
    "_links": {
        "self": {
            "href": "https://api-sandbox.slimpay.net/creditors/democreditor/orders/16f45997-ff69-11e6-83f6-000000000000/extended-user-approval?mode=iframepopin"
        },
        "profile": {
            "href": "https://api-sandbox.slimpay.net/alps/v1/user-approvals"
        }
    }
}

3. user-approval (relation)

Description: Redirect to the user approval. This is a special link in the API which is not made available for use by the REST client, but instead is to be provided to the end user so that he can reach a SlimPay web page in order to provide it's approval as well as additional details.

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!