103 lines
3.8 KiB
YAML
103 lines
3.8 KiB
YAML
get:
|
|
tags: [Payment Methods]
|
|
summary: Get payment method
|
|
description: Returns payment method by `payment_methods_ref` inside `organizations_ref`.
|
|
operationId: paymentMethodsGet
|
|
security:
|
|
- bearerAuth: []
|
|
parameters:
|
|
- $ref: ../parameters/organizations_ref.yaml#/components/parameters/OrganizationsRef
|
|
- $ref: ../parameters/payment_methods_ref.yaml#/components/parameters/Payment MethodsRef
|
|
responses:
|
|
'200':
|
|
description: Payment method data
|
|
content:
|
|
application/json:
|
|
schema:
|
|
allOf:
|
|
- $ref: ../response/response.yaml#/components/schemas/BaseResponse
|
|
- type: object
|
|
properties:
|
|
data:
|
|
$ref: ./response/payment_method.yaml#/components/schemas/Payment MethodsAuthData
|
|
'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
|
|
|
|
patch:
|
|
tags: [Payment Methods]
|
|
summary: Update payment method
|
|
description: Updates mutable payment method fields for the record identified by `payment_methods_ref` inside `organizations_ref`.
|
|
operationId: paymentMethodsUpdate
|
|
security:
|
|
- bearerAuth: []
|
|
parameters:
|
|
- $ref: ../parameters/organizations_ref.yaml#/components/parameters/OrganizationsRef
|
|
- $ref: ../parameters/payment_methods_ref.yaml#/components/parameters/Payment MethodsRef
|
|
requestBody:
|
|
$ref: ./bodies/payment_method.yaml#/components/requestBodies/PaymentMethodUpdateBody
|
|
responses:
|
|
'200':
|
|
description: Payment method updated
|
|
content:
|
|
application/json:
|
|
schema:
|
|
allOf:
|
|
- $ref: ../response/response.yaml#/components/schemas/BaseResponse
|
|
- type: object
|
|
properties:
|
|
data:
|
|
$ref: ./response/payment_method.yaml#/components/schemas/Payment MethodsAuthData
|
|
'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
|
|
|
|
delete:
|
|
tags: [Payment Methods]
|
|
summary: Delete payment method
|
|
description: Deletes payment method by reference.
|
|
operationId: paymentMethodsDelete
|
|
security:
|
|
- bearerAuth: []
|
|
parameters:
|
|
- $ref: ../parameters/organizations_ref.yaml#/components/parameters/OrganizationsRef
|
|
- $ref: ../parameters/payment_methods_ref.yaml#/components/parameters/Payment MethodsRef
|
|
responses:
|
|
'200':
|
|
description: Payment method deleted
|
|
content:
|
|
application/json:
|
|
schema:
|
|
allOf:
|
|
- $ref: ../response/response.yaml#/components/schemas/BaseResponse
|
|
- type: object
|
|
properties:
|
|
data:
|
|
$ref: ./response/payment_method.yaml#/components/schemas/Payment MethodsAuthData
|
|
'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
|