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

38 lines
1.6 KiB
YAML

post:
tags: [Payments]
summary: Quote single payment intent
description: |
Calculates quote for one payment intent without executing payment. The response includes
`quote.executable`, `quote.state`, and optional `quote.blockReason` so clients can reject
non-executable quotes before attempting execution. Raw `card` destinations can omit expiry
while quoting, but quotes intended for later execution should include `exp_month` and
`exp_year`. Card-recipient AML screening is not performed during quotation; it runs during
payment execution, so an executable quote does not guarantee AML acceptance.
operationId: paymentsQuote
security:
- bearerAuth: []
parameters:
- $ref: ../parameters/organizations_ref.yaml#/components/parameters/OrganizationsRef
requestBody:
$ref: ./bodies/payment.yaml#/components/requestBodies/QuotePaymentBody
responses:
'200':
description: Quote generated
content:
application/json:
schema:
allOf:
- $ref: ../response/response.yaml#/components/schemas/BaseResponse
- type: object
properties:
data:
$ref: ./response/payment.yaml#/components/schemas/PaymentQuoteData
'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