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.

bank-accounts

  1. bank-account-representation
  2. bank-accounts-representation
  3. get-bank-account
  4. get-bank-accounts
  5. get-debtor-bank-account
  6. search-bank-account-by-id
  7. show-bank-accounts-history
  8. update-bank-account

1. bank-account-representation

Description: A bank account representation.

Properties
id
The account id. Constraints: 36 characters or less, Read-Only.
bic
The BIC (Bank Identifier Code) identifying the bank. Constraints: Text, 11 characters or less, Read-Write.
iban
The IBAN (International Bank Account Number) identifying the bank account. Constraints: Text, 34 characters or less, Read-Write.
institutionName
The institution name. Constraints: Text, 32 characters or less, Read-Only.
countryCode
The country code. If set, then sortCode and accountNumber must be set, while iban and bic must not. Constraints: Text, 2 characters, Read-Write.
sortCode
The sort code. If set, then countryCode and accountNumber must be set, while iban and bic must not. Constraints: 6 or 8 characters, Read-Write.
accountNumber
The account number. If set, then sortCode and countryCode must be set, while iban and bic must not. Constraints: 8 characters, Read-Write.

2. bank-accounts-representation

Description: A collection of bank accounts.

3. get-bank-account (relation)

Description: Get one bank account.

Properties

No dynamic property needed. This usually means that the server already took the liberty to build the full URL for you depending on the context. Less code for you!

Example: Get one bank account
Request
GET follow(https://api.slimpay.net/alps#get-bank-account) 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: 642

{
    "bic": "SLMPFRP1XXX",
    "iban": "FR7616348000011523698541261",
    "_links": {
        "self": {
            "href": "https://api.preprod.slimpay.com/mandates/6def0e61-7258-11e5-9eed-314e36732557/signatory/bank-account"
        },
        "profile": {
            "href": "https://api.preprod.slimpay.com/alps/v1/bank-accounts"
        },
        "https://api.slimpay.net/alps#get-mandate": {
            "href": "https://api.preprod.slimpay.com/mandates/6def0e61-7258-11e5-9eed-314e36732557"
        },
        "https://api.slimpay.net/alps#get-signatory": {
            "href": "https://api.preprod.slimpay.com/mandates/6def0e61-7258-11e5-9eed-314e36732557/signatory"
        }
    }
}

4. get-bank-accounts (relation)

Description: Get bank accounts. They will be 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!

5. get-debtor-bank-account (relation)

Description: Get one debtor bank account.

Properties

No dynamic property needed. This usually means that the server already took the liberty to build the full URL for you depending on the context. Less code for you!

Example: Get a debtor bank account from a direct debit
Request
GET follow(https://api.slimpay.net/alps#get-debtor-bank-account) 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: 385

{
    "bic": "SLMPFRP1",
    "iban": "FR7616348000010000000001953",
    "id": "fcf85bce-aa4c-11e6-a71f-000000000000",
    "institutionName": "SLIMPAY",
    "_links": {
        "self": {
            "href": "https://api.preprod.slimpay.com/bank-accounts/fcf85bce-aa4c-11e6-a71f-000000000000"
        },
        "profile": {
            "href": "https://api.preprod.slimpay.com/alps/v1/bank-accounts"
        }
    }
}

6. search-bank-account-by-id (relation)

Description: Search one bank account by id.

Properties
id
The account id. Constraints: 36 characters or less, Read-Only.
Example: Search a bank account by id
Request
GET follow(https://api.slimpay.net/alps#search-bank-account-by-id) HTTP/1.1
Accept: application/hal+json; profile="https://api.slimpay.net/alps/v1"
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJhcGkiXSwiZXhwIjoxNTMwNjMzNTk0LCJqdGkiOiI2ODNmNGE1Ni1kZjQ3LTQ0ZWYtYmIxYy02MDJhYmFlNGYwYjgiLCJjbGllbnRfaWQiOiJkZW1vY3JlZGl0b3IwMSJ9.VSmbmu4upmKj5_lTiBlqtbqSH42yx83AB1IFXJs08Tw
Response
HTTP/1.1 200 OK
Content-Type: application/hal+json; profile="https://api.slimpay.net/alps/v1";charset=UTF-8
Content-Length: 826

{
    "bic": "DEUTFRPP",
    "iban": "FR7617789100011000000100790",
    "id": "1724b704-a503-11e6-97cb-000000000001",
    "institutionName": "TEST account 2",
    "_links": {
        "self": {
            "href": "https://api.preprod.slimpay.com/bank-accounts/1724b704-a503-11e6-97cb-000000000001"
        },
        "profile": {
            "href": "https://api.preprod.slimpay.com/alps/v1/bank-accounts"
        },
        "https://api.slimpay.net/alps#get-balance": {
            "href": "https://api.preprod.slimpay.com/bank-accounts/1724b704-a503-11e6-97cb-000000000001/balance{?entityReference}",
            "templated": true
        },
        "https://api.slimpay.net/alps#get-report": {
            "href": "https://api.preprod.slimpay.com/bank-accounts/1724b704-a503-11e6-97cb-000000000001/report{?entityReference,dateFrom,dateTo}",
            "templated": true
        }
    }
}

7. show-bank-accounts-history (relation)

Description: Show mandate bank accounts history. They will be 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!

Example: Show the debtor bank account history of a mandate
Request
GET follow(https://api.slimpay.net/alps#show-bank-accounts-history) 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: 2250

{
    "_embedded": {
        "bankAccounts": [
            {
                "_links": {
                    "self": {
                        "href": "https://api.preprod.slimpay.com/bank-accounts/fcf8d194-aa4c-11e6-a71f-000000000000"
                    },
                    "profile": {
                        "href": "https://api.preprod.slimpay.com/alps/v1/bank-accounts"
                    }
                },
                "id": "fcf8d194-aa4c-11e6-a71f-000000000000",
                "bic": "SLMPFRP1XXX",
                "iban": "FR7616348000011799737514625",
                "institutionName": "SLIMPAY"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.preprod.slimpay.com/bank-accounts/b3b64102-72cc-11e7-a699-000000000000"
                    },
                    "profile": {
                        "href": "https://api.preprod.slimpay.com/alps/v1/bank-accounts"
                    }
                },
                "id": "b3b64102-72cc-11e7-a699-000000000000",
                "bic": "ABNANL2AXXX",
                "iban": "NL26ABNA0767717262",
                "institutionName": "ABN AMRO BANK"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.preprod.slimpay.com/bank-accounts/fcf8d194-aa4c-11e6-a71f-000000000000"
                    },
                    "profile": {
                        "href": "https://api.preprod.slimpay.com/alps/v1/bank-accounts"
                    }
                },
                "id": "fcf8d194-aa4c-11e6-a71f-000000000000",
                "bic": "SLMPFRP1XXX",
                "iban": "FR7616348000011799737514625",
                "institutionName": "SLIMPAY"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.preprod.slimpay.com/bank-accounts/fcf8aa54-aa4c-11e6-a71f-000000000000"
                    },
                    "profile": {
                        "href": "https://api.preprod.slimpay.com/alps/v1/bank-accounts"
                    }
                },
                "id": "fcf8aa54-aa4c-11e6-a71f-000000000000",
                "bic": "SLMPFRP1XXX",
                "iban": "FR7616348000011523698541261",
                "institutionName": "SLIMPAY"
            }
        ]
    },
    "page": {
        "size": 10,
        "totalElements": 4,
        "totalPages": 1,
        "number": 0
    },
    "_links": {
        "self": {
            "href": "https://api.preprod.slimpay.com/mandates/6def0e61-7258-11e5-9eed-314e36732557/bank-accounts-history"
        },
        "search": {
            "href": "https://api.preprod.slimpay.com/mandates/6def0e61-7258-11e5-9eed-314e36732557/bank-accounts-history{?page,size}",
            "templated": true
        }
    }
}

