user-approvals

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.

1. extended-user-approval-representation

Description: A representation of an extended user approval resource. This resource is used to construct an embedded or popin iframe on a merchant's website during the Checkout process to obtain a customer’s approval (rather than redirecting them to SlimPay).

Properties

mode: The iframe mode. Constraints: Text, set to iframeembedded or iframepopin, Read-Write.
content: The base64 encoded content to put in an iframe. Constraints: Text, Read-Only.

2. extended-user-approval (relation)

Description: Retrieve an extended user approval resource. Follow this relation to obtain a customer’s approval during Checkout using an embedded or popin iframe on the merchant's website (rather than redirecting them to SlimPay).

Properties

mode: The iframe mode. Constraints: Text, set to iframeembedded or iframepopin, Read-Only.

Example: Retrieve a user approval representation

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.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: 704

{
    "content": "PGlmcmFtZSBzcmM9Imh0dHBzOi8vY2hlY2tvdXQucHJlcHJvZC5zbGltcGF5LmNvbS91c2VyQXBwcm92YWw/YWNjZXNzQ29kZT1zcFFreEU0cHlKTUZsY0hvc0xjcDJjRlJwcWY4NndFWmlCcjFSR2JwZHRsbnF6Wlh0a1d1WXRMY011YjRQdyZhbXA7bW9kZT1pZnJhbWVfcG9waW4iIHN0eWxlPSJ6LWluZGV4OiAxNjc3NzI3MTsgcG9zaXRpb246IGZpeGVkOyB0b3A6IDA7IGxlZnQ6IDA7IHdpZHRoOiAxMDAlOyBoZWlnaHQ6IDEwMCU7IGJvcmRlcjogbm9uZTsiPjwvaWZyYW1lPgo=",
    "mode": "iframepopin",
    "_links": {
        "self": {
            "href": "https://api.preprod.slimpay.com/creditors/democreditor/orders/cdacc418-7ed7-11e8-bf72-000000000000/extended-user-approval?mode=iframepopin"
        },
        "profile": {
            "href": "https://api.preprod.slimpay.com/alps/v1/user-approvals"
        }
    }
}

3. user-approval (relation)

Description: This relation returns a special URL link, which is not available for use by the REST client. During the Checkout process, this link will redirect a customer to a SlimPay webpage in order to provide their approval and other additional information (such as bank account or credit card 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!