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.

direct-debit-issues

  1. direct-debit-issue-representation
  2. direct-debit-issues-representation
  3. ack-direct-debit-issue
  4. get-direct-debit-issue
  5. get-direct-debit-issues
  6. search-direct-debit-issues

1. direct-debit-issue-representation

Description: A direct debit issue representation. A direct debit issue, also known as R-Transaction, is an issue that can happen when executing a direct debit.

Properties
id
The direct debit issue id. Constraints: 36 characters or less, Read-Only.
rejectAmount
The reject amount of the direct debit. Constraints: Number, 22 characters or less, Read-Only.
currency
The currency. Constraints: Test among EUR|GBP, Read-Write.
executionStatus
The direct debit execution status. Constraints: Text among processing|rejected|processed|notprocessed|transformed|contested|toreplay|togenerate|toprocess, Read-Only.
rejectReason
The reject reason of the direct debit. Constraints: 255 characters or less, Read-Only.
returnReasonCode
ISO-20022 return reason code. Constraints: 4 characters or less, Read-Only.
type
The issue type. Constraints: Text among revocation|requestForCancellation|rejects|refusal|returns|refunds|reversal, Read-Only.
dateCreated
The direct debit issue creation date. Constraints: DateTime, Read-Only.
dateBooked
The direct debit booking date. Constraints: DateTime, ISO8601, Read-Only.
dateValued
The direct debit value date. Constraints: DateTime, ISO8601, Read-Only.

2. direct-debit-issues-representation

Description: A collection of direct-debit-issue-representation

3. ack-direct-debit-issue (relation)

