Buscar Cobrança

Buscar cobrança por UUID

get

https://api.barte.comhttps://sandbox-api.barte.com

/v2/charges/{uuid}

Retorna os detalhes de uma cobrança específica

Authorizations

ApiKeyAuth

X-Token-ApistringRequired

Token de autenticação para acesso à API

Path parameters

uuidstring · uuidRequired

UUID da cobrança

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

Responses

200

Cobrança encontrada com sucesso

application/json

uuidstring · uuidOptionalExample: bbce8cf5-7a07-46c5-9494-99c76c42688f

titlestringOptionalExample: Teste

expirationDatestring · dateOptionalExample: 2025-10-16

valuenumber · doubleOptionalExample: 100

paymentMethodstring · enumOptionalExample: CREDIT_CARD_EARLY_SELLERPossible values:

statusstring · enumOptionalExample: CANCELEDPossible values:

authorizationCodestring · nullableOptionalExample: null

authorizationNsustringOptionalExample: 154055

refundsobject[]Optional

retryablebooleanOptionalExample: false

orderUuidstring · uuid · nullableOptional

UUID da cobrança associada

Example: 550e8400-e29b-41d4-a716-446655440001

subscriptionUuidstring · uuid · nullableOptional

UUID da assinatura associada

Example: 550e8400-e29b-41d4-a716-446655440002

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

get/v2/charges/{uuid}

HTTPcURLJavaScriptPython

GET /v2/charges/{uuid} HTTP/1.1
Host: api.barte.com
X-Token-Api: text
Accept: */*

{
  "uuid": "bbce8cf5-7a07-46c5-9494-99c76c42688f",
  "title": "Teste",
  "expirationDate": "2025-10-16",
  "value": 100,
  "paymentMethod": "CREDIT_CARD_EARLY_SELLER",
  "status": "PAID",
  "customer": {
    "uuid": "",
    "document": "001052647",
    "type": "SSN",
    "name": "Joshua Henry",
    "email": "[e-mail]",
    "phone": "9409822523",
    "alternativeEmail": ""
  },
  "authorizationCode": null,
  "authorizationNsu": "154055",
  "refunds": [],
  "retryable": false,
  "orderUuid": "550e8400-e29b-41d4-a716-446655440001"
}