Custom Bordeaux API

All notable changes to the API will be documented in this file.
Please pay attention to last major updates referenced in the Breaking Changes section

Breaking changes

These changes will affect the exposed interfaces, therefore external integrations of the API. Please make sure to check these points :

2025-04-18 (3.4.16)

Added

/admin/subscriptions/

• Added new payment type NO_TITAN_IMPACT on unpaid regularization (BM-2104)
• Added new field on subscription export endpoint (BM-2115)

/admin/orders/

• Added SCODI user birthdate on order export (BM-2129)

Updated

/admin/subscriptions/

• Updated SCODI subscription order which no longer uses customer profile (BM-1718, BM-2125)
• Updated access control list for BO users (BM-2043)
• Updated new Cykleo subscription status to be considered as ACTIVE (BM-2107)
• Updated subscription cancellation which now update mTicket contract end date (BM-2109)

Fixed

/admin/orders/

• Fixed order view with SVD order missing (BM-2083)
• Fixed precheck issue on monthly (BM-2131)

/eshop/orders/

• Fixed contract start date on schedule PDF document (BM-1884)

script

• Fixed Titan export on installment change (BM-2036)

2025-03-28 (3.4.16)

Added

/admin/subscriptions/

• Added next IBAN change installment date (BM-2094)
• Added subscription next cancellation date (BM-2060)
• Added history for installment change operation (BM-2064)
• Added history for subscription cancellation operation (BM-2065)
• Added endpoint to change installment IBAN (BM-2058)
• Added endpoint to cancel subscription (BM-2059)

/admin/profiles/

• Added allowMediaSale field management(BM-2097)

script

• Import installment payment script now fetch RUM and IBAN (BM-2093)

Updated

script

• Updated Titan export script to handle installment change operation (BM-2098, BM-2099)
• Updated Titan export script to handle subscription cancellation operation (BM-2100)

/eshop/customer/subscriptions/

• Updated Cykleo park subscription type (BM-2087)

2025-03-03 (3.4.15)

Added

/admin/subscriptions/

• Added new route to update installments (BM-2056)
• Added subscription history endpoint (BM-2047)
• Added subscription update history
• Added Cykleo specific statuses (BM-1994)

script

• Added Titan export on tacit reconduction (BM-2040)
• Added Titan export on unpaid regularization by an operator (BM-1968)
• Added status filter (TRANSACTION_STATUS) on paid installments import script (BM-1946)

Updated

/admin/subscriptions/

• Added new fields on subscription retrieval endpoint (BM-2070)

/admin/orders/

• Added new fields on orders export (BM-1987)
• Park subscription order max date is now retrieved from Cykleo (BM-1937)

2025-02-20 (3.4.14)

Fixed

/eshop/order

• Fixed /pu/auth url on Cykleo call (BM-1936)
• Fixed main referent email on salary pass order (BM-1662)
• Fixed customer title translation on salary pass referent email (BM-1989)
• Fixed internal error (BM-1984)
• Fixed wrong month on monthly order email (BM-1990)

/eshop/customer

• Fixed customer SVD pairing (BM-1928)

Updated

/eshop/order

• Updated order creation on SVD media and customer with existing profile (BM-2081)

script

• Fixed Titan export script to handle installment status change before export (BM-1975)

2025-02-07 (3.4.14)

Added

script

• Added script for tacit renewal of mTicket subscriptions (BM-1566)

/eshop/customer

• Added Cykleo specific error codes on precheck (BM-1972)

Fixed

/eshop/customer

• Fixed customer pairing with SVD user without email (BM-1928)
• Fixed customer pairing with PH profile (BM-1976)

/eshop/auth

• Fixed token parameter on /verify endpoint (BM-1964)

Updated

script

• Updated paid installment script to exclude monthly JT file (BM-1951)

system

• Updated Cykleo API URL (BM-1938)
• Updated Proxy API version to 1.13 (BM-1959)

2025-01-29 (3.4.13)

Added

/eshop/customer

• Added Scellius subscription existence before change payer (BM-1973)

Updated

