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.

payment-issues

  1. payment-issue-representation
  2. payment-issues-representation
  3. ack-payment-issue
  4. get-payment-issue
  5. get-payment-issues
  6. search-payment-issue-by-id
  7. search-payment-issues

1. payment-issue-representation

Description: A representation of a payment issue resource. A payment issue (also known as an R-Transaction) is a failed direct debit or card transaction.

Properties
id
The payment issue id. Constraints: 36 characters or less, Read-Only.
rejectAmount
The amount of the rejected payment. Constraints: Number, 22 characters or less, Read-Only.
currency
The currency of the rejected payment. Constraints: Text, an ISO 4217 standard currency code, set to EUR, Read-Write.
executionStatus
The payment execution status. Constraints: Text, set to processing, rejected, processed, notprocessed, transformed, contested, toreplay, togenerate or toprocess, Read-Only.
rejectReason
The reject reason of the payment. Constraints: Text, 255 characters or less, Read-Only.
returnReasonCode
An ISO 20022 standard return reason code, offering details on why the payment failed. Constraints: 4 characters or less, Read-Only.
type
The type of payment issue. Constraints: Text, set to revocation, requestForCancellation, rejects, refusal, returns, refunds or reversal, Read-Only.
dateCreated
The date the payment issue was created. Constraints: DateTime, formatted to ISO 8601 standard, Read-Only.

2. payment-issues-representation

Description: A collection of payment issue representations.

3. ack-payment-issue (relation)

