Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Cariqa Payments API

The Payments API from Cariqa — 4 operation(s) for payments.

Cariqa Payments API is one of 7 APIs that Cariqa publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 4 operations across 4 paths, and defines 9 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0 (v1).

Requests are made against 2 base URLs: https://connect.cariqa.com, https://dev.connect.cariqa.com.

4 operations 4 paths 9 schemas 1 DELETE2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0 (v1)
Base URL
https://connect.cariqa.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Cariqa Payments API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth).

  • BearerAuth — JWT Authorization header using the Bearer scheme.

Paths & Operations 4

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

Payments 4
GET
/api/v1/users/{user_id}/payment-methods/
List Payment Methods
users_payment_methods_list 3 params → 200403404
DELETE
/api/v1/users/{user_id}/payment-methods/{pm}/
Delete Payment Method
users_payment_methods_destroy 2 params → 204400402403404
POST
/api/v1/users/{user_id}/payment-methods/{pm}/default/
Set Payment Method as Default
users_payment_methods_default_create 2 params → 204403404
GET
/api/v1/users/{user_id}/setup-intents/
Get Setup Intent
users_setup_intents_retrieve 2 params → 200400403404

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are ConnectAPIPM (5 properties), ConnectAPICardPM (4 properties), PaginatedConnectAPIPMList (4 properties), Error (3 properties). Each schema is shown below with its type and property counts.

PaginatedConnectAPIPMList
object
4 properties 2 required
ConnectAPISetupIntent
object
1 property 1 required
ConnectAPIPMTypeEnum
string
card - card applepay - applepay googlepay - googlepay
ErrorDetail
object
2 properties 2 required
ConnectAPIPM
object
5 properties 5 required
ErrorTypeEnum
string
validationerror - validationerror paymentmethoderror - paymentmethoderror paymenterror - paymenterror temporarylocked - temporarylocked alreadycharging - alrea…
Detail
object
400 status error message response serializer.
1 property 1 required
Error
object
3 properties 2 required
ConnectAPICardPM
object
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cariqa-payments-api-openapi.yml Raw ↑

Other APIs Cariqa publishes across the network.

Cariqa Billing Details API
Cariqa Charging Sessions API
Cariqa Debts API
Cariqa Invoices API
Cariqa Stations API
Cariqa Users API