Files
sxchnge/backend/contracts/sendico/api/payments/documents_certificate.yaml
T

48 lines
1.6 KiB
YAML

get:
tags: [Payments]
summary: Download payment certificate
description: |
Returns a generated payment certificate as binary content.
The payment must be settled; the BFF resolves certificate details from the payment reference.
operationId: paymentsGetPaymentCertificate
security:
- bearerAuth: []
parameters:
- $ref: ../parameters/organizations_ref.yaml#/components/parameters/OrganizationsRef
- name: payment_ref
in: query
required: true
description: Settled payment reference used to generate the payment certificate.
schema:
type: string
responses:
'200':
description: Payment certificate file
content:
application/pdf:
schema:
type: string
format: binary
application/octet-stream:
schema:
type: string
format: binary
'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
'409':
$ref: ../response/operation.yaml#/components/responses/Conflict
'500':
$ref: ../response/operation.yaml#/components/responses/InternalServerError
'503':
description: Upstream service unavailable
content:
application/json:
schema:
$ref: ../response/response.yaml#/components/schemas/ErrorResponse