payment-accounts

Version 0.1.07 operations

Payment accounts within your scope, with routing and providers

GET/organisations/{id}/payment-accountsAPI key

Parameters

idstringpathrequired
includeArchivedbooleanquery
Include archived accounts (default false)

Responses

200
- idstring (uuid)required
- organisationIdstring (uuid)required
- namestringrequired
- slugstringrequired
- displayNamestring | nullrequired
  Checkout name; null uses name
- logoFileIdstring (uuid) | nullrequired
- themeColorstring | nullrequired
- successUrlstring | nullrequired
- failUrlstring | nullrequired
- statusstringrequired
  - enum: "active", "paused", "archived"
- isDefaultbooleanrequired
- archivedAtstring (date-time) | nullrequired
- routesRouteDto[]required
  - providerstringrequired
    - enum: "clictopay", "flouci", "izi", "mpgs_poste", "pluxee", "kashy", "enda_tao"
  - labelstringrequired
  - affiliationIdstring (uuid)required
  - affiliationStatusstringrequired
    Status of the affiliation; only active ones make the provider accepted
    - enum: "draft", "verifying", "active", "suspended", "revoked", "unknown"
- acceptedProvidersstring[]required
  Providers with an active routed affiliation; empty unless the account is active
- createdAtstring (date-time)required
- updatedAtstring (date-time)required

Code samples

curl -X GET "$KONNECT_API_URL/organisations/id/payment-accounts" \
  -H "x-api-key: $KONNECT_API_KEY"

Example: 200

[
  {
    "id": "id",
    "organisationId": "org_01J9Z3K4EXAMPLE0000000000",
    "name": "name",
    "slug": "online-shop",
    "displayName": "displayName",
    "logoFileId": "logoFileId",
    "themeColor": "#1a2b3c",
    "successUrl": "successUrl",
    "failUrl": "failUrl",
    "status": "active",
    "isDefault": true,
    "archivedAt": "2026-10-01T09:30:00.000Z",
    "routes": [
      {
        "provider": "clictopay",
        "label": "default",
        "affiliationId": "affiliationId",
        "affiliationStatus": "draft"
      }
    ],
    "acceptedProviders": [
      "clictopay"
    ],
    "createdAt": "2026-10-01T09:30:00.000Z",
    "updatedAt": "2026-10-01T09:30:00.000Z"
  }
]

Create a payment account (a collection point of the organisation)

POST/organisations/{id}/payment-accountsDashboard session

Parameters

idstringpathrequired

Request body application/json

displayNamestring | null
logoFileIdstring (uuid) | null
A file of this organisation (upload it first with type logo)
themeColorstring | null
successUrlstring | null
failUrlstring | null
namestringrequired
slugstring
Derived from name when omitted

Responses

201
- idstring (uuid)required
- organisationIdstring (uuid)required
- namestringrequired
- slugstringrequired
- displayNamestring | nullrequired
  Checkout name; null uses name
- logoFileIdstring (uuid) | nullrequired
- themeColorstring | nullrequired
- successUrlstring | nullrequired
- failUrlstring | nullrequired
- statusstringrequired
  - enum: "active", "paused", "archived"
- isDefaultbooleanrequired
- archivedAtstring (date-time) | nullrequired
- routesRouteDto[]required
  - providerstringrequired
    - enum: "clictopay", "flouci", "izi", "mpgs_poste", "pluxee", "kashy", "enda_tao"
  - labelstringrequired
  - affiliationIdstring (uuid)required
  - affiliationStatusstringrequired
    Status of the affiliation; only active ones make the provider accepted
    - enum: "draft", "verifying", "active", "suspended", "revoked", "unknown"
- acceptedProvidersstring[]required
  Providers with an active routed affiliation; empty unless the account is active
- createdAtstring (date-time)required
- updatedAtstring (date-time)required

Code samples

curl -X POST "$KONNECT_API_URL/organisations/id/payment-accounts" \
  -H "Cookie: konnect_session=$KONNECT_SESSION" \
  -H "Content-Type: application/json" \
  -d '{
  "displayName": "Test shop",
  "logoFileId": "logoFileId",
  "themeColor": "#1a2b3c",
  "successUrl": "https://shop.example.test/ok",
  "failUrl": "https://shop.example.test/ko",
  "name": "Online shop",
  "slug": "online-shop"
}'

