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.

payments

  1. payment-representation
  2. payments-representation
  3. cancel-payment
  4. capture-payment
  5. create-payins
  6. create-payouts
  7. get-payment
  8. get-payments
  9. get-refunded-payment
  10. get-rejected-payment
  11. get-replayed-payment
  12. patch-payment
  13. refund-payment
  14. reverse-payment
  15. search-payment-by-id
  16. search-payments

1. payment-representation

Description: A payment representation. A payment is initiated by a creditor (merchant) to transfer money to or from a debtor account. A payment is mainly characterized by its scheme and by its direction.

Properties
id
The payment id. Constraints: 36 characters or less, Read-Only.
reference
Value provided by the user to specify a payment reference. Constraints: 35 characters or less, Read-Write.
scheme
The payment scheme. The payment scheme allows to specify is the payment is a direct debit, a credit transfer or a card transaction. Constraints: Text among SEPA.DIRECT_DEBIT.CORE|SEPA.DIRECT_DEBIT.B2B|SEPA.CREDIT_TRANSFER|BACS.DIRECT_DEBIT|CARD, Read-Write
direction
The payment direction. The payment direction is to be considered from the merchants point of view. If the money goes from the customer to the merchant, then the direction is IN and the payment can be called a payin. If the money goes from the merchant to the customer, then the direction is OUT and the payment can be considered a payout. Constraints: Text among IN|OUT, Read-Write.
category
The payment category. Only valid for credit transfers. Constraints: Text among funds_transfer|refund|regular, Read-Write
amount
The amount of the payment. Constraints: Number, 22 characters or less, Read-Write.
currency
The currency. Constraints: Text among EUR|GBP, Read-Write.
label
Value provided by the user to specify a label. Constraints: 140 characters or less, Read-Write.
state
The payment state. Constraints: Text among accepted|settling|settled|returned|cancelled|refunded|rejected|reversing|reversed, Read-Only.
executionDate
The desired payment execution date. If missing from the request, the closest possible value is computed according to the rules of the payment scheme (SEPA, BACS etc.). Constraints: 140 characters or less, Read-Write.
executionStatus
The payment execution status. Constraints: Text among processing|rejected|processed|notprocessed|transformed|contested|toreplay|togenerate|toprocess, Read-Only.
sequenceType
The payment sequence type. Constraints: Text among FRST|RCUR|FNAL|OOFF, Read-Only.
replayCount
The payment replay count. Constraints: Integer, Read-Only.
dateCreated
The date the payment has been created. Constraints: DateTime, ISO8601, Read-Only.
dateModified
The date the payment has been created. Constraints: DateTime, ISO8601, Read-Only.
dateBooked
The payment booking date. Constraints: DateTime, ISO8601, Read-Only.
dateValued
The payment value date. Constraints: DateTime, ISO8601, Read-Only.
capture
A flag to indicate whether a card payment should be captured or not. Default: true. Constraint: Boolean, Read-Write.
confirmed
A flag to indicate whether a payment is confirmed or not. Default: false. Constraint: Boolean, Read-Only.
processor
The payment processor defines who is responsible for processing the payment. Constraints: Text among slimpay|sofort|ideal|unknown, Read-Only.
correlationId
A correlation property that can be used by external systems for correlation purpose. Constraints: 100 characters or less, Read-Write.

2. payments-representation

Description: A collection of payments.

3. cancel-payment (relation)

Description: Cancel a payment 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 payment
Request
POST follow(https://api.slimpay.net/alps#cancel-payment) 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: 1864

{
    "amount": "100.00",
    "confirmed": false,
    "currency": "EUR",
    "dateCreated": "2018-07-03T15:44:07.000+0000",
    "dateValued": "2018-07-02T22:00:00.000+0000",
    "direction": "IN",
    "executionDate": "2018-07-03T22:00:00.000+0000",
    "executionStatus": "notprocessed",
    "id": "ebb6bcf1-7ed7-11e8-bf72-000000000000",
    "label": "The label",
    "reference": "Payment 123",
    "replayCount": 0,
    "scheme": "SEPA.DIRECT_DEBIT.CORE",
    "sequenceType": "RCUR",
    "state": "cancelled",
    "_links": {
        "self": {
            "href": "https://api.preprod.slimpay.com/payments/ebb6bcf1-7ed7-11e8-bf72-000000000000"
        },
        "profile": {
            "href": "https://api.preprod.slimpay.com/alps/v1/payments"
        },
        "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/creditors/democreditor/subscribers/subscriber01"
        },
        "https://api.slimpay.net/alps#get-payment-issues": {
            "href": "https://api.preprod.slimpay.com/payments/ebb6bcf1-7ed7-11e8-bf72-000000000000/issues"
        },
        "https://api.slimpay.net/alps#get-debtor-bank-account": {
            "href": "https://api.preprod.slimpay.com/payments/ebb6bcf1-7ed7-11e8-bf72-000000000000/debtor-bank-account"
        },
        "https://api.slimpay.net/alps#get-mandate": {
            "href": "https://api.preprod.slimpay.com/mandates/bd1055b8-2cac-11e6-a540-000000000000"
        },
        "https://api.slimpay.net/alps#get-destination-bank-account": {
            "href": "https://api.preprod.slimpay.com/bank-accounts/1724b704-a503-11e6-97cb-000000000001"
        },
        "https://api.slimpay.net/alps#get-origin-bank-account": {
            "href": "https://api.preprod.slimpay.com/bank-accounts/fcf8f80f-aa4c-11e6-a71f-000000000000"
        }
    }
}

4. capture-payment (relation)

Description: Capture a payment.

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. create-payins (relation)

