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-refunds
  11. get-rejected-payment
  12. get-replayed-payment
  13. patch-payment
  14. refund-payment
  15. reverse-payment
  16. search-payment-by-id
  17. search-payments

1. payment-representation

Description: A representation of a payment resource. A payment is initiated by a creditor (the merchant) to transfer funds to or from a debtor account. A payment is mainly characterised by its scheme and 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: Text, 35 characters or less, Read-Write.
scheme
The payment scheme. The payment scheme allows the user to specify whether the payment is a direct debit, a credit transfer or a card transaction. Constraints: Text, set to SEPA.DIRECT_DEBIT.CORE, SEPA.DIRECT_DEBIT.B2B, SEPA.CREDIT_TRANSFER or CARD, Read-Write
direction
The direction of the payment, from the merchant’s perspective. If funds are being paid from the customer to the merchant, then the direction is IN (payin). If the funds go from the merchant to the customer, then the direction is OUT (payout). Constraints: Text, set to IN or OUT, Read-Write.
category
The payment category (only valid for credit transfers). Constraints: Text, set to funds_transfer, refund or regular, Read-Write.
amount
The amount of the payment. Constraints: Number, 22 characters or less, Read-Write.
currency
The currency of the payment. Constraints: Text, an ISO 4217 standard currency code, set to EUR, Read-Write.
label
Value provided by the user to specify a payment label. Constraints: Text, 140 characters or less, Read-Write.
state
The payment state. Constraints: Text, set to accepted, settling, settled, returned, cancelled, refunded, rejected, reversing or reversed, Read-Only.
executionDate
The desired date the transaction should be executed. If not provided in the request, the earliest possible date is calculated according to the rules of the payment scheme (e.g SEPA). Constraints: DateTime, formatted to ISO 8601 standard, Read-Write.
executionStatus
The payment execution status. Constraints: Text, set to processing, rejected, processed, notprocessed, transformed, contested, toreplay, togenerate or toprocess, Read-Only.
sequenceType
The payment sequence type. Constraints: Text, set to FRST, RCUR, FNAL or OOFF, Read-Only.
replayCount
The payment replay count. Constraints: Integer, Read-Only.
dateCreated
The date the payment was created. Constraints: DateTime, formatted to ISO 8601 standard, Read-Only.
dateModified
The date the payment was modified. Constraints: DateTime, formatted to ISO 8601 standard, Read-Only.
dateBooked
The payment booking date. Constraints: DateTime, formatted to ISO 8601 standard, Read-Only.
dateValued
The payment value date. Constraints: DateTime, formatted to ISO 8601 standard, Read-Only.
capture
A flag to indicate whether a card payment should be captured or not (by default set to true). Constraint: Boolean, Read-Write.
confirmed
A flag to indicate whether a payment is confirmed or not (by default set to false). Constraint: Boolean, Read-Only.
processor
The payment processor defines who is responsible for processing the payment. Constraints: Text, set to slimpay, sofort, ideal or unknown, Read-Only.
threeDsPreference
The 3DS preference allows the merchant to inform the issuing bank whether they want to apply Strong Customer Authentication to a one-off transaction. Constraints: Text, set to NoPreference, Challenge, NoChallenge (optional).
correlationId
A correlation property that can be used by external systems for correlation purposes. Constraints: Text, 100 characters or less, Read-Write.

2. payments-representation

Description: A collection of payment representations.

3. cancel-payment (relation)

Description: Merchants set up for acquiring may sometimes need to cancel direct debit payments, but this can only be done under certain conditions. If your payment has the status toProcess and the execution date is in more than 3 business days, then you can cancel the payment. Alternatively, you can make a last-minute cancellation to a payment through the API, provided the call is made before 6am UTC. Clients set up for processing aren't eligible for this option.

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 a 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 payment with a direction of IN (funds being paid from the customer to the merchant). It can be specified using a subscriber reference, a mandate reference (for a direct debit), or a card alias reference (for a card transaction). If a creditor entity is required, it can be passed within the creditor property. If the subscriber is specified for a direct debit, SlimPay will create the payment using the most recently signed mandate associated with this subscriber. If the mandate is specified, SlimPay will create the payment using the given mandate. If the subscriber is specified for a card transaction, SlimPay will create the payment using the latest card alias associated with this subscriber. If the card alias is specified, SlimPay will create the payment using the given card alias.

