> ## Documentation Index
> Fetch the complete documentation index at: https://docs.4seletpay.com.br/llms.txt
> Use this file to discover all available pages before exploring further.
# Cancelar Link de Pagamento
> Cancela um link de pagamento ativo. Apenas links com status `InProgress` podem ser cancelados. Esta operação é irreversível — um link cancelado não pode ser reativado. Requer o header `account` com o código da conta.
Requer o header `account` com o código da conta. Apenas links com status `InProgress` podem ser cancelados.
Esta ação é irreversível. Um link cancelado não pode ser reativado — crie um novo link se necessário.
## OpenAPI
````yaml POST /v1/payment-links/{code}/cancel
openapi: 3.1.0
info:
title: 4Selet Pay API
description: >
API de processamento de pagamentos da plataforma 4Selet Pay. Suporta
cobranças únicas, assinaturas recorrentes, PIX, Cartão de Crédito. Todas as
rotas autenticadas requerem um Bearer Token obtido via `/v1/login`.
version: 1.0.0
contact:
name: 4Selet Pay
email: suporte@4selet.com.br
servers:
- url: https://sandbox.4seletpay.com.br/api
description: Servidor de Sandbox
security:
- bearerAuth: []
tags:
- name: Autenticação
description: Rotas de autenticação e criação de usuários
- name: Cobranças
description: Criação, consulta, cancelamento e reembolso de cobranças
- name: Pedidos
description: Consulta de pedidos e gerenciamento de confirmações desafiadas
- name: Cartões
description: Cadastro e gerenciamento dos cartões salvos de um cliente
- name: Assinaturas
description: Criação e gerenciamento de assinaturas recorrentes
- name: Faturas
description: Gerenciamento de faturas e pagamento de faturas em atraso
- name: Clientes Bloqueados
description: Gerenciamento de lista negra de clientes
- name: Contas
description: Criação e gerenciamento de contas na plataforma
- name: Aplicativo
description: Endpoints para dashboard e uso via aplicativo mobile
- name: Notificações Push
description: Envio e gerenciamento de notificações push
- name: Utilitários
description: Endpoints utilitários como listagem de fusos horários
- name: Gestão
description: Relatórios gerenciais (acesso restrito a Super Admins)
- name: Webhooks
description: Endpoints para receber notificações de gateways de pagamento
- name: Endpoints de Webhook
description: >-
Gerenciamento de endpoints de webhook para receber notificações de eventos
da plataforma
- name: Links de Pagamento
description: Criação e gerenciamento de links de pagamento com checkout pré-configurado
- name: Análise de Fraude
description: >-
API de Risco — consulta o risco de fraude de uma transação (autenticada
por chave de API)
paths:
/v1/payment-links/{code}/cancel:
post:
tags:
- Links de Pagamento
summary: Cancelar link de pagamento
description: >
Cancela um link de pagamento ativo. Apenas links com status `InProgress`
podem ser cancelados. Esta operação é irreversível — um link cancelado
não pode ser reativado. Requer o header `account` com o código da conta.
operationId: cancelPaymentLink
parameters:
- $ref: '#/components/parameters/AccountHeader'
- name: code
in: path
required: true
description: Código único do link de pagamento
schema:
type: string
example: lnk_abc123xyz
responses:
'200':
description: Link de pagamento cancelado com sucesso
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentLinkResponse'
example:
mensagem: Link de pagamento cancelado com sucesso
erro: false
mensagenserro: []
codigoretorno: 200
id: 00000000-0000-0000-0000-000000000000
data:
code: lnk_abc123xyz
order_code: ord_abc123xyz
token: a1b2c3d4e5f6...
url: null
status: Canceled
payment_types:
- CreditCard
- PIX
installments: []
obfuscate_client: false
obfuscate_items: false
expires_at: null
max_uses: null
uses_count: 7
split: []
value: 97.99
created_at: '2026-05-27T10:00:00.000000Z'
'400':
description: Link já cancelado
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
mensagem: Link de pagamento já está cancelado.
erro: true
mensagenserro:
- Link de pagamento já está cancelado.
codigoretorno: 400
id: 00000000-0000-0000-0000-000000000000
data: []
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
security:
- bearerAuth: []
components:
parameters:
AccountHeader:
name: account
in: header
required: true
description: Código da conta à qual a operação se aplica
schema:
type: string
example: acc_abc123xyz
schemas:
PaymentLinkResponse:
type: object
properties:
mensagem:
type: string
example: Link de pagamento criado com sucesso
erro:
type: boolean
example: false
mensagenserro:
type: array
items:
type: string
example: []
codigoretorno:
type: integer
example: 201
id:
type: string
example: 00000000-0000-0000-0000-000000000000
data:
$ref: '#/components/schemas/PaymentLinkData'
ErrorResponse:
type: object
properties:
mensagem:
type: string
example: Um erro inesperado acabou de acontecer.
erro:
type: boolean
example: true
mensagenserro:
type: array
items:
type: string
example:
- Detalhe do erro ocorrido.
codigoretorno:
type: integer
example: 400
id:
type: string
example: 00000000-0000-0000-0000-000000000000
data:
type: array
example: []
PaymentLinkData:
type: object
properties:
code:
type: string
description: Código único do link de pagamento
example: lnk_abc123xyz
order_code:
type: string
nullable: true
description: Código do pedido gerado na criação
example: ord_abc123xyz
token:
type: string
description: Token de segurança do checkout (64 caracteres hex)
example: a1b2c3d4e5f6...
url:
type: string
nullable: true
description: URL completa do checkout para compartilhar com o cliente
example: https://checkout.4seletpay.com.br/lnk_abc123xyz?token=...
status:
type: string
description: Status atual do link
enum:
- InProgress
- Canceled
- Concluded
example: InProgress
payment_types:
type: array
items:
type: string
description: Métodos de pagamento configurados
example:
- CreditCard
- PIX
installments:
type: array
description: >-
Opções de parcelamento expandidas (uma entrada por parcela de 1 a
12)
items:
type: object
properties:
count:
type: integer
example: 1
interest_rate:
type: number
format: float
example: 1
obfuscate_client:
type: boolean
description: Dados do pagador mascarados no checkout
example: false
obfuscate_items:
type: boolean
description: Itens ocultos no checkout
example: false
expires_at:
type: string
format: date-time
nullable: true
description: Data/hora de expiração ou null
example: '2026-12-31T23:59:59.000000Z'
max_uses:
type: integer
nullable: true
description: Limite máximo de pagamentos ou null se ilimitado
example: 100
uses_count:
type: integer
description: Quantidade de pagamentos realizados via este link
example: 0
value:
type: number
format: float
description: Valor total do link em reais
example: 97.99
created_at:
type: string
format: date-time
description: Data de criação (ISO 8601)
example: '2026-05-27T10:00:00.000000Z'
image_warning:
type: string
nullable: true
description: >-
Presente apenas quando o processamento da imagem falhou (fail-soft).
Descreve o motivo.
example: 'Não foi possível processar a imagem: URL inacessível.'
responses:
Unauthorized:
description: Não autorizado — token inválido ou ausente
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
mensagem: Unauthenticated.
erro: true
mensagenserro: []
codigoretorno: 401
id: 00000000-0000-0000-0000-000000000000
data: []
NotFound:
description: Recurso não encontrado
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
mensagem: The charge code does not match any charge
erro: true
mensagenserro: []
codigoretorno: 404
id: 00000000-0000-0000-0000-000000000000
data: []
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: >-
Token JWT obtido via `POST /v1/login`. Envie no header `Authorization:
Bearer `.
````