Skip to content
/Recipient Management

Cheqi API (v1)

Cheqi provides APIs for creating receipts and reading receipts for customers

Download OpenAPI description
api-docs.json
api-docs.yaml
Languages
Servers
Mock server
https://docs.cheqi.io/_mock/apis/api-docs
Generated server url
https://test.api.cheqi.io

Client Application Management

Endpoints for managing OAuth2 client applications, including registration, secret management, and public key configuration

Operations

Credit Note Management

Endpoints for creating, managing, and retrieving credit notes (refund receipts)

Operations

Recipient Management

Endpoints for resolving and matching receipt recipients

Operations

Resolve receipt recipient

Request

Resolves and matches a receipt recipient based on the provided identification details (email, phone number, IBAN, or card number). Returns the matched recipient's details if found, enabling receipt delivery to the correct user.

Accessible for: Company, Client Application

Security
cheqi_oauth
Bodyapplication/jsonrequired
paymentTypestringrequired

The payment type

Enum"CARD_PAYMENT""DIRECT_DEBIT""CASH"
Example: "CREDIT_CARD"
cardDetailsobject(CardDetails)

The card details

paymentAccountDetailsobject(PaymentAccountDetails)

The payment account details, for now only IBAN/WERO is supported

paymentIdsArray of strings

The payment IDs that are used to identify the payment on your side

recipientEmailstring

The recipient email

Example: "recipient@example.com"
cheqiReceiptIdstring

The Cheqi receipt ID, only needed for credit notes

Example: "CHQ-12345678-123456-123456"
userIdstring(uuid)

The user ID

curl -i -X POST \
  https://docs.cheqi.io/_mock/apis/api-docs/recipient/resolve \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "paymentType": "CREDIT_CARD",
    "cardDetails": {
      "cardProvider": "MAESTRO",
      "paymentAccountNumber": "string",
      "paymentAccountReference": "string",
      "additionalProperties": {
        "property1": {},
        "property2": {}
      }
    },
    "paymentAccountDetails": {
      "identifier": "string",
      "accountIdentifierType": "IBAN",
      "bic": "string",
      "bankName": "string",
      "accountHolderName": "string",
      "institutionName": "string"
    },
    "paymentIds": [
      "string"
    ],
    "recipientEmail": "recipient@example.com",
    "cheqiReceiptId": "CHQ-12345678-123456-123456",
    "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
  }'

Responses

Recipient successfully resolved and matched

Body*/*
customerFoundboolean
matchIdstring
recipientsArray of objects(Recipient)
paymentMeansArray of objects(PaymentMeans)
expiresAtstring(date-time)
instructionsstring

Receipt Management

Endpoints for creating and managing purchase receipts with end-to-end encryption

Operations

Webhook Management

Endpoints for managing webhook subscriptions to receive real-time event notifications

Operations