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.

webhook

  1. webhook-representation
  2. create-webhook
  3. delete-webhook
  4. get-webhook
  5. get-webhooks
  6. update-webhook

1. webhook-representation

Description: A representation of a webhook.

Properties
id
The webhook id. Constraints: 36 characters, Read-Only.
title
A name given to the webhook. Constraints: Text, 100 characters or less, Read-Write.
description
A description associated to the webhook. Constraints: Text, 255 characters or less, Read-Write.
url
The URL of the server where SlimPay will send all the notifications related to the chosen event types. Note: a same url can be added to different webhook. Constraints: Text, 255 characters or less, Read-Only.
secret
Please store the secret value safely, as this value cannot be retrieved again. Use this secret to verify the signature of incoming notifications. Constraints: 64 bytes-key, Read-Only.
enabled
Boolean to confirm if the webhook is enabled or not. Constraints: boolean, Read-Write.
dateCreated
The date the resource was created. Constraints: DateTime, formatted to ISO 8601 standard, i.e. 2023-12-01T09:13:37.187+0000, Read-Only.
dateModified
The date the resource was updated for the last time. Constraints: DateTime, formatted to ISO 8601 standard, i.e. 2023-12-01T09:13:37.187+0000, Read-Only.
eventTypes
List of specific strings to use to subscribe for the notification: "order_slimcollectpay.update": All the order notifications linked to SlimCollect Pay. "order_slimcollectverify.update": All the order notifications linked to SlimCollect Verify. "mandate_slimcollectpay.update": All the mandate notifications linked to SlimCollect Pay. "mandate_slimcollectverify.update": All the mandate notifications linked to SlimCollect Verify. "payment_slimcollectpay.update": All the payment transfer notifications linked to SlimCollect Pay: Constraints: Array of string, i.e. ["order_slimcollectpay.update"], Read-Only.

2. create-webhook (relation)

Description: Create a webhook.

Properties
creditor » reference
The unique identifier of a SlimPay account, allocated by SlimPay. Constraints: Text, 35 characters or less, Read-Write.
title
A name given to the webhook. Constraints: Text, 100 characters or less, Read-Write.
description
A description associated to the webhook. Constraints: Text, 255 characters or less, Read-Write.
url
The URL of the server where SlimPay will send all the notifications related to the chosen event types. Note: a same url can be added to different webhook. Constraints: Text, 255 characters or less, Read-Only.
eventTypes
List of specific strings to use to subscribe for the notification: "order_slimcollectpay.update": All the order notifications linked to SlimCollect Pay. "order_slimcollectverify.update": All the order notifications linked to SlimCollect Verify. "mandate_slimcollectpay.update": All the mandate notifications linked to SlimCollect Pay. "mandate_slimcollectverify.update": All the mandate notifications linked to SlimCollect Verify. "payment_slimcollectpay.update": All the payment transfer notifications linked to SlimCollect Pay: Constraints: Array of string, i.e. ["order_slimcollectpay.update"], Read-Only.
Example: Create webhook configuration
Request
POST follow(https://api.slimpay.net/alps#create-webhook) 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": "creditor"
    },
    "title": "SlimCollect payment subscription",
    "description": "SlimCollect payment subscription details",
    "url": "https://merchant.com/webhook",
    "enabled": true,
    "eventTypes": [
        "mandate_slimcollectverify.update",
        "order_slimcollectpay.update"
    ]
}
Response
HTTP/1.1 201 Created
Content-Type: application/hal+json; profile="https://api.slimpay.net/alps/v1";charset=UTF-8
Content-Length: 1473

{
    "dateCreated": "2023-08-11T11:09:51.463+0000",
    "dateModified": "2023-08-11T11:09:51.463+0000",
    "description": "SlimCollect payment subscription details",
    "enabled": true,
    "eventTypes": [
        "mandate_slimcollectverify.update",
        "order_slimcollectpay.update"
    ],
    "id": "073f16f8-5303-11ef-87f6-edbb2502f725",
    "secret": "secretKey",
    "title": "SlimCollect payment subscription",
    "url": "https://merchant.com/webhook",
    "_links": {
        "self": {
            "href": "https://api.slimpay.net/v1/webhook-configurations/073f16f8-5303-11ef-87f6-edbb2502f725"
        },
        "profile": {
            "href": "https://api.slimpay.net/alps/v1/webhook-configurations"
        },
        "https://api.slimpay.net/alps#put-webhook": {
            "href": "https://api.slimpay.net/v1/webhook-configurations/073f16f8-5303-11ef-87f6-edbb2502f725"
        },
        "https://api.slimpay.net/alps#delete-webhook": {
            "href": "https://api.slimpay.net/v1/webhook-configurations/073f16f8-5303-11ef-87f6-edbb2502f725"
        }
    }
}

