> ## Documentation Index > Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt > Use this file to discover all available pages before exploring further. # Cancel a payment > NOT IMPLEMENTED IN THIS API VERSION. Every request that reaches the handler is answered 501 with code PBP-0203, including one for a payment that is already canceled; no payment is read or changed. A malformed request, or one that fails authentication, is still refused ahead of the handler with the 4xx this operation also declares. The operation stays published so that the operationId, the request schema and the generated SDK method are already in place when cancellation ships. ## OpenAPI ````yaml /en/openapi/v3-current/payments.yaml post /v1/payments/{id}/cancel openapi: 3.1.0 info: description: >- API for the Lerian Payments interface via BTG. It covers boleto issuance, cancellation, installments, and queries; bill payments (bankslip, utilities, and DARF), cancellation, and queries; aggregated boleto and payment dashboards; provider connection and outbound webhook configuration; and the provider webhook receiver for settlement events. ERROR BODIES. A failed request arrives in one of three shapes, and which one you get depends on where the service catches the failure, not on which endpoint you called. The authentication and authorization layer runs ahead of everything else and answers plain text with a bare reason and no error code. A failure that the request pipeline catches next, before the API layer sees it, answers a flat JSON body on application/json; the idempotency check is the pipeline rule you meet most often. Everything the API layer catches answers an RFC 9457 problem document on application/problem+json. Read the media type to tell the two JSON bodies apart. The code member holds the same PBP-NNNN value in both, so branch on it, and handle 401 and 403 by status because a refusal from the authentication layer carries no code. One pipeline refusal is not listed on the operations below: while a first request under the same idempotency key is still in flight, a retry is answered 409 with code PBP-0007 and the flat body. title: Payments — via BTG API version: 1.0.0 servers: - url: https://payments.sandbox.lerian.net security: [] tags: - description: >- Tenant-level setup: connecting the banking provider and configuring where status notifications are delivered. name: Admin - description: >- Issuing, querying and cancelling boletos, including installment series and the rendered PDF. name: Boletos - description: >- Aggregated counts, amounts and breakdowns over a period, for boletos and for payments. name: Dashboards - description: >- Paying bankslips, utility bills and DARF tax slips, and querying or cancelling those payments. name: Payments - description: >- The webhook the payment provider posts settlement events to. Authenticated with a credential agreed with the provider, not with the platform identity used by the rest of this API. name: Settlement paths: /v1/payments/{id}/cancel: post: tags: - Payments summary: Cancel a payment description: >- NOT IMPLEMENTED IN THIS API VERSION. Every request that reaches the handler is answered 501 with code PBP-0203, including one for a payment that is already canceled; no payment is read or changed. A malformed request, or one that fails authentication, is still refused ahead of the handler with the 4xx this operation also declares. The operation stays published so that the operationId, the request schema and the generated SDK method are already in place when cancellation ships. operationId: cancelPayment parameters: - description: >- Tenant organization ID. Accepted but ignored: the tenant is determined by the credentials you authenticate with, so sending this header, or sending a different value in it, changes nothing. in: header name: X-Organization-Id schema: description: >- Tenant organization ID. Accepted but ignored: the tenant is determined by the credentials you authenticate with, so sending this header, or sending a different value in it, changes nothing. type: string - description: >- Client-supplied idempotency key. Required in practice even though the schema marks it optional: a request that omits this header is refused with 400 PBP-0012. in: header name: Idempotency-Key schema: description: >- Client-supplied idempotency key. Required in practice even though the schema marks it optional: a request that omits this header is refused with 400 PBP-0012. type: string - description: Payment identifier (UUID). in: path name: id required: true schema: description: Payment identifier (UUID). examples: - 123e4567-e89b-12d3-a456-426614174000 format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CancelPaymentRequest' required: true responses: '400': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' application/json: schema: $ref: '#/components/schemas/PipelineError' description: Bad Request '401': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' text/plain: schema: type: string application/json: schema: $ref: '#/components/schemas/PipelineError' description: >- Authentication failed. Two shapes are possible and a client must accept both: the authentication middleware answers `text/plain` with a bare reason (for example `Missing Token`) and carries no error code, while a refusal raised inside the service answers `application/problem+json` with code `PBP-0003`. '403': content: text/plain: schema: type: string description: >- The authenticated principal is not permitted to perform this action. Answered as `text/plain` by the authorization middleware, with no error code. '422': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' application/json: schema: $ref: '#/components/schemas/PipelineError' description: Unprocessable Entity '500': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' application/json: schema: $ref: '#/components/schemas/PipelineError' description: Internal Server Error '501': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: >- Not Implemented. Payment cancellation is not built in this API version, so EVERY request that reaches the handler is answered this way — including one for a payment that is already canceled. Nothing about the request or the payment is examined to get here; the 400, 401 and 422 this operation also declares come from the validation, authentication and idempotency layers that run BEFORE the handler, so a caller still has to handle them. The response body carries `code` PBP-0203 and a `detail` naming the capability that is absent. No payment is read or changed. Do not retry. '503': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' application/json: schema: $ref: '#/components/schemas/PipelineError' description: Service Unavailable security: - BearerAuth: [] components: schemas: CancelPaymentRequest: additionalProperties: false properties: reason: type: string required: - reason type: object Detail: additionalProperties: false properties: code: description: >- Stable, machine-readable domain error code scoped to the emitting service (format: -NNNN). examples: - ERR-0001 type: string detail: description: >- A human-readable explanation specific to this occurrence of the problem. examples: - Property foo is required but is missing. type: string errors: description: Optional list of individual error details items: $ref: '#/components/schemas/ErrorDetail' type: - array - 'null' instance: description: >- A URI reference that identifies the specific occurrence of the problem. examples: - https://example.com/error-log/abc123 format: uri type: string status: description: HTTP status code examples: - 400 format: int64 type: integer title: description: >- A short, human-readable summary of the problem type. This value should not change between occurrences of the error. examples: - Bad Request type: string type: default: about:blank description: A URI reference to human-readable documentation for the error. examples: - https://example.com/errors/example format: uri type: string upstream: $ref: '#/components/schemas/Upstream' description: >- RFC 9457 extension member: the error a proxied third-party provider reported. Absent unless the emitting service explicitly surfaced one. type: object PipelineError: additionalProperties: false description: >- The flat error body. A failure caught before the API layer sees the request answers this shape on the application/json media type, instead of the RFC 9457 problem document. Read the media type to tell the two apart. The idempotency check is the rule that answers this way most often. properties: code: description: >- Stable, machine-readable error code, in the form PBP-NNNN. Branch on this value. It carries the same meaning as the code member of the problem document. examples: - PBP-0013 type: string details: additionalProperties: true description: Optional object carrying further facts about this occurrence. type: - object - 'null' message: description: A human-readable explanation specific to this occurrence. examples: - >- The request body does not match the original request for this idempotency key. type: string title: description: Short label for the condition. examples: - Idempotency Key Conflict type: string required: - code - title - message type: object ErrorDetail: additionalProperties: false properties: location: description: >- Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id' type: string message: description: Error message text type: string value: description: The value at the given location type: object Upstream: additionalProperties: false properties: code: description: The upstream provider's own error code, verbatim. examples: - E4001 type: string message: description: >- The upstream provider's own error message, verbatim (bounded, never its raw response body). examples: - account not found at provider type: string type: object securitySchemes: BearerAuth: bearerFormat: JWT description: JWT bearer token issued by the identity provider. scheme: bearer type: http ````