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

49 lines
1.9 KiB
YAML

get:
tags: [Payments]
summary: List available FX directions
description: |
Returns organization-level FX direction availability.
A returned direction means the organization has at least one eligible
direction-level route. It does not mean that every quote or payment for this
direction will be accepted. The actual route, gateway, limits, pricing, fees,
asset domain, and settlement details are resolved during quotation/payment
execution.
If dependencies are healthy but no organization-eligible executable
directions match oracle quoteable pair sides, the response contains an empty
`directions` array. Oracle or gateway/route registry dependency failures are
returned as errors and are not converted to oracle-only or empty successful
responses.
operationId: paymentsFXDirections
security:
- bearerAuth: []
parameters:
- $ref: ../parameters/organizations_ref.yaml#/components/parameters/OrganizationsRef
responses:
'200':
description: Organization-level directed FX availability
content:
application/json:
schema:
allOf:
- $ref: ../response/response.yaml#/components/schemas/BaseResponse
- type: object
properties:
data:
$ref: ./response/payment.yaml#/components/schemas/FXDirectionsData
'400':
$ref: ../response/operation.yaml#/components/responses/BadRequest
'401':
$ref: ../response/operation.yaml#/components/responses/Unauthorized
'403':
$ref: ../response/operation.yaml#/components/responses/Forbidden
'412':
description: Dependency precondition failed
content:
application/json:
schema:
$ref: ../response/response.yaml#/components/schemas/ErrorResponse
'503':
$ref: ../response/operation.yaml#/components/responses/ServiceUnavailable