Properties
reference
Value provided by the user to specify a payment reference. Constraints: Text, 35 characters or less, Read-Write.
correlationId
A correlation property that can be used by external systems for correlation purposes. Constraints: Text, 100 characters or less, Read-Write.
scheme
The payment scheme. The payment scheme allows the user to specify whether the payment is a direct debit, a credit transfer or a card transaction. Constraints: Text, set to SEPA.DIRECT_DEBIT.CORE, SEPA.DIRECT_DEBIT.B2B, SEPA.CREDIT_TRANSFER or CARD, Read-Write
amount
The amount of the payment. Constraints: Number, 22 characters or less, Read-Write.
currency
The currency of the payment. Constraints: Text, an ISO 4217 standard currency code, set to EUR, Read-Write.
label
Value provided by the user to specify a payment label. Constraints: Text, 140 characters or less, Read-Write.
executionDate
The desired date the transaction should be executed. If not provided in the request, the earliest possible date is calculated according to the rules of the payment scheme (e.g SEPA). Constraints: DateTime, formatted to ISO 8601 standard, Read-Write.
capture
A flag to indicate whether a card payment should be captured or not (by default set to true). Constraint: Boolean, Read-Write.
reference
Value provided by the user to specify a payment reference. Constraints: Text, 35 characters or less, Read-Write.
creditor » reference
The unique identifier of a SlimPay account, allocated by SlimPay. Constraints: Text, 35 characters or less, Read-Write.
creditor » entity » reference
The entity reference of the creditor, allocated 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 a 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
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJhcGkiXSwiZXhwIjoxNTMwNjMzNTk0LCJqdGkiOiI2ODNmNGE1Ni1kZjQ3LTQ0ZWYtYmIxYy02MDJhYmFlNGYwYjgiLCJjbGllbnRfaWQiOiJkZW1vY3JlZGl0b3IwMSJ9.VSmbmu4upmKj5_lTiBlqtbqSH42yx83AB1IFXJs08Tw

