aYOUne
← Configuration API

CardReaders

Singular: CardReader — Base URL: https://config-api.ayoune.app — Access: CRUD

play_circle Try it now beta

Requests are proxied through the consumer-app to *.ayoune.app. Tokens stay in your browser and are forwarded per call.

Example response (recorded) sample

A real, previously recorded GET /:id response of this endpoint — not the live call above. Sensitive fields are masked.

{
  "payload": {
    "_id": "6a618e4b31196b877e8553f7",
    "name": "BORED_COFFEE_TAUN WE",
    "status": "",
    "createdBy": "6045f4d25704710012485569",
    "createdAt": "2026-07-23T03:45:15.317Z",
    "updatedAt": "2026-07-23T03:45:15.317Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://config-api.ayoune.app/cardreaders/6a618e4b31196b877e8553f7",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [
      {
        "rel": "PaymentProviders",
        "title": "MODEL_PAYMENTPROVIDER",
        "href": "https://api.ayoune.app/config/paymentproviders",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.paymentproviders"
      }
    ],
    "debugId": "6a62df2cf27d6098834b295e",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_CARDREADER",
        "href": "https://api.ayoune.app/config/cardreaders/6a618e4b31196b877e8553f7/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_CARDREADER",
        "href": "https://api.ayoune.app/config/cardreaders/6a618e4b31196b877e8553f7/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.95.0",
      "core": "2026.258.0"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "151",
      "reset": "1784865648",
      "resetDate": "Fri Jul 24 2026"
    },
    "responseTime": 188.274588,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

MethodPathDescriptionRight
GET /cardreaders List with filters/pagination config.cardreaders.view
GET /cardreaders/:id Single record config.cardreaders.view
POST /cardreaders Create new record config.cardreaders.new
PUT /cardreaders Update record config.cardreaders.edit
DELETE /cardreaders/:id Delete record config.cardreaders.delete

SDK

import { aYOUne } from '@tolinax/ayoune';
const ay = new aYOUne('pat_your_token');

// List all
const list = await ay.config.cardReaders.find().limit(10).exec();

// Single record
const one = await ay.config.cardReaders.findById('OBJECT_ID').exec();

// Create
const created = await ay.config.cardReaders.create({ name: 'Foo' });

See also