How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Scalapay Instore API

The Instore API from Scalapay — 6 operation(s) for instore.

Scalapay Instore API is one of 3 APIs that Scalapay publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include In-Store. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 6 operations across 6 paths, and defines 4 schemas. It is described by OpenAPI 3.2.0, at version 3.0.

Requests are made against 2 base URLs: https://integration.api.scalapay.com, https://api.scalapay.com.

6 operations 6 paths 4 schemas 2 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
3.0
Base URL
https://api.scalapay.com
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

Scalapay Instore API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (ApiKeyAuth). An API key is passed in the header as Authorization (InstoreApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — API key authentication using the Authorization header with a Bearer token.
  • InstoreApiKeyAuth — API key authentication for instore endpoints using the Authorization header with a Bearer token.

Paths & Operations 6

Across 6 paths, the API surfaces 6 operations — 2 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Instore 6
POST
/v1/instore/orders
Create instore order
body → 200400401
GET
/v1/instore/orders/references
Get instore orders by reference
3 params → 200400401
GET
/v1/instore/orders/{token}
Get an instore order
1 param → 200400401
POST
/v1/instore/orders/{token}/refund
Refund an instore order
1 param body → 200400401
POST
/v2/instore/paybylink/orders
Create an offline pay-by-link order
body → 200400401
POST
/v2/instore/paybylink/orders/{token}/void
Void an offline pay-by-link order
1 param body → 200400401

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are extensions (2 properties), amount (2 properties). Each schema is shown below with its type and property counts.

amount
object
The monetary amount.
2 properties 2 required
extensions
object
Additional extension properties for the order.
2 properties
items
array
List of items in the order.
merchantReference
string
Merchant reference for tracking the order in your system.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

scalapay-instore-api-openapi.yml Raw ↑

Other APIs Scalapay publishes across the network.

Scalapay Orders API
Scalapay Reporting API
Where this information came from

This is an independent, third-party profile of Scalapay Instore API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.