Skip to content

DropPay API - Shop v.1 - POS - Devices

DropPay comes with several enabled POS Devices by which a merchant can collects payments through:

  1. Application - merchant applications consuming DropPay POS API on behalf of a merchant; these devices operates directly over DropPay POS API (Payment Scheme available: DropPay, SEPA SCT);
  2. Static - a single persistent customer engagement code you can create and manage. Once it's created it can be printed as a QR code or shared as a deeplink. Whenever a DropPay user import it in his DropPay mobile application a payment flow is execute on merchant behalf (Payment Scheme: DropPay); forthcoming 2017-11-30
  3. Sepa SCT - this device lets a merchant define a regular expression that traps a Sepa Credit Transfer incoming in his Brand's payable Account, considering it as a payment and taking advantage from all the other Shop API features and tools (Payment Scheme: SEPA SCT); forthcoming 2017-11-30

DropPay API publish methods to programmatically creates, update and delete POS Devices and to link them to your Brand's Stores.

All those task can be accomplished by a Business Account Owner through the DropPay Secure website as well, but using Brand API could avoid to engage merchant users in mixing tasks on both Application and DropPay Secure website.

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.

Set your Application to act as a POS Device

In order to create a POS in a Store that your Application can run, and accordingly obtaining a valid pos_id, you have to :

  • ☑️ fetch the Brand and Stores list to make the merchant choose a Store from;

  • ☑️ set your Application as POS Device for a selected Store

Get to POS Application Device for details.

Use your Application to manage a POS Device

forthcoming 2017-11-30

  • ☑️ fetch the Brand and Stores list to make the merchant choose a Store from;

  • ☑️ use your Application to configure a POS Device for a selected Store

Available POS Devices your Application can manage are:

  • Static
  • Sepa SCT

Get to

for details.

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 a property value
  • (type, returned) is the type of a returned property
  • (type, posted) is the type of a requested property
  • after "-" there's a description

Brand

Properties

  • id: BRNC8K195PZ1Q (string, returned) - Brand's DropPay public ID
  • name: Acme Super Toons (string, returned) - Merchant brand name
  • image: http://acme.server/acmesupertoons.png (string, returned) - Merchant brand logo
  • description: Toons since XIX century (string, 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

Properties

  • 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

Properties

  • 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

Details at Authentication v.1 API Reference

GET - Retrieve Brands and Store list

Example

⬆️ Request

DropPay is identifing

1
2
3
curl --request GET
--url https://api.drop-pay.io/shop/v1/brands
--header 'Authorization: Bearer ac9185e9f2984867b11069fd2881ff1a'
⬇️ Response
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
{
    "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.