Capturar cobrança

Capturar cobrança

post

Captura uma cobrança previamente autorizada

Autorizações

ApiKeyAuth

Parâmetros de rota

uuidstring · uuidObrigatório

UUID da cobrança a ser capturada

Parâmetros de cabeçalho

X-Token-ApistringObrigatório

Token de autenticação para acesso à API

Content-Typestring · enumObrigatório

Tipo de conteúdo da requisição

Valores possíveis:

x-idempotency-keystringOpcional

Chave de idempotência

x-ip-origin-requeststringOpcional

IP de origem da requisição

Corpo

application/json

valuenumber · doubleOpcional

Valor a ser capturado (opcional, se não informado captura o valor total)

Example: 100.5

Respostas

200

Cobrança capturada com sucesso

application/json

201

Cobrança capturada 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

post

HTTPcURLJavaScriptPython

POST /v2/charges/{uuid}/capture HTTP/1.1
Host: api.barte.com
X-Token-Api: text
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "value": 100.5
}

{
  "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": "[e-mail]",
  "createdAt": "2024-03-20T10:00:00Z",
  "updatedAt": "2024-03-20T10:00:00Z",
  "paymentMethod": "CREDIT_CARD",
  "metadata": [
    {
      "key": "código",
      "value": "YMC"
    }
  ]
}