{
    "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 payment with a direction of OUT (funds being paid from the merchant to their customer). It can be specified using a subscriber reference or a mandate reference. If a creditor entity is required, it can be passed within the creditor property. If the subscriber is specified, SlimPay will create the payment using the most recently signed mandate associated with this subscriber. If the mandate is specified, SlimPay will create the payment using the given mandate.

Properties
reference
Value provided by the user to specify a payment reference. Constraints: Text, 35 characters or less, Read-Write.
correlationId
A correlation property that can be used by external systems for correlation purposes. Constraints: Text, 100 characters or less, Read-Write.
scheme
The payment scheme. The payment scheme allows the user to specify whether the payment is a direct debit, a credit transfer or a card transaction. Constraints: Text, set to SEPA.DIRECT_DEBIT.CORE, SEPA.DIRECT_DEBIT.B2B, SEPA.CREDIT_TRANSFER or CARD, Read-Write
category
The payment category (only valid for credit transfers). Constraints: Text, set to funds_transfer, refund or regular, Read-Write.
amount
The amount of the payment. Constraints: Number, 22 characters or less, Read-Write.
currency
The currency of the payment. Constraints: Text, an ISO 4217 standard currency code, set to EUR, Read-Write.
label
Value provided by the user to specify a payment label. Constraints: Text, 140 characters or less, Read-Write.
executionDate
The desired date the transaction should be executed. If not provided in the request, the earliest possible date is calculated according to the rules of the payment scheme (e.g SEPA). Constraints: DateTime, formatted to ISO 8601 standard, Read-Write.
reference
Value provided by the user to specify a payment reference. Constraints: Text, 35 characters or less, Read-Write.
creditor » reference
The unique identifier of a SlimPay account, allocated by SlimPay. Constraints: Text, 35 characters or less, Read-Write.
creditor » entity » reference
The entity reference of the creditor, allocated 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 a 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: Retrieve the representation of a single payment 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!

8. get-payments (relation)

Description: Retrieve a collection of payment 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!

9. get-refunded-payment (relation)

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

Example: Retrieve a refunded payment (direct debit) from a refund (credit transfer)
Request
GET follow(https://api.slimpay.net/alps#get-refunded-payment) HTTP/1.1
Accept: application/hal+json; profile="https://api.slimpay.net/alps/v1"
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJhcGkiXSwiZXhwIjoxNTMwNjMzNTk0LCJqdGkiOiI2ODNmNGE1Ni1kZjQ3LTQ0ZWYtYmIxYy02MDJhYmFlNGYwYjgiLCJjbGllbnRfaWQiOiJkZW1vY3JlZGl0b3IwMSJ9.VSmbmu4upmKj5_lTiBlqtbqSH42yx83AB1IFXJs08Tw
Response
HTTP/1.1 200 OK
Content-Type: application/hal+json; profile="https://api.slimpay.net/alps/v1";charset=UTF-8
Content-Length: 1912

{
    "amount": "113.00",
    "confirmed": false,
    "currency": "EUR",
    "dateCreated": "2020-03-02T12:59:00.000+0000",
    "direction": "IN",
    "executionDate": "2020-03-08T23:00:00.000+0000",
    "executionStatus": "processed",
    "id": "95af4a0a-5c85-11ea-b89a-000000000000",
    "label": "The label",
    "reference": "SDD-EXE-20200309-16",
    "replayCount": 0,
    "scheme": "SEPA.DIRECT_DEBIT.CORE",
    "sequenceType": "FRST",
    "state": "accepted",
    "_links": {
        "self": {
            "href": "https://api.preprod.slimpay.com/payments/95af4a0a-5c85-11ea-b89a-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/subscriber-20200225"
        },
        "https://api.slimpay.net/alps#reverse-payment": {
            "href": "https://api.preprod.slimpay.com/payments/95af4a0a-5c85-11ea-b89a-000000000000/reversal"
        },
        "https://api.slimpay.net/alps#get-debtor-bank-account": {
            "href": "https://api.preprod.slimpay.com/payments/95af4a0a-5c85-11ea-b89a-000000000000/debtor-bank-account"
        },
        "https://api.slimpay.net/alps#get-mandate": {
            "href": "https://api.preprod.slimpay.com/mandates/8fff36c4-57eb-11ea-a11c-000000000000"
        },
        "https://api.slimpay.net/alps#get-destination-bank-account": {
            "href": "https://api.preprod.slimpay.com/bank-accounts/07ee9bfe-b592-11e7-b971-000000000000"
        },
        "https://api.slimpay.net/alps#get-origin-bank-account": {
            "href": "https://api.preprod.slimpay.com/bank-accounts/8fcc8e03-57eb-11ea-a11c-000000000000"
        },
        "https://api.slimpay.net/alps#get-refunds": {
            "href": "https://api.preprod.slimpay.com/payments/95af4a0a-5c85-11ea-b89a-000000000000/refunds"
        }
    }
}

10. get-refunds (relation)

Description: Retrieve the refunds associated with an initial 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!

Example: Retrieve the refund (credit transfer) linked to a refunded payment (direct debit)
Request
GET follow(https://api.slimpay.net/alps#get-refunds) HTTP/1.1
Accept: application/hal+json; profile="https://api.slimpay.net/alps/v1"
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJhcGkiXSwiZXhwIjoxNTMwNjMzNTk0LCJqdGkiOiI2ODNmNGE1Ni1kZjQ3LTQ0ZWYtYmIxYy02MDJhYmFlNGYwYjgiLCJjbGllbnRfaWQiOiJkZW1vY3JlZGl0b3IwMSJ9.VSmbmu4upmKj5_lTiBlqtbqSH42yx83AB1IFXJs08Tw
Response
HTTP/1.1 200 OK
Content-Type: application/hal+json; profile="https://api.slimpay.net/alps/v1";charset=UTF-8
Content-Length: 2561

{
    "_embedded": {
        "payments": [
            {
                "_links": {
                    "self": {
                        "href": "https://api.preprod.slimpay.com/payments/ac443beb-5c85-11ea-b89a-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/subscriber-20200225"
                    },
                    "https://api.slimpay.net/alps#patch-payment": {
                        "href": "https://api.preprod.slimpay.com/payments/ac443beb-5c85-11ea-b89a-000000000000"
                    },
                    "https://api.slimpay.net/alps#cancel-payment": {
                        "href": "https://api.preprod.slimpay.com/payments/ac443beb-5c85-11ea-b89a-000000000000/cancellation"
                    },
                    "https://api.slimpay.net/alps#get-refunded-payment": {
                        "href": "https://api.preprod.slimpay.com/payments/95af4a0a-5c85-11ea-b89a-000000000000"
                    },
                    "https://api.slimpay.net/alps#get-debtor-bank-account": {
                        "href": "https://api.preprod.slimpay.com/payments/ac443beb-5c85-11ea-b89a-000000000000/debtor-bank-account"
                    },
                    "https://api.slimpay.net/alps#get-destination-bank-account": {
                        "href": "https://api.preprod.slimpay.com/bank-accounts/8fcc8e03-57eb-11ea-a11c-000000000000"
                    },
                    "https://api.slimpay.net/alps#get-origin-bank-account": {
                        "href": "https://api.preprod.slimpay.com/bank-accounts/07ee9bfe-b592-11e7-b971-000000000000"
                    }
                },
                "id": "ac443beb-5c85-11ea-b89a-000000000000",
                "scheme": "SEPA.CREDIT_TRANSFER",
                "reference": "REB-EXE-20200302-58",
                "direction": "OUT",
                "amount": "113.00",
                "currency": "EUR",
                "label": "Virement Slimpay",
                "state": "accepted",
                "executionStatus": "toprocess",
                "executionDate": "2020-03-01T23:00:00.000+0000",
                "dateCreated": "2020-03-02T12:59:38.000+0000",
                "confirmed": false,
                "category": "refund",
                "processor": "slimpay"
            }
        ]
    },
    "page": {
        "size": 10,
        "totalElements": 1,
        "totalPages": 1,
        "number": 0
    },
    "_links": {
        "self": {
            "href": "https://api.preprod.slimpay.com/payments/95af4a0a-5c85-11ea-b89a-000000000000/refunds"
        },
        "search": {
            "href": "https://api.preprod.slimpay.com/payments/95af4a0a-5c85-11ea-b89a-000000000000/refunds{?page,size}",
            "templated": true
        }
    }
}

11. get-rejected-payment (relation)

Description: Retrieve the representation of a rejected payment resource, using its id as a search parameter. A rejected payment is a payment which failed and triggered the creation of a replayed payment.

Properties
id
The payment id. Constraints: 36 characters or less, Read-Only.
Example: Retrieve a rejected payment representation
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"
        }
    }
}

