Capturar Cobrança

Capturar cobrança

post

/v2/charges/{uuid}/capture

Captura uma cobrança previamente autorizada

Authorizations

X-Token-ApistringRequired

Token de autenticação para acesso à API

Path parameters

uuidstring · uuidRequired

UUID da cobrança a ser capturada

Header parameters

X-Token-ApistringRequired

Token de autenticação para acesso à API

Content-Typestring · enumOptional

Tipo de conteúdo da requisição

Possible values:

x-idempotency-keystringOptional

Chave de idempotência

x-ip-origin-requeststringOptional

IP de origem da requisição

Body

valuenumber · doubleOptional

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

Example: 100.5

Responses

200

Requisição processada. O resultado da captura está em status e retryable: PAID (capturada), PRE_AUTHORIZED com retryable true (não concluída, pode tentar de novo) ou CANCELED (autorização expirada ou limite de tentativas atingido)

application/json

uuidstring · uuidOptionalExample: 3e40ddbe-6ef7-4cdb-ab22-6a54bc405abd

titlestringOptionalExample: Fatura mensal do cliente

expirationDatestring · dateOptionalExample: 2025-09-18

paidDatestring · dateOptionalExample: 2025-09-18

valuenumber · doubleOptionalExample: 1000

paymentMethodstring · enumOptionalExample: CREDIT_CARD_EARLY_SELLERPossible values:

statusstring · enumOptionalExample: PAIDPossible values:

authorizationCodestring · nullableOptional

authorizationNsustringOptionalExample: 296

retryablebooleanOptional

Indica se vale tentar a captura de novo. true: a captura não foi concluída e a cobrança continua PRE_AUTHORIZED. false: a captura terminou; com status PAID foi capturada, com status CANCELED a autorização expirou na adquirente ou o limite de tentativas foi atingido.

Example: false

201

Requisição processada. O resultado da captura está em status e retryable: PAID (capturada), PRE_AUTHORIZED com retryable true (não concluída, pode tentar de novo) ou CANCELED (autorização expirada ou limite de tentativas atingido)

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/v2/charges/{uuid}/capture

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": "3e40ddbe-6ef7-4cdb-ab22-6a54bc405abd",
  "title": "Fatura mensal do cliente",
  "expirationDate": "2025-09-18",
  "paidDate": "2025-09-18",
  "value": 1000,
  "paymentMethod": "CREDIT_CARD_EARLY_SELLER",
  "status": "PAID",
  "customer": {
    "uuid": "",
    "document": "39600937000133",
    "type": "CNPJ",
    "name": "Daniel e Manoel Pães e Doces Ltda",
    "email": "[e-mail]",
    "phone": "15982705981"
  },
  "authorizationCode": null,
  "authorizationNsu": "296",
  "retryable": false
}