Skip to content

CON-10547: Regenerate docs with, deprecate external payment types #43

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jnv merged 6 commits into from
Apr 8, 2026
Merged

CON-10547: Regenerate docs with, deprecate external payment types #43

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
abbb86c
Regenerate docs
jnv Apr 2, 2026
0b347d0
Update changelog
jnv Apr 2, 2026
187b643
Merge branch 'main' into CON-10547-deprecate-depositcc
jnv Apr 2, 2026
87ca66c
Add deprecation table for enum values
jnv Apr 2, 2026
e573b1d
Fix dates
jnv Apr 2, 2026
c5f2d3f
Bump changelog date
jnv Apr 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions connector-api/_generator/types.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2619,3 +2619,9 @@ types:
closetaskparameters:
file: tasks.md
anchor: closetaskparameters
paymentalternativedata:
file: payments.md
anchor: alternative-payment-data
alternativepaymentmethodtypeenum:
file: payments.md
anchor: alternative-payment-method-type
13 changes: 13 additions & 0 deletions connector-api/changelog/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,19 @@
# Changelog

{% updates format="full" %}
{% update date="2026-04-03" %}

## Payments and payment methods updates

- [Get all payments](../operations/payments.md#get-all-payments):
- Extended [Payment data](../operations/payments.md#payment-data) response object with `Alternative` property.
- Extended [Payment data discriminator](../operations/payments.md#payment-data-discriminator) with `Alternative` value.
- Added [Alternative payment data](../operations/payments.md#alternative-payment-data) response object with [Alternative payment method type](../operations/payments.md#alternative-payment-method-type) enum.
- **Deprecated:** `DepositCreditCard` value in [External payment type](../operations/payments.md#external-payment-type). Only supported for existing partners.
- [Add payment requests](../operations/paymentrequests.md#add-payment-requests):
- Extended [Payment request parameters](../operations/paymentrequests.md#payment-request-parameters) request object with optional `BillId` parameter.

{% endupdate %}
{% update date="2026-03-25" %}

## March 2026 updates
Expand Down
17 changes: 17 additions & 0 deletions connector-api/deprecations/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,23 @@ The table columns have the following meanings:
| `TaxRate`<br>in [Currency value](../operations/accountingitems.md#currency-value) | - | Prior to 2021 | - |
| Object `UnitCost`<br> in [Get all accounting items](../operations/accountingitems.md#get-all-accounting-items) | Replaced by `Amount` | Prior to 2021 | - |

### Deprecated enum values

| Feature | Comments | Deprecated | Discontinued |
| :-- | :-- | :-- | :-- |
| `CreditCard` value in [External payment type](../operations/payments.md#external-payment-type) | Only supported for existing partners. | 14 Jul 2025 | - |
| `IDeal` value in [External payment type](../operations/payments.md#external-payment-type) | Only supported for existing partners. | 14 Jul 2025 | - |
| `PayPal` value in [External payment type](../operations/payments.md#external-payment-type) | Only supported for existing partners. | 14 Jul 2025 | - |
| `OnlinePayment` value in [External payment type](../operations/payments.md#external-payment-type) | Only supported for existing partners. | 14 Jul 2025 | - |
| `MasterCard` value in [External payment type](../operations/payments.md#external-payment-type) | Only supported for existing partners. | 14 Jul 2025 | - |
| `Visa` value in [External payment type](../operations/payments.md#external-payment-type) | Only supported for existing partners. | 14 Jul 2025 | - |
| `Amex` value in [External payment type](../operations/payments.md#external-payment-type) | Only supported for existing partners. | 14 Jul 2025 | - |
| `Discover` value in [External payment type](../operations/payments.md#external-payment-type) | Only supported for existing partners. | 14 Jul 2025 | - |
| `DinersClub` value in [External payment type](../operations/payments.md#external-payment-type) | Only supported for existing partners. | 14 Jul 2025 | - |
| `Jcb` value in [External payment type](../operations/payments.md#external-payment-type) | Only supported for existing partners. | 14 Jul 2025 | - |
| `UnionPay` value in [External payment type](../operations/payments.md#external-payment-type) | Only supported for existing partners. | 14 Jul 2025 | - |
| `DepositCreditCard` value in [External payment type](../operations/payments.md#external-payment-type) | Only supported for existing partners. | 3 Apr 2026 | - |
Copy link

Copilot AI Apr 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The deprecation date for DepositCreditCard is listed as 3 Apr 2026, but this PR’s changelog entry is dated 2026-04-08. If the deprecation is being introduced/communicated as part of this update, consider aligning the date (or adding a brief clarification if the API was deprecated earlier than the documentation update) to avoid confusion for readers.

Suggested change
| `DepositCreditCard` value in [External payment type](../operations/payments.md#external-payment-type) | Only supported for existing partners. | 3 Apr 2026 | - |
| `DepositCreditCard` value in [External payment type](../operations/payments.md#external-payment-type) | Only supported for existing partners. Deprecated on 3 Apr 2026; documented in the changelog on 2026-04-08. | 3 Apr 2026 | - |

Copilot uses AI. Check for mistakes.

### Operations using deprecated time filters

* [Get all customers](../operations/customers.md#get-all-customers)
Expand Down
4 changes: 3 additions & 1 deletion connector-api/operations/paymentrequests.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,8 @@ Creates a payment request to the specified [Customer](customers.md#customer). No
"ExpirationUtc": "2023-02-20T12:00:00Z",
"Description": "Payment required",
"Notes": "Internal notes.",
"ReservationId": "0f515589-99b4-423d-b83a-b237009f0509"
"ReservationId": "0f515589-99b4-423d-b83a-b237009f0509",
"BillId": "ea087d64-3901-4eee-b0b7-9fce4c58a005"
}
],
"SendPaymentRequestEmails": true,
Expand Down Expand Up @@ -198,6 +199,7 @@ Creates a payment request to the specified [Customer](customers.md#customer). No
| `Description` | string | required, max length 1000 characters | Description of the payment request. |
| `Notes` | string | optional, max length 1000 characters | Payment request's notes. |
| `ReservationId` | string | optional | Unique identifier of the `Reservation` the payment request belongs to. |
| `BillId` | string | optional | Unique identifier of the `Bill` the payment request is linked to. |
Comment thread
jnv marked this conversation as resolved.

### Response

Expand Down
88 changes: 85 additions & 3 deletions connector-api/operations/payments.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,8 @@ Returns all payments in the system, filtered by various parameters. At least one
},
"Invoice": null,
"External": null,
"Ghost": null
"Ghost": null,
"Alternative": null
},
"PaymentOrigin": "Terminal"
},
Expand Down Expand Up @@ -221,9 +222,73 @@ Returns all payments in the system, filtered by various parameters. At least one
"Kind": "Payment",
"Data": null,
"PaymentOrigin": "PointOfSales"
},
{
"Id": "a3e7f291-6c4d-4b8a-9f12-1d3e5c7b9a01",
"EnterpriseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"AccountId": "fadd5bb6-b428-45d5-94f8-fd0d89fece6d",
"AccountType": "Customer",
"PaymentRequestId": null,
"BillId": "ea087d64-3901-4eee-b0b7-9fce4c58a005",
"ReservationId": "0f515589-99b4-423d-b83a-b237009f0509",
"AccountingCategoryId": null,
"Amount": {
"Currency": "EUR",
"NetValue": -500,
"GrossValue": -500,
"TaxValues": [],
"Breakdown": {
"Items": [
{
"TaxRateCode": null,
"NetValue": -500,
"TaxValue": 0
}
]
}
},
"OriginalAmount": {
"Currency": "EUR",
"NetValue": -500,
"GrossValue": -500,
"TaxValues": [],
"Breakdown": {
"Items": [
{
"TaxRateCode": null,
"NetValue": -500,
"TaxValue": 0
}
]
}
},
"Notes": null,
"SettlementId": null,
"ConsumedUtc": null,
"ClosedUtc": null,
"ChargedUtc": null,
"CreatedUtc": "2023-03-06T09:00:00Z",
"UpdatedUtc": "2023-03-06T09:00:01Z",
"SettlementUtc": null,
"AccountingState": "Open",
"State": "Pending",
"Identifier": null,
"Type": "AlternativePayment",
"Kind": "Payment",
"Data": {
"Discriminator": "Alternative",
"CreditCard": null,
"Invoice": null,
"External": null,
"Ghost": null,
"Alternative": {
"Type": "WireTransfer"
}
},
"PaymentOrigin": "System"
}
],
"Cursor": "be922eb7-bc5f-4877-b847-1120c0c2acd2"
"Cursor": "a3e7f291-6c4d-4b8a-9f12-1d3e5c7b9a01"
}
```

Expand Down Expand Up @@ -297,13 +362,15 @@ Returns all payments in the system, filtered by various parameters. At least one
| `Invoice` | [Invoice payment data](payments.md#invoice-payment-data) | optional | Contains additional data in the case of an invoice payment. |
| `External` | [External payment data](payments.md#external-payment-data) | optional | Contains additional data in the case of an external payment. |
| `Ghost` | [Ghost payment data](payments.md#ghost-payment-data) | optional | Contains additional data in the case of a ghost payment. |
| `Alternative` | [Alternative payment data](payments.md#alternative-payment-data) | optional | Contains additional data in the case of an alternative payment. |

#### Payment data discriminator

* `CreditCard`
* `Invoice`
* `External`
* `Ghost`
* `Alternative`

#### Credit card payment data

Expand Down Expand Up @@ -389,7 +456,7 @@ Returns all payments in the system, filtered by various parameters. At least one
* `DirectDebit` - Direct debit
* `DepositCheck` - Deposit - check
* `DepositCash` - Deposit - cash
* `DepositCreditCard` - Deposit - credit card
* `DepositCreditCard` - Deposit - credit card – deprecated, only for existing partners
* `DepositWireTransfer` - Deposit - wire transfer

#### Ghost payment data
Expand All @@ -398,6 +465,21 @@ Returns all payments in the system, filtered by various parameters. At least one
| :-- | :-- | :-- | :-- |
| `OriginalPaymentId` | string | required | Unique identifier of the original payment. |

#### Alternative payment data

| Property | Type | Contract | Description |
| :-- | :-- | :-- | :-- |
| `Type` | [Alternative payment method type](payments.md#alternative-payment-method-type) | required | Type of the alternative payment method. |

#### Alternative payment method type

* `Ideal` - iDEAL
* `ApplePay` - Apple Pay
* `GooglePay` - Google Pay
* `SepaDirectDebit` - SEPA Direct Debit
* `PayPal` - PayPal
* `WireTransfer` - Wire transfer
Comment thread
jnv marked this conversation as resolved.

#### Payment origin

* `Other` - Fallback value unmapped in the current version of the API.
Expand Down
Loading