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 representation of a billing address resource. A billing address is a postal address used for invoicing purposes.

Properties
street1
The first line of the street address. Optional, but if set, then city, postalCode and country must also be provided. Constraints: Text, 70 characters or less, Read-Write.
street2
The second line of the street address. Constraints: Text, 70 characters or less, Read-Write (optional).
city
The city of the address. Optional, but if set, then street1, postalCode and country must also be provided. Constraints: Text, 35 characters or less, Read-Write.
postalCode
The postal code of the address. Optional, but if set, then street1, city and country must also be provided. Constraints: Text, 15 characters or less, Read-Write.
country
The country of the address. Optional, but if set, then street1, city and postalCode must also be provided. Constraints: Text, an ISO-3166-1 standard alpha-2 country code (e.g. FR for France), Read-Write.

2. get-billing-address (relation)

Description: Retrieve the representation of a billing address 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 billing address representation
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.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: 705

{
    "city": "Paris",
    "country": "FR",
    "postalCode": "75008",
    "street1": "27 rue des fleurs",
    "street2": "Bat 2",
    "_links": {
        "self": {
            "href": "https://api.preprod.slimpay.com/mandates/6def0e61-7258-11e5-9eed-314e36732557/signatory/billingAddress"
        },
        "profile": {
            "href": "https://api.preprod.slimpay.com/alps/v1/billing-addresses"
        },
        "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"
        }
    }
}