bank-accounts — Web API Reference

1. bank-account-representation

Description: A representation of a bank account resource.

Properties

id: The bank account id. Constraints: 36 characters or less, Read-Only.
bic: The BIC (Bank Identifier Code) identifying the account's bank. Optional, SlimPay can always compute a BIC when an IBAN is provided. 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 of the bank. Constraints: Text, 32 characters or less, Read-Only.
countryCode: The account's country code. Optional, but if set, then sortCode and accountNumber must also be provided, while iban and bic must not. Constraints: Text, 2 characters, Read-Write.
sortCode: The account's sort code. Optional, but if set, then countryCode and accountNumber must also be provided, while iban and bic must not. Constraints: 6 or 8 characters, Read-Write.
accountNumber: The account number. Optional, but if set, then sortCode and countryCode must also be provided, while iban and bic must not. Constraints: 8 characters, Read-Write.

2. bank-accounts-representation

Description: A collection of bank account representations.

3. get-bank-account (relation)

Description: Retrieve the representation of a single bank account 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 bank account representation

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: Retrieve a collection of bank account 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!

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

Description: Retrieve the representation of a debtor's 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: Retrieve the representation of a debtor's bank account

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 for the representation of a specific bank account resource, using its id parameter.

Properties

id: The bank 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: A debtor’s SEPA mandate is always associated with a bank account, which can be updated over time. You can retrieve a list of bank accounts from a mandate's history using this relation. The bank account representations will be returned in a collection, 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 the IBAN of a debtor’s bank account. The server returns the updated bank account resource in the response.

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"
        }
    }
}