/eshop/customer

• On payer change if the payer is also the recipient only one email is sent (BM-1971)

/eshop/order

• Updated order retry rules on IPN payment (BM-1955)

Fixed

/eshop/order

• Fixed Cykleo order precheck (BM-1982)

2025-01-22 (3.4.12)

Added

/eshop/customer

• Added /subscriptions/:contractId/payer/change endpoint to change payer of given contract (BM-1948)
• Added rcuId validity check on customer authentication (BM-1956)
• Added payer informations on /subscription endpoint (BM-1931)
• Added next payer change date on /subscription endpoint (BM-1932)

/hooks

• Added /scellius/payer/change/notifications to handle payer change notification (BM-1944, BM-1945, BM-1949, BM-1969)

script

• Added unpaid installment status when paid after (BM-1908)

Updated

/eshop/order

• Updated schedule pdf file name (BM-1848)
  script
• Updated Caisse code on Titan export script (BM-1861)

Fixed

script

• Fixed Titan export on several installments unpaid the same day on the same subscription (BM-1941)
• Fixed Titan export on several unpaid installments regularized the same day on the same subscription (BM-1965)
• Fixed useless SVD call on archived orders on order status synchonization script (BM-1953)

/eshop/customer

• Fixed subscription start date (BM-1923, BM-1939)
• Fixed park station subscription dates (BM-1919)
• Fixed SEPA pivot date (BM-1909)
• Fixed mailjet template variable on unpaid mail (BM-1900)

/eshop/order

• Fixed Precheck duplicate error codes (BM-1893)
• Fixed orders with multiple Cykleo options (BM-1888)
• Fixed Precheck minimum start date (BM-1887)
• Fixed special characters on customer data while on SEPA mandate creation (Nuapay and Scellius) (BM-1839, BM-1780)

/admin/order

• Fixed customer rcuId on order detail (BM-1958)
• Fixed filter and export timezone (BM-1904)
• Fixed unpaid exported data (BM-1899)

2024-12-12 (3.4.10)

Fixed

/eshop/order

• Fixed pivot date calculation for scheduled order (BM-1909)
• Fixed duplicate precheck error code (BM-1893)
• Fixed monthly order quantity on receipt (BM-1826)
• Fixed hour format on order receipt (BM-1815)
• Fixed order receipt with monthly products (BM-1826)

/eshop/customer

• Fixed mTicket expired subscription on /subscription enpoint (BM-1772)
• Removed "force:true" parameter on SVD pairing (BM-1742)

script

• Fixed 'code caisse' on Titan export script (BM-1861)

2024-12-06 (3.4.9)

Updated

script

• Updated bank unpaid installment script to handle installment not on 5th of the month (BM-1912)

/eshop/customer

• Removing "force:true" parameter on pairing (BM-1742)
• /subscriptions endpoint now returns park subscription (BM-1771)

/eshop/order

• Endpoint can now returns paginated result (BM-1542)
• Endpoint now returns temporal validities (BM-1542)

/customer/subscriptions

• Adding installments schedule PDF download for a tiers (BM-1879)

/admin/order

• Adding new order status CANCELLED_AND_REFUNDED (BM-1873)

/admin/subscriptions

• Adding manual installment endpoints (BM-1711)
• Adding new fields (BM-1735, BM-1875)
• Adding endpoint to download installments schedule PDF (BM-1874)
• Adding endpoint to manually update payer informations (BM-1876, BM-1911)

Fixed

/eshop/order

• Fixed Cykleo subscription dates (BM-1883)

2024-11-25 (3.4.8)

Added

script

• Fixed multiple installment update on same day on Titan export (BM-1885)
• Updated bank paid import script to fit JT file format (BM-1831)

/eshop/customer

• Added payer informations on subscription endpoint (BM-1774)
• Added contract tacital informations on subscription endpoint (BM-1773)

Fixed

/eshop/customer

• Fixed expired contract retrieval on subscription endpoint (BM-1772)

2024-10-31 (3.4.7)

Fixed

/eshop/order