Example: request body

{
  "displayName": "Test shop",
  "logoFileId": "logoFileId",
  "themeColor": "#1a2b3c",
  "successUrl": "https://shop.example.test/ok",
  "failUrl": "https://shop.example.test/ko",
  "name": "Online shop",
  "slug": "online-shop"
}

Example: 201

{
  "id": "id",
  "organisationId": "org_01J9Z3K4EXAMPLE0000000000",
  "name": "name",
  "slug": "online-shop",
  "displayName": "displayName",
  "logoFileId": "logoFileId",
  "themeColor": "#1a2b3c",
  "successUrl": "successUrl",
  "failUrl": "failUrl",
  "status": "active",
  "isDefault": true,
  "archivedAt": "2026-10-01T09:30:00.000Z",
  "routes": [
    {
      "provider": "clictopay",
      "label": "default",
      "affiliationId": "affiliationId",
      "affiliationStatus": "draft"
    }
  ],
  "acceptedProviders": [
    "clictopay"
  ],
  "createdAt": "2026-10-01T09:30:00.000Z",
  "updatedAt": "2026-10-01T09:30:00.000Z"
}

One payment account

GET/organisations/{id}/payment-accounts/{accountId}API key

Parameters

idstringpathrequired
accountIdstringpathrequired

Responses

200
- idstring (uuid)required
- organisationIdstring (uuid)required
- namestringrequired
- slugstringrequired
- displayNamestring | nullrequired
  Checkout name; null uses name
- logoFileIdstring (uuid) | nullrequired
- themeColorstring | nullrequired
- successUrlstring | nullrequired
- failUrlstring | nullrequired
- statusstringrequired
  - enum: "active", "paused", "archived"
- isDefaultbooleanrequired
- archivedAtstring (date-time) | nullrequired
- routesRouteDto[]required
  - providerstringrequired
    - enum: "clictopay", "flouci", "izi", "mpgs_poste", "pluxee", "kashy", "enda_tao"
  - labelstringrequired
  - affiliationIdstring (uuid)required
  - affiliationStatusstringrequired
    Status of the affiliation; only active ones make the provider accepted
    - enum: "draft", "verifying", "active", "suspended", "revoked", "unknown"
- acceptedProvidersstring[]required
  Providers with an active routed affiliation; empty unless the account is active
- createdAtstring (date-time)required
- updatedAtstring (date-time)required

Code samples

curl -X GET "$KONNECT_API_URL/organisations/id/payment-accounts/accountId" \
  -H "x-api-key: $KONNECT_API_KEY"

Example: 200

{
  "id": "id",
  "organisationId": "org_01J9Z3K4EXAMPLE0000000000",
  "name": "name",
  "slug": "online-shop",
  "displayName": "displayName",
  "logoFileId": "logoFileId",
  "themeColor": "#1a2b3c",
  "successUrl": "successUrl",
  "failUrl": "failUrl",
  "status": "active",
  "isDefault": true,
  "archivedAt": "2026-10-01T09:30:00.000Z",
  "routes": [
    {
      "provider": "clictopay",
      "label": "default",
      "affiliationId": "affiliationId",
      "affiliationStatus": "draft"
    }
  ],
  "acceptedProviders": [
    "clictopay"
  ],
  "createdAt": "2026-10-01T09:30:00.000Z",
  "updatedAt": "2026-10-01T09:30:00.000Z"
}

Edit name, slug, branding, URLs; pause, resume or make default

PATCH/organisations/{id}/payment-accounts/{accountId}Dashboard session

Parameters

idstringpathrequired
accountIdstringpathrequired

Request body application/json

displayNamestring | null
logoFileIdstring (uuid) | null
A file of this organisation (upload it first with type logo)
themeColorstring | null
successUrlstring | null
failUrlstring | null
namestring
slugstring
statusstring
Pause or resume; archiving has its own route
- enum: "active", "paused"
isDefaultnumber
Make this account the default one (the previous default stops being it)
- enum: true

Responses

