DropPay API¶

Shop v.1¶

Brand & Stores¶

Brand and Stores are currently created and managed from within the DropPay Secure Web application.

API described below can be used to read and list merchant's available Brands and Stores.

Brand Account and Connected Account must be the same

Please keep in mind it as very important constraint. Application performing requests against POS API on behalf of a merchant must have been connected to the same DropPay Account the Brand is using as payable account.

Listing available Brands and Stores¶

Brands¶

All the merchant's Brands using the same payable account as the one your Application is connected to are returned by this method.

When a Brand is filled up with many different Stores, an array of them will be included as well.

REST Entities¶

Every REST entity is described listing her properties with the following formatting conventions:

this is a property name
this is an example of property value
(type, policy, direction) is the specification of a property
- type can be "string", "number", "object" or a proper object class name
- policy can be "optional" or "required"
- direction can be "posted" or "received" depending on whether you set it in the request or you got it from the response
after the dash "-" there's the property description

name: example_value (type, policy, direction) - Property description

Brand¶

Brand

id: BRNC8K195PZ1Q (string, required, returned) - Brand's DropPay public ID
name: Acme Super Toons (string, required, returned) - Merchant brand name
image: http://acme.server/acmesupertoons.png (string, optional,returned) - Merchant brand logo
description: Toons since XIX century (string, required, returned) - Merchant brand description or payoff
business_categories: (array of strings, returned) - Business Categories that characterized products and services offered by the merchant brand. For forthcoming use, now still unuseful
payable_account:ACC32123FHS8V (string, returned) - Business Account DropPay public ID. For forthcoming use, now still unuseful
status: ENABLED (string, returned) - Status label, one of [ENABLED, DISABLED]
stores: (array of Store, returned) - Arrau of Store objects containing merchant store data

Store¶

Store

id: STRX88DHT129M (string, returned) - Store's DropPay public ID
name: Rome Store 1 (string, returned, optional) - Short name of the Store
place: REAL (string, returned) - Define is the Store is place to step in or to look at (i.e. adv display) or a virtual place to be visited/read/viewed. Cab be one of [REAL, VIRTUAL].
address: Piazza della rotonda - 00186 (string, returned) - Street Address if place is REAL or any other string with the same meaning if place is VIRTUAL (web address, magazines, etc.)
georef: (GeoReference, returned, optional) - If place is REAL also georef is present.

GeoReference¶

GeoReference

lat: 41.8922566 (string, returned) - latitude
lon: 12.476499 (string, returned) - longitude

REST Endpoints¶

DropPay POS API publishes a single method :

GET the Brand object entity list

Security¶

Requests must be authenticated with User Access Token. User Access Token can be obtained requesting it with and active Connection Code.

Details at Authentication v.1 API Reference

GET - Retrieve Brands and Store list¶

Example¶

Request¶

DropPay is identifing

curl --request GET
--url https://api.drop-pay.io/shop/v1/brands
--header 'Authorization: Bearer ac9185e9f2984867b11069fd2881ff1a'

Response¶

{
    "brands": [
        {
            "id": "BRNC8K195PZ1Q",
            "status": "ENABLED",
            "name": "Acme Super Toons",
            "logo": "http://acme.server/acmesupertoons.png",
            "description": "Toons since XIX century",
            "business_categories": [
                1,12,19
            ],
            "payable_account": "ACC32123FHS8V",
            "stores": [
                {
                  "id": "STRB45H8JJA97L",
                  "status": "ENABLED",
                  "name": "My E-commerce Site",
                  "place": "VIRTUAL",
                  "address": "www.mycommerce.com"
                },
                {
                  "id": "STRX88DHT129M",
                  "status": "ENABLED",
                  "name": "Rome Store 1",
                  "place": "REAL",
                  "address": "Piazza della rotonda - 00186",
                  "georef" : {
                      "lat": 41.8922566,
                      "lon": 12.476499
                  },
                }
            ]
        }
    ]
}

Errors handling¶

DropPay POS API is built around REST paradigm so HTTP Status code are consistently informing about what happened running your request.

See DropPay Common Errors for details about global common errors.