• Fixed yearly subscription order dates (BM-1843)
• Fixed monthly order date (BM-1842)
• Fixed precheck on solidaire1 order (BM-1835)
• Fixed required proof documents on Thales + bike order (BM-1822)
• Fixed Cykleo subscription end date (BM-1821)
• Fixed error 500 on Scellius hook (BM-1816)
• Fixed schedule order error email (BM-1814)
• Fixed missing warranty deposit on bike order (BM-1812)
• Fixed Solidaire3 order (BM-1808)
• Fixed order receipt VAT (BM-1789)

/eshop/customer

• Fixed tacit subscription cancel for a recipient customer (BM-1838)

script

• Fixed unbalanced reglement line on Titan export (BM-1834)
• Fixed free installment on Titan export (BM-1817)

Added

/eshop/order

• Added schedule PDF on mobile order (BM-1806)
• Added minimum required age before order (BM-1737)

/admin/sybscriptions

• Added extra fields on subscription installments (BM-1837, BM 1836)

script

• Added specific tiers code on free installment (BM-1929)

2024-10-18 (3.4.6)

Fixed

/eshop/customer

• Fixed CGV acceptance endpoint (BM-1399)

Added

/eshop/order

• Added /document/schedule endpoint to download schedule PDF (BM-1746)

Fixed

/eshop/order

• Fixed order number on Scellius subscription (BM-1749)
• Fixed basketSummary first installment with 0 amount (BM-1784)
• Fixed amount sent to Scellius subscription (BM-1788)
• Fixed VAT calculation on order receipt (BM-1789)
• Fixed bike park subscription order (BM-1801)

/eshop/customer/subscriptions

• Fixed mTicket contract retrieval (BM-1794)

2024-10-08 (3.4.5)

Added

/eshop/order/

• Added acceptCGU endpoint to send CGU consent to RCU (BM-1399)
• Added FREE status on free installment (BM-1769)
• Added order block if customer age does not fit minimal age requierement (BM-1737)
• Added start date on basket summary (BM-1748)
• Added "canal" variable on validation email (BM-1706)
• Added discount code on Scellius SEPA orders (BM-1581)

/admin/subscriptions

• Added new fields : nextRenewDate, firstInstallmentDate, firstInstallmentAmount (BM-1754)
• Added deleted flag on installment plan configuration (BM-1768)
• Added extra fields on unpaid installments (BM-1736)
• Added CSV export endpoint (BM-1597)

/admin/deposits

• Added subOrder field (BM-1604)

/admin/order/

• Added provider filter on orders (BM-1738)
• Added product renewable information (BM-1599)

Updated

/eshop/order/

• Updated first installment on Scellius SEPA subscription (BM-1755)

2024-09-25 (3.4.3)

Added

/eshop/order

• Added basketSummary endpoint (BM-1582)

Fixed

/eshop/customer/

• Fixed SVD customer creation with accented uppercase character (BM-1734)

/eshop/order/

• Fixed scheduled order with free option (BM-1731)
• Fixed Titan export on Scellius SEPA order (unpaid, regularization)

/admin/order/

• Fixed order csv export (BM-1628)

2024-09-19 (3.4.2)

Added

/eshop/order

• Added callback URLs parameters on /payment/scheduled
• Added pass validity dates on order receipt (yearly subscription only) (BM-1303)
• Added order amount on order certificate (BM-1276)

/eshop/customer/

• Added subscription IBAN change endpoint
• Added subscription cancel tacit renewal endpoint

/admin/subscription

• Added unpaid subscription retrieval endpoint
• Added unpaid subscription export enpoint
• Added subscription renew cancel endpoint

script

• Added Titan export script for scheduled order
• Added bank file import scripts (remittance and unpaid )

other

• Added memCached server (BM-1646)

Fixed

/eshop/order

• Fixed recipient photo upload on order (BM-1683)

script

• Fixed fraud regularization date (BM-1680)

/admin/order

• Fixed Cykleo order status (BM-1648)
• Updated order export (BM-1628)

2024-08-05 (3.4.0)

Added

/eshop/order

