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.

billing-addresses

  1. billing-address-representation
  2. get-billing-address

1. billing-address-representation

Description: A billing address representation. A billing address is a postal address used to bill for something.

Properties
street1
The first line of the street address. Constraints: Text, 70 characters or less, Read-Write.
street2
The second line of the street address. Constraints: Text, 70 characters or less, Read-Write.
city
The city of the address. Constraints: Text, 35 characters or less, Read-Write.
postalCode
The postal code of the debtor's invoicing address. Constraints: Text, 15 characters or less, Read-Write.
country
The country of the address (For France : FR). Constraints: Text, ISO3166, Read-Write.

2. get-billing-address (relation)

Description: Get one billing address.

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 billing address
Request
GET follow(https://api.slimpay.net/alps#get-billing-address) HTTP/1.1
Accept: application/hal+json; profile="https://api.slimpay.net/alps/v1"
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJhcGkiXSwiZXhwIjoxNDg4NDc0NzI1LCJqdGkiOiI3OThhNGEyYy1hOGE4LTQwNmItOGY0YS1mMjE3ZmNhMTM5YjciLCJjbGllbnRfaWQiOiJkZW1vY3JlZGl0b3IwMSJ9.VoN5FoWOoPfLkJU15ZIcYp2iRam4WJoVfMBw_35XCkw
Response
HTTP/1.1 200 OK
Content-Type: application/hal+json; profile="https://api.slimpay.net/alps/v1";charset=UTF-8
Content-Length: 705

{
    "city": "Paris",
    "country": "FR",
    "postalCode": "75008",
    "street1": "27 rue des fleurs",
    "street2": "Bat 2",
    "_links": {
        "https://api.slimpay.net/alps#get-mandate": {
            "href": "https://api-sandbox.slimpay.net/mandates/6def0e61-7258-11e5-9eed-314e36732557"
        },
        "https://api.slimpay.net/alps#get-signatory": {
            "href": "https://api-sandbox.slimpay.net/mandates/6def0e61-7258-11e5-9eed-314e36732557/signatory"
        },
        "self": {
            "href": "https://api-sandbox.slimpay.net/mandates/6def0e61-7258-11e5-9eed-314e36732557/signatory/billingAddress"
        },
        "profile": {
            "href": "https://api-sandbox.slimpay.net/alps/v1/billing-addresses"
        }
    }
}