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.

credit-transfers

  1. credit-transfer-representation
  2. credit-transfers-representation
  3. cancel-credit-transfer
  4. create-credit-transfers
  5. get-credit-transfer
  6. get-credit-transfers
  7. patch-credit-transfer
  8. search-credit-transfers

1. credit-transfer-representation

Description: A credit transfer representation. A credit transfer is a payment initiated by a debtor from his bank account to another bank account.

Properties
id
The credit transfer id. Constraints: 36 characters or less, Read-Only.
amount
The amount of the credit transfer. Constraints: Number, 22 characters or less, Read-Write.
currency
The currency. Constraints: Text among EUR|GBP, Read-Write.
paymentReference
Value provided by the user to specify a payment reference. Constraints: 35 characters or less, Read-Write.
label
Value provided by the user to specify a label. Constraints: 140 characters or less, Read-Write.
executionDate
Indicates when the credit transfer should be executed. If missing from the request, the closest possible value is computed according to SEPA rules. Constraints: 140 characters or less, Read-Write.
executionStatus
The credit transfer execution status. Constraints: Text among processing|rejected|processed|notprocessed|transformed|contested|toreplay|togenerate|toprocess, Read-Only.
dateCreated
The date the mandate has been created. Constraints: DateTime, ISO8601, Read-Only.
dateBooked
The credit transfer booking date. Constraints: DateTime, ISO8601, Read-Only.
dateValued
The credit transfer value date. Constraints: DateTime, ISO8601, Read-Only.

2. credit-transfers-representation

Description: A collection of credit transfers.

3. cancel-credit-transfer (relation)