200
- idstring (uuid)required
- organisationIdstring (uuid)required
- namestringrequired
- slugstringrequired
- displayNamestring | nullrequired
  Checkout name; null uses name
- logoFileIdstring (uuid) | nullrequired
- themeColorstring | nullrequired
- successUrlstring | nullrequired
- failUrlstring | nullrequired
- statusstringrequired
  - enum: "active", "paused", "archived"
- isDefaultbooleanrequired
- archivedAtstring (date-time) | nullrequired
- routesRouteDto[]required
  - providerstringrequired
    - enum: "clictopay", "flouci", "izi", "mpgs_poste", "pluxee", "kashy", "enda_tao"
  - labelstringrequired
  - affiliationIdstring (uuid)required
  - affiliationStatusstringrequired
    Status of the affiliation; only active ones make the provider accepted
    - enum: "draft", "verifying", "active", "suspended", "revoked", "unknown"
- acceptedProvidersstring[]required
  Providers with an active routed affiliation; empty unless the account is active
- createdAtstring (date-time)required
- updatedAtstring (date-time)required

Code samples

curl -X PATCH "$KONNECT_API_URL/organisations/id/payment-accounts/accountId" \
  -H "Cookie: konnect_session=$KONNECT_SESSION" \
  -H "Content-Type: application/json" \
  -d '{
  "displayName": "Test shop",
  "logoFileId": "logoFileId",
  "themeColor": "#1a2b3c",
  "successUrl": "https://shop.example.test/ok",
  "failUrl": "https://shop.example.test/ko",
  "name": "name",
  "slug": "slug",
  "status": "active",
  "isDefault": true
}'

Example: request body

{
  "displayName": "Test shop",
  "logoFileId": "logoFileId",
  "themeColor": "#1a2b3c",
  "successUrl": "https://shop.example.test/ok",
  "failUrl": "https://shop.example.test/ko",
  "name": "name",
  "slug": "slug",
  "status": "active",
  "isDefault": true
}

Example: 200

{
  "id": "id",
  "organisationId": "org_01J9Z3K4EXAMPLE0000000000",
  "name": "name",
  "slug": "online-shop",
  "displayName": "displayName",
  "logoFileId": "logoFileId",
  "themeColor": "#1a2b3c",
  "successUrl": "successUrl",
  "failUrl": "failUrl",
  "status": "active",
  "isDefault": true,
  "archivedAt": "2026-10-01T09:30:00.000Z",
  "routes": [
    {
      "provider": "clictopay",
      "label": "default",
      "affiliationId": "affiliationId",
      "affiliationStatus": "draft"
    }
  ],
  "acceptedProviders": [
    "clictopay"
  ],
  "createdAt": "2026-10-01T09:30:00.000Z",
  "updatedAt": "2026-10-01T09:30:00.000Z"
}

Archive a payment account (terminal; never the default account)

POST/organisations/{id}/payment-accounts/{accountId}/archiveDashboard session

Parameters

idstringpathrequired
accountIdstringpathrequired

Responses

200
- idstring (uuid)required
- organisationIdstring (uuid)required
- namestringrequired
- slugstringrequired
- displayNamestring | nullrequired
  Checkout name; null uses name
- logoFileIdstring (uuid) | nullrequired
- themeColorstring | nullrequired
- successUrlstring | nullrequired
- failUrlstring | nullrequired
- statusstringrequired
  - enum: "active", "paused", "archived"
- isDefaultbooleanrequired
- archivedAtstring (date-time) | nullrequired
- routesRouteDto[]required
  - providerstringrequired
    - enum: "clictopay", "flouci", "izi", "mpgs_poste", "pluxee", "kashy", "enda_tao"
  - labelstringrequired
  - affiliationIdstring (uuid)required
  - affiliationStatusstringrequired
    Status of the affiliation; only active ones make the provider accepted
    - enum: "draft", "verifying", "active", "suspended", "revoked", "unknown"
- acceptedProvidersstring[]required
  Providers with an active routed affiliation; empty unless the account is active
- createdAtstring (date-time)required
- updatedAtstring (date-time)required

Code samples

curl -X POST "$KONNECT_API_URL/organisations/id/payment-accounts/accountId/archive" \
  -H "Cookie: konnect_session=$KONNECT_SESSION"

