# Facilipay API v2

> Official Facilipay public API for third-party integrators. Covers authentication and registration, member accounts, merchant details, transactions and customers, inventory (products, categories, modifier groups), orders, campaigns, gift card liability reporting, payments, and digital gift card delivery. Each operation lists its supported authentication schemes: an API key issued from the Facilipay Dashboard (X-API-Key header) where ApiKeyAuth is shown, or a merchant JWT bearer token. For access and support, contact support@facilipay.io.

- Staging server: https://api-staging.loylap.com/v2
- Production server: https://api.loylap.com/v2

## Specification

- [Full reference (Markdown)](https://developers.facilipay.io/llms-full.txt): every operation below with its parameters, request body and responses
- [OpenAPI 3 (JSON)](https://developers.facilipay.io/openapi.json): full schemas for every operation below
- [OpenAPI 3 (YAML)](https://developers.facilipay.io/openapi.yml): same document, importable into Postman or Insomnia
- [Interactive reference](https://developers.facilipay.io/)

## Accounts

### Authentication

- POST /auth/refresh: Renews authentication token
- POST /auth/login/email: Authenticates the user by email in the system
- POST /auth/forgot/init/email: Starts recovering a forgotten password by email
- POST /auth/resend-activation: Re-send the account activation email

### Members

- POST /member: Register a new member
- GET /member/account/{accountId}: Get the user information from the account ID

## Merchants

### Merchant Details

- POST /merchants: Register a new merchant
- GET /merchants/{merchantId}: Returns merchant details

### Customers

- GET /merchants/{merchantId}/customers/v2: list customers
- GET /merchants/{merchantId}/customers/account/{accountId}: Look up a customer and balance by card number
- POST /merchants/{merchantId}/customers/cards: Register a card
- PUT /merchants/{merchantId}/customers/activate-account: Activate Account
- GET /merchants/{merchantId}/customers/{customerId}: Returns a customer details

### Transactions

- GET /merchants/{merchantId}/transactions/byUniqueId/{uniqueIdentifier}: Find a transaction by your identifier
- GET /merchants/{merchantId}/transactions/v2: List merchant transaction

### Orders

- GET /merchants/{merchantId}/orders: Returns merchant orders
- GET /merchants/{merchantId}/orders/v2: Returns Merchant Orders
- GET /merchants/{merchantId}/orders/products: Returns merchant order products

### Reporting

- GET /merchants/{merchantId}/reports/gift-cards/liability/kpis: Returns KPI data for gift cards liability report
- GET /merchants/{merchantId}/reports/gift-cards/liability: Returns merchant gift cards liability report data

### Gateway Reports

- GET /merchants/{merchantId}/reports/transactions: Fetch transaction report from payment gateways
- GET /merchants/{merchantId}/reports/batches: Fetch batch report with settlement data

## Inventory

### Products

- GET /inventory/products: Returns a list of Merchant's Inventory Products
- POST /inventory/products: Creates an inventory product
- GET /inventory/products/{productId}: Returns a product details
- PUT /inventory/products/{productId}: Updates a product
- PUT /inventory/products/{productId}/image: Update image of a product
- DELETE /inventory/products/{productId}/image: Deletes image of a category

### Categories

- GET /inventory/categories: Returns a list of Merchant's Inventory Categories
- POST /inventory/categories: Updates a category
- GET /inventory/categories/{categoryId}: Returns a categoty details
- PUT /inventory/categories/{categoryId}: Updates a category
- PUT /inventory/categories/{categoryId}/image: Update image of a category
- DELETE /inventory/categories/{categoryId}/image: Deletes image of a category
- GET /inventory/categories/{categoryId}/products: Returns products from a category
- PUT /inventory/categories/{categoryId}/products: Update products from a category

### Modifier Groups

- GET /inventory/modifiers-groups: Returns modifier groups
- POST /inventory/modifiers-groups: creates a new modifier group
- GET /inventory/modifiers-groups/{modifiersGroupId}: Returns a modifier group
- PUT /inventory/modifiers-groups/{modifiersGroupId}: Updates a modifier group
- PUT /inventory/modifiers-groups/{modifiersGroupId}/image: Updates a modifier group image
- DELETE /inventory/modifiers-groups/{modifiersGroupId}/image: Deletes a modifier group image
- GET /inventory/modifiers-groups/{modifiersGroupId}/products: Returns a modifier group with its associated products
- PUT /inventory/modifiers-groups/{modifiersGroupId}/products: Returns a modifier group with its associated products

### Products (by merchant ID)

- GET /merchants/{merchantId}/inventory/products: Returns a list of Merchant's Inventory Products
- POST /merchants/{merchantId}/inventory/products: Creates an inventory product
- GET /merchants/{merchantId}/inventory/products/{productId}: Returns a product details
- PUT /merchants/{merchantId}/inventory/products/{productId}: Updates a product
- PUT /merchants/{merchantId}/inventory/products/{productId}/image: Update image of a product
- DELETE /merchants/{merchantId}/inventory/products/{productId}/image: Deletes image of a category

### Categories (by merchant ID)

- GET /merchants/{merchantId}/inventory/categories: Returns a list of Merchant's Inventory Categories
- POST /merchants/{merchantId}/inventory/categories: Updates a category
- GET /merchants/{merchantId}/inventory/categories/{categoryId}: Returns a Categoty details
- PUT /merchants/{merchantId}/inventory/categories/{categoryId}: Updates a category
- PUT /merchants/{merchantId}/inventory/categories/{categoryId}/image: Update image of a category
- DELETE /merchants/{merchantId}/inventory/categories/{categoryId}/image: Deletes image of a category
- GET /merchants/{merchantId}/inventory/categories/{categoryId}/products: Returns products from a category
- PUT /merchants/{merchantId}/inventory/categories/{categoryId}/products: Update products from a category

### Modifier Groups (by merchant ID)

- GET /merchants/{merchantId}/inventory/modifiers-groups: Returns modifier groups
- POST /merchants/{merchantId}/inventory/modifiers-groups: creates a new modifier group
- GET /merchants/{merchantId}/inventory/modifiers-groups/{modifiersGroupId}: Returns a modifier group
- PUT /merchants/{merchantId}/inventory/modifiers-groups/{modifiersGroupId}: Updates a modifier group
- PUT /merchants/{merchantId}/inventory/modifiers-groups/{modifiersGroupId}/image: Updates a modifier group image
- DELETE /merchants/{merchantId}/inventory/modifiers-groups/{modifiersGroupId}/image: Deletes a modifier group image
- GET /merchants/{merchantId}/inventory/modifiers-groups/{modifiersGroupId}/products: Returns a modifier group with its associated products
- PUT /merchants/{merchantId}/inventory/modifiers-groups/{modifiersGroupId}/products: Returns a modifier group with its associated products

## Campaigns

### Campaigns

- GET /campaigns: Returns a list of campaigns
- GET /campaigns/{campaignId}: Returns a campaign
- PUT /campaigns/{campaignId}/notifications: Updates a campaign notification
- PUT /campaigns/{campaignId}/highlight: Updates a campaign highlight
- PUT /campaigns/{campaignId}/status: Updates a campaign status
- PUT /campaigns/{campaignId}/basic: Updates a campaign
- GET /campaigns/{campaignId}/transactions: Returns a campaign transactions
- GET /campaigns/{campaignId}/stats: Returns a campaign stats

### Segmentation Rules

- PUT /campaigns/{campaignId}/rules/gender: Updates a campaign gender rule
- PUT /campaigns/{campaignId}/rules/age: Updates a campaign age rule
- PUT /campaigns/{campaignId}/rules/customer_domains: Updates a campaign customer domains rule
- PUT /campaigns/{campaignId}/rules/birthday: Updates a campaign birthday rule
- PUT /campaigns/{campaignId}/rules/lapsed_customers: Updates a campaign lapsed customers rule
- PUT /campaigns/{campaignId}/rules/cake_day: Updates a campaign cake day rule
- PUT /campaigns/{campaignId}/rules/visits: Updates a campaign visits rule
- PUT /campaigns/{campaignId}/rules/spent: Updates a campaign spent rule
- PUT /campaigns/{campaignId}/rules/products: Updates a campaign products rule
- PUT /campaigns/{campaignId}/rules/top_visitors: Updates a campaign top visitors rule
- PUT /campaigns/{campaignId}/rules/top_spenders: Updates a campaign top spenders rule
- PUT /campaigns/{campaignId}/rules/role: Updates a campaign role rule
- PUT /campaigns/{campaignId}/rules/branches: Updates a campaign branches rule
- PUT /campaigns/{campaignId}/rules/customers: Updates a campaign customers rule
- PUT /campaigns/{campaignId}/rules/transaction_types: Updates a campaign transaction types rule

### Rewards

- PUT /campaigns/{campaignId}/rewards/discount: Updates a campaign discount reward
- PUT /campaigns/{campaignId}/rewards/discount_product: Updates a campaign discount_product reward
- PUT /campaigns/{campaignId}/rewards/cashback: Updates a campaign cashback reward
- PUT /campaigns/{campaignId}/rewards/voucher: Updates a campaign voucher reward

## Payments

### Payments

- POST /payments: Redeem or load stored value on a customer's card

### Gift Cards

- POST /gift-card/digital/send: Send digital giftcard