Description: Cancel a credit transfer of which executionStatus property is either toprocess or toreplay.

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: Cancel one credit transfer
Request
POST follow(https://api.slimpay.net/alps#cancel-credit-transfer) 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: 829

{
    "amount": "1.00",
    "currency": "EUR",
    "dateCreated": "2017-03-02T16:56:01.000+0000",
    "executionDate": "2017-03-01T23:00:00.000+0000",
    "executionStatus": "notprocessed",
    "id": "1dcd6ddf-ff69-11e6-83f6-000000000000",
    "label": "The label",
    "paymentReference": "Payment 123",
    "_links": {
        "https://api.slimpay.net/alps#get-subscriber": {
            "href": "https://api-sandbox.slimpay.net/creditors/democreditor/subscribers/subscriber01"
        },
        "https://api.slimpay.net/alps#get-creditor": {
            "href": "https://api-sandbox.slimpay.net/creditors/democreditor"
        },
        "self": {
            "href": "https://api-sandbox.slimpay.net/credit-transfers/1dcd6ddf-ff69-11e6-83f6-000000000000"
        },
        "profile": {
            "href": "https://api-sandbox.slimpay.net/alps/v1/credit-transfers"
        }
    }
}

4. create-credit-transfers (relation)

Description: Create a credit transfer. You must specify a subscriber with a reference. When the subscriber is given, SlimPay will create the credit transfer against the bank account for this subscriber. If a creditor entity is required, it can be passed within the creditor.

Properties
amount
The amount of the credit transfer. Constraints: Number, 22 characters or less, Read-Write.
currency
The currency. Constraints: Text among EUR|GBP, Read-Write.
paymentReference
Value provided by the user to specify a payment reference. Constraints: 35 characters or less, Read-Write.
label
Value provided by the user to specify a label. Constraints: 140 characters or less, Read-Write.
executionDate
Indicates when the credit transfer should be executed. If missing from the request, the closest possible value is computed according to SEPA rules. Constraints: 140 characters or less, Read-Write.
creditor » reference
The creditor reference within the SlimPay referential. This reference is given by SlimPay. Constraints: Text, 35 characters or less, Read-Write.
creditor » entity » reference
The entity reference within the SlimPay referential. It is is given 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.
Example: Create one credit transfer by subscriber reference
Request
POST follow(https://api.slimpay.net/alps#create-credit-transfers) HTTP/1.1
Accept: application/hal+json; profile="https://api.slimpay.net/alps/v1"
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJhcGkiXSwiZXhwIjoxNDg4NDc0NzI1LCJqdGkiOiI3OThhNGEyYy1hOGE4LTQwNmItOGY0YS1mMjE3ZmNhMTM5YjciLCJjbGllbnRfaWQiOiJkZW1vY3JlZGl0b3IwMSJ9.VoN5FoWOoPfLkJU15ZIcYp2iRam4WJoVfMBw_35XCkw

{
    "creditor": {
        "reference": "democreditor"
    },
    "subscriber": {
        "reference": "subscriber01"
    },
    "amount": 1,
    "currency": "EUR",
    "label": "The label",
    "paymentReference": "Payment 123"
}
Response
HTTP/1.1 201 Created
Content-Type: application/hal+json; profile="https://api.slimpay.net/alps/v1";charset=UTF-8
Content-Length: 1182

{
    "amount": "1.00",
    "currency": "EUR",
    "dateCreated": "2017-03-02T16:56:01.519+0000",
    "executionDate": "2017-03-01T23:00:00.000+0000",
    "executionStatus": "toprocess",
    "id": "1da2181e-ff69-11e6-83f6-000000000000",
    "label": "The label",
    "paymentReference": "Payment 123",
    "_links": {
        "https://api.slimpay.net/alps#patch-credit-transfer": {
            "href": "https://api-sandbox.slimpay.net/credit-transfers/1da2181e-ff69-11e6-83f6-000000000000"
        },
        "https://api.slimpay.net/alps#get-creditor": {
            "href": "https://api-sandbox.slimpay.net/creditors/democreditor"
        },
        "self": {
            "href": "https://api-sandbox.slimpay.net/credit-transfers/1da2181e-ff69-11e6-83f6-000000000000"
        },
        "https://api.slimpay.net/alps#cancel-credit-transfer": {
            "href": "https://api-sandbox.slimpay.net/credit-transfers/1da2181e-ff69-11e6-83f6-000000000000/cancellation"
        },
        "https://api.slimpay.net/alps#get-subscriber": {
            "href": "https://api-sandbox.slimpay.net/creditors/democreditor/subscribers/subscriber01"
        },
        "profile": {
            "href": "https://api-sandbox.slimpay.net/alps/v1/credit-transfers"
        }
    }
}

5. get-credit-transfer (relation)

Description: Get one credit transfer.

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-credit-transfers (relation)

Description: Get one one credit transfer.

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

{
    "amount": "1.00",
    "currency": "EUR",
    "dateCreated": "2016-03-17T13:10:00.000+0000",
    "executionDate": "2016-03-17T23:00:00.000+0000",
    "executionStatus": "processing",
    "id": "8e199a55-ec41-11e5-bea7-000000000000",
    "label": "label01",
    "paymentReference": "payment01",
    "_links": {
        "https://api.slimpay.net/alps#get-subscriber": {
            "href": "https://api-sandbox.slimpay.net/creditors/democreditor/subscribers/subscriber01"
        },
        "https://api.slimpay.net/alps#get-creditor": {
            "href": "https://api-sandbox.slimpay.net/creditors/democreditor"
        },
        "self": {
            "href": "https://api-sandbox.slimpay.net/credit-transfers/8e199a55-ec41-11e5-bea7-000000000000"
        },
        "profile": {
            "href": "https://api-sandbox.slimpay.net/alps/v1/credit-transfers"
        }
    }
}

7. patch-credit-transfer (relation)

Description: Patch a credit transfer.

Properties
label
Value provided by the user to specify a label. Constraints: 140 characters or less, Read-Write.
executionDate
Indicates when the credit transfer should be executed. If missing from the request, the closest possible value is computed according to SEPA rules. Constraints: 140 characters or less, Read-Write.
Example: Patch one credit transfer
Request
PATCH follow(https://api.slimpay.net/alps#patch-credit-transfer) HTTP/1.1
Accept: application/hal+json; profile="https://api.slimpay.net/alps/v1"
Content-Type: application/merge-patch+json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJhcGkiXSwiZXhwIjoxNDg4NDc0NzI1LCJqdGkiOiI3OThhNGEyYy1hOGE4LTQwNmItOGY0YS1mMjE3ZmNhMTM5YjciLCJjbGllbnRfaWQiOiJkZW1vY3JlZGl0b3IwMSJ9.VoN5FoWOoPfLkJU15ZIcYp2iRam4WJoVfMBw_35XCkw

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

{
    "amount": "1.00",
    "currency": "EUR",
    "dateCreated": "2017-03-02T16:56:01.000+0000",
    "executionDate": "2017-03-01T23:00:00.000+0000",
    "executionStatus": "toprocess",
    "id": "1da2181e-ff69-11e6-83f6-000000000000",
    "label": "The label New",
    "paymentReference": "Payment 123",
    "_links": {
        "https://api.slimpay.net/alps#patch-credit-transfer": {
            "href": "https://api-sandbox.slimpay.net/credit-transfers/1da2181e-ff69-11e6-83f6-000000000000"
        },
        "https://api.slimpay.net/alps#get-creditor": {
            "href": "https://api-sandbox.slimpay.net/creditors/democreditor"
        },
        "self": {
            "href": "https://api-sandbox.slimpay.net/credit-transfers/1da2181e-ff69-11e6-83f6-000000000000"
        },
        "https://api.slimpay.net/alps#cancel-credit-transfer": {
            "href": "https://api-sandbox.slimpay.net/credit-transfers/1da2181e-ff69-11e6-83f6-000000000000/cancellation"
        },
        "https://api.slimpay.net/alps#get-subscriber": {
            "href": "https://api-sandbox.slimpay.net/creditors/democreditor/subscribers/subscriber01"
        },
        "profile": {
            "href": "https://api-sandbox.slimpay.net/alps/v1/credit-transfers"
        }
    }
}

8. search-credit-transfers (relation)

Description: Search credit transfers. They will be in DESCENDING order.

Properties
creditorReference
The creditor reference within the SlimPay referential. This reference is given by SlimPay. Constraints: Text, 35 characters or less, Read-Write.
entityReference
The entity reference within the SlimPay referential. It is is given 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.
paymentReference
Value provided by the user to specify a payment reference. Constraints: 35 characters or less, Read-Write.
currency
The currency. Constraints: Text among EUR|GBP, Read-Write.
executionDateBefore
Search credit transfers that are executed or will be executed before this date. Constraints: DateTime, ISO8601, Optional.
executionDateAfter
Search credit transfers that are executed or will be executed after this date. Constraints: DateTime, ISO8601, Optional.
Example: Search credit-transfers
Request
GET follow(https://api.slimpay.net/alps#search-credit-transfers) 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: 4859

{
    "_embedded": {
        "creditTransfers": [
            {
                "executionStatus": "toprocess",
                "executionDate": "2017-03-01T23:00:00.000+0000",
                "id": "132ca331-ff69-11e6-83f6-000000000000",
                "_links": {
                    "https://api.slimpay.net/alps#patch-credit-transfer": {
                        "href": "https://api-sandbox.slimpay.net/credit-transfers/132ca331-ff69-11e6-83f6-000000000000"
                    },
                    "https://api.slimpay.net/alps#get-creditor": {
                        "href": "https://api-sandbox.slimpay.net/creditors/democreditor"
                    },
                    "self": {
                        "href": "https://api-sandbox.slimpay.net/credit-transfers/132ca331-ff69-11e6-83f6-000000000000"
                    },
                    "https://api.slimpay.net/alps#cancel-credit-transfer": {
                        "href": "https://api-sandbox.slimpay.net/credit-transfers/132ca331-ff69-11e6-83f6-000000000000/cancellation"
                    },
                    "https://api.slimpay.net/alps#get-subscriber": {
                        "href": "https://api-sandbox.slimpay.net/creditors/democreditor/subscribers/subscriber01"
                    },
                    "profile": {
                        "href": "https://api-sandbox.slimpay.net/alps/v1/credit-transfers"
                    }
                },
                "label": "The label",
                "dateCreated": "2017-03-02T16:55:43.000+0000",
                "amount": "1.00",
                "currency": "EUR",
                "paymentReference": "Payment 123"
            },
            {
                "executionStatus": "toprocess",
                "executionDate": "2017-03-01T23:00:00.000+0000",
                "id": "12fd2ec0-ff69-11e6-83f6-000000000000",
                "_links": {
                    "https://api.slimpay.net/alps#patch-credit-transfer": {
                        "href": "https://api-sandbox.slimpay.net/credit-transfers/12fd2ec0-ff69-11e6-83f6-000000000000"
                    },
                    "https://api.slimpay.net/alps#get-creditor": {
                        "href": "https://api-sandbox.slimpay.net/creditors/democreditor"
                    },
                    "self": {
                        "href": "https://api-sandbox.slimpay.net/credit-transfers/12fd2ec0-ff69-11e6-83f6-000000000000"
                    },
                    "https://api.slimpay.net/alps#cancel-credit-transfer": {
                        "href": "https://api-sandbox.slimpay.net/credit-transfers/12fd2ec0-ff69-11e6-83f6-000000000000/cancellation"
                    },
                    "https://api.slimpay.net/alps#get-subscriber": {
                        "href": "https://api-sandbox.slimpay.net/creditors/democreditor/subscribers/subscriber01"
                    },
                    "profile": {
                        "href": "https://api-sandbox.slimpay.net/alps/v1/credit-transfers"
                    }
                },
                "label": "The label",
                "dateCreated": "2017-03-02T16:55:43.000+0000",
                "amount": "1.00",
                "currency": "EUR",
                "paymentReference": "Payment 123"
            },
            {
                "executionStatus": "toprocess",
                "executionDate": "2017-03-01T23:00:00.000+0000",
                "id": "7a3610e4-ff57-11e6-83f6-000000000000",
                "_links": {
                    "https://api.slimpay.net/alps#patch-credit-transfer": {
                        "href": "https://api-sandbox.slimpay.net/credit-transfers/7a3610e4-ff57-11e6-83f6-000000000000"
                    },
                    "https://api.slimpay.net/alps#get-creditor": {
                        "href": "https://api-sandbox.slimpay.net/creditors/testmerchant"
                    },
                    "self": {
                        "href": "https://api-sandbox.slimpay.net/credit-transfers/7a3610e4-ff57-11e6-83f6-000000000000"
                    },
                    "https://api.slimpay.net/alps#cancel-credit-transfer": {
                        "href": "https://api-sandbox.slimpay.net/credit-transfers/7a3610e4-ff57-11e6-83f6-000000000000/cancellation"
                    },
                    "https://api.slimpay.net/alps#get-subscriber": {
                        "href": "https://api-sandbox.slimpay.net/creditors/testmerchant/subscribers/QualityAssurance-4303406"
                    },
                    "profile": {
                        "href": "https://api-sandbox.slimpay.net/alps/v1/credit-transfers"
                    }
                },
                "dateCreated": "2017-03-02T14:49:45.000+0000",
                "amount": "1.00",
                "currency": "EUR",
                "paymentReference": "REB-EXE-20170302-1863"
            }
        ]
    },
    "page": {
        "totalPages": 413,
        "totalElements": 1237,
        "size": 3,
        "number": 0
    },
    "_links": {
        "last": {
            "href": "https://api-sandbox.slimpay.net/credit-transfers?creditorReference=democreditor&page=412&size=3"
        },
        "search": {
            "href": "https://api-sandbox.slimpay.net/credit-transfers{?creditorReference,entityReference,subscriberReference,mandateReference,paymentReference,currency,executionDateBefore,executionDateAfter,page,size}",
            "templated": true
        },
        "self": {
            "href": "https://api-sandbox.slimpay.net/credit-transfers?creditorReference=democreditor&size=3"
        },
        "next": {
            "href": "https://api-sandbox.slimpay.net/credit-transfers?creditorReference=democreditor&page=1&size=3"
        },
        "first": {
            "href": "https://api-sandbox.slimpay.net/credit-transfers?creditorReference=democreditor&page=0&size=3"
        }
    }
}