Example: 200

{
  "id": "id",
  "organisationId": "org_01J9Z3K4EXAMPLE0000000000",
  "name": "name",
  "slug": "online-shop",
  "displayName": "displayName",
  "logoFileId": "logoFileId",
  "themeColor": "#1a2b3c",
  "successUrl": "successUrl",
  "failUrl": "failUrl",
  "status": "active",
  "isDefault": true,
  "archivedAt": "2026-10-01T09:30:00.000Z",
  "routes": [
    {
      "provider": "clictopay",
      "label": "default",
      "affiliationId": "affiliationId",
      "affiliationStatus": "draft"
    }
  ],
  "acceptedProviders": [
    "clictopay"
  ],
  "createdAt": "2026-10-01T09:30:00.000Z",
  "updatedAt": "2026-10-01T09:30:00.000Z"
}

Affiliation used per provider, and the accepted providers

GET/organisations/{id}/payment-accounts/{accountId}/routingAPI key

Parameters

idstringpathrequired
accountIdstringpathrequired

Responses

200
- paymentAccountIdstring (uuid)required
- routesRouteDto[]required
  - providerstringrequired
    - enum: "clictopay", "flouci", "izi", "mpgs_poste", "pluxee", "kashy", "enda_tao"
  - labelstringrequired
  - affiliationIdstring (uuid)required
  - affiliationStatusstringrequired
    Status of the affiliation; only active ones make the provider accepted
    - enum: "draft", "verifying", "active", "suspended", "revoked", "unknown"
- acceptedProvidersstring[]required

Code samples

curl -X GET "$KONNECT_API_URL/organisations/id/payment-accounts/accountId/routing" \
  -H "x-api-key: $KONNECT_API_KEY"

Example: 200

{
  "paymentAccountId": "paymentAccountId",
  "routes": [
    {
      "provider": "clictopay",
      "label": "default",
      "affiliationId": "affiliationId",
      "affiliationStatus": "draft"
    }
  ],
  "acceptedProviders": [
    "clictopay"
  ]
}

Route providers to affiliations of this organisation (null removes a route); revoked affiliations and affiliations of another organisation are refused

PUT/organisations/{id}/payment-accounts/{accountId}/routingDashboard session

Parameters

idstringpathrequired
accountIdstringpathrequired

Request body application/json

routesRouteChangeDto[]required
Changes per provider; providers not listed keep their routing
- providerstringrequired
  - enum: "clictopay", "flouci", "izi", "mpgs_poste", "pluxee", "kashy", "enda_tao"
- labelstring
  Label of the route. With an affiliation, it must match the affiliation label (taken from it when omitted). With null, omitting it removes every route of the provider.
- affiliationIdstring (uuid) | nullrequired
  Affiliation to use, or null to stop routing this provider

Responses

200
- paymentAccountIdstring (uuid)required
- routesRouteDto[]required
  - providerstringrequired
    - enum: "clictopay", "flouci", "izi", "mpgs_poste", "pluxee", "kashy", "enda_tao"
  - labelstringrequired
  - affiliationIdstring (uuid)required
  - affiliationStatusstringrequired
    Status of the affiliation; only active ones make the provider accepted
    - enum: "draft", "verifying", "active", "suspended", "revoked", "unknown"
- acceptedProvidersstring[]required

Code samples

curl -X PUT "$KONNECT_API_URL/organisations/id/payment-accounts/accountId/routing" \
  -H "Cookie: konnect_session=$KONNECT_SESSION" \
  -H "Content-Type: application/json" \
  -d '{
  "routes": [
    {
      "provider": "clictopay",
      "label": "default",
      "affiliationId": "affiliationId"
    }
  ]
}'

Example: request body

{
  "routes": [
    {
      "provider": "clictopay",
      "label": "default",
      "affiliationId": "affiliationId"
    }
  ]
}

Example: 200

{
  "paymentAccountId": "paymentAccountId",
  "routes": [
    {
      "provider": "clictopay",
      "label": "default",
      "affiliationId": "affiliationId",
      "affiliationStatus": "draft"
    }
  ],
  "acceptedProviders": [
    "clictopay"
  ]
}