Skip to main content

Documentation Index

Fetch the complete documentation index at: https://cariqa.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

​
Payment Method Setup Flow

Payment methods must be added using Stripe SDK and native UI elements for PSD2/SCA compliance.

​
1. Fetch Setup Intent

curl -X GET "https://connect.cariqa.com/api/v1/users/9405cf8c-8375-4373-b4d3-b61f9a0c01eb/setup-intents/?pm_type=card" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
Response: 
{
  "client_secret": "seti_1THkgXHtgZxQ1KXxOhLbYQKU_secret_UGHFCX0iihdboXkwx4QfiR9V2ma55vk"
}

​
2. Frontend Integration

Initialize Stripe on the client using:
  • Stripe SDK with publishable key from onboarding
  • Native Stripe UI elements (required)
  • Complete payment method creation client-side

​
3. Confirm Setup with Stripe

Use the client_secret to complete payment method attachment through Stripe SDK.

​
Payment Method Management

​
List User Payment Methods

Common use cases:
  • Show saved cards in settings page
  • Let user choose default payment method
  • Allow payment method removal
Response includes various payment types: card, google_pay, apple_pay

​
List Payment Methods

curl -X GET "https://connect.cariqa.com/api/v1/users/9405cf8c-8375-4373-b4d3-b61f9a0c01eb/payment-methods/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
Response: 
{
  "count": 2,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": "pm_1TD1M3HtgZxQ1KXx5wMzfx15",
      "default": false,
      "type": "apple_pay",
      "card": {
        "brand": "visa",
        "last4": "4242",
        "expiration_date": "12/2027",
        "cardholder_name": "John Doe"
      },
      "created_at": "2026-03-20T11:36:39Z"
    },
    {
      "id": "pm_1TD1LuHtgZxQ1KXxNj5sKkKM",
      "default": true,
      "type": "card",
      "card": {
        "brand": "visa",
        "last4": "4242",
        "expiration_date": "04/2044",
        "cardholder_name": null
      },
      "created_at": "2026-03-20T11:36:30Z"
    }
  ]
}

​
Set Default Payment Method

curl -X POST "https://connect.cariqa.com/api/v1/users/9405cf8c-8375-4373-b4d3-b61f9a0c01eb/payment-methods/pm_abc123/default/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

​
Remove Payment Method

curl -X DELETE "https://connect.cariqa.com/api/v1/users/9405cf8c-8375-4373-b4d3-b61f9a0c01eb/payment-methods/pm_abc123/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

​
Removal Restrictions

Payment method removal may fail if:
  • Charging session is in progress
  • Payment method is attached to active session
  • Payment method is set as default
  • Active charging session present
  • CDR processing incomplete
  • User debt exists (402 Payment Required)