12. get-replayed-payment (relation)

Description: Retrieve the representation of a replayed payment resource, using its id as a search parameter. 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: Retrieve a replayed payment representation
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"
        }
    }
}

13. patch-payment (relation)

Description: Patch a payment that has an executionStatus property set to 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: Text, 35 characters or less, Read-Write.
executionDate
The desired date the transaction should be executed. If not provided in the request, the earliest possible date is calculated according to the rules of the payment scheme (e.g SEPA). Constraints: DateTime, formatted to ISO 8601 standard, Read-Write.
label
Value provided by the user to specify a payment label. Constraints: Text, 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"
        }
    }
}

14. refund-payment (relation)

Description: Refund a payment.

Properties
amount
The amount to refund, optional. When not provided, the full amount of the payment is refunded. Constraints: Number, 22 characters or less, Read-Write.
reference
Value provided by the merchant to specify a payment refund reference. Constraints: Text, 35 characters or less (optional).
Example: Refund one card payment
Request
POST follow(https://api.slimpay.net/alps#refund-payment) HTTP/1.1
Accept: application/hal+json; profile="https://api.slimpay.net/alps/v1"
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJhcGkiXSwiZXhwIjoxNTMwNjMzNTk0LCJqdGkiOiI2ODNmNGE1Ni1kZjQ3LTQ0ZWYtYmIxYy02MDJhYmFlNGYwYjgiLCJjbGllbnRfaWQiOiJkZW1vY3JlZGl0b3IwMSJ9.VSmbmu4upmKj5_lTiBlqtbqSH42yx83AB1IFXJs08Tw

{
    "amount": 10
}
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": "100.00",
    "confirmed": false,
    "currency": "EUR",
    "dateCreated": "2019-12-13T15:25:31.000+0000",
    "direction": "IN",
    "executionDate": "2019-12-13T15:25:31.000+0000",
    "executionStatus": "processed",
    "id": "cc3b5902-1dbc-11ea-a5b2-000000000000",
    "label": "The label",
    "reference": "Payment 123",
    "scheme": "CARD",
    "_links": {
        "self": {
            "href": "https://api.preprod.slimpay.com/payments/cc3b5902-1dbc-11ea-a5b2-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/subscriber5df3ad5a6bc6d"
        },
        "https://api.slimpay.net/alps#refund-payment": {
            "href": "https://api.preprod.slimpay.com/payments/cc3b5902-1dbc-11ea-a5b2-000000000000/refund"
        },
        "https://api.slimpay.net/alps#get-payment-issues": {
            "href": "https://api.preprod.slimpay.com/payments/cc3b5902-1dbc-11ea-a5b2-000000000000/issues"
        },
        "https://api.slimpay.net/alps#get-card-alias": {
            "href": "https://api.preprod.slimpay.com/card-aliases/cc3872d1-1dbc-11ea-a5b2-000000000000"
        },
        "https://api.slimpay.net/alps#get-card": {
            "href": "https://api.preprod.slimpay.com/cards/160afae4-9f5e-11e7-aeca-000000000000"
        },
        "https://api.slimpay.net/alps#get-refunds": {
            "href": "https://api.preprod.slimpay.com/payments/cc3b5902-1dbc-11ea-a5b2-000000000000/refunds"
        }
    }
}

