Reference

API reference

Every public endpoint, grouped by area. All paths are relative to the versioned base URL.

https://sandbox-api.baxpay.com/v1   # sandbox: bx_test_… keys (live keys are refused here)
https://api.baxpay.com/v1           # live: bx_live_… keys

Each endpoint below names its credential:

Label	Credential
key	Your API key, `Bearer bx_test_…` / `Bearer bx_live_…` (server-side only)
bxc	A connection credential, `Bearer bxc_…` (tills, pumps, ERP links)
public	None: payer and shopper pages, rate-limited per IP
dashboard	A signed-in Business dashboard user; not callable with an API key

Read API conventions first: the response envelope, pagination, idempotency keys and rate limits apply everywhere.

Developer

GET/pingkey · which business and mode a key belongs to

POST/connectionskey · create a bxc_ connection (till, pump, ERP link)

GET/connectionskey · list this mode's connections

DEL/connections/{id}key · revoke

GET/sessionskey · recent in-store sessions in this mode

Webhooks

POST/webhookskey · register an endpoint (secret returned once)

GET/webhookskey · list

GET/webhooks/{id}key · retrieve

POST/webhooks/{id}/testkey · send a signed webhook.test

DEL/webhooks/{id}key · delete

Payment links

POST/payment-linkskey · charge anyone online

GET/payment-linkskey · list (status, storeId)

GET/payment-links/{id}key · retrieve

POST/payment-links/{id}/cancelkey · cancel an open link

GET/pay/link/{token}public · payer view

POST/pay/link/{token}/cardpublic · guest card payment (sandbox / acquirer)

POST/pay/link/{token}/card/3dspublic · test links: finish simulated 3D Secure

POST/pay/link/{token}/simulatepublic · test links: pay with another active method, simulated

POST/business/payment-links/{id}/resenddashboard · email the link again

Clients

POST/clientskey · create

GET/clientskey · list / search (search, kind, includeArchived)

GET/clients/{id}key · retrieve

PUT/clients/{id}key · update (invoices keep their snapshot)

POST/clients/{id}/archivekey · hide from pickers, keep history

POST/clients/{id}/unarchivekey · restore

DEL/clients/{id}key · delete

E-invoicing (France)

POST/einvoiceskey · create an EN 16931-validated draft

PUT/einvoices/{id}key · update a draft

GET/einvoiceskey · list sent + received

GET/einvoices/{id}key · detail and lifecycle trail

POST/einvoices/{id}/sendkey · deposit + emit as Factur-X

POST/einvoices/{id}/lifecyclekey · approve / refuse / dispute / collect

POST/einvoices/{id}/payment-linkkey · create the hosted pay link

GET/einvoices/ereporting/periodskey · legal periods for your VAT regime

POST/einvoices/ereporting/generatekey · build a period submission

POST/einvoices/ereporting/{id}/submitkey · transmit it

GET/einvoices/ereportingkey · list submissions

GET/pay/einvoice/{token}public · payer view

POST/pay/einvoice/{token}/cardpublic · guest card payment

POST/pay/einvoice/{token}/card/3dspublic · test invoices: finish simulated 3D Secure

Products & catalog

POST/productskey · create (image optional)

GET/productskey · list active products (search, channel)

GET/products/{id}key · retrieve

PATCH/products/{id}key · update

GET/products/{id}/labelkey · shelf-label payload

GET/products/export/catalogkey · baxpay.catalog.v1

GET/products/export/intrastatkey · HS code rows (from, to)

POST/products/export/push-erpkey · push to every active accounting link

In-store sessions

All under /integration. See Terminal & Session API.

POST/integration/sessionsbxc · open a SALE or PREAUTH

GET/integration/sessions/{id}bxc · poll until final

GET/integration/sessions/by-reference/{saleReferenceId}bxc · find by your reference

POST/integration/sessions/{id}/voidbxc · void before capture

POST/integration/sessions/{id}/simulatebxc · sandbox outcome

POST/integration/sessions/{id}/fuel/capturebxc · capture the dispensed amount

POST/integration/sessions/{id}/fuel/releasebxc · release a pre-auth

POST/integration/nexo/saleToPOIbxc · nexo adapter

POST/integration/ifsf/reservationbxc · IFSF pre-auth

POST/integration/ifsf/completionbxc · IFSF capture

POST/integration/opi/cardServiceRequestbxc · OPI adapter

Settlement & reconciliation

POST/integration/reconciliation/closebxc · close a business day (Paris date)

GET/integration/reconciliation/batchesbxc · list this mode's batches

GET/integration/reconciliation/batches/{id}bxc · batch + sessions

GET/integration/reconciliation/batches/{id}/export.csvbxc · per-session CSV

GET/integration/reconciliation/batches/{id}/export.camt053bxc · camt.053-style JSON

Online shop (storefront)

See Storefront API.

GET/shop/resolvepublic · ?host=

GET/shop/{slug}/catalogpublic · online products

GET/shop/{slug}/products/{productId}public · one product + related

POST/shop/{slug}/quotepublic · price a cart

POST/shop/{slug}/checkoutpublic · create the order → payUrl

GET/shop/{slug}/orders/{token}public · order page

POST/shop/{slug}/orders/{token}/cancelpublic · drop an unpaid order

GET/shop/{slug}/products/{productId}/slotspublic · free booking slots

GET/shop/{slug}/bookings/{token}public · booking page

GET/shop/{slug}/bookings/{token}/icspublic · calendar file

POST/shop/{slug}/bookings/{token}/cancelpublic · cancel a paid booking in its window

POST/shop/{slug}/bookings/{token}/reschedulepublic · move a paid booking

Dashboard only

These exist for the Business dashboard and need a signed-in user: /merchant-integrations (accounting OAuth links), /webhooks (the dashboard's own webhook screens), /payments, /business/theme-studio/* and /business/products/import.