• Added mTicket and Cykleo order on scheduled payment method

/hooks/notification

• Added IPN response signature verification

Fixed

/eshop/order

• Fixed Park station subscription order status
• Fixed error when invalid proof document (BM-1616)

2024-07-30 (3.3.23)

Fixed

/customer/pairing/svd/creation

• Costumer personnal data are no longer sent to RCU when certified (BM-1583)
• Costumer personnal data are no longer sent to RCU when creation is for a tiers (BM-1591)

/eshop/order

• Fixed country and phone number format on personalizationData (BM-1585)

Added

/eshop/order

• Added Park station subscription (BM-1540)

2024-07-18 (3.3.22)

Added

/eshop/order

• Added mTicket error handling

/admin/catalog

• Added product price value check (to avoid decimals)

Fixed

/eshop/order

• Fixed orders with missing profiles (Solidaire, Scodi)
• Fixed implicit profile verification on monthly pass
• Fixed option proofDocuments not required
• Fixed cykleo endDate on option product

/admin/order

• Fixed export orders latency
• Fixed missing promo code column
• Fixed missing data on order CSV export
• Fixed local time on order filter

/eshop/customer/association/validation

• Fixed space characters on customer code

script

• Fixed Titan export script (processing date, price calculation, multiple loan)

2024-07-04 (3.3.21)

/eshop/order

• Removed unused SVD call (bim/installment)
• Fixed Cykleo token issue

script

• Fixed Titan export script
• Added execution log on Cykleo import and process script
• Added retry option on export Titan script

/admin/proof-document

• Fixed sending picture to RCU when certified
• Added file download link

2024-07-01 (3.3.20)

Fixed

/eshop/order

• Fixed occasionnal order transaction id (IPN)

/admin/proof-document

• Fixed salary pass proof document download

2024-06-28 (3.3.19)

Updated

script

• Titan export no longer process products without Titan code

Added

/admin/script

• Added files (optionnal) on script execution log endpoint

2024-06-26 (3.3.18)

Fixed

/eshop/order

• Fixed fine order amount

/customer/subscriptions

• Fixed mTicket subcription retrieval (ticket credited from the back-office)

2024-06-26 (3.3.17)

Fixed

/admin/customer

• Fixed missing customers

/eshop/order

• Fixed identity proof document on Cykleo option
• Fixed subscriber only order

script

• Fixed null and zero amount on Titan export

Added

/admin/script

• Added script execution endpoint

2024-06-20 (3.3.16)

Fixed

/eshop/order

• Fixed Salary Pass proof document default status

Fixed

/eshop/fine/payment

• Fixed error when paying a fine

Fixed

/eshop/customer/pairing/svd/validation

• Fixed error message if incorrect customer payer code

Update

/eshop/order

• Update adding identity when ordering the CSC in cykleo bike option

2024-06-18 (3.3.15)

Fixed

/eshop/order

• Fixed used custome on multiple option order
• Fixed salary pass order

Added

/eshop/customer

• Added HTTP error code on customer pairing endpoint

2024-06-13 (3.3.14)

Fixed

script

• Fixed Cykleo loan amount on Titan export

/eshop/order

• Fixed order and precheck on annual Cykleo subscription for subscribers (products are longer blocked)

Updated

/eshop/order

• Updated Cykleo product retrieval (using whole catalog)
• Updated precheck to call RCU CertInfo
• PaymentMode parameter is no longer mandatory on /requirements endpoint

Added

/eshop/order

• Added precheck error code (see documentation)

2024-06-10 (3.3.13)

Updated

• Updated RCU token usage to prevent potential cache problems

2024-06-06 (3.3.12)

Fixed

/eshop/order

• Fixed order validation issue that left orders in a status "PAID_ORDER_ERROR"

Updated

/eshop/order

• Improve order and precheck performances

/eshop/customer

• Improve customer subscription request time

/eshop/document/upload

• PDF files are no longer accepted for proof document

Added

/eshop/customer

• Added pending customer association

/eshop/catalog

• Added catalog retrieval without category if sales tree not specified

/admin/proof-documents

