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.

orders

  1. order-representation
  2. orders-representation
  3. cancel-order
  4. create-orders
  5. get-order
  6. get-orders
  7. otp-sending
  8. patch-order
  9. search-order-by-id
  10. search-orders
  11. sign-mandate

1. order-representation

Description: A representation of an order resource. An order is the resource used to combine several tasks into a single API call to the SlimPay server during Checkout. Orders can be created using one or more order items. An order is primarily related to a creditor and a subscriber.

Properties
id
The order id. Constraints: 36 characters or less, Read-Only.
reference
The order reference is related to the creditor the order is associated with. It can be submitted by the merchant or generated by the SlimPay server. Each order reference must be unique per creditor, which means it can be used to prevent duplicate orders. Constraints: Text, 40 characters or less, Read-Write.
state
The state of the order. The initial state is open.not_running.not_started. Transient states start with open, final states start with closed. If the order is successful, the state is a substate of closed.completed. If the order has failed, the state is a substate of closed.aborted. If the order is cancelled by the client, the final state is closed.aborted.abortedbyclient. If the order is cancelled by the server, the final state is closed.aborted.aborted_byserver. Constraints: Text, set to closed, closed.aborted, closed.aborted.aborted_byclient, closed.aborted.aborted_byserver, closed.completed, open.not_running, open.running, open.not_running.suspended, open.not_running.suspended.awaiting_input, open.not_running.suspended.awaiting_validation or open.not_running.not_started, Read-Only.
paymentScheme
The order's payment scheme. Constraints: Text, set to SEPA.DIRECT_DEBIT.CORE, SEPA.DIRECT_DEBIT.B2B or CARD, Read-Write
locale
If set, SlimPay will apply this locale to the order during Checkout. If not set, SlimPay will attempt to deduce the locale from the user’s browser. Constraints: Text, an ISO 639-1 standard country code, set to de, en, es, fr, it, nl, pl or pt, Read-Write.
started
A true/false descriptor controlling whether the order should be started. It can be populated when creating an order, which means that the order will be started automatically right after its creation. Alternatively, it can be started at a later date by patching the order. The value is set to false by default. Constraints: Boolean, Read-Write.
dateClosed
The date the order reached the closed state. Constraints: DateTime, formatted to ISO 8601 standard, i.e. 2022-01-01T10:00:00+00:00, Read-Only.
dateCreated
The date the resource was created. Constraints: DateTime, formatted to ISO 8601 standard, i.e. 2022-01-01T10:00:00+00:00, Read-Only.
dateModified
The date of the last update to the order. Constraints: DateTime, formatted to ISO 8601 standard, i.e. 2022-01-01T10:00:00+00:00, Read-Only.
mandateReused
A true/false flag set in a final state, indicating whether the mandate has been reused (a value of false indicates that a new mandate has been signed). Constraints: Boolean, Read-Only.
userIpAddress
The IP address of the end user. Constraints: Text, Read-Only.
sendUserApproval
A true/false descriptor controlling whether a user approval link will be sent to a subscriber's email address when finishing order creation. Constraints: Boolean, Read-Write.
checkoutActor
The checkout actor indicates who created the order (by default the value is set to end_user). Constraints: Text, set to end_user or third_party, Read-Write
returnUrl
This is the URL of the webpage a customer is redirected to following the completion of an order during Checkout. If set, then successUrl, failureUrl and cancelUrl must all be null. Text, 4096 characters or less, Read-Write.
failureUrl
This is the URL of the webpage a customer is redirected to following an order failure during Checkout. Optional, but if set, then successUrl and cancelUrl must be set, while returnUrl must not. Text, 4096 characters or less, Read-Write.
successUrl
This is the URL of the webpage a customer is redirected to following a successful order during Checkout. Optional, but if set, then failureUrl and cancelUrl must be set, while returnUrl must not. Text, 4096 characters or less, Read-Write.
cancelUrl
This is the URL of the webpage a customer is redirected to following a cancelled order during Checkout. Optional, but if set, then successUrl and failureUrl must be set, while returnUrl must not. Text, 4096 characters or less, Read-Write.
userApprovalMode
The user approval mode to be used. Constraints: Text, set to POPIN, IFRAME or API, Read-Write (Optional).
otpChannelType
The channel type to be used in sending otp code. Constraints: Text, set to SMS or EMAIL, Read-Write (Optional).
errors » code
A code identifying an order error during Checkout. Constraints: Integer, Read-Only.
errors » message
A human readable message describing the order error. Constraints: Text, Read-Only.
Example: An order representation
{
    "checkoutActor": "end_user",
    "dateCreated": "2014-12-12T09:35:39.000+0000",
    "id": "a621cee0-d679-11e6-bd80-000000000001",
    "mandateReused": false,
    "paymentScheme": "SEPA.DIRECT_DEBIT.CORE",
    "reference": "1",
    "sendUserApproval": false,
    "started": true,
    "state": "closed.completed",
    "_links": {
        "self": {
            "href": "https://api.preprod.slimpay.com/orders/a621cee0-d679-11e6-bd80-000000000001"
        },
        "profile": {
            "href": "https://api.preprod.slimpay.com/alps/v1/orders"
        },
        "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/orders/a621cee0-d679-11e6-bd80-000000000001/subscriber"
        },
        "https://api.slimpay.net/alps#get-order-items": {
            "href": "https://api.preprod.slimpay.com/orders/a621cee0-d679-11e6-bd80-000000000001/order-items"
        },
        "https://api.slimpay.net/alps#get-mandate": {
            "href": "https://api.preprod.slimpay.com/mandates/462942d2-7648-11e5-add6-f175896a8489"
        }
    }
}