8. update-bank-account (relation)

Description: Update a bank account.

Properties
iban
The IBAN (International Bank Account Number) identifying the bank account. Constraints: Text, 34 characters or less, Read-Write.
Example: Update a bank account
Request
POST follow(https://api.slimpay.net/alps#update-bank-account) HTTP/1.1
Accept: application/hal+json; profile="https://api.slimpay.net/alps/v1"
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJhcGkiXSwiZXhwIjoxNTMwNjMzNTk0LCJqdGkiOiI2ODNmNGE1Ni1kZjQ3LTQ0ZWYtYmIxYy02MDJhYmFlNGYwYjgiLCJjbGllbnRfaWQiOiJkZW1vY3JlZGl0b3IwMSJ9.VSmbmu4upmKj5_lTiBlqtbqSH42yx83AB1IFXJs08Tw

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

{
    "bic": "SLMPFRP1XXX",
    "iban": "FR7616348000011799737514625",
    "id": "fcf8d194-aa4c-11e6-a71f-000000000000",
    "institutionName": "SLIMPAY",
    "_links": {
        "self": {
            "href": "https://api.preprod.slimpay.com/mandates/6def0e61-7258-11e5-9eed-314e36732557/bank-account"
        },
        "profile": {
            "href": "https://api.preprod.slimpay.com/alps/v1/bank-accounts"
        },
        "https://api.slimpay.net/alps#get-mandate": {
            "href": "https://api.preprod.slimpay.com/mandates/6def0e61-7258-11e5-9eed-314e36732557"
        }
    }
}