• Added customer picture sent to RCU on proof document validation (photo)

2024-06-04 (3.3.11)

Updated

/eshop/order

• Update Cykleo order to not sent start day to Cykleo when subscription starts on today
• Update Cykleo order subscription end date
• Update free Cykleo order subscription

2024-05-31 (3.3.10)

Updated

/eshop/order/precheck

• Improve precheck queries (removed useless SVD calls)

/eshop/order

• Improve order queries (removed useless SVD and RCU calls)

Fixed

/eshop/order

• Fixed email wrong informations (order localtime and amount on mTicket orders )

/admin/proof-documents

• Fixed proof document validation status

/admin/orders

• Fixed gift code payment method (added new entry: FREE)

2024-05-28 (3.3.9)

Added

/eshop/order/requirements

• Added requirements on options

2024-05-24 (3.3.8)

Added

/eshop/order

• Added AccessCode env parameter for Cykleo orders
• Added Cykleo API error handling

Fixed

/eshop/order

• Fixed missing email to recipient when order
• Fixed order error when ordering for recipient
• Fixed reduced ticket precheck verification

2024-05-17 (3.3.7)

Fixed

/eshop/order

• Fixed Cykleo token issue
• Fixed RCU issue when upload photo from order
• Fixed subscription order with option
• Fixed order issue when amount is 0

/eshop/order/precheck

• Fixed certified photo verification and needed proof document
• Fixed monthly subscriptions check when several active subscriptions

/eshop/customer/subscriptions

• Expired Cykleo subscriptions (>24h) are no longer returned

script

• Fixed currency format on Cykleo loan import script

Added

/eshop/customer

• Added GET eshop/customer/cykleo endpoint to retrieve cykleo customer informations

2024-05-03 (3.3.6)

Fixed

/eshop/customer

• Fixed RCU breaking changes on customer data
• Fixed subscription issue

/eshop/order

• Fixed emandate creation issue

2024-04-23 (3.3.5)

Fixed

/eshop/orders

• Fixed required customer profiles
• Fixed Cykleo subscription dates
• Fixed Cykleo option temporal validity
• Fixed order address issues (mandatory streetname, country)

/eshop/orders/precheck

• Fixed monthly subscription check (available months, check conflicts with annuals)
• Fixed yearly subscription check (start date, Scodi dates)

/eshop/customer

• Fixed missing children profiles
• Fixed already ordered media endpoint
• Fixed address update on SVD account creation

/admin/catalog

• Fixed product variant update
• Fixed product variant document proof update

script

• Fixed missing amount on Titan Recette export script
• Fixed timezone on Titan Recette export script

Added

/eshop/customer

• Added customer technical account pairing status
• Added children customer association status

2024-04-19 (3.3.4)

Fixed

/eshop/orders

• Fixed Cykleo order with option
• Fixed IBAN and emandate issues
• Fixed subscription retrieval on precheck

/eshop/customer

• Fixed association mail parameter

Added

/eshop/catalog

• Renamed isReducedPrice field to subscribersOnly

2024-04-15 (3.3.3)

Fixed

/eshop/customer

• Fixed/updated customer association
• Fixed customer phones update
• Fixed customer children profiles

/eshop/orders

• Fixed address on BSC order
• Fixed redeem order (stored customer data, now works with a recipient)
• Fixed order/precheck on monthly subscription
• Fixed order on annual subscription + Cykleo option
• Fixed timezone on payment certificate

/eshop/document

• Fixed uploaded document extension

Added

/eshop/orders

• Added profile label on orders/requirements
• Added order/precheck available months on monthly subscription

2024-04-11 (3.3.2)

Fixed

/eshop/orders

• Fixed customer title
• Fixed confirmation email
• Fixed precheck on monthly subscription

/eshop/customer

• Fixed customer association endpoint

2024-04-09 (3.3.1)

Fixed

/eshop/customer

• Fixed missing explicit profile
• Fixed profile format
• Fixed customer address upadte
• Fixed customer SVD pairing and creation
• Fixed customer subcription certificate

