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.

creditors

  1. creditor-representation
  2. creditors-representation
  3. get-creditor
  4. get-creditors

1. creditor-representation

Description: A creditor representation. A creditor is, most of the time, a merchant.

Properties
reference
The creditor reference within the SlimPay referential. This reference is given by SlimPay. Constraints: Text, 35 characters or less, Read-Write.
Example: A creditor representation
{
    "reference": "democreditor",
    "_links": {
        "self": {
            "href": "https://api.preprod.slimpay.com/creditors/democreditor"
        },
        "profile": {
            "href": "https://api.preprod.slimpay.com/alps/v1/creditors"
        },
        "https://api.slimpay.net/alps#get-orders": {
            "href": "https://api.preprod.slimpay.com/orders?creditorReference=democreditor{&reference}",
            "templated": true
        },
        "https://api.slimpay.net/alps#get-mandates": {
            "href": "https://api.preprod.slimpay.com/mandates?creditorReference=democreditor{&rum,reference,paymentScheme}",
            "templated": true
        },
        "https://api.slimpay.net/alps#get-bank-accounts": {
            "href": "https://api.preprod.slimpay.com/creditors/democreditor/bank-accounts{?page,size}",
            "templated": true
        }
    }
}

2. creditors-representation

Description: A collection of creditors.

3. get-creditor (relation)

Description: Get one creditor.

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 creditor
Request
GET follow(https://api.slimpay.net/alps#get-creditor) 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: 813

{
    "reference": "democreditor",
    "_links": {
        "self": {
            "href": "https://api.preprod.slimpay.com/creditors/democreditor"
        },
        "profile": {
            "href": "https://api.preprod.slimpay.com/alps/v1/creditors"
        },
        "https://api.slimpay.net/alps#get-orders": {
            "href": "https://api.preprod.slimpay.com/orders?creditorReference=democreditor{&reference}",
            "templated": true
        },
        "https://api.slimpay.net/alps#get-mandates": {
            "href": "https://api.preprod.slimpay.com/mandates?creditorReference=democreditor{&rum,reference,paymentScheme}",
            "templated": true
        },
        "https://api.slimpay.net/alps#get-bank-accounts": {
            "href": "https://api.preprod.slimpay.com/creditors/democreditor/bank-accounts{?page,size}",
            "templated": true
        }
    }
}

4. get-creditors (relation)

Description: Get one creditor.

Properties
reference
The creditor reference within the SlimPay referential. This reference is given by SlimPay. Constraints: Text, 35 characters or less, Read-Write.