Description: Acknowledge a direct debit issue. The main result of this operation is to turn the executionStatus into processed when possible.

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: Acknowledge one direct debit issue
Request
POST follow(https://api.slimpay.net/alps#ack-direct-debit-issue) HTTP/1.1
Accept: application/hal+json; profile="https://api.slimpay.net/alps/v1"

4. get-direct-debit-issue (relation)

Description: Get one direct debit issue.

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: Get one direct debit issue from a direct debit
Request
GET follow(https://api.slimpay.net/alps#get-direct-debit-issue) HTTP/1.1
Accept: application/hal+json; profile="https://api.slimpay.net/alps/v1"

5. get-direct-debit-issues (relation)

Description: Get one direct debit issue.

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

{
    "currency": "EUR",
    "dateCreated": "2015-06-05T03:32:06.000+0000",
    "executionStatus": "processed",
    "id": "70d91284-0b33-11e5-b1a9-1d89409ab21b",
    "rejectAmount": "100.00",
    "rejectReason": "rejectReason.clientMandateNotActive",
    "returnReasonCode": "MS03",
    "type": "rejects",
    "_links": {
        "https://api.slimpay.net/alps#get-direct-debit": {
            "href": "https://api-sandbox.slimpay.net/direct-debits/de753e94-0afc-11e5-b1a9-653908a566e3"
        },
        "self": {
            "href": "https://api-sandbox.slimpay.net/direct-debit-issues/70d91284-0b33-11e5-b1a9-1d89409ab21b"
        },
        "https://api.slimpay.net/alps#get-creditor": {
            "href": "https://api-sandbox.slimpay.net/creditors/democreditor"
        },
        "profile": {
            "href": "https://api-sandbox.slimpay.net/alps/v1/direct-debit-issues"
        }
    }
}

6. search-direct-debit-issues (relation)

Description: Search direct debit issues. 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.
currency
The currency. Constraints: Test among EUR|GBP, Read-Write.
executionStatus
The direct debit execution status. Constraints: Text among processing|rejected|processed|notprocessed|transformed|contested|toreplay|togenerate|toprocess, Read-Only.
dateCreatedBefore
Search direct debit issues created before this date. Constraints: DateTime, ISO8601, Optional.
dateCreatedAfter
Search direct debit issues created after this date. Constraints: DateTime, ISO8601, Optional.
Example: Search direct debit issues
Request
GET follow(https://api.slimpay.net/alps#search-direct-debit-issues) 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: 8875

{
    "_embedded": {
        "directDebitIssues": [
            {
                "returnReasonCode": "FOCR",
                "rejectAmount": "100.00",
                "executionStatus": "processed",
                "id": "a2b504ed-ff44-11e6-83f6-000000000000",
                "_links": {
                    "https://api.slimpay.net/alps#get-direct-debit": {
                        "href": "https://api-sandbox.slimpay.net/direct-debits/a26fe59c-ff44-11e6-83f6-000000000000"
                    },
                    "self": {
                        "href": "https://api-sandbox.slimpay.net/direct-debit-issues/a2b504ed-ff44-11e6-83f6-000000000000"
                    },
                    "profile": {
                        "href": "https://api-sandbox.slimpay.net/alps/v1/direct-debit-issues"
                    }
                },
                "type": "rejects",
                "dateCreated": "2017-03-02T12:34:53.000+0000",
                "rejectReason": "sepaReturnReasonCode.focr.reason",
                "currency": "EUR"
            },
            {
                "returnReasonCode": "FOCR",
                "rejectAmount": "100.00",
                "executionStatus": "processed",
                "id": "99892602-ff44-11e6-83f6-000000000000",
                "_links": {
                    "https://api.slimpay.net/alps#get-direct-debit": {
                        "href": "https://api-sandbox.slimpay.net/direct-debits/94f6cc9b-ff44-11e6-83f6-000000000000"
                    },
                    "self": {
                        "href": "https://api-sandbox.slimpay.net/direct-debit-issues/99892602-ff44-11e6-83f6-000000000000"
                    },
                    "profile": {
                        "href": "https://api-sandbox.slimpay.net/alps/v1/direct-debit-issues"
                    }
                },
                "type": "rejects",
                "dateCreated": "2017-03-02T12:34:38.000+0000",
                "rejectReason": "sepaReturnReasonCode.focr.reason",
                "currency": "EUR"
            },
            {
                "returnReasonCode": "MS03",
                "rejectAmount": "100.00",
                "executionStatus": "processed",
                "id": "327139f0-ff01-11e6-9e3d-000000000000",
                "_links": {
                    "https://api.slimpay.net/alps#get-direct-debit": {
                        "href": "https://api-sandbox.slimpay.net/direct-debits/ab0a32c1-feca-11e6-9e3d-000000000000"
                    },
                    "self": {
                        "href": "https://api-sandbox.slimpay.net/direct-debit-issues/327139f0-ff01-11e6-9e3d-000000000000"
                    },
                    "profile": {
                        "href": "https://api-sandbox.slimpay.net/alps/v1/direct-debit-issues"
                    }
                },
                "type": "rejects",
                "dateCreated": "2017-03-02T04:32:08.000+0000",
                "rejectReason": "rejectReason.clientMandateNotActive",
                "currency": "EUR"
            },
            {
                "returnReasonCode": "MS03",
                "rejectAmount": "200.00",
                "executionStatus": "processed",
                "id": "32704f8f-ff01-11e6-9e3d-000000000000",
                "_links": {
                    "https://api.slimpay.net/alps#get-direct-debit": {
                        "href": "https://api-sandbox.slimpay.net/direct-debits/aafb3ea0-feca-11e6-9e3d-000000000000"
                    },
                    "self": {
                        "href": "https://api-sandbox.slimpay.net/direct-debit-issues/32704f8f-ff01-11e6-9e3d-000000000000"
                    },
                    "profile": {
                        "href": "https://api-sandbox.slimpay.net/alps/v1/direct-debit-issues"
                    }
                },
                "type": "rejects",
                "dateCreated": "2017-03-02T04:32:08.000+0000",
                "rejectReason": "rejectReason.clientMandateNotActive",
                "currency": "EUR"
            },
            {
                "returnReasonCode": "MS03",
                "rejectAmount": "100.00",
                "executionStatus": "processed",
                "id": "326f8c3e-ff01-11e6-9e3d-000000000000",
                "_links": {
                    "https://api.slimpay.net/alps#get-direct-debit": {
                        "href": "https://api-sandbox.slimpay.net/direct-debits/aaece7bf-feca-11e6-9e3d-000000000000"
                    },
                    "self": {
                        "href": "https://api-sandbox.slimpay.net/direct-debit-issues/326f8c3e-ff01-11e6-9e3d-000000000000"
                    },
                    "profile": {
                        "href": "https://api-sandbox.slimpay.net/alps/v1/direct-debit-issues"
                    }
                },
                "type": "rejects",
                "dateCreated": "2017-03-02T04:32:08.000+0000",
                "rejectReason": "rejectReason.clientMandateNotActive",
                "currency": "EUR"
            },
            {
                "returnReasonCode": "MS03",
                "rejectAmount": "200.00",
                "executionStatus": "processed",
                "id": "326ec8ed-ff01-11e6-9e3d-000000000000",
                "_links": {
                    "https://api.slimpay.net/alps#get-direct-debit": {
                        "href": "https://api-sandbox.slimpay.net/direct-debits/aadeddfe-feca-11e6-9e3d-000000000000"
                    },
                    "self": {
                        "href": "https://api-sandbox.slimpay.net/direct-debit-issues/326ec8ed-ff01-11e6-9e3d-000000000000"
                    },
                    "profile": {
                        "href": "https://api-sandbox.slimpay.net/alps/v1/direct-debit-issues"
                    }
                },
                "type": "rejects",
                "dateCreated": "2017-03-02T04:32:08.000+0000",
                "rejectReason": "rejectReason.clientMandateNotActive",
                "currency": "EUR"
            },
            {
                "returnReasonCode": "MS03",
                "rejectAmount": "100.00",
                "executionStatus": "processed",
                "id": "326dde8c-ff01-11e6-9e3d-000000000000",
                "_links": {
                    "https://api.slimpay.net/alps#get-direct-debit": {
                        "href": "https://api-sandbox.slimpay.net/direct-debits/aacf4d9d-feca-11e6-9e3d-000000000000"
                    },
                    "self": {
                        "href": "https://api-sandbox.slimpay.net/direct-debit-issues/326dde8c-ff01-11e6-9e3d-000000000000"
                    },
                    "profile": {
                        "href": "https://api-sandbox.slimpay.net/alps/v1/direct-debit-issues"
                    }
                },
                "type": "rejects",
                "dateCreated": "2017-03-02T04:32:08.000+0000",
                "rejectReason": "rejectReason.clientMandateNotActive",
                "currency": "EUR"
            },
            {
                "returnReasonCode": "MS03",
                "rejectAmount": "200.00",
                "executionStatus": "processed",
                "id": "326d1b3b-ff01-11e6-9e3d-000000000000",
                "_links": {
                    "https://api.slimpay.net/alps#get-direct-debit": {
                        "href": "https://api-sandbox.slimpay.net/direct-debits/aac0f5bc-feca-11e6-9e3d-000000000000"
                    },
                    "self": {
                        "href": "https://api-sandbox.slimpay.net/direct-debit-issues/326d1b3b-ff01-11e6-9e3d-000000000000"
                    },
                    "profile": {
                        "href": "https://api-sandbox.slimpay.net/alps/v1/direct-debit-issues"
                    }
                },
                "type": "rejects",
                "dateCreated": "2017-03-02T04:32:08.000+0000",
                "rejectReason": "rejectReason.clientMandateNotActive",
                "currency": "EUR"
            },
            {
                "returnReasonCode": "MS03",
                "rejectAmount": "200.00",
                "executionStatus": "processed",
                "id": "326c57ea-ff01-11e6-9e3d-000000000000",
                "_links": {
                    "https://api.slimpay.net/alps#get-direct-debit": {
                        "href": "https://api-sandbox.slimpay.net/direct-debits/aab29ddb-feca-11e6-9e3d-000000000000"
                    },
                    "self": {
                        "href": "https://api-sandbox.slimpay.net/direct-debit-issues/326c57ea-ff01-11e6-9e3d-000000000000"
                    },
                    "profile": {
                        "href": "https://api-sandbox.slimpay.net/alps/v1/direct-debit-issues"
                    }
                },
                "type": "rejects",
                "dateCreated": "2017-03-02T04:32:08.000+0000",
                "rejectReason": "rejectReason.clientMandateNotActive",
                "currency": "EUR"
            },
            {
                "returnReasonCode": "MS03",
                "rejectAmount": "100.00",
                "executionStatus": "processed",
                "id": "326b6d89-ff01-11e6-9e3d-000000000000",
                "_links": {
                    "https://api.slimpay.net/alps#get-direct-debit": {
                        "href": "https://api-sandbox.slimpay.net/direct-debits/aaa445fa-feca-11e6-9e3d-000000000000"
                    },
                    "self": {
                        "href": "https://api-sandbox.slimpay.net/direct-debit-issues/326b6d89-ff01-11e6-9e3d-000000000000"
                    },
                    "profile": {
                        "href": "https://api-sandbox.slimpay.net/alps/v1/direct-debit-issues"
                    }
                },
                "type": "rejects",
                "dateCreated": "2017-03-02T04:32:08.000+0000",
                "rejectReason": "rejectReason.clientMandateNotActive",
                "currency": "EUR"
            }
        ]
    },
    "page": {
        "totalPages": 2064,
        "totalElements": 20640,
        "size": 10,
        "number": 0
    },
    "_links": {
        "last": {
            "href": "https://api-sandbox.slimpay.net/direct-debit-issues?creditorReference=democreditor&page=2063&size=10"
        },
        "search": {
            "href": "https://api-sandbox.slimpay.net/direct-debit-issues{?creditorReference,entityReference,subscriberReference,currency,executionStatus,dateCreatedBefore,dateCreatedAfter,page,size}",
            "templated": true
        },
        "self": {
            "href": "https://api-sandbox.slimpay.net/direct-debit-issues?creditorReference=democreditor"
        },
        "next": {
            "href": "https://api-sandbox.slimpay.net/direct-debit-issues?creditorReference=democreditor&page=1&size=10"
        },
        "first": {
            "href": "https://api-sandbox.slimpay.net/direct-debit-issues?creditorReference=democreditor&page=0&size=10"
        }
    }
}