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

ShopBack Pre Auth API

The Pre-Auth API from ShopBack — 6 operation(s) for pre-auth.

ShopBack Pre Auth API is one of 5 APIs that ShopBack publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Pre-Auth. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, and a getting-started guide.

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

Requests are made against a single base URL, https://integrations-sandbox.shopback.com/demo/merchant.

6 operations 6 paths 10 schemas 1 GET5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0
Base URL
https://prod-merchant-service.hoolah.co/merchant
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

ShopBack Pre Auth API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearer).

  • bearer — Merchant JWT obtained from POST /merchant-gateway/auth/login.

Paths & Operations 6

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

Pre-Auth 6
POST
/tokenized-payment/v1/pre-auths/{id}/capture
Capture a pre-authorization
capture-pre-auth 1 param body → 201401404409
POST
/tokenized-payment/v1/pre-auths
Create a pre-authorization
create-pre-auth 1 param body → 201400401
POST
/tokenized-payment/v1/tokens/cashback-balance
Get cashback balance for a payment token
get-cashback-balance body → 200400401
GET
/tokenized-payment/v1/pre-auths/{id}
Get a pre-authorization by ID
get-pre-auth 1 param → 200400401404
POST
/tokenized-payment/v1/charge
Immediate tokenized payment charge (auth + capture)
immediate-charge 1 param body → 201400401
POST
/tokenized-payment/v1/pre-auths/{id}/void
Void a pre-authorization
void-pre-auth 1 param body → 200401404409

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are PreAuthResponseDto (11 properties), CapturePreAuthResponseDto (9 properties), ImmediateChargeResponseDto (9 properties), MgsExternalErrorResponseDto (7 properties). Each schema is shown below with its type and property counts.

GetCashbackBalanceRequest
object
1 property 1 required
PreAuthResponseDto
object
11 properties 11 required
MgsExternalErrorResponseDto
object
7 properties 7 required
CapturePreAuthRequestDto
object
3 properties
ImmediateChargeResponseDto
object
9 properties 9 required
GetCashbackBalanceResponse
object
2 properties 2 required
CapturePreAuthResponseDto
object
9 properties 9 required
ImmediateChargeRequestDto
object
7 properties 5 required
CreatePreAuthRequestDto
object
6 properties 5 required
VoidPreAuthRequest
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

shopback-pre-auth-api-openapi.yml Raw ↑

Other APIs ShopBack publishes across the network.

ShopBack Account Linking API
ShopBack Authentication API
ShopBack Notification API
ShopBack Orders API
Where this information came from

This is an independent, third-party profile of ShopBack Pre Auth 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.