2. orders-representation

Description: A collection of order representations.

3. cancel-order (relation)

Description: Cancel an existing order.

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!

4. create-orders (relation)

Description: To create an order, the request entity must be a representation of the order to create. This order entity will likely include representations of the resources it is related to, in particular the order items. These related representations can themselves contain a representation of their own related resources. For example, an order to sign a mandate will contain a signMandate order item representation, which in turn contains a mandate representation. If the order is successful, final resources (such as a mandate, a signatory, a subscriber etc) will be created, in addition to the order resource itself, which is returned in the server’s response.

Properties
reference
The order reference is related to the creditor the order is associated with. It can be submitted by the merchant or generated by the SlimPay server. Each order reference must be unique per creditor, which means it can be used to prevent duplicate orders. Constraints: Text, 40 characters or less, Read-Write.
paymentScheme
The order's payment scheme. Constraints: Text, set to SEPA.DIRECT_DEBIT.CORE, SEPA.DIRECT_DEBIT.B2B or CARD, Read-Write
locale
If set, SlimPay will apply this locale to the order during Checkout. If not set, SlimPay will attempt to deduce the locale from the user’s browser. Constraints: Text, an ISO 639-1 standard country code, set to de, en, es, fr, it, nl, pl or pt, Read-Write.
started
A true/false descriptor controlling whether the order should be started. It can be populated when creating an order, which means that the order will be started automatically right after its creation. Alternatively, it can be started at a later date by patching the order. The value is set to false by default. Constraints: Boolean, Read-Write.
creditor » reference
The unique identifier of a SlimPay account, allocated by SlimPay. Constraints: Text, 35 characters or less, Read-Write.
creditor » entity » reference
The entity reference of the creditor, allocated by SlimPay. Constraints: Text, 35 characters or less, Read-Only.
subscriber » reference
The subscriber reference, also known as client reference. Constraints: Text, 35 characters or less, Read-Write.
subscriber » givenName
The given name of the customer. Also known as firstName. Constraints: Text, 32 characters or less, Read-Write (optional).
subscriber » familyName
The family name of the customer. Also known as lastName. Constraints: Text, 70 characters or less, Read-Write (optional).
subscriber » email
The email address of the customer. Constraints: Text, 70 characters or less, Read-Write (optional).
subscriber » telephone
The telephone number of the customer. Constraints: Text, 16 characters or less, must start with a +, Read-Write (optional).
subscriber » 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.
subscriber » 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.
subscriber » 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.
subscriber » 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.
subscriber » 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.
subscriber » 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.
subscriber » 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.
subscriber » 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.
items » id
The order item id. Constraints: 36 characters or less, Read-Only.
items » type
The type of order item being created. For example, the value of signMandate identifies the order item as a sign-mandate-order-item. Constraints: Text, Read-Write.
origin
A flag to indicate phone or mail orders, which are SCA exempt. Constraints: Text, set to Telephone or Mail (optional).
userApprovalMode
The user approval mode to be used. Constraints: Text, set to POPIN, IFRAME or API, Read-Write (Optional).
otpChannelType
The channel type to be used in sending otp code. Constraints: Text, set to SMS or EMAIL, Read-Write (Optional).
Example: Create an order to sign a mandate and add a first credit transfer payment (Sofort, iDeal)
Request
POST follow(https://api.slimpay.net/alps#create-orders) HTTP/1.1
Accept: application/hal+json; profile="https://api.slimpay.net/alps/v1"
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJhcGkiXSwiZXhwIjoxNTMwNjMzNTk0LCJqdGkiOiI2ODNmNGE1Ni1kZjQ3LTQ0ZWYtYmIxYy02MDJhYmFlNGYwYjgiLCJjbGllbnRfaWQiOiJkZW1vY3JlZGl0b3IwMSJ9.VSmbmu4upmKj5_lTiBlqtbqSH42yx83AB1IFXJs08Tw

{
    "creditor": {
        "reference": "democreditor"
    },
    "subscriber": {
        "reference": "subscriber01"
    },
    "items": [
        {
            "type": "signMandate",
            "mandate": {
                "signatory": {
                    "honorificPrefix": "Mr",
                    "familyName": "Doe",
                    "givenName": "John",
                    "telephone": "+33612345678",
                    "email": "change.me@slimpay.com",
                    "billingAddress": {
                        "street1": "27 rue des fleurs",
                        "street2": "Bat 2",
                        "postalCode": "75008",
                        "city": "Paris",
                        "country": "FR"
                    }
                }
            }
        },
        {
            "type": "payment",
            "payin": {
                "scheme": "SEPA.CREDIT_TRANSFER",
                "amount": 100,
                "label": "The label",
                "reference": "Credit transfer by Sofort or iDeal"
            }
        }
    ],
    "started": true
}

5. get-order (relation)

Description: Retrieve the representation of an order 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!

6. get-orders (relation)

Description: Retrieve the representation of specific order resource, using creditor reference and the order reference as parameters (both are mandatory).

Properties
creditorReference
The unique identifier of a SlimPay account, allocated by SlimPay. Constraints: Text, 35 characters or less, Read-Write.
reference
The order reference is related to the creditor the order is associated with. It can be submitted by the merchant or generated by the SlimPay server. Each order reference must be unique per creditor, which means it can be used to prevent duplicate orders. Constraints: Text, 40 characters or less, Read-Write.
Example: Retrieve an order representation by reference
Request
GET follow(https://api.slimpay.net/alps#get-orders) 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: 1148

{
    "checkoutActor": "end_user",
    "dateCreated": "2014-12-12T09:35:39.000+0000",
    "id": "a621cee0-d679-11e6-bd80-000000000001",
    "mandateReused": false,
    "paymentScheme": "SEPA.DIRECT_DEBIT.CORE",
    "reference": "1",
    "sendUserApproval": false,
    "started": true,
    "state": "closed.completed",
    "_links": {
        "self": {
            "href": "https://api.preprod.slimpay.com/orders/a621cee0-d679-11e6-bd80-000000000001"
        },
        "profile": {
            "href": "https://api.preprod.slimpay.com/alps/v1/orders"
        },
        "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/orders/a621cee0-d679-11e6-bd80-000000000001/subscriber"
        },
        "https://api.slimpay.net/alps#get-order-items": {
            "href": "https://api.preprod.slimpay.com/orders/a621cee0-d679-11e6-bd80-000000000001/order-items"
        },
        "https://api.slimpay.net/alps#get-mandate": {
            "href": "https://api.preprod.slimpay.com/mandates/462942d2-7648-11e5-add6-f175896a8489"
        }
    }
}

7. otp-sending (relation)

Description: Endpoint for sending otp to sign mandate

Properties
otpChannelType
The channel type to be used in sending otp code. Constraints: Text, set to SMS or EMAIL, Read-Write (Optional).

8. patch-order (relation)

Description: Patch an order. Follow this relation with the started descriptor set to true to start an order which has not started yet.

Properties
started
A true/false descriptor controlling whether the order should be started. It can be populated when creating an order, which means that the order will be started automatically right after its creation. Alternatively, it can be started at a later date by patching the order. The value is set to false by default. Constraints: Boolean, Read-Write.

9. search-order-by-id (relation)

Description: Search for the representation of a specific order resource, using its id parameter.

Properties
id
The order id. Constraints: 36 characters or less, Read-Only.
Example: Search one order by id
Request
GET follow(https://api.slimpay.net/alps#search-order-by-id) 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: 1492

{
    "checkoutActor": "end_user",
    "dateCreated": "2017-02-28T14:39:37.000+0000",
    "dateModified": "2017-02-28T14:39:37.000+0000",
    "id": "babac13d-fdc3-11e6-99e0-000000000000",
    "paymentScheme": "SEPA.DIRECT_DEBIT.CORE",
    "reference": "bab3e36c-fdc3-11e6-99e0-000000000000",
    "sendUserApproval": false,
    "started": true,
    "state": "open.running",
    "_links": {
        "self": {
            "href": "https://api.preprod.slimpay.com/orders/babac13d-fdc3-11e6-99e0-000000000000"
        },
        "profile": {
            "href": "https://api.preprod.slimpay.com/alps/v1/orders"
        },
        "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/orders/babac13d-fdc3-11e6-99e0-000000000000/subscriber"
        },
        "https://api.slimpay.net/alps#get-order-items": {
            "href": "https://api.preprod.slimpay.com/orders/babac13d-fdc3-11e6-99e0-000000000000/order-items"
        },
        "https://api.slimpay.net/alps#user-approval": {
            "href": "https://checkout.preprod.slimpay.com/userApproval?accessCode=sppWrIVDNJ5MV4QOmQm7tZOZtnNVOFehG58auoECjWWbJbl7mPnlgzvyBsK0gx"
        },
        "https://api.slimpay.net/alps#extended-user-approval": {
            "href": "https://api.preprod.slimpay.com/creditors/democreditor/orders/bab3e36c-fdc3-11e6-99e0-000000000000/extended-user-approval{?mode}",
            "templated": true
        }
    }
}

10. search-orders (relation)

Description: Search orders. 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.
subscriberReference
The subscriber reference, also known as client reference. Constraints: Text, 35 characters or less, Read-Write.
reference
The order reference is related to the creditor the order is associated with. It can be submitted by the merchant or generated by the SlimPay server. Each order reference must be unique per creditor, which means it can be used to prevent duplicate orders. Constraints: Text, 40 characters or less, Read-Write.
state
The state of the order (optional). Constraints: Text, set to closed, closed.aborted, closed.aborted.aborted_byclient, closed.aborted.aborted_byserver, closed.completed, open.not_running, open.running, open.not_running.suspended, open.not_running.suspended.awaiting_input, open.not_running.suspended.awaiting_validation or open.not_running.not_started.
dateCreatedBefore
Search orders created before this date. Constraints: DateTime, formatted to ISO 8601 standard, i.e. 2022-01-01T10:00:00+00:00, (optional).
dateCreatedAfter
Search orders created after this date. Constraints: DateTime, formatted to ISO 8601 standard, i.e. 2022-01-01T10:00:00+00:00, (optional).
Example: Search orders
Request
GET follow(https://api.slimpay.net/alps#search-orders) 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: 16962

{
    "_embedded": {
        "orders": [
            {
                "_links": {
                    "self": {
                        "href": "https://api.preprod.slimpay.com/orders/cdacc418-7ed7-11e8-bf72-000000000000"
                    },
                    "profile": {
                        "href": "https://api.preprod.slimpay.com/alps/v1/orders"
                    },
                    "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/orders/cdacc418-7ed7-11e8-bf72-000000000000/subscriber"
                    },
                    "https://api.slimpay.net/alps#get-order-items": {
                        "href": "https://api.preprod.slimpay.com/orders/cdacc418-7ed7-11e8-bf72-000000000000/order-items"
                    },
                    "https://api.slimpay.net/alps#user-approval": {
                        "href": "https://checkout.preprod.slimpay.com/userApproval?accessCode=spQkxE4pyJMFlcHosLcp2cFRpqf86wEZiBr1RGbpdtlnqzZXtkWuYtLcMub4Pw"
                    },
                    "https://api.slimpay.net/alps#extended-user-approval": {
                        "href": "https://api.preprod.slimpay.com/creditors/democreditor/orders/cdacc418-7ed7-11e8-bf72-000000000000/extended-user-approval{?mode}",
                        "templated": true
                    }
                },
                "id": "cdacc418-7ed7-11e8-bf72-000000000000",
                "reference": "cdacc418-7ed7-11e8-bf72-000000000000",
                "state": "open.running",
                "started": true,
                "dateCreated": "2018-07-03T15:43:17.000+0000",
                "dateStarted": "2018-07-03T15:43:17.000+0000",
                "paymentScheme": "SEPA.DIRECT_DEBIT.CORE",
                "sendUserApproval": false,
                "checkoutActor": "end_user"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.preprod.slimpay.com/orders/f9b475ec-7ed4-11e8-bf72-000000000000"
                    },
                    "profile": {
                        "href": "https://api.preprod.slimpay.com/alps/v1/orders"
                    },
                    "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/orders/f9b475ec-7ed4-11e8-bf72-000000000000/subscriber"
                    },
                    "https://api.slimpay.net/alps#get-order-items": {
                        "href": "https://api.preprod.slimpay.com/orders/f9b475ec-7ed4-11e8-bf72-000000000000/order-items"
                    },
                    "https://api.slimpay.net/alps#get-mandate": {
                        "href": "https://api.preprod.slimpay.com/mandates/fe5770cc-7ed4-11e8-9238-000000000000"
                    }
                },
                "id": "f9b475ec-7ed4-11e8-bf72-000000000000",
                "reference": "f9b475ec-7ed4-11e8-bf72-000000000000",
                "state": "closed.completed",
                "locale": "en",
                "started": true,
                "dateCreated": "2018-07-03T15:23:02.000+0000",
                "dateStarted": "2018-07-03T15:23:02.000+0000",
                "dateClosed": "2018-07-03T15:23:12.000+0000",
                "paymentScheme": "SEPA.DIRECT_DEBIT.CORE",
                "mandateReused": false,
                "sendUserApproval": false,
                "checkoutActor": "end_user"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.preprod.slimpay.com/orders/104bf516-7ed4-11e8-bf72-000000000000"
                    },
                    "profile": {
                        "href": "https://api.preprod.slimpay.com/alps/v1/orders"
                    },
                    "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/orders/104bf516-7ed4-11e8-bf72-000000000000/subscriber"
                    },
                    "https://api.slimpay.net/alps#get-order-items": {
                        "href": "https://api.preprod.slimpay.com/orders/104bf516-7ed4-11e8-bf72-000000000000/order-items"
                    },
                    "https://api.slimpay.net/alps#user-approval": {
                        "href": "https://checkout.preprod.slimpay.com/userApproval?accessCode=spBxcwwm4FhxB1NY2GHavssCj3XnnWPv2RAjUz96TgAZH0bXnj3Dlr1z7fuov3"
                    },
                    "https://api.slimpay.net/alps#extended-user-approval": {
                        "href": "https://api.preprod.slimpay.com/creditors/democreditor/orders/104bf516-7ed4-11e8-bf72-000000000000/extended-user-approval{?mode}",
                        "templated": true
                    }
                },
                "id": "104bf516-7ed4-11e8-bf72-000000000000",
                "reference": "104bf516-7ed4-11e8-bf72-000000000000",
                "state": "open.running",
                "started": true,
                "dateCreated": "2018-07-03T15:16:31.000+0000",
                "dateStarted": "2018-07-03T15:16:31.000+0000",
                "paymentScheme": "SEPA.DIRECT_DEBIT.CORE",
                "sendUserApproval": false,
                "checkoutActor": "end_user"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.preprod.slimpay.com/orders/e6a8c705-7ed3-11e8-bf72-000000000000"
                    },
                    "profile": {
                        "href": "https://api.preprod.slimpay.com/alps/v1/orders"
                    },
                    "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/orders/e6a8c705-7ed3-11e8-bf72-000000000000/subscriber"
                    },
                    "https://api.slimpay.net/alps#get-order-items": {
                        "href": "https://api.preprod.slimpay.com/orders/e6a8c705-7ed3-11e8-bf72-000000000000/order-items"
                    },
                    "https://api.slimpay.net/alps#user-approval": {
                        "href": "https://checkout.preprod.slimpay.com/userApproval?accessCode=spXcDdQdSZEY03rtZAWEW7WDBNgzDsVxgDDwEVoWMzOI3IIVzhj9JX2NWd7FRQ"
                    },
                    "https://api.slimpay.net/alps#extended-user-approval": {
                        "href": "https://api.preprod.slimpay.com/creditors/democreditor/orders/e6a8c705-7ed3-11e8-bf72-000000000000/extended-user-approval{?mode}",
                        "templated": true
                    }
                },
                "id": "e6a8c705-7ed3-11e8-bf72-000000000000",
                "reference": "e6a8c705-7ed3-11e8-bf72-000000000000",
                "state": "open.running",
                "started": true,
                "dateCreated": "2018-07-03T15:15:21.000+0000",
                "dateStarted": "2018-07-03T15:15:21.000+0000",
                "paymentScheme": "SEPA.DIRECT_DEBIT.CORE",
                "sendUserApproval": false,
                "checkoutActor": "end_user"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.preprod.slimpay.com/orders/e69cb914-7ed3-11e8-bf72-000000000000"
                    },
                    "profile": {
                        "href": "https://api.preprod.slimpay.com/alps/v1/orders"
                    },
                    "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/orders/e69cb914-7ed3-11e8-bf72-000000000000/subscriber"
                    },
                    "https://api.slimpay.net/alps#get-order-items": {
                        "href": "https://api.preprod.slimpay.com/orders/e69cb914-7ed3-11e8-bf72-000000000000/order-items"
                    },
                    "https://api.slimpay.net/alps#user-approval": {
                        "href": "https://checkout.preprod.slimpay.com/userApproval?accessCode=spJD6rjnUKGk9qfmmUxXfE1p3OsOU4LM21JsF5thXOzv433LzheFnxgZMJ9nbQ"
                    },
                    "https://api.slimpay.net/alps#extended-user-approval": {
                        "href": "https://api.preprod.slimpay.com/creditors/democreditor/orders/e69cb914-7ed3-11e8-bf72-000000000000/extended-user-approval{?mode}",
                        "templated": true
                    }
                },
                "id": "e69cb914-7ed3-11e8-bf72-000000000000",
                "reference": "e69cb914-7ed3-11e8-bf72-000000000000",
                "state": "open.running",
                "started": true,
                "dateCreated": "2018-07-03T15:15:21.000+0000",
                "dateStarted": "2018-07-03T15:15:21.000+0000",
                "paymentScheme": "SEPA.DIRECT_DEBIT.CORE",
                "sendUserApproval": false,
                "checkoutActor": "end_user"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.preprod.slimpay.com/orders/e68c3e52-7ed3-11e8-bf72-000000000000"
                    },
                    "profile": {
                        "href": "https://api.preprod.slimpay.com/alps/v1/orders"
                    },
                    "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/orders/e68c3e52-7ed3-11e8-bf72-000000000000/subscriber"
                    },
                    "https://api.slimpay.net/alps#get-order-items": {
                        "href": "https://api.preprod.slimpay.com/orders/e68c3e52-7ed3-11e8-bf72-000000000000/order-items"
                    },
                    "https://api.slimpay.net/alps#user-approval": {
                        "href": "https://checkout.preprod.slimpay.com/userApproval?accessCode=spbbwM3hryDGP1CjVGFPiH0BYAAjjS4JumrZc1g3UN2ZICmciAiYTxLzd0nUOp"
                    },
                    "https://api.slimpay.net/alps#extended-user-approval": {
                        "href": "https://api.preprod.slimpay.com/creditors/democreditor/orders/e68c3e52-7ed3-11e8-bf72-000000000000/extended-user-approval{?mode}",
                        "templated": true
                    }
                },
                "id": "e68c3e52-7ed3-11e8-bf72-000000000000",
                "reference": "e68c3e52-7ed3-11e8-bf72-000000000000",
                "state": "open.running",
                "started": true,
                "dateCreated": "2018-07-03T15:15:21.000+0000",
                "dateStarted": "2018-07-03T15:15:21.000+0000",
                "paymentScheme": "SEPA.DIRECT_DEBIT.CORE",
                "sendUserApproval": false,
                "checkoutActor": "end_user"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.preprod.slimpay.com/orders/e6772faf-7ed3-11e8-bf72-000000000000"
                    },
                    "profile": {
                        "href": "https://api.preprod.slimpay.com/alps/v1/orders"
                    },
                    "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/orders/e6772faf-7ed3-11e8-bf72-000000000000/subscriber"
                    },
                    "https://api.slimpay.net/alps#get-order-items": {
                        "href": "https://api.preprod.slimpay.com/orders/e6772faf-7ed3-11e8-bf72-000000000000/order-items"
                    },
                    "https://api.slimpay.net/alps#user-approval": {
                        "href": "https://checkout.preprod.slimpay.com/userApproval?accessCode=spbGt1UaEr0YthTERyF9j1fxZfBncSH89i4dXOydOi7FdapVHuf90Y38oDeeqx"
                    },
                    "https://api.slimpay.net/alps#extended-user-approval": {
                        "href": "https://api.preprod.slimpay.com/creditors/democreditor/orders/e6772faf-7ed3-11e8-bf72-000000000000/extended-user-approval{?mode}",
                        "templated": true
                    }
                },
                "id": "e6772faf-7ed3-11e8-bf72-000000000000",
                "reference": "e6772faf-7ed3-11e8-bf72-000000000000",
                "state": "open.running",
                "started": true,
                "dateCreated": "2018-07-03T15:15:20.000+0000",
                "dateStarted": "2018-07-03T15:15:20.000+0000",
                "paymentScheme": "SEPA.DIRECT_DEBIT.CORE",
                "sendUserApproval": false,
                "checkoutActor": "end_user"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.preprod.slimpay.com/orders/e666dbfd-7ed3-11e8-bf72-000000000000"
                    },
                    "profile": {
                        "href": "https://api.preprod.slimpay.com/alps/v1/orders"
                    },
                    "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/orders/e666dbfd-7ed3-11e8-bf72-000000000000/subscriber"
                    },
                    "https://api.slimpay.net/alps#get-order-items": {
                        "href": "https://api.preprod.slimpay.com/orders/e666dbfd-7ed3-11e8-bf72-000000000000/order-items"
                    },
                    "https://api.slimpay.net/alps#user-approval": {
                        "href": "https://checkout.preprod.slimpay.com/userApproval?accessCode=sp1lP7iDBVQKNguZWbfOcSOHa175ZK9DBjGWA9i8YFxKAauFZMo4IlYlfldD6w"
                    },
                    "https://api.slimpay.net/alps#extended-user-approval": {
                        "href": "https://api.preprod.slimpay.com/creditors/democreditor/orders/e666dbfd-7ed3-11e8-bf72-000000000000/extended-user-approval{?mode}",
                        "templated": true
                    }
                },
                "id": "e666dbfd-7ed3-11e8-bf72-000000000000",
                "reference": "e666dbfd-7ed3-11e8-bf72-000000000000",
                "state": "open.running",
                "started": true,
                "dateCreated": "2018-07-03T15:15:20.000+0000",
                "dateStarted": "2018-07-03T15:15:20.000+0000",
                "paymentScheme": "SEPA.DIRECT_DEBIT.CORE",
                "sendUserApproval": false,
                "checkoutActor": "end_user"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.preprod.slimpay.com/orders/e648ccaa-7ed3-11e8-bf72-000000000000"
                    },
                    "profile": {
                        "href": "https://api.preprod.slimpay.com/alps/v1/orders"
                    },
                    "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/orders/e648ccaa-7ed3-11e8-bf72-000000000000/subscriber"
                    },
                    "https://api.slimpay.net/alps#get-order-items": {
                        "href": "https://api.preprod.slimpay.com/orders/e648ccaa-7ed3-11e8-bf72-000000000000/order-items"
                    },
                    "https://api.slimpay.net/alps#user-approval": {
                        "href": "https://checkout.preprod.slimpay.com/userApproval?accessCode=spXvOSEAa693mid2tH3JUaZHRqtq773hAwEaIjIPXpCKVAxS1ga0h0A7VBB7Fn"
                    },
                    "https://api.slimpay.net/alps#extended-user-approval": {
                        "href": "https://api.preprod.slimpay.com/creditors/democreditor/orders/e648ccaa-7ed3-11e8-bf72-000000000000/extended-user-approval{?mode}",
                        "templated": true
                    }
                },
                "id": "e648ccaa-7ed3-11e8-bf72-000000000000",
                "reference": "e648ccaa-7ed3-11e8-bf72-000000000000",
                "state": "open.running",
                "started": true,
                "dateCreated": "2018-07-03T15:15:20.000+0000",
                "dateStarted": "2018-07-03T15:15:20.000+0000",
                "paymentScheme": "SEPA.DIRECT_DEBIT.CORE",
                "sendUserApproval": false,
                "checkoutActor": "end_user"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.preprod.slimpay.com/orders/e62e8de8-7ed3-11e8-bf72-000000000000"
                    },
                    "profile": {
                        "href": "https://api.preprod.slimpay.com/alps/v1/orders"
                    },
                    "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/orders/e62e8de8-7ed3-11e8-bf72-000000000000/subscriber"
                    },
                    "https://api.slimpay.net/alps#get-order-items": {
                        "href": "https://api.preprod.slimpay.com/orders/e62e8de8-7ed3-11e8-bf72-000000000000/order-items"
                    },
                    "https://api.slimpay.net/alps#user-approval": {
                        "href": "https://checkout.preprod.slimpay.com/userApproval?accessCode=spx5VygDfdm4jrNvAFXBl6qBoD4Le0Pwsb0dV5MI2iB8mI4e4K5btmVPZhHZCt"
                    },
                    "https://api.slimpay.net/alps#extended-user-approval": {
                        "href": "https://api.preprod.slimpay.com/creditors/democreditor/orders/e62e8de8-7ed3-11e8-bf72-000000000000/extended-user-approval{?mode}",
                        "templated": true
                    }
                },
                "id": "e62e8de8-7ed3-11e8-bf72-000000000000",
                "reference": "e62e8de8-7ed3-11e8-bf72-000000000000",
                "state": "open.running",
                "started": true,
                "dateCreated": "2018-07-03T15:15:20.000+0000",
                "dateStarted": "2018-07-03T15:15:20.000+0000",
                "paymentScheme": "SEPA.DIRECT_DEBIT.CORE",
                "sendUserApproval": false,
                "checkoutActor": "end_user"
            }
        ]
    },
    "page": {
        "size": 10,
        "totalElements": 40430,
        "totalPages": 4043,
        "number": 0
    },
    "_links": {
        "first": {
            "href": "https://api.preprod.slimpay.com/orders?creditorReference=democreditor&page=0&size=10"
        },
        "self": {
            "href": "https://api.preprod.slimpay.com/orders?creditorReference=democreditor"
        },
        "next": {
            "href": "https://api.preprod.slimpay.com/orders?creditorReference=democreditor&page=1&size=10"
        },
        "last": {
            "href": "https://api.preprod.slimpay.com/orders?creditorReference=democreditor&page=4042&size=10"
        },
        "search": {
            "href": "https://api.preprod.slimpay.com/orders{?creditorReference,entityReference,subscriberReference,state,dateCreatedBefore,dateCreatedAfter,page,size}",
            "templated": true
        }
    }
}

11. sign-mandate (relation)

Description: Sign a mandate linked to an existing order

Properties
otpCode
Otp code provided by user. Constraints: Text, Read-Write (Mandatory).