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

Simplifi/Simplifipay Card API

The Card API from Simplifi/Simplifipay — 12 operation(s) for card.

Simplifi/Simplifipay Card API is one of 9 APIs that Simplifi/Simplifipay publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Card. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 17 operations across 12 paths, and defines 20 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://{env}-lb.simplifipay.com.

17 operations 12 paths 20 schemas 2 DELETE5 GET9 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://uat-lb.simplifipay.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Simplifi/Simplifipay Card API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — JWT access token from POST /v1/auth/login/{companyName}, sent as Authorization: Bearer .

Paths & Operations 17

Across 12 paths, the API surfaces 17 operations — 2 DELETE, 5 GET, 9 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Card 17
GET
/v1/card
List all Cards
listAllCards 5 params → 200400401
POST
/v1/card
Create a Card
createACard 2 params body → 200400401
GET
/v1/card/{uuid}
Get Card Details
getCardDetails 3 params → 200400401
GET
/v1/card/{uuid}/balance-inquiry
Retrieve Balance on the Card
retrieveBalanceOnTheCard 3 params → 200400401
POST
/v1/card/{uuid}/activate
Activate a Card
activateACard 3 params → 200400401
POST
/v1/card/{uuid}/status
Manage Card Status
manageCardStatus 3 params body → 200400401
POST
/v1/card/{uuid}/load
Load a Card
loadACard 3 params body → 200400401
POST
/v1/card/{uuid}/unload
Unload a Card
unloadACard 3 params body → 200400401
POST
/v1/card/{uuid}/renew
Renewal of the Card
renewalOfTheCard 3 params → 200400401
POST
/v1/card/{uuid}/card-type
Request a Physical Card
requestAPhysicalCard 3 params → 200400401
GET
/v1/statement/card/{uuid}
Get Card Statement
getCardStatement 7 params → 200400401
GET
/v1/card/{uuid}/rule-group
Get Rule Groups on Card
getRuleGroupsOnCard 3 params → 202400401
POST
/v1/card/{uuid}/rule-group
Create Rule Group on Card
createRuleGroupOnCard 3 params body → 202400401
PUT
/v1/card/{uuid}/rule-group
Update Rule Group on Card
updateRuleGroupOnCard 3 params body → 202400401
DELETE
/v1/card/{uuid}/rule-group
Delete Rule Group on Card
deleteRuleGroupOnCard 3 params body → 202400401
POST
/v1/card/{uuid}/rule-group/{ruleGroupUuid}
Apply Rule Group on Card
applyRuleGroupOnCard 4 params → 202400401
DELETE
/v1/card/{uuid}/rule-group/{ruleGroupUuid}
Remove Rule Group on Card
removeRuleGroupOnCard 4 params → 202400401

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are TransactionResponseDetails (24 properties), CardResponseModel (14 properties), CardStatementResponse (13 properties), RuleGroupLoadRestrictions (8 properties). Each schema is shown below with its type and property counts.

TransactionResponseDetails
object
24 properties 13 required
CardStatementResponse
object
13 properties 13 required
ErrorModel
object
2 properties
RuleGroupLoadRestrictions
object
Details of card load-related restrictions.
8 properties
CardAmountModel
object
2 properties 1 required
RuleGroupResponseModel
object
2 properties 2 required
RuleGroupModel
object
6 properties 1 required
CardRequestModel
object
4 properties 2 required
CardResponseModel
object
14 properties 10 required
MaskedPanParameter
string
This field contains the partially hidden Primary Account Number i.e. all digits are masked, except for the last four ones.
CardRenewalModel
object
2 properties 2 required
AmountModel
object
2 properties 1 required
CardStatusParameter
string
This field contains the current status of the card.
TransactionUuidParameter
string
This is a unique identifier of the transaction.
RuleGroupTransactionRestrictions
object
Details of transaction-related restrictions.
1 property 1 required
InstrumentType
string
This field specifies the type of card that is being issued.
CardStatusModel
object
2 properties 2 required
RuleGroupSpendRestrictions
object
Details of card spend-related restrictions.
7 properties
TransactionIdParameter
string
This is an identifier of the transaction.
RuleGroupMerchantRules
object
Allow or deny merchant category codes.
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

simplifi-simplifipay-card-api-openapi.yml Raw ↑

Other APIs Simplifi/Simplifipay publishes across the network.

Simplifi/Simplifipay Auth API
Simplifi/Simplifipay Card Program API
Simplifi/Simplifipay Document API
Simplifi/Simplifipay Fee API
Simplifi/Simplifipay Funding Source API
Simplifi/Simplifipay Transaction API
Simplifi/Simplifipay User API
Simplifi/Simplifipay Webhook API
Where this information came from

This is an independent, third-party profile of Simplifi/Simplifipay Card 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.