Files
sendico/interface/api/payments/object.yaml

32 lines
1.0 KiB
YAML

get:
tags: [Payments]
summary: Get payment by reference
description: Returns a single payment by `payments_ref`.
operationId: paymentsGet
security:
- bearerAuth: []
parameters:
- $ref: ../parameters/payments_ref.yaml#/components/parameters/PaymentsRef
responses:
'200':
description: Payment data
content:
application/json:
schema:
allOf:
- $ref: ../response/response.yaml#/components/schemas/BaseResponse
- type: object
properties:
data:
$ref: ./response/payment.yaml#/components/schemas/PaymentData
'400':
$ref: ../response/operation.yaml#/components/responses/BadRequest
'401':
$ref: ../response/operation.yaml#/components/responses/Unauthorized
'403':
$ref: ../response/operation.yaml#/components/responses/Forbidden
'404':
$ref: ../response/operation.yaml#/components/responses/NotFound
'500':
$ref: ../response/operation.yaml#/components/responses/InternalServerError