Description: Create a payin. A payin is a payment with a direction IN. Can be specified a subscriber with a reference, a mandate with a reference (for a direct debit), or a card alias with a reference (for a card transaction). If a creditor entity is required, it can be passed within the creditor. When creating a direct debit, if the subscriber is given, SlimPay will create the direct debit against the last signed mandate for this subscriber. When creating a direct debit, if the mandate is given, SlimPay will create the direct debit against the given mandate. When creating a card transaction, if the subscriber is given, SlimPay will create the card transaction against the last card alias for this subscriber. When creating a card transaction, if the card alias is given, SlimPay will create the card transaction against the given card alias.

Properties
reference
Value provided by the user to specify a payment reference. Constraints: 35 characters or less, Read-Write.
correlationId
A correlation property that can be used by external systems for correlation purpose. Constraints: 100 characters or less, Read-Write.
scheme
The payment scheme. The payment scheme allows to specify is the payment is a direct debit, a credit transfer or a card transaction. Constraints: Text among SEPA.DIRECT_DEBIT.CORE|SEPA.DIRECT_DEBIT.B2B|SEPA.CREDIT_TRANSFER|BACS.DIRECT_DEBIT|CARD, Read-Write
amount
The amount of the payment. Constraints: Number, 22 characters or less, Read-Write.
currency
The currency. Constraints: Text among EUR|GBP, Read-Write.
label
Value provided by the user to specify a label. Constraints: 140 characters or less, Read-Write.
executionDate
The desired payment execution date. If missing from the request, the closest possible value is computed according to the rules of the payment scheme (SEPA, BACS etc.). Constraints: 140 characters or less, Read-Write.
capture
A flag to indicate whether a card payment should be captured or not. Default: true. Constraint: Boolean, Read-Write.
reference
Value provided by the user to specify a payment reference. Constraints: 35 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.
mandate » reference
The Unique Reference of the Mandate (attributed by SlimPay if not set by the merchant). Constraints: Text, 35 characters or less, Read-Write.
cardAlias » reference
The card alias reference. Constraints: Text, 250 characters or less, Read-Write.
Example: Create one card payin by card alias reference
Request
POST follow(https://api.slimpay.net/alps#create-payins) HTTP/1.1
Accept: application/hal+json; profile="https://api.slimpay.net/alps/v1"
Content-Type: application/json

{
    "creditor": {
        "reference": "democreditor"
    },
    "cardAlias": {
        "reference": "1692#democreditor#subscriber01"
    },
    "amount": 1,
    "label": "The label",
    "reference": "Payment 123",
    "scheme": "CARD"
}

6. create-payouts (relation)

Description: Create a payout. A payout is a payment with a direction OUT. You can specify a subscriber with a reference, or a mandate with a reference. If a creditor entity is required, it can be passed within the creditor. When the subscriber is given, SlimPay will create the payment against the last signed mandate for this subscriber. When the mandate is given, SlimPay will create the payment against the given mandate.

Properties
reference
Value provided by the user to specify a payment reference. Constraints: 35 characters or less, Read-Write.
correlationId
A correlation property that can be used by external systems for correlation purpose. Constraints: 100 characters or less, Read-Write.
scheme
The payment scheme. The payment scheme allows to specify is the payment is a direct debit, a credit transfer or a card transaction. Constraints: Text among SEPA.DIRECT_DEBIT.CORE|SEPA.DIRECT_DEBIT.B2B|SEPA.CREDIT_TRANSFER|BACS.DIRECT_DEBIT|CARD, Read-Write
category
The payment category. Only valid for credit transfers. Constraints: Text among funds_transfer|refund|regular, Read-Write
amount
The amount of the payment. Constraints: Number, 22 characters or less, Read-Write.
currency
The currency. Constraints: Text among EUR|GBP, Read-Write.
label
Value provided by the user to specify a label. Constraints: 140 characters or less, Read-Write.
executionDate
The desired payment execution date. If missing from the request, the closest possible value is computed according to the rules of the payment scheme (SEPA, BACS etc.). Constraints: 140 characters or less, Read-Write.
reference
Value provided by the user to specify a payment reference. Constraints: 35 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.
mandate » reference
The Unique Reference of the Mandate (attributed by SlimPay if not set by the merchant). Constraints: Text, 35 characters or less, Read-Write.
refundedPaymentUrl
The URL of a refunded payment.
Example: Create one refund payout by subscriber reference
Request
POST follow(https://api.slimpay.net/alps#create-payouts) 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"
    },
    "amount": 1,
    "label": "The label",
    "reference": "Payment 123",
    "scheme": "SEPA.CREDIT_TRANSFER"
}
Response
HTTP/1.1 201 Created
Content-Type: application/hal+json; profile="https://api.slimpay.net/alps/v1";charset=UTF-8
Content-Length: 1816

{
    "amount": "1.00",
    "category": "refund",
    "confirmed": false,
    "currency": "EUR",
    "dateCreated": "2018-07-03T15:44:10.641+0000",
    "direction": "OUT",
    "executionDate": "2018-07-02T22:00:00.000+0000",
    "executionStatus": "toprocess",
    "id": "edbc7803-7ed7-11e8-bf72-000000000000",
    "label": "The label",
    "processor": "slimpay",
    "reference": "Payment 123",
    "scheme": "SEPA.CREDIT_TRANSFER",
    "state": "accepted",
    "_links": {
        "self": {
            "href": "https://api.preprod.slimpay.com/payments/edbc7803-7ed7-11e8-bf72-000000000000"
        },
        "profile": {
            "href": "https://api.preprod.slimpay.com/alps/v1/payments"
        },
        "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/creditors/democreditor/subscribers/subscriber01"
        },
        "https://api.slimpay.net/alps#patch-payment": {
            "href": "https://api.preprod.slimpay.com/payments/edbc7803-7ed7-11e8-bf72-000000000000"
        },
        "https://api.slimpay.net/alps#cancel-payment": {
            "href": "https://api.preprod.slimpay.com/payments/edbc7803-7ed7-11e8-bf72-000000000000/cancellation"
        },
        "https://api.slimpay.net/alps#get-debtor-bank-account": {
            "href": "https://api.preprod.slimpay.com/payments/edbc7803-7ed7-11e8-bf72-000000000000/debtor-bank-account"
        },
        "https://api.slimpay.net/alps#get-destination-bank-account": {
            "href": "https://api.preprod.slimpay.com/bank-accounts/4b1d6e34-7e0b-11e8-abe5-000000000000"
        },
        "https://api.slimpay.net/alps#get-origin-bank-account": {
            "href": "https://api.preprod.slimpay.com/bank-accounts/1724b704-a503-11e6-97cb-000000000001"
        }
    }
}

