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

Medusa Store Credit Accounts API

A store credit account is a ledger of store credit transactions for a customer. They hold the customer's store credit balance, including their credit and debit amounts.Store credit accounts allow you to build features that let customers pay for items using their store credit balance, such as gift cards or loyalty points.These API routes allow admin users to manage store credit accounts, their transactions, and more.Store Credit Account routes are only available for Cloud users using the [Loyalty Plugin](https://docs.medusajs.com/resources/commerce-modules/loyalty).

Medusa Store Credit Accounts API is one of 82 APIs that Medusa publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Store Credit Accounts. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 8 operations across 7 paths, and defines 18 schemas. It is described by OpenAPI 3.2.0, at version 2.19.0.

Requests are made against 2 base URLs: http://localhost:9000, https://api.medusajs.com.

8 operations 7 paths 18 schemas 5 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.19.0
Base URL
https://{medusa-backend-domain}
Authentication
HTTP Basic, HTTP Bearer, API Key, HTTP Bearer
Resource Areas
1

Authentication & Security 4

Medusa Store Credit Accounts API declares 4 security schemes for authenticating requests. It accepts HTTP basic authentication (api_token). It accepts HTTP bearer tokens (jwt_token). An API key is passed in the cookie as connect.sid (cookie_auth). It accepts HTTP bearer tokens (reset_password).

Paths & Operations 8

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

Store Credit Accounts 8

A store credit account is a ledger of store credit transactions for a customer. They hold the customer's store credit balance, including their credit and debit amounts. Store cred…

GET
/admin/store-credit-accounts
List Store Credit Accounts
GetStoreCreditAccounts 13 params → 200400401404409422500
POST
/admin/store-credit-accounts
Create Store Credit Account
PostStoreCreditAccounts body → 200400401404409422500
GET
/admin/store-credit-accounts/{id}
Get a Store Credit Account
GetStoreCreditAccountsId 14 params → 200400401404409422500
POST
/admin/store-credit-accounts/{id}/credit
Add Credit to Store Credit Account
PostStoreCreditAccountsIdCredit 1 param body → 200400401404409422500
GET
/admin/store-credit-accounts/{id}/transactions
List Transactions
GetStoreCreditAccountsIdTransactions 13 params → 200400401404409422500
GET
/store/store-credit-accounts
List Customer's Store Credit Accounts
GetStoreCreditAccounts 13 params → 200400401404409422500
POST
/store/store-credit-accounts/claim
Claim a Store Credit Account
PostStoreCreditAccountsClaim 3 params body → 200400401404409422500
GET
/store/store-credit-accounts/{id}
Get Customer's Store Credit Account
GetStoreCreditAccountsId 4 params → 200400401404409422500

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are AdminCustomerAddress (18 properties), StoreCustomerAddress (18 properties), AdminCustomer (16 properties), StoreCustomer (13 properties). Each schema is shown below with its type and property counts.

AdminStoreCreditAccount
object
The store credit account's details.
11 properties 9 required
AdminStoreCreditAccountResponse
object
The store credit account's details.
1 property 1 required
AdminCreateStoreCreditAccount
object
The details of the store credit account to create.
3 properties 1 required
AdminCustomer
object
The customer's details.
16 properties 9 required
Error
object
3 properties
AdminCustomerGroup
object
The customer group's details.
6 properties 6 required
AdminCustomerAddress
object
The customer's address.
18 properties 18 required
AdminTransactionsResponse
object
The paginated list of transactions.
5 properties 4 required
AdminCreditStoreCreditAccountParams
object
The details of crediting a store credit account.
2 properties 1 required
AdminStoreCreditAccountsResponse
object
The paginated list of store credit accounts.
5 properties 4 required
AdminTransaction
object
The transaction's details.
11 properties 8 required
StoreStoreCreditAccountsResponse
object
The paginated list of store credit accounts.
5 properties 4 required
StoreClaimStoreCreditAccountResponse
object
The details of the claimed store credit account.
1 property 1 required
StoreClaimStoreCreditAccountParams
object
The parameters required to claim a store credit account.
1 property 1 required
StoreCustomer
object
The customer's details.
13 properties 8 required
StoreCustomerAddress
object
The customer address's details
18 properties 18 required
StoreStoreCreditAccountResponse
object
The store credit account's details.
1 property 1 required
StoreStoreCreditAccount
object
The store credit account's details.
11 properties 9 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

medusa-store-credit-accounts-api-openapi.yml Raw ↑

Other APIs Medusa publishes across the network.

Medusa GraphQL API
Medusa MCP Remote Server
Medusa Api Keys API
Medusa Auth API
Medusa [auth Provider] API
Medusa Campaigns API
Medusa Carts API
Medusa Claims API
Medusa Collections API
Medusa Currencies API
Medusa Customer Groups API
Medusa Customers API
Where this information came from

This is an independent, third-party profile of Medusa Store Credit Accounts 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.