Cancelar pré-captura
Cancela uma pré-autorização de cobrança
Autorizações
Parâmetros de rota
uuidstring · uuidObrigatório
UUID da cobrança com pré-autorização a ser cancelada
Parâmetros de cabeçalho
X-Token-ApistringObrigatório
Token de autenticação para acesso à API
Content-Typestring · enumObrigatórioValores possíveis:
Tipo de conteúdo da requisição
x-idempotency-keystringOpcional
Chave de idempotência
x-ip-origin-requeststringOpcional
IP de origem da requisição
Respostas
200
Pré-autorização cancelada com sucesso
application/json
201
Cancelamento processado com sucesso
application/json
202
Requisição aceita para processamento
204
Sem conteúdo
301
Redirecionamento permanente
400
Erro de validação
application/json
401
Token inativo ou inexistente
application/json
403
Acesso negado
application/json
404
Cobrança não encontrada
application/json
429
Muitas requisições
application/json
500
Erro interno do servidor
application/json
patch
PATCH /v2/charges/{uuid}/cancel/pre-authorization HTTP/1.1
Host: api.barte.com
X-Token-Api: text
Content-Type: application/json
Accept: */*
{
"uuid": "550e8400-e29b-41d4-a716-446655440000",
"status": "PENDING",
"value": 100.5,
"title": "Cobrança de produto",
"description": "Descrição da cobrança",
"uuidBuyer": "550e8400-e29b-41d4-a716-446655440000",
"expirationDate": "2024-12-31",
"notificationEmail": "cliente@exemplo.com",
"createdAt": "2024-03-20T10:00:00Z",
"updatedAt": "2024-03-20T10:00:00Z",
"paymentMethod": "CREDIT_CARD",
"metadata": [
{
"key": "código",
"value": "YMC"
}
]
}
Atualizado
Isto foi útil?