7. get-payment (relation)

Description: Get one payment.

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!

8. get-payments (relation)

Description: Get a collection of payments.

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!

9. get-refunded-payment (relation)

Description: Get the refunded payment of one payment.

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!

10. get-rejected-payment (relation)

Description: Get the rejected payment of one payment. A rejected payment is a payment which failed and caused the creation of a replayed payment.

Properties
id
The payment id. Constraints: 36 characters or less, Read-Only.
Example: Get a rejected payment
Request
GET follow(https://api.slimpay.net/alps#get-rejected-payment) 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: 1875

{
    "amount": "192.00",
    "confirmed": false,
    "currency": "EUR",
    "dateCreated": "2015-11-17T12:54:04.000+0000",
    "dateValued": "2015-11-16T23:00:00.000+0000",
    "direction": "IN",
    "executionDate": "2015-11-23T23:00:00.000+0000",
    "executionStatus": "rejected",
    "id": "482560c4-8d2a-11e5-878b-000000000000",
    "label": "This is my Direct Debit",
    "reference": "mypayment",
    "replayCount": 0,
    "scheme": "SEPA.DIRECT_DEBIT.CORE",
    "sequenceType": "FRST",
    "state": "rejected",
    "_links": {
        "self": {
            "href": "https://api.preprod.slimpay.com/payments/482560c4-8d2a-11e5-878b-000000000000"
        },
        "profile": {
            "href": "https://api.preprod.slimpay.com/alps/v1/payments"
        },
        "https://api.slimpay.net/alps#get-creditor": {
            "href": "https://api.preprod.slimpay.com/creditors/democreditor"
        },
        "https://api.slimpay.net/alps#get-replayed-payment": {
            "href": "https://api.preprod.slimpay.com/payments/41b69eee-8d2d-11e5-878b-000000000000"
        },
        "https://api.slimpay.net/alps#get-payment-issues": {
            "href": "https://api.preprod.slimpay.com/payments/482560c4-8d2a-11e5-878b-000000000000/issues"
        },
        "https://api.slimpay.net/alps#get-debtor-bank-account": {
            "href": "https://api.preprod.slimpay.com/payments/482560c4-8d2a-11e5-878b-000000000000/debtor-bank-account"
        },
        "https://api.slimpay.net/alps#get-mandate": {
            "href": "https://api.preprod.slimpay.com/mandates/462942d2-7648-11e5-add6-f175896a8489"
        },
        "https://api.slimpay.net/alps#get-destination-bank-account": {
            "href": "https://api.preprod.slimpay.com/bank-accounts/1724b704-a503-11e6-97cb-000000000001"
        },
        "https://api.slimpay.net/alps#get-origin-bank-account": {
            "href": "https://api.preprod.slimpay.com/bank-accounts/fcf85bce-aa4c-11e6-a71f-000000000000"
        }
    }
}

11. get-replayed-payment (relation)

Description: Get the replayed payment of one payment. A replayed payment is a payment which has been created in order to retry a payment which has failed.

Properties
id
The payment id. Constraints: 36 characters or less, Read-Only.
Example: Get a replayed payment
Request
GET follow(https://api.slimpay.net/alps#get-replayed-payment) 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: 1880

{
    "amount": "192.00",
    "confirmed": false,
    "currency": "EUR",
    "dateCreated": "2015-11-17T13:15:22.000+0000",
    "dateValued": "2015-11-17T23:00:00.000+0000",
    "direction": "IN",
    "executionDate": "2015-11-23T23:00:00.000+0000",
    "executionStatus": "notprocessed",
    "id": "41b69eee-8d2d-11e5-878b-000000000000",
    "label": "This is my Direct Debit",
    "reference": "mypayment",
    "replayCount": 0,
    "scheme": "SEPA.DIRECT_DEBIT.CORE",
    "sequenceType": "FRST",
    "state": "cancelled",
    "_links": {
        "self": {
            "href": "https://api.preprod.slimpay.com/payments/41b69eee-8d2d-11e5-878b-000000000000"
        },
        "profile": {
            "href": "https://api.preprod.slimpay.com/alps/v1/payments"
        },
        "https://api.slimpay.net/alps#get-creditor": {
            "href": "https://api.preprod.slimpay.com/creditors/democreditor"
        },
        "https://api.slimpay.net/alps#get-rejected-payment": {
            "href": "https://api.preprod.slimpay.com/payments/482560c4-8d2a-11e5-878b-000000000000"
        },
        "https://api.slimpay.net/alps#get-payment-issues": {
            "href": "https://api.preprod.slimpay.com/payments/41b69eee-8d2d-11e5-878b-000000000000/issues"
        },
        "https://api.slimpay.net/alps#get-debtor-bank-account": {
            "href": "https://api.preprod.slimpay.com/payments/41b69eee-8d2d-11e5-878b-000000000000/debtor-bank-account"
        },
        "https://api.slimpay.net/alps#get-mandate": {
            "href": "https://api.preprod.slimpay.com/mandates/462942d2-7648-11e5-add6-f175896a8489"
        },
        "https://api.slimpay.net/alps#get-destination-bank-account": {
            "href": "https://api.preprod.slimpay.com/bank-accounts/1724b704-a503-11e6-97cb-000000000001"
        },
        "https://api.slimpay.net/alps#get-origin-bank-account": {
            "href": "https://api.preprod.slimpay.com/bank-accounts/fcf85bce-aa4c-11e6-a71f-000000000000"
        }
    }
}

12. patch-payment (relation)

Description: Patch a payment of which executionStatus property is either toprocess or toreplay.

Properties
amount
The amount of the payment. Constraints: Number, 22 characters or less, Read-Write.
reference
Value provided by the user to specify a payment reference. Constraints: 35 characters or less, Read-Write.
executionDate
The desired payment execution date. If missing from the request, the closest possible value is computed according to the rules of the payment scheme (SEPA, BACS etc.). Constraints: 140 characters or less, Read-Write.
label
Value provided by the user to specify a label. Constraints: 140 characters or less, Read-Write.
Example: Patch one payment
Request
PATCH follow(https://api.slimpay.net/alps#patch-payment) HTTP/1.1
Accept: application/hal+json; profile="https://api.slimpay.net/alps/v1"
Content-Type: application/merge-patch+json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJhcGkiXSwiZXhwIjoxNTMwNjMzNTk0LCJqdGkiOiI2ODNmNGE1Ni1kZjQ3LTQ0ZWYtYmIxYy02MDJhYmFlNGYwYjgiLCJjbGllbnRfaWQiOiJkZW1vY3JlZGl0b3IwMSJ9.VSmbmu4upmKj5_lTiBlqtbqSH42yx83AB1IFXJs08Tw

{
    "amount": 101,
    "label": "The label New",
    "reference": "Payment 123 New",
    "executionDate": "2018-12-26T08:47:53.925+0000"
}
Response
HTTP/1.1 200 OK
Content-Type: application/hal+json; profile="https://api.slimpay.net/alps/v1";charset=UTF-8
Content-Length: 1976

{
    "amount": "101.00",
    "confirmed": false,
    "currency": "EUR",
    "dateCreated": "2018-07-03T15:44:07.000+0000",
    "direction": "IN",
    "executionDate": "2018-12-26T08:47:53.925+0000",
    "executionStatus": "toprocess",
    "id": "eba38310-7ed7-11e8-bf72-000000000000",
    "label": "The label New",
    "reference": "Payment 123 New",
    "replayCount": 0,
    "scheme": "SEPA.DIRECT_DEBIT.CORE",
    "sequenceType": "RCUR",
    "state": "accepted",
    "_links": {
        "self": {
            "href": "https://api.preprod.slimpay.com/payments/eba38310-7ed7-11e8-bf72-000000000000"
        },
        "profile": {
            "href": "https://api.preprod.slimpay.com/alps/v1/payments"
        },
        "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/creditors/democreditor/subscribers/subscriber01"
        },
        "https://api.slimpay.net/alps#patch-payment": {
            "href": "https://api.preprod.slimpay.com/payments/eba38310-7ed7-11e8-bf72-000000000000"
        },
        "https://api.slimpay.net/alps#cancel-payment": {
            "href": "https://api.preprod.slimpay.com/payments/eba38310-7ed7-11e8-bf72-000000000000/cancellation"
        },
        "https://api.slimpay.net/alps#get-debtor-bank-account": {
            "href": "https://api.preprod.slimpay.com/payments/eba38310-7ed7-11e8-bf72-000000000000/debtor-bank-account"
        },
        "https://api.slimpay.net/alps#get-mandate": {
            "href": "https://api.preprod.slimpay.com/mandates/753be6b5-7e0b-11e8-abe5-000000000000"
        },
        "https://api.slimpay.net/alps#get-destination-bank-account": {
            "href": "https://api.preprod.slimpay.com/bank-accounts/1724b704-a503-11e6-97cb-000000000001"
        },
        "https://api.slimpay.net/alps#get-origin-bank-account": {
            "href": "https://api.preprod.slimpay.com/bank-accounts/4b1d6e34-7e0b-11e8-abe5-000000000000"
        }
    }
}

13. refund-payment (relation)

Description: Refund a payment.

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!

14. reverse-payment (relation)

Description: Reverse a payment.

Properties
returnReasonCode
ISO-20022 return reason code. Constraints: 4 characters or less, Read-Only.

15. search-payment-by-id (relation)

Description: Search one payment by id.

Properties
id
The payment id. Constraints: 36 characters or less, Read-Only.

16. search-payments (relation)

Description: Search payments. 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.
mandateReference
The Unique Reference of the Mandate (attributed by SlimPay if not set by the merchant). Constraints: Text, 35 characters or less, Read-Write.
cardAliasReference
The card alias reference. Constraints: Text, 250 characters or less, Read-Write.
reference
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.
scheme
The payment scheme. The payment scheme allows to specify is the payment is a direct debit, a credit transfer or a card transaction. Constraints: Text among SEPA.DIRECT_DEBIT.CORE|SEPA.DIRECT_DEBIT.B2B|SEPA.CREDIT_TRANSFER|BACS.DIRECT_DEBIT|CARD, Read-Write
direction
The payment direction. The payment direction is to be considered from the merchants point of view. If the money goes from the customer to the merchant, then the direction is IN and the payment can be called a payin. If the money goes from the merchant to the customer, then the direction is OUT and the payment can be considered a payout. Constraints: Text among IN|OUT, Read-Write.
category
A comma separated list of category. Constraints: Text, Optional.
state
A comma separated list of payment state. Constraints: Text, Optional.
processor
A comma separated list of processor. Constraints: Text, Optional.
executionStatus
A comma separated list of execution status. Constraints: Text, Optional.
executionDateBefore
Search payments that are executed or will be executed before this date. Constraints: DateTime, ISO8601, Optional.
executionDateAfter
Search payments that are executed or will be executed after this date. Constraints: DateTime, ISO8601, Optional.
Example: Search direct debit payments
Request
GET follow(https://api.slimpay.net/alps#search-payments) 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: 22172

{
    "_embedded": {
        "payments": [
            {
                "_links": {
                    "self": {
                        "href": "https://api.preprod.slimpay.com/payments/ec4eb349-7ed3-11e8-bf72-000000000000"
                    },
                    "profile": {
                        "href": "https://api.preprod.slimpay.com/alps/v1/payments"
                    },
                    "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/creditors/democreditor/subscribers/subscriber01"
                    },
                    "https://api.slimpay.net/alps#get-payment-issues": {
                        "href": "https://api.preprod.slimpay.com/payments/ec4eb349-7ed3-11e8-bf72-000000000000/issues"
                    },
                    "https://api.slimpay.net/alps#get-debtor-bank-account": {
                        "href": "https://api.preprod.slimpay.com/payments/ec4eb349-7ed3-11e8-bf72-000000000000/debtor-bank-account"
                    },
                    "https://api.slimpay.net/alps#get-mandate": {
                        "href": "https://api.preprod.slimpay.com/mandates/bd1055b8-2cac-11e6-a540-000000000000"
                    },
                    "https://api.slimpay.net/alps#get-destination-bank-account": {
                        "href": "https://api.preprod.slimpay.com/bank-accounts/1724b704-a503-11e6-97cb-000000000001"
                    },
                    "https://api.slimpay.net/alps#get-origin-bank-account": {
                        "href": "https://api.preprod.slimpay.com/bank-accounts/fcf8f80f-aa4c-11e6-a71f-000000000000"
                    }
                },
                "id": "ec4eb349-7ed3-11e8-bf72-000000000000",
                "scheme": "SEPA.DIRECT_DEBIT.CORE",
                "reference": "Payment 123",
                "direction": "IN",
                "amount": "100.00",
                "currency": "EUR",
                "label": "The label",
                "sequenceType": "RCUR",
                "state": "cancelled",
                "executionStatus": "notprocessed",
                "replayCount": 0,
                "executionDate": "2018-07-03T22:00:00.000+0000",
                "dateCreated": "2018-07-03T15:15:30.000+0000",
                "dateValued": "2018-07-02T22:00:00.000+0000",
                "confirmed": false
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.preprod.slimpay.com/payments/ec311928-7ed3-11e8-bf72-000000000000"
                    },
                    "profile": {
                        "href": "https://api.preprod.slimpay.com/alps/v1/payments"
                    },
                    "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/creditors/democreditor/subscribers/subscriber01"
                    },
                    "https://api.slimpay.net/alps#patch-payment": {
                        "href": "https://api.preprod.slimpay.com/payments/ec311928-7ed3-11e8-bf72-000000000000"
                    },
                    "https://api.slimpay.net/alps#cancel-payment": {
                        "href": "https://api.preprod.slimpay.com/payments/ec311928-7ed3-11e8-bf72-000000000000/cancellation"
                    },
                    "https://api.slimpay.net/alps#get-debtor-bank-account": {
                        "href": "https://api.preprod.slimpay.com/payments/ec311928-7ed3-11e8-bf72-000000000000/debtor-bank-account"
                    },
                    "https://api.slimpay.net/alps#get-mandate": {
                        "href": "https://api.preprod.slimpay.com/mandates/753be6b5-7e0b-11e8-abe5-000000000000"
                    },
                    "https://api.slimpay.net/alps#get-destination-bank-account": {
                        "href": "https://api.preprod.slimpay.com/bank-accounts/1724b704-a503-11e6-97cb-000000000001"
                    },
                    "https://api.slimpay.net/alps#get-origin-bank-account": {
                        "href": "https://api.preprod.slimpay.com/bank-accounts/4b1d6e34-7e0b-11e8-abe5-000000000000"
                    }
                },
                "id": "ec311928-7ed3-11e8-bf72-000000000000",
                "scheme": "SEPA.DIRECT_DEBIT.CORE",
                "reference": "Payment 123 New",
                "direction": "IN",
                "amount": "101.00",
                "currency": "EUR",
                "label": "The label New",
                "sequenceType": "RCUR",
                "state": "accepted",
                "executionStatus": "toprocess",
                "replayCount": 0,
                "executionDate": "2018-12-26T08:47:54.000+0000",
                "dateCreated": "2018-07-03T15:15:30.000+0000",
                "confirmed": false
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.preprod.slimpay.com/payments/de1f91b5-7ed3-11e8-bf72-000000000000"
                    },
                    "profile": {
                        "href": "https://api.preprod.slimpay.com/alps/v1/payments"
                    },
                    "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/creditors/democreditor/subscribers/subscriber01"
                    },
                    "https://api.slimpay.net/alps#get-payment-issues": {
                        "href": "https://api.preprod.slimpay.com/payments/de1f91b5-7ed3-11e8-bf72-000000000000/issues"
                    },
                    "https://api.slimpay.net/alps#get-debtor-bank-account": {
                        "href": "https://api.preprod.slimpay.com/payments/de1f91b5-7ed3-11e8-bf72-000000000000/debtor-bank-account"
                    },
                    "https://api.slimpay.net/alps#get-mandate": {
                        "href": "https://api.preprod.slimpay.com/mandates/bd1055b8-2cac-11e6-a540-000000000000"
                    },
                    "https://api.slimpay.net/alps#get-destination-bank-account": {
                        "href": "https://api.preprod.slimpay.com/bank-accounts/1724b704-a503-11e6-97cb-000000000001"
                    },
                    "https://api.slimpay.net/alps#get-origin-bank-account": {
                        "href": "https://api.preprod.slimpay.com/bank-accounts/fcf8f80f-aa4c-11e6-a71f-000000000000"
                    }
                },
                "id": "de1f91b5-7ed3-11e8-bf72-000000000000",
                "scheme": "SEPA.DIRECT_DEBIT.CORE",
                "reference": "Payment 123",
                "direction": "IN",
                "amount": "100.00",
                "currency": "EUR",
                "label": "The label",
                "sequenceType": "RCUR",
                "state": "cancelled",
                "executionStatus": "notprocessed",
                "replayCount": 0,
                "executionDate": "2018-07-03T22:00:00.000+0000",
                "dateCreated": "2018-07-03T15:15:06.000+0000",
                "dateValued": "2018-07-02T22:00:00.000+0000",
                "confirmed": false
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.preprod.slimpay.com/payments/de052be4-7ed3-11e8-bf72-000000000000"
                    },
                    "profile": {
                        "href": "https://api.preprod.slimpay.com/alps/v1/payments"
                    },
                    "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/creditors/democreditor/subscribers/subscriber01"
                    },
                    "https://api.slimpay.net/alps#patch-payment": {
                        "href": "https://api.preprod.slimpay.com/payments/de052be4-7ed3-11e8-bf72-000000000000"
                    },
                    "https://api.slimpay.net/alps#cancel-payment": {
                        "href": "https://api.preprod.slimpay.com/payments/de052be4-7ed3-11e8-bf72-000000000000/cancellation"
                    },
                    "https://api.slimpay.net/alps#get-debtor-bank-account": {
                        "href": "https://api.preprod.slimpay.com/payments/de052be4-7ed3-11e8-bf72-000000000000/debtor-bank-account"
                    },
                    "https://api.slimpay.net/alps#get-mandate": {
                        "href": "https://api.preprod.slimpay.com/mandates/753be6b5-7e0b-11e8-abe5-000000000000"
                    },
                    "https://api.slimpay.net/alps#get-destination-bank-account": {
                        "href": "https://api.preprod.slimpay.com/bank-accounts/1724b704-a503-11e6-97cb-000000000001"
                    },
                    "https://api.slimpay.net/alps#get-origin-bank-account": {
                        "href": "https://api.preprod.slimpay.com/bank-accounts/4b1d6e34-7e0b-11e8-abe5-000000000000"
                    }
                },
                "id": "de052be4-7ed3-11e8-bf72-000000000000",
                "scheme": "SEPA.DIRECT_DEBIT.CORE",
                "reference": "Payment 123 New",
                "direction": "IN",
                "amount": "101.00",
                "currency": "EUR",
                "label": "The label New",
                "sequenceType": "RCUR",
                "state": "accepted",
                "executionStatus": "toprocess",
                "replayCount": 0,
                "executionDate": "2018-12-26T08:47:54.000+0000",
                "dateCreated": "2018-07-03T15:15:06.000+0000",
                "confirmed": false
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.preprod.slimpay.com/payments/2a5d7220-7ece-11e8-bf72-000000000000"
                    },
                    "profile": {
                        "href": "https://api.preprod.slimpay.com/alps/v1/payments"
                    },
                    "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/creditors/democreditor/subscribers/subscriber01"
                    },
                    "https://api.slimpay.net/alps#get-payment-issues": {
                        "href": "https://api.preprod.slimpay.com/payments/2a5d7220-7ece-11e8-bf72-000000000000/issues"
                    },
                    "https://api.slimpay.net/alps#get-debtor-bank-account": {
                        "href": "https://api.preprod.slimpay.com/payments/2a5d7220-7ece-11e8-bf72-000000000000/debtor-bank-account"
                    },
                    "https://api.slimpay.net/alps#get-mandate": {
                        "href": "https://api.preprod.slimpay.com/mandates/bd1055b8-2cac-11e6-a540-000000000000"
                    },
                    "https://api.slimpay.net/alps#get-destination-bank-account": {
                        "href": "https://api.preprod.slimpay.com/bank-accounts/1724b704-a503-11e6-97cb-000000000001"
                    },
                    "https://api.slimpay.net/alps#get-origin-bank-account": {
                        "href": "https://api.preprod.slimpay.com/bank-accounts/fcf8f80f-aa4c-11e6-a71f-000000000000"
                    }
                },
                "id": "2a5d7220-7ece-11e8-bf72-000000000000",
                "scheme": "SEPA.DIRECT_DEBIT.CORE",
                "reference": "Payment 123",
                "direction": "IN",
                "amount": "100.00",
                "currency": "EUR",
                "label": "The label",
                "sequenceType": "RCUR",
                "state": "cancelled",
                "executionStatus": "notprocessed",
                "replayCount": 0,
                "executionDate": "2018-07-03T22:00:00.000+0000",
                "dateCreated": "2018-07-03T14:34:17.000+0000",
                "dateValued": "2018-07-02T22:00:00.000+0000",
                "confirmed": false
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.preprod.slimpay.com/payments/2a3e786f-7ece-11e8-bf72-000000000000"
                    },
                    "profile": {
                        "href": "https://api.preprod.slimpay.com/alps/v1/payments"
                    },
                    "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/creditors/democreditor/subscribers/subscriber01"
                    },
                    "https://api.slimpay.net/alps#patch-payment": {
                        "href": "https://api.preprod.slimpay.com/payments/2a3e786f-7ece-11e8-bf72-000000000000"
                    },
                    "https://api.slimpay.net/alps#cancel-payment": {
                        "href": "https://api.preprod.slimpay.com/payments/2a3e786f-7ece-11e8-bf72-000000000000/cancellation"
                    },
                    "https://api.slimpay.net/alps#get-debtor-bank-account": {
                        "href": "https://api.preprod.slimpay.com/payments/2a3e786f-7ece-11e8-bf72-000000000000/debtor-bank-account"
                    },
                    "https://api.slimpay.net/alps#get-mandate": {
                        "href": "https://api.preprod.slimpay.com/mandates/753be6b5-7e0b-11e8-abe5-000000000000"
                    },
                    "https://api.slimpay.net/alps#get-destination-bank-account": {
                        "href": "https://api.preprod.slimpay.com/bank-accounts/1724b704-a503-11e6-97cb-000000000001"
                    },
                    "https://api.slimpay.net/alps#get-origin-bank-account": {
                        "href": "https://api.preprod.slimpay.com/bank-accounts/4b1d6e34-7e0b-11e8-abe5-000000000000"
                    }
                },
                "id": "2a3e786f-7ece-11e8-bf72-000000000000",
                "scheme": "SEPA.DIRECT_DEBIT.CORE",
                "reference": "Payment 123 New",
                "direction": "IN",
                "amount": "101.00",
                "currency": "EUR",
                "label": "The label New",
                "sequenceType": "RCUR",
                "state": "accepted",
                "executionStatus": "toprocess",
                "replayCount": 0,
                "executionDate": "2018-12-26T08:47:54.000+0000",
                "dateCreated": "2018-07-03T14:34:17.000+0000",
                "confirmed": false
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.preprod.slimpay.com/payments/1cc18fdc-7ece-11e8-bf72-000000000000"
                    },
                    "profile": {
                        "href": "https://api.preprod.slimpay.com/alps/v1/payments"
                    },
                    "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/creditors/democreditor/subscribers/subscriber01"
                    },
                    "https://api.slimpay.net/alps#get-payment-issues": {
                        "href": "https://api.preprod.slimpay.com/payments/1cc18fdc-7ece-11e8-bf72-000000000000/issues"
                    },
                    "https://api.slimpay.net/alps#get-debtor-bank-account": {
                        "href": "https://api.preprod.slimpay.com/payments/1cc18fdc-7ece-11e8-bf72-000000000000/debtor-bank-account"
                    },
                    "https://api.slimpay.net/alps#get-mandate": {
                        "href": "https://api.preprod.slimpay.com/mandates/bd1055b8-2cac-11e6-a540-000000000000"
                    },
                    "https://api.slimpay.net/alps#get-destination-bank-account": {
                        "href": "https://api.preprod.slimpay.com/bank-accounts/1724b704-a503-11e6-97cb-000000000001"
                    },
                    "https://api.slimpay.net/alps#get-origin-bank-account": {
                        "href": "https://api.preprod.slimpay.com/bank-accounts/fcf8f80f-aa4c-11e6-a71f-000000000000"
                    }
                },
                "id": "1cc18fdc-7ece-11e8-bf72-000000000000",
                "scheme": "SEPA.DIRECT_DEBIT.CORE",
                "reference": "Payment 123",
                "direction": "IN",
                "amount": "100.00",
                "currency": "EUR",
                "label": "The label",
                "sequenceType": "RCUR",
                "state": "cancelled",
                "executionStatus": "notprocessed",
                "replayCount": 0,
                "executionDate": "2018-07-03T22:00:00.000+0000",
                "dateCreated": "2018-07-03T14:33:55.000+0000",
                "dateValued": "2018-07-02T22:00:00.000+0000",
                "confirmed": false
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.preprod.slimpay.com/payments/1cae2eeb-7ece-11e8-bf72-000000000000"
                    },
                    "profile": {
                        "href": "https://api.preprod.slimpay.com/alps/v1/payments"
                    },
                    "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/creditors/democreditor/subscribers/subscriber01"
                    },
                    "https://api.slimpay.net/alps#patch-payment": {
                        "href": "https://api.preprod.slimpay.com/payments/1cae2eeb-7ece-11e8-bf72-000000000000"
                    },
                    "https://api.slimpay.net/alps#cancel-payment": {
                        "href": "https://api.preprod.slimpay.com/payments/1cae2eeb-7ece-11e8-bf72-000000000000/cancellation"
                    },
                    "https://api.slimpay.net/alps#get-debtor-bank-account": {
                        "href": "https://api.preprod.slimpay.com/payments/1cae2eeb-7ece-11e8-bf72-000000000000/debtor-bank-account"
                    },
                    "https://api.slimpay.net/alps#get-mandate": {
                        "href": "https://api.preprod.slimpay.com/mandates/753be6b5-7e0b-11e8-abe5-000000000000"
                    },
                    "https://api.slimpay.net/alps#get-destination-bank-account": {
                        "href": "https://api.preprod.slimpay.com/bank-accounts/1724b704-a503-11e6-97cb-000000000001"
                    },
                    "https://api.slimpay.net/alps#get-origin-bank-account": {
                        "href": "https://api.preprod.slimpay.com/bank-accounts/4b1d6e34-7e0b-11e8-abe5-000000000000"
                    }
                },
                "id": "1cae2eeb-7ece-11e8-bf72-000000000000",
                "scheme": "SEPA.DIRECT_DEBIT.CORE",
                "reference": "Payment 123 New",
                "direction": "IN",
                "amount": "101.00",
                "currency": "EUR",
                "label": "The label New",
                "sequenceType": "RCUR",
                "state": "accepted",
                "executionStatus": "toprocess",
                "replayCount": 0,
                "executionDate": "2018-12-26T08:47:54.000+0000",
                "dateCreated": "2018-07-03T14:33:54.000+0000",
                "confirmed": false
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.preprod.slimpay.com/payments/f4f02a82-7ec4-11e8-bf72-000000000000"
                    },
                    "profile": {
                        "href": "https://api.preprod.slimpay.com/alps/v1/payments"
                    },
                    "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/creditors/democreditor/subscribers/subscriber01"
                    },
                    "https://api.slimpay.net/alps#get-payment-issues": {
                        "href": "https://api.preprod.slimpay.com/payments/f4f02a82-7ec4-11e8-bf72-000000000000/issues"
                    },
                    "https://api.slimpay.net/alps#get-debtor-bank-account": {
                        "href": "https://api.preprod.slimpay.com/payments/f4f02a82-7ec4-11e8-bf72-000000000000/debtor-bank-account"
                    },
                    "https://api.slimpay.net/alps#get-mandate": {
                        "href": "https://api.preprod.slimpay.com/mandates/bd1055b8-2cac-11e6-a540-000000000000"
                    },
                    "https://api.slimpay.net/alps#get-destination-bank-account": {
                        "href": "https://api.preprod.slimpay.com/bank-accounts/1724b704-a503-11e6-97cb-000000000001"
                    },
                    "https://api.slimpay.net/alps#get-origin-bank-account": {
                        "href": "https://api.preprod.slimpay.com/bank-accounts/fcf8f80f-aa4c-11e6-a71f-000000000000"
                    }
                },
                "id": "f4f02a82-7ec4-11e8-bf72-000000000000",
                "scheme": "SEPA.DIRECT_DEBIT.CORE",
                "reference": "Payment 123",
                "direction": "IN",
                "amount": "100.00",
                "currency": "EUR",
                "label": "The label",
                "sequenceType": "RCUR",
                "state": "cancelled",
                "executionStatus": "notprocessed",
                "replayCount": 0,
                "executionDate": "2018-07-03T22:00:00.000+0000",
                "dateCreated": "2018-07-03T13:28:22.000+0000",
                "dateValued": "2018-07-02T22:00:00.000+0000",
                "confirmed": false
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.preprod.slimpay.com/payments/f4c8f371-7ec4-11e8-bf72-000000000000"
                    },
                    "profile": {
                        "href": "https://api.preprod.slimpay.com/alps/v1/payments"
                    },
                    "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/creditors/democreditor/subscribers/subscriber01"
                    },
                    "https://api.slimpay.net/alps#patch-payment": {
                        "href": "https://api.preprod.slimpay.com/payments/f4c8f371-7ec4-11e8-bf72-000000000000"
                    },
                    "https://api.slimpay.net/alps#cancel-payment": {
                        "href": "https://api.preprod.slimpay.com/payments/f4c8f371-7ec4-11e8-bf72-000000000000/cancellation"
                    },
                    "https://api.slimpay.net/alps#get-debtor-bank-account": {
                        "href": "https://api.preprod.slimpay.com/payments/f4c8f371-7ec4-11e8-bf72-000000000000/debtor-bank-account"
                    },
                    "https://api.slimpay.net/alps#get-mandate": {
                        "href": "https://api.preprod.slimpay.com/mandates/753be6b5-7e0b-11e8-abe5-000000000000"
                    },
                    "https://api.slimpay.net/alps#get-destination-bank-account": {
                        "href": "https://api.preprod.slimpay.com/bank-accounts/1724b704-a503-11e6-97cb-000000000001"
                    },
                    "https://api.slimpay.net/alps#get-origin-bank-account": {
                        "href": "https://api.preprod.slimpay.com/bank-accounts/4b1d6e34-7e0b-11e8-abe5-000000000000"
                    }
                },
                "id": "f4c8f371-7ec4-11e8-bf72-000000000000",
                "scheme": "SEPA.DIRECT_DEBIT.CORE",
                "reference": "Payment 123 New",
                "direction": "IN",
                "amount": "101.00",
                "currency": "EUR",
                "label": "The label New",
                "sequenceType": "RCUR",
                "state": "accepted",
                "executionStatus": "toprocess",
                "replayCount": 0,
                "executionDate": "2018-12-26T08:47:54.000+0000",
                "dateCreated": "2018-07-03T13:28:22.000+0000",
                "confirmed": false
            }
        ]
    },
    "page": {
        "size": 10,
        "totalElements": 762389,
        "totalPages": 76239,
        "number": 0
    },
    "_links": {
        "first": {
            "href": "https://api.preprod.slimpay.com/payments?creditorReference=democreditor&scheme=SEPA.DIRECT_DEBIT.CORE&page=0&size=10"
        },
        "self": {
            "href": "https://api.preprod.slimpay.com/payments?creditorReference=democreditor&scheme=SEPA.DIRECT_DEBIT.CORE"
        },
        "next": {
            "href": "https://api.preprod.slimpay.com/payments?creditorReference=democreditor&scheme=SEPA.DIRECT_DEBIT.CORE&page=1&size=10"
        },
        "last": {
            "href": "https://api.preprod.slimpay.com/payments?creditorReference=democreditor&scheme=SEPA.DIRECT_DEBIT.CORE&page=76238&size=10"
        },
        "search": {
            "href": "https://api.preprod.slimpay.com/payments{?creditorReference,entityReference,subscriberReference,mandateReference,cardAliasReference,scheme,direction,reference,category,currency,state,executionStatus,processor,executionDateBefore,executionDateAfter,page,size}",
            "templated": true
        }
    }
}