Merchants

Merchant operations:

  • List all Merchants
  • Create a new Merchant
  • Retrieve a Merchant
  • Update a Merchant
post

Create a new merchant.

get

Returns a list of your merchants. The merchants are returned sorted by creation date, with the most recent merchants appearing first.

patch

Update an existing merchant.

get

Retrieve the merchant details.

Shops

Shops operations:

  • List all Shops.
  • Create a new Shop
  • Update a Shop
  • Retrieve a Shop
  • Delete a Shop
post

Create a shop.

get

Return a list of shops.

patch

Update an existing shop.

delete

Delete a Shop.

get

Retrieve the shop details.

Pois

A POI (Point Of Interaction) is a hardware and/or software component in the merchant ecosystem, allowing interaction with the end-customer.
POI types are : POS, ECR, SMARTPHONE, TABLET, ESHOP, VIDEO_SECURITY.
POI operations:

  • List all POIs
  • Create a POI
  • Update a POI
  • Delete a POI
  • Retrieve a POI
  • List all payment transactions done on a POI
  • Administrate POI periods : TODO
post

Creates a new poi object

get

Return a list of POIs.

get

Returns a POI.

patch

Updates the specified poi by setting the values of the json passed.

delete

Removes the currently POI.

get

Periods

Period operations:

  • List all periods.
  • Creating a new period
  • Delete a period
  • Retrieving a period
get

TODO

post

Creating a new period

delete

Deletes a period that has previously been created.

get

Retrieves the details of a period that has previously been created. Supply the unique period ID that was returned from your previous request, and Opsise will return the corresponding period information. The same information is returned when creating the period.

Users

Merchant operations:

  • List all User accounts.
  • Creating a new user account
  • Update a user account
  • Delete a user account
  • Retrieving a User account
post

Create a user account

get

Returns a list of your users accounts. The users accounts are returned sorted by creation date, with the most recent users appearing first.

patch

Updates a user account

delete

Delete a user account

Notifications

A notification is a message or alert delivered by the server to an endpoint device. Notification type are

  • VIDEO_SECURITY use to send a message on merchant from VIDEO_SECURITY POI type
  • ECR use to send a message on merchant from ECR POI type
  • SERVICE use to send a message on merchant from a service
  • COM use to send un global message
  • PROMO use to send and add message
post

Create and push notifications to smart control App users.

Services

A service is an application contracted by a merchant, installed on POI. For example, CB, AMEX, ...

get

Returns a list of services

Contracts

Contract operations:

  • List all Contracts.
  • Creating a Contract
  • Retrieving a Contract
post

Creates a new Contract object

get

Returns a list of your contracts.

get

Retrieves the details of a contract

Operations

Operation represent an order with a list of items. Before POST or GET an operation, you should create a poi in order to attach the Operation to the merchant. Operations allowed are:

  • Creating a new Operation
  • Adding a new Payment_transaction to an Operation
post

Create an operation

get

Returns a list of your Operations.

post

Create a payment transaction associate to the operation. The payment service list is : CB, AMEX, CASH, CHECK, LUNCHEON_VOUCHER or UNDEFINED. If you want to post a other service transaction, please send us a request by email at admin@opsise.com.

get

Returns a list of transactions assoxciate to the operation.

Payment transactions

Payment transaction : CB, VISA, Mastarcard, Paypal, Cofinoga, ...

get

Returns a list of transactions you've previously created. The transactions are returned in sorted order, with the most recent transactions

get

Retrieves the details of a payment transaction that has previously been created. Supply the unique transaction ID that was returned from your previous request, and Opsise will return the corresponding transaction information. The same information is returned when creating or refunding the transaction.

Authorizations

Authorizations operations:

  • List all Authorizations transactions.
  • Creating a Authorizations
  • Retrieving an Authorizations
get

Returns a list of authorizations you've previously created. The authorizations are returned in sorted order, with the most recent transactions

get

Retrieves the details of a payment authorization that has previously been created. Supply the unique authorization ID that was returned from your previous request, and Opsise will return the corresponding authorization information. The same information is returned when creating the authorization.

Settlements

Settlement. is the process through which a Merchant receives funds for a transaction with a customer. Settlements operations:

  • List all Settlements transactions.
  • Creating a Settlements
  • Retrieving an Settlements
get

Retrieves all payment settlement that has previously been created.

get

Retrieves the details of a payment settlement that has previously been created. Supply the unique settlement ID that was returned from your previous request, and Opsise will return the corresponding settlement information. The same information is returned when creating the settlement.

Payment means

Represents payment methods : credits / debits cards, wallet, paylpal account, ...

get

List All Payment means

get

Retun a payment means

PLBS

TODO

post

TODO

get

TODO

get

TODO