15. reverse-payment (relation)

Description: Reverse a payment.

Properties
returnReasonCode
An ISO 20022 standard return reason code, offering details on why the payment failed. Constraints: 4 characters or less, Read-Only.

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

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

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

17. search-payments (relation)

Description: Search for the representations of payment 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.
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: Text, 35 characters or less, Read-Write.
currency
The currency of the payment. Constraints: Text, an ISO 4217 standard currency code, set to EUR, Read-Write.
scheme
The payment scheme. The payment scheme allows to specify if the payment is a direct debit, a credit transfer or a card transaction. You can collect payments with a combination of payment scheme. Please note that only the combination of SEPA.DIRECT_DEBIT.CORE, SEPA.DIRECT_DEBIT.B2B payment scheme is currently supported. Constraints: Text, set to SEPA.DIRECT_DEBIT.CORE, SEPA.DIRECT_DEBIT.B2B, SEPA.CREDIT_TRANSFER or CARD, Read-Write
direction
The direction of the payment, from the merchant’s perspective. If funds are being paid from the customer to the merchant, then the direction is IN (payin). If the funds go from the merchant to the customer, then the direction is OUT (payout). Constraints: Text, set to IN or OUT, Read-Write.
category
The payment category (only valid for credit transfers). Constraints: Text, set to funds_transfer, refund or regular (optional).
state
The payment state. Constraints: Text, set to accepted, settling, settled, returned, cancelled, refunded, rejected, reversing or reversed (optional).
processor
The payment processor defines who is responsible for processing the payment. Constraints: Text, set to slimpay, sofort, ideal or unknown (optional).
executionStatus
The payment execution status. Constraints: Text, set to processing, rejected, processed, notprocessed, transformed, contested, toreplay, togenerate or toprocess (optional).
executionDateBefore
Search payments that are executed or will be executed before this date. Constraints: DateTime, formatted to ISO 8601 standard (optional).
executionDateAfter
Search payments that are executed or will be executed after this date. Constraints: DateTime, formatted to ISO 8601 standard (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
        }
    }
}