95 lines
2.5 KiB
Markdown
95 lines
2.5 KiB
Markdown
---
|
|
name: online-checkout-routes
|
|
description: Handle 9 OpenAPI operation(s) under /v2/online-checkout for the online checkout route group.
|
|
---
|
|
|
|
# online checkout API Routes
|
|
|
|
Handle 9 OpenAPI operation(s) under /v2/online-checkout for the online checkout route group.
|
|
|
|
Use the generated operation tools to make real API calls. Do not invent API responses.
|
|
If a tool reports missing setup, return the exact setup field name to the caller.
|
|
For write, update, or delete operations, state the intended action before calling the tool.
|
|
|
|
## Operations
|
|
|
|
### retrieve_location_settings
|
|
|
|
- Operation ID: `retrieve_location_settings`
|
|
- Route: `GET /v2/online-checkout/location-settings/{location_id}`
|
|
- Mode: READ
|
|
- Summary: RetrieveLocationSettings
|
|
- Parameters:
|
|
- `location_id` in `path` required
|
|
|
|
### update_location_settings
|
|
|
|
- Operation ID: `update_location_settings`
|
|
- Route: `PUT /v2/online-checkout/location-settings/{location_id}`
|
|
- Mode: WRITE
|
|
- Summary: UpdateLocationSettings
|
|
- Parameters:
|
|
- `location_id` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### retrieve_merchant_settings
|
|
|
|
- Operation ID: `retrieve_merchant_settings`
|
|
- Route: `GET /v2/online-checkout/merchant-settings`
|
|
- Mode: READ
|
|
- Summary: RetrieveMerchantSettings
|
|
|
|
### update_merchant_settings
|
|
|
|
- Operation ID: `update_merchant_settings`
|
|
- Route: `PUT /v2/online-checkout/merchant-settings`
|
|
- Mode: WRITE
|
|
- Summary: UpdateMerchantSettings
|
|
- Body: JSON request body accepted.
|
|
|
|
### list_payment_links
|
|
|
|
- Operation ID: `list_payment_links`
|
|
- Route: `GET /v2/online-checkout/payment-links`
|
|
- Mode: READ
|
|
- Summary: ListPaymentLinks
|
|
- Parameters:
|
|
- `cursor` in `query`
|
|
- `limit` in `query`
|
|
|
|
### create_payment_link
|
|
|
|
- Operation ID: `create_payment_link`
|
|
- Route: `POST /v2/online-checkout/payment-links`
|
|
- Mode: WRITE
|
|
- Summary: CreatePaymentLink
|
|
- Body: JSON request body accepted.
|
|
|
|
### delete_payment_link
|
|
|
|
- Operation ID: `delete_payment_link`
|
|
- Route: `DELETE /v2/online-checkout/payment-links/{id}`
|
|
- Mode: WRITE
|
|
- Summary: DeletePaymentLink
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
|
|
### retrieve_payment_link
|
|
|
|
- Operation ID: `retrieve_payment_link`
|
|
- Route: `GET /v2/online-checkout/payment-links/{id}`
|
|
- Mode: READ
|
|
- Summary: RetrievePaymentLink
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
|
|
### update_payment_link
|
|
|
|
- Operation ID: `update_payment_link`
|
|
- Route: `PUT /v2/online-checkout/payment-links/{id}`
|
|
- Mode: WRITE
|
|
- Summary: UpdatePaymentLink
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- Body: JSON request body accepted.
|