Description: Acknowledge a payment issue. This operation results in converting the payment issue's executionStatus to processed, where 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 payment issue
Request
POST follow(https://api.slimpay.net/alps#ack-payment-issue) HTTP/1.1
Accept: application/hal+json; profile="https://api.slimpay.net/alps/v1"
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJhcGkiXSwiZXhwIjoxNTMwNjMzNTk0LCJqdGkiOiI2ODNmNGE1Ni1kZjQ3LTQ0ZWYtYmIxYy02MDJhYmFlNGYwYjgiLCJjbGllbnRfaWQiOiJkZW1vY3JlZGl0b3IwMSJ9.VSmbmu4upmKj5_lTiBlqtbqSH42yx83AB1IFXJs08Tw

4. get-payment-issue (relation)

Description: Retrieve the representation of a single payment issue 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!

5. get-payment-issues (relation)

Description: Retrieve a collection of payment issue resources, returned in descending 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!

6. search-payment-issue-by-id (relation)

Description: Search for the representation of a specific payment issue, using id as the search parameter.

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

{
    "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": {
        "self": {
            "href": "https://api.preprod.slimpay.com/payment-issues/70d91284-0b33-11e5-b1a9-1d89409ab21b"
        },
        "profile": {
            "href": "https://api.preprod.slimpay.com/alps/v1/payment-issues"
        },
        "https://api.slimpay.net/alps#get-payment": {
            "href": "https://api.preprod.slimpay.com/payments/de753e94-0afc-11e5-b1a9-653908a566e3"
        }
    }
}

7. search-payment-issues (relation)

Description: Search for the representations of payment issue resources. These will be returned in a collection, 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.
currency
The currency of the rejected payment. Constraints: Text, an ISO 4217 standard currency code, set to EUR, Read-Write.
scheme
The payment scheme, which allows the user to specify whether the payment issue is a direct debit or a card transaction. Constraints: Text, set to SEPA.DIRECT_DEBIT.CORE, SEPA.DIRECT_DEBIT.B2B or CARD, Read-Write
executionStatus
The payment execution status. Constraints: Text, set to processing, rejected, processed, notprocessed, transformed, contested, toreplay, togenerate or toprocess (optional).
dateCreatedBefore
Search payment issues created before this date. Constraints: DateTime, formatted to ISO 8601 standard (optional).
dateCreatedAfter
Search payment issues created after this date. Constraints: DateTime, formatted to ISO 8601 standard (optional).
Example: Search payment issues
Request
GET follow(https://api.slimpay.net/alps#search-payment-issues) 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: 8752

{
    "_embedded": {
        "paymentIssues": [
            {
                "_links": {
                    "self": {
                        "href": "https://api.preprod.slimpay.com/payment-issues/ecaa67da-7ed3-11e8-bf72-000000000000"
                    },
                    "profile": {
                        "href": "https://api.preprod.slimpay.com/alps/v1/payment-issues"
                    },
                    "https://api.slimpay.net/alps#get-payment": {
                        "href": "https://api.preprod.slimpay.com/payments/ec4eb349-7ed3-11e8-bf72-000000000000"
                    }
                },
                "id": "ecaa67da-7ed3-11e8-bf72-000000000000",
                "rejectAmount": "100.00",
                "currency": "EUR",
                "rejectReason": "sepaReturnReasonCode.focr.reason",
                "returnReasonCode": "FOCR",
                "type": "rejects",
                "executionStatus": "toprocess",
                "dateCreated": "2018-07-03T15:15:31.000+0000"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.preprod.slimpay.com/payment-issues/e20cd17c-7ed3-11e8-bf72-000000000000"
                    },
                    "profile": {
                        "href": "https://api.preprod.slimpay.com/alps/v1/payment-issues"
                    },
                    "https://api.slimpay.net/alps#get-payment": {
                        "href": "https://api.preprod.slimpay.com/payments/de1f91b5-7ed3-11e8-bf72-000000000000"
                    }
                },
                "id": "e20cd17c-7ed3-11e8-bf72-000000000000",
                "rejectAmount": "100.00",
                "currency": "EUR",
                "rejectReason": "sepaReturnReasonCode.focr.reason",
                "returnReasonCode": "FOCR",
                "type": "rejects",
                "executionStatus": "toprocess",
                "dateCreated": "2018-07-03T15:15:13.000+0000"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.preprod.slimpay.com/payment-issues/2aa74c61-7ece-11e8-bf72-000000000000"
                    },
                    "profile": {
                        "href": "https://api.preprod.slimpay.com/alps/v1/payment-issues"
                    },
                    "https://api.slimpay.net/alps#get-payment": {
                        "href": "https://api.preprod.slimpay.com/payments/2a5d7220-7ece-11e8-bf72-000000000000"
                    }
                },
                "id": "2aa74c61-7ece-11e8-bf72-000000000000",
                "rejectAmount": "100.00",
                "currency": "EUR",
                "rejectReason": "sepaReturnReasonCode.focr.reason",
                "returnReasonCode": "FOCR",
                "type": "rejects",
                "executionStatus": "processed",
                "dateCreated": "2018-07-03T14:34:18.000+0000"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.preprod.slimpay.com/payment-issues/204d27a0-7ece-11e8-bf72-000000000000"
                    },
                    "profile": {
                        "href": "https://api.preprod.slimpay.com/alps/v1/payment-issues"
                    },
                    "https://api.slimpay.net/alps#get-payment": {
                        "href": "https://api.preprod.slimpay.com/payments/1cc18fdc-7ece-11e8-bf72-000000000000"
                    }
                },
                "id": "204d27a0-7ece-11e8-bf72-000000000000",
                "rejectAmount": "100.00",
                "currency": "EUR",
                "rejectReason": "sepaReturnReasonCode.focr.reason",
                "returnReasonCode": "FOCR",
                "type": "rejects",
                "executionStatus": "processed",
                "dateCreated": "2018-07-03T14:34:01.000+0000"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.preprod.slimpay.com/payment-issues/f53ceaf3-7ec4-11e8-bf72-000000000000"
                    },
                    "profile": {
                        "href": "https://api.preprod.slimpay.com/alps/v1/payment-issues"
                    },
                    "https://api.slimpay.net/alps#get-payment": {
                        "href": "https://api.preprod.slimpay.com/payments/f4f02a82-7ec4-11e8-bf72-000000000000"
                    }
                },
                "id": "f53ceaf3-7ec4-11e8-bf72-000000000000",
                "rejectAmount": "100.00",
                "currency": "EUR",
                "rejectReason": "sepaReturnReasonCode.focr.reason",
                "returnReasonCode": "FOCR",
                "type": "rejects",
                "executionStatus": "processed",
                "dateCreated": "2018-07-03T13:28:23.000+0000"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.preprod.slimpay.com/payment-issues/eb79d511-7ec4-11e8-bf72-000000000000"
                    },
                    "profile": {
                        "href": "https://api.preprod.slimpay.com/alps/v1/payment-issues"
                    },
                    "https://api.slimpay.net/alps#get-payment": {
                        "href": "https://api.preprod.slimpay.com/payments/e79547dd-7ec4-11e8-bf72-000000000000"
                    }
                },
                "id": "eb79d511-7ec4-11e8-bf72-000000000000",
                "rejectAmount": "100.00",
                "currency": "EUR",
                "rejectReason": "sepaReturnReasonCode.focr.reason",
                "returnReasonCode": "FOCR",
                "type": "rejects",
                "executionStatus": "processed",
                "dateCreated": "2018-07-03T13:28:06.000+0000"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.preprod.slimpay.com/payment-issues/893fc406-7ec3-11e8-bf72-000000000000"
                    },
                    "profile": {
                        "href": "https://api.preprod.slimpay.com/alps/v1/payment-issues"
                    },
                    "https://api.slimpay.net/alps#get-payment": {
                        "href": "https://api.preprod.slimpay.com/payments/887b3b85-7ec3-11e8-bf72-000000000000"
                    }
                },
                "id": "893fc406-7ec3-11e8-bf72-000000000000",
                "rejectAmount": "100.00",
                "currency": "EUR",
                "rejectReason": "sepaReturnReasonCode.focr.reason",
                "returnReasonCode": "FOCR",
                "type": "rejects",
                "executionStatus": "processed",
                "dateCreated": "2018-07-03T13:18:12.000+0000"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.preprod.slimpay.com/payment-issues/79876965-7ec3-11e8-bf72-000000000000"
                    },
                    "profile": {
                        "href": "https://api.preprod.slimpay.com/alps/v1/payment-issues"
                    },
                    "https://api.slimpay.net/alps#get-payment": {
                        "href": "https://api.preprod.slimpay.com/payments/737f5ff1-7ec3-11e8-bf72-000000000000"
                    }
                },
                "id": "79876965-7ec3-11e8-bf72-000000000000",
                "rejectAmount": "100.00",
                "currency": "EUR",
                "rejectReason": "sepaReturnReasonCode.focr.reason",
                "returnReasonCode": "FOCR",
                "type": "rejects",
                "executionStatus": "processed",
                "dateCreated": "2018-07-03T13:17:46.000+0000"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.preprod.slimpay.com/payment-issues/321b430d-7ec3-11e8-bf72-000000000000"
                    },
                    "profile": {
                        "href": "https://api.preprod.slimpay.com/alps/v1/payment-issues"
                    },
                    "https://api.slimpay.net/alps#get-payment": {
                        "href": "https://api.preprod.slimpay.com/payments/31b72a0c-7ec3-11e8-bf72-000000000000"
                    }
                },
                "id": "321b430d-7ec3-11e8-bf72-000000000000",
                "rejectAmount": "100.00",
                "currency": "EUR",
                "rejectReason": "sepaReturnReasonCode.focr.reason",
                "returnReasonCode": "FOCR",
                "type": "rejects",
                "executionStatus": "processed",
                "dateCreated": "2018-07-03T13:15:46.000+0000"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.preprod.slimpay.com/payment-issues/25441058-7ec3-11e8-bf72-000000000000"
                    },
                    "profile": {
                        "href": "https://api.preprod.slimpay.com/alps/v1/payment-issues"
                    },
                    "https://api.slimpay.net/alps#get-payment": {
                        "href": "https://api.preprod.slimpay.com/payments/20ba9092-7ec3-11e8-bf72-000000000000"
                    }
                },
                "id": "25441058-7ec3-11e8-bf72-000000000000",
                "rejectAmount": "100.00",
                "currency": "EUR",
                "rejectReason": "sepaReturnReasonCode.focr.reason",
                "returnReasonCode": "FOCR",
                "type": "rejects",
                "executionStatus": "processed",
                "dateCreated": "2018-07-03T13:15:24.000+0000"
            }
        ]
    },
    "page": {
        "size": 10,
        "totalElements": 752712,
        "totalPages": 75272,
        "number": 0
    },
    "_links": {
        "first": {
            "href": "https://api.preprod.slimpay.com/payment-issues?creditorReference=democreditor&scheme=SEPA.DIRECT_DEBIT.CORE&page=0&size=10"
        },
        "self": {
            "href": "https://api.preprod.slimpay.com/payment-issues?creditorReference=democreditor&scheme=SEPA.DIRECT_DEBIT.CORE"
        },
        "next": {
            "href": "https://api.preprod.slimpay.com/payment-issues?creditorReference=democreditor&scheme=SEPA.DIRECT_DEBIT.CORE&page=1&size=10"
        },
        "last": {
            "href": "https://api.preprod.slimpay.com/payment-issues?creditorReference=democreditor&scheme=SEPA.DIRECT_DEBIT.CORE&page=75271&size=10"
        },
        "search": {
            "href": "https://api.preprod.slimpay.com/payment-issues{?creditorReference,entityReference,subscriberReference,scheme,currency,executionStatus,dateCreatedBefore,dateCreatedAfter,page,size}",
            "templated": true
        }
    }
}