77 lines
2.5 KiB
YAML
77 lines
2.5 KiB
YAML
get:
|
|
tags: [Payments]
|
|
summary: List payments in organization
|
|
description: |
|
|
Returns organization payments with cursor pagination and optional filters.
|
|
State filters accept aliases (`accepted`, `settled`, `failed`, etc.) or canonical orchestration states.
|
|
operationId: paymentsList
|
|
security:
|
|
- bearerAuth: []
|
|
parameters:
|
|
- $ref: ../parameters/organizations_ref.yaml#/components/parameters/OrganizationsRef
|
|
- $ref: ../parameters/cursor.yaml#/components/parameters/Cursor
|
|
- $ref: ../parameters/limit.yaml#/components/parameters/Limit
|
|
- name: quotation_ref
|
|
in: query
|
|
required: false
|
|
description: Filter by quotation reference used for execution.
|
|
schema:
|
|
type: string
|
|
- name: quote_ref
|
|
in: query
|
|
required: false
|
|
description: Alias of `quotation_ref`.
|
|
schema:
|
|
type: string
|
|
- name: created_from
|
|
in: query
|
|
required: false
|
|
description: Include payments created at or after this RFC3339 timestamp.
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- name: createdFrom
|
|
in: query
|
|
required: false
|
|
description: Alias of `created_from`.
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- name: created_to
|
|
in: query
|
|
required: false
|
|
description: Include payments created before this RFC3339 timestamp (must be after `created_from`).
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- name: createdTo
|
|
in: query
|
|
required: false
|
|
description: Alias of `created_to`.
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- $ref: ../parameters/state.yaml#/components/parameters/State
|
|
- $ref: ../parameters/states.yaml#/components/parameters/States
|
|
- $ref: ../parameters/filter_states.yaml#/components/parameters/FilterStates
|
|
responses:
|
|
'200':
|
|
description: Payments list
|
|
content:
|
|
application/json:
|
|
schema:
|
|
allOf:
|
|
- $ref: ../response/response.yaml#/components/schemas/BaseResponse
|
|
- type: object
|
|
properties:
|
|
data:
|
|
$ref: ./response/payment.yaml#/components/schemas/PaymentsData
|
|
'400':
|
|
$ref: ../response/operation.yaml#/components/responses/BadRequest
|
|
'401':
|
|
$ref: ../response/operation.yaml#/components/responses/Unauthorized
|
|
'403':
|
|
$ref: ../response/operation.yaml#/components/responses/Forbidden
|
|
'500':
|
|
$ref: ../response/operation.yaml#/components/responses/InternalServerError
|