/eshop/orders

• Fixed profile check on order
• Fixed redeem order

2024-03-29 (3.3.0)

Fixed

/eshop/orders

• Fixed CYKLEO annual order subcription
• Fixed regression on order requirements endpoint
• Fixed email parameters
• Fixed Scellius method for 0 amount orders (using createToken instead of createPayment)

/eshop/customer

• Fixed SVD account pairing using validation code
• Fixed contract title on orders
• Fixed media retrieval
• fixed ordered media issue

script

• Fixed missing carriage return and date format on Titan Recette export script
• Fixed pre-authorization amount on bike loan payment script

Added

/eshop/customer

• Added subscription filters and new periodicity field
• Added Cykleo account pairing endpoint

/eshop/orders

• Removing existing subscription check on occasional VLS
• Removing amount check on VLS annual order subscription
• Added new order statuses for occasional VLS

/admin/catalog

• Added new product fields (isDaily, isOccasionnal)

2024-03-19 (3.2.4)

Added

/eshop/orders

• Added VLS annual order subscription
• Added VLS time credit order
• Added ApplePay handling

/eshop/customer

• Added SVD account search and pairing endpoints

Fixed

/eshop/customer

• Fixed birthdate format on customer update

/eshop/orders

• Fixed Cykleo token management on IPN hook

Updated

/eshop/orders

• Updated bike loan import script
• Updated bike loan payment script and payment transaction update

2024-03-12 (3.2.3)

Added

/eshop/catalog

• Added CYKLEO Provider

/eshop/orders

• Added CYKLEO occasional order subscription

/eshop/customer/subscriptions

• Added CYKLEO suscriptions

script

• Added CYKLEO loan billing script

Fixed

/eshop/orders/redeem

• fixed optional rcuUserId parameter

2024-03-05 (3.2.2)

Added

/eshop/orders

• Added POST /eshop/orders/requirements endpoint
• Customer photo is now sent to RCU when given as proof document if no existing photo on RCU

/eshop/customer

• Added certified identity information

/eshop/catalog

• Added tag filter to retrieve only products with given tag

/admin/catalog

• Added new product fields:
  • "tags"
  • "isDisplayed"
  • "deferredPayment"
  • "deferredPaymentJob"
  • "preAutoAmount"
  • "warrantyDepositAmount"
  • "warrantyDepositDescription"
  • "mobileDescription"

script

• Added Titan Recette export script

Fixed

/eshop/orders

• Check if customer already have a monthly subscription on given date

/eshop/orders

• Check if customer already have a monthly subscription on given date
• Payment mode is no longer mandatory

2024-02-21 (3.2.1)

Fixed

/eshop/customer

• Fixed missing profiles

/eshop/customer/subscriptions

• Fixed existing mTicket subscriptions retrieval

/eshop/orders

• Fixed local timezone on mTicket subscription order
• Fixed customer profiles and proof document verification
• Fixed mTicket order start date (subscription)

/eshop/orders/precheck

• Fixed customer profiles verification
• Fixed customer existing subscriptions
• Updated message when no technical account

/admin/orders

• Fixed customer name and lastname
• mTicket orders with no payment are no longer displayed

/admin/proof-documents

• Fixing customer name and lastname

Added

/eshop/customer

• Added technical accounts

2024-02-13 (3.2.0)

Added

/eshop/orders/

• Added route POST /eshop/orders/precheck

Fixed

/eshop/customer

• Fixed route GET /eshop/customer/media for given specific rcuId
• Fixed route GET /eshop/customer/subscription for given specific rcuId
• Fixed route POST /eshop/customer to update user informations

/eshop/orders/

• Fixed route POST /eshop/orders for orders with several date range

eshop/thales/

• Fixed route GET eshop/thales/customers
• Fixed route POST eshop/thales/customers to create a SVD/RCU customer

eshop/catalog/

• Fixed category sort on route GET eshop/catalog

Breaking changes

• Route POST /eshop/orders no longer use startDate field at articles root. Article start date must be provided in temporalValidity array field

2024-02-09 (3.1.0)