3. delete-webhook (relation)

Description: Delete a specific webhook.

Properties
id
The webhook id. Constraints: 36 characters, Read-Only.
Example: delete webhook configuration
Request
DELETE follow(https://api.slimpay.net/alps#delete-webhook) HTTP/1.1
Accept: application/hal+json; profile="https://api.slimpay.net/alps/v1"
Content-Type: application/json
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: 1473

[]

4. get-webhook (relation)

Description: Retrieve a specific webhook.

Properties
id
The webhook id. Constraints: 36 characters, Read-Only.
Example: Retrieve webhook representation by id
Request
GET follow(https://api.slimpay.net/alps#get-webhook) 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: 705

{
    "dateCreated": "2024-08-01T09:59:28.737+0000",
    "dateModified": "2024-08-01T09:59:28.752+0000",
    "description": "",
    "enabled": true,
    "eventTypes": [
        "mandate_slimcollectverify.update",
        "order_slimcollectpay.update"
    ],
    "id": "073f16f8-5303-11ef-87f6-edbb2502f725",
    "title": "my webhook for payment update",
    "url": "https://www.slimpay.com/",
    "_links": {
        "self": {
            "href": "https://api.slimpay.net/v1/webhook-configurations/073f16f8-5303-11ef-87f6-edbb2502f725"
        },
        "profile": {
            "href": "https://api.slimpay.net/alps/v1/webhook-configurations"
        },
        "https://api.slimpay.net/alps#put-webhook": {
            "href": "https://api.slimpay.net/v1/webhook-configurations/073f16f8-5303-11ef-87f6-edbb2502f725"
        },
        "https://api.slimpay.net/alps#delete-webhook": {
            "href": "https://api.slimpay.net/v1/webhook-configurations/073f16f8-5303-11ef-87f6-edbb2502f725"
        }
    }
}

5. get-webhooks (relation)

Description: Retrieve all the webhook for a specific merchant.

Properties
creditorReference
The unique identifier of a SlimPay account, allocated by SlimPay. Constraints: Text, 35 characters or less, Read-Write.
Example: Get all webhook configuration
Request
PUT follow(https://api.slimpay.net/alps#get-webhooks) HTTP/1.1
Accept: application/hal+json; profile="https://api.slimpay.net/alps/v1"
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJhcGkiXSwiZXhwIjoxNTMwNjMzNTk0LCJqdGkiOiI2ODNmNGE1Ni1kZjQ3LTQ0ZWYtYmIxYy02MDJhYmFlNGYwYjgiLCJjbGllbnRfaWQiOiJkZW1vY3JlZGl0b3IwMSJ9.VSmbmu4upmKj5_lTiBlqtbqSH42yx83AB1IFXJs08Tw

{
    "creditorReference": "reference"
}
Response
HTTP/1.1 200 OK
Content-Type: application/hal+json; profile="https://api.slimpay.net/alps/v1";charset=UTF-8
Content-Length: 1473

{
    "_embedded": {
        "webhooks": [
            {
                "_links": {
                    "self": {
                        "href": "http://localhost:9580/api/v1/webhook-configurations/831df65a-7e33-4789-9b51-a27dc4996b6b"
                    },
                    "profile": {
                        "href": "http://localhost:9580/api/alps/v1/webhook-configurations"
                    },
                    "https://api.slimpay.net/alps#put-webhook": {
                        "href": "http://localhost:9580/api/v1/webhook-configurations"
                    },
                    "https://api.slimpay.net/alps#delete-webhook": {
                        "href": "http://localhost:9580/api/v1/webhook-configurations/831df65a-7e33-4789-9b51-a27dc4996b6b"
                    }
                },
                "id": "831df65a-7e33-4789-9b51-a27dc4996b6b",
                "title": "my webhook for payment update",
                "url": "https://www.slimpay.com/payment",
                "eventTypes": [
                    "payment_slimcollectpay.update",
                    "order_slimcollectpay.update"
                ],
                "enabled": true
            },
            {
                "_links": {
                    "self": {
                        "href": "http://localhost:9580/api/v1/webhook-configurations/073f16f8-5303-11ef-87f6-edbb2502f725"
                    },
                    "profile": {
                        "href": "http://localhost:9580/api/alps/v1/webhook-configurations"
                    },
                    "https://api.slimpay.net/alps#put-webhook": {
                        "href": "http://localhost:9580/api/v1/webhook-configurations"
                    },
                    "https://api.slimpay.net/alps#delete-webhook": {
                        "href": "http://localhost:9580/api/v1/webhook-configurations/073f16f8-5303-11ef-87f6-edbb2502f725"
                    }
                },
                "id": "073f16f8-5303-11ef-87f6-edbb2502f725",
                "title": "my webhook for order update",
                "url": "https://www.slimpay.com/order",
                "eventTypes": [
                    "payment_slimcollectpay.update"
                ],
                "enabled": false
            }
        ]
    }
}

6. update-webhook (relation)

Description: Update a specific webhook with new parameters.

Properties
id
The webhook id. Constraints: 36 characters, Read-Only.
title
A name given to the webhook. Constraints: Text, 100 characters or less, Read-Write.
url
The URL of the server where SlimPay will send all the notifications related to the chosen event types. Note: a same url can be added to different webhook. Constraints: Text, 255 characters or less, Read-Only.
creditor » reference
The unique identifier of a SlimPay account, allocated by SlimPay. Constraints: Text, 35 characters or less, Read-Write.
eventTypes
List of specific strings to use to subscribe for the notification: "order_slimcollectpay.update": All the order notifications linked to SlimCollect Pay. "order_slimcollectverify.update": All the order notifications linked to SlimCollect Verify. "mandate_slimcollectpay.update": All the mandate notifications linked to SlimCollect Pay. "mandate_slimcollectverify.update": All the mandate notifications linked to SlimCollect Verify. "payment_slimcollectpay.update": All the payment transfer notifications linked to SlimCollect Pay: Constraints: Array of string, i.e. ["order_slimcollectpay.update"], Read-Only.
enabled
Boolean to confirm if the webhook is enabled or not. Constraints: boolean, Read-Write.
Example: Update webhook configuration
Request
PUT follow(https://api.slimpay.net/alps#update-webhook) HTTP/1.1
Accept: application/hal+json; profile="https://api.slimpay.net/alps/v1"
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJhcGkiXSwiZXhwIjoxNTMwNjMzNTk0LCJqdGkiOiI2ODNmNGE1Ni1kZjQ3LTQ0ZWYtYmIxYy02MDJhYmFlNGYwYjgiLCJjbGllbnRfaWQiOiJkZW1vY3JlZGl0b3IwMSJ9.VSmbmu4upmKj5_lTiBlqtbqSH42yx83AB1IFXJs08Tw

{
    "id": "073f16f8-5303-11ef-87f6-edbb2502f725",
    "title": "title in DB",
    "url": "https://www.merchant.com/notification",
    "creditor": {
        "reference": "my site"
    },
    "eventTypes": [
        "payment_slimcollectpay.update"
    ],
    "enabled": false
}
Response
HTTP/1.1 200 OK
Content-Type: application/hal+json; profile="https://api.slimpay.net/alps/v1";charset=UTF-8
Content-Length: 1473

{
    "dateCreated": "2023-08-11T11:10:00.074+0000",
    "enabled": false,
    "eventTypes": [
        "payment_slimcollectpay.update"
    ],
    "id": "073f16f8-5303-11ef-87f6-edbb2502f725",
    "title": "title in DB",
    "url": "https://www.merchant.com/notification",
    "_links": {
        "self": {
            "href": "https://api.slimpay.net/v1/webhook-configurations/073f16f8-5303-11ef-87f6-edbb2502f725"
        },
        "profile": {
            "href": "https://api.slimpay.net/alps/v1/webhook-configurations"
        },
        "https://api.slimpay.net/alps#put-webhook": {
            "href": "https://api.slimpay.net/v1/webhook-configurations/073f16f8-5303-11ef-87f6-edbb2502f725"
        },
        "https://api.slimpay.net/alps#delete-webhook": {
            "href": "https://api.slimpay.net/v1/webhook-configurations/073f16f8-5303-11ef-87f6-edbb2502f725"
        }
    }
}