2.2 KiB
2.2 KiB
name, description
| name | description |
|---|---|
| payments-routes | Handle 7 OpenAPI operation(s) under /v2/payments for the payments route group. |
payments API Routes
Handle 7 OpenAPI operation(s) under /v2/payments for the payments 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
list_payments
- Operation ID:
list_payments - Route:
GET /v2/payments - Mode: READ
- Summary: ListPayments
- Parameters:
begin_timeinqueryend_timeinquerysort_orderinquerycursorinquerylocation_idinquerytotalinquerylast_4inquerycard_brandinquerylimitinqueryis_offline_paymentinqueryoffline_begin_timeinqueryoffline_end_timeinqueryupdated_at_begin_timeinqueryupdated_at_end_timeinquerysort_fieldinquery
create_payment
- Operation ID:
create_payment - Route:
POST /v2/payments - Mode: WRITE
- Summary: CreatePayment
- Body: JSON request body accepted.
cancel_payment_by_idempotency_key
- Operation ID:
cancel_payment_by_idempotency_key - Route:
POST /v2/payments/cancel - Mode: WRITE
- Summary: CancelPaymentByIdempotencyKey
- Body: JSON request body accepted.
get_payment
- Operation ID:
get_payment - Route:
GET /v2/payments/{payment_id} - Mode: READ
- Summary: GetPayment
- Parameters:
payment_idinpathrequired
update_payment
- Operation ID:
update_payment - Route:
PUT /v2/payments/{payment_id} - Mode: WRITE
- Summary: UpdatePayment
- Parameters:
payment_idinpathrequired
- Body: JSON request body accepted.
cancel_payment
- Operation ID:
cancel_payment - Route:
POST /v2/payments/{payment_id}/cancel - Mode: WRITE
- Summary: CancelPayment
- Parameters:
payment_idinpathrequired
complete_payment
- Operation ID:
complete_payment - Route:
POST /v2/payments/{payment_id}/complete - Mode: WRITE
- Summary: CompletePayment
- Parameters:
payment_idinpathrequired
- Body: JSON request body accepted.