Cards

Stored and saved card management

List saved cards

get

Authorizations

SessionCookie

CookiestringRequired

Session cookie (e.g., sessionid=abc123)

Header parameters

CookiestringRequired

Session cookie header (e.g. sessionid=abc123)

Responses

200

Saved cards listed

application/json

Saved card resource returned by saved-cards endpoints. Fields mirror omnishop.payments.models.SavedCard.

pkintegerRequired

Saved card identifier

namestring · nullableOptional

User-defined card label

Example: Personal Visa

tokenstringRequired

Gateway token for the saved card (opaque)

userintegerRequired

Owner user ID

masked_card_numberstringRequired

Masked PAN (e.g., **** **** **** 1234)

Example: **** **** **** 1234

posinteger · nullableOptional

POS identifier associated with the card

created_datestring · date-timeOptional

Creation timestamp

modified_datestring · date-timeOptional

Last update timestamp

401

Authentication required

get

/users/saved-cards/

HTTPcURLJavaScriptPython

GET /users/saved-cards/ HTTP/1.1
Host: sandbox.akinon.com
Cookie: text
Accept: */*

[
  {
    "pk": 1,
    "name": "Personal Visa",
    "token": "text",
    "user": 1,
    "masked_card_number": "**** **** **** 1234",
    "pos": null,
    "created_date": "2026-05-18T15:57:43.362Z",
    "modified_date": "2026-05-18T15:57:43.362Z"
  }
]

Retrieve saved card

get

Authorizations

SessionCookie

CookiestringRequired

Session cookie (e.g., sessionid=abc123)

Path parameters

pkintegerRequired

Header parameters

CookiestringRequired

Session cookie header (e.g. sessionid=abc123)

Responses

200

Saved card retrieved

application/json

Saved card resource returned by saved-cards endpoints. Fields mirror omnishop.payments.models.SavedCard.

pkintegerRequired

Saved card identifier

namestring · nullableOptional

User-defined card label

Example: Personal Visa

tokenstringRequired

Gateway token for the saved card (opaque)

userintegerRequired

Owner user ID

masked_card_numberstringRequired

Masked PAN (e.g., **** **** **** 1234)

Example: **** **** **** 1234

posinteger · nullableOptional

POS identifier associated with the card

created_datestring · date-timeOptional

Creation timestamp

modified_datestring · date-timeOptional

Last update timestamp

401

Authentication required

404

Card not found

get

/users/saved-cards/{pk}/

HTTPcURLJavaScriptPython

GET /users/saved-cards/{pk}/ HTTP/1.1
Host: sandbox.akinon.com
Cookie: text
Accept: */*

{
  "pk": 1,
  "name": "Personal Visa",
  "token": "text",
  "user": 1,
  "masked_card_number": "**** **** **** 1234",
  "pos": null,
  "created_date": "2026-05-18T15:57:43.362Z",
  "modified_date": "2026-05-18T15:57:43.362Z"
}

Delete saved card

delete

Authorizations

SessionCookie

CookiestringRequired

Session cookie (e.g., sessionid=abc123)

Path parameters

pkintegerRequired

Header parameters

CookiestringRequired

Session cookie header (e.g. sessionid=abc123)

X-CSRFTokenstringRequired

CSRF token header for unsafe methods (POST/PUT/PATCH/DELETE)

Responses

204

Saved card deleted

401

Authentication required

404

Card not found

delete

/users/saved-cards/{pk}/

HTTPcURLJavaScriptPython

DELETE /users/saved-cards/{pk}/ HTTP/1.1
Host: sandbox.akinon.com
Cookie: text
X-CSRFToken: text
Accept: */*

No content

Update saved card

patch

Authorizations

SessionCookie

CookiestringRequired

Session cookie (e.g., sessionid=abc123)

Path parameters

pkintegerRequired

Header parameters

CookiestringRequired

Session cookie header (e.g. sessionid=abc123)

X-CSRFTokenstringRequired

CSRF token header for unsafe methods (POST/PUT/PATCH/DELETE)

Body

application/json

Fields allowed for saved card update

namestring · nullableOptional

User-defined card label

Responses

200

Saved card updated

application/json

Saved card resource returned by saved-cards endpoints. Fields mirror omnishop.payments.models.SavedCard.

pkintegerRequired

Saved card identifier

namestring · nullableOptional

User-defined card label

Example: Personal Visa

tokenstringRequired

Gateway token for the saved card (opaque)

userintegerRequired

Owner user ID

masked_card_numberstringRequired

Masked PAN (e.g., **** **** **** 1234)

Example: **** **** **** 1234

posinteger · nullableOptional

POS identifier associated with the card

created_datestring · date-timeOptional

Creation timestamp

modified_datestring · date-timeOptional

Last update timestamp

401

Authentication required

404

Card not found

patch

/users/saved-cards/{pk}/

HTTPcURLJavaScriptPython

PATCH /users/saved-cards/{pk}/ HTTP/1.1
Host: sandbox.akinon.com
Cookie: text
X-CSRFToken: text
Content-Type: application/json
Accept: */*
Content-Length: 13

{
  "name": null
}

{
  "pk": 1,
  "name": "Personal Visa",
  "token": "text",
  "user": 1,
  "masked_card_number": "**** **** **** 1234",
  "pos": null,
  "created_date": "2026-05-18T15:57:43.362Z",
  "modified_date": "2026-05-18T15:57:43.362Z"
}

List stored cards

get

Returns stored cards for the authenticated user.

Authorizations

SessionCookie

CookiestringRequired

Session cookie (e.g., sessionid=abc123)

Header parameters

CookiestringRequired

Session cookie header (e.g. sessionid=abc123)

Responses

200

Stored cards listed

application/json

401

Authentication required

get

/users/stored-cards/

HTTPcURLJavaScriptPython

GET /users/stored-cards/ HTTP/1.1
Host: sandbox.akinon.com
Cookie: text
Accept: */*

{
  "cards": [
    {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ]
}