Pagamento de Cartão sem Tokenização
Corpo da Requisição (JSON)
Campos de primeiro nível
Campo
Tipo
Obrigatório
Descrição
startDate
string
(YYYY-MM-DD)
Não
Data em que a ordem deve ser processada. Se ausente, usa a data atual.
value
number
Sim
Valor total da cobrança em centavos ou unidades monetárias (BRL).
installments
integer
Sim
Número de parcelas (mín. 1).
title
string
Não
Identificação amigável da ordem (aparece nos relatórios).
attemptReference
string
Sim
Mesmo valor do header x‑idempotency-key
.
description
string
Não
Descrição detalhada da ordem.
payment
object
Sim
Dados de pagamento (ver abaixo).
uuidBuyer
string
(UUID)
Sim
Identificador do comprador criado previamente via API /v2/buyers
.
Objeto payment
payment
Campo
Tipo
Obrigatório
Descrição
method
string
Sim
Método de pagamento. Ex.: CREDIT_CARD_EARLY_SELLER
(captura imediata + antecipação).
brand
string
Sim
Bandeira do cartão (visa
, mastercard
, etc.).
capture
boolean
Não
true
para capturar imediatamente após a autorização (default false
).
softDescriptor
string
Não
Texto (máx. 13 caracteres) que aparecerá na fatura do comprador.
¹ Obrigatório se o method
for baseado em cartão de crédito.
Objeto payment.card
Campo
Tipo
Obrigatório
Descrição
holderName
string
Sim
Nome impresso no cartão.
number
string
Sim
Número do cartão (PAN).
cvv
string
ou int
Sim
Código de verificação.
expiration
string
(MM/YYYY)
Sim
Data de expiração do cartão.
Objeto payment.fraudData
Campo
Tipo
Descrição
internationalDocument
object
Documento do comprador.
name
string
Nome completo do comprador.
email
string
E‑mail do comprador.
phone
string
Telefone do comprador (E.164 ou local).
billingAddress
object
Endereço de cobrança.
internationalDocument
Campo
Tipo
Descrição
documentNumber
string
Número do documento (CPF, CNPJ, passaporte, etc.).
documentType
string
Tipo do documento (CPF, CNPJ, PASSPORT…).
documentNation
string
País emissor no formato ISO‑3166‑1 alpha‑2 (ex.: BR
).
billingAddress
Campo
Tipo
Descrição
country
string
País (ISO‑3166‑1 alpha‑2).
state
string
Estado/UF.
city
string
Cidade.
district
string
Bairro.
street
string
Logradouro.
zipCode
string
CEP somente números.
number
string
Número.
complement
string
Complemento (opcional).
Exemplo de Request (cURL)
curl --location 'https://api.barte.com/v2/orders' \
--header 'X-Token-Api: <SUA_CHAVE_AQUI>' \
--header 'x-idempotency-key: aaeaf5f9-1efd-49e2-8631-ce2b187452a7' \
--header 'Content-Type: application/json' \
--data-raw '{
"startDate": "2025-07-22",
"value": 56,
"installments": 2,
"title": "Barte - Postman - 2cf",
"attemptReference": "aaeaf5f9-1efd-49e2-8631-ce2b187452a7",
"description": "Barte - Postman - yaG",
payment": {
"capture": true,
"softDescriptor": "Soft Descriptor 123456",
"method": "CREDIT_CARD_EARLY_BUYER",
"card": {
"holderName": "JOSE DAS NEVES TEST",
"number": "5383638854440891",
"cvv": 220,
"expiration": "12/2028"
},
"brand": "mastercard",
"fraudData": {
"internationalDocument": {
"documentNumber": "02880494117",
"documentType": "CPF",
"documentNation": "BR"
},
"name": "ClienteExterno-PVvT",
"email": "ClienteExterno-PVvT@email.com",
"phone": "1199999-9999",
"billingAddress": {
"country": "BR",
"state": "SP",
"city": "São Paulo",
"district": "Bela Vista",
"street": "Avenida Paulista",
"zipCode": "08735440",
"number": "620",
"complement": ""
}
}
},
"uuidBuyer": "e3dbdcae-1bc8-4d55-862a-e96b8d0805bc"
}'
Exemplo de Resposta (201 Created)
{
"uuidOrder": "5e80f8e4-b9d4-4b0d-9303-55f2692cb3b5",
"status": "APPROVED",
"value": 56,
"installments": 2,
"createdAt": "2025-07-22T18:04:11.123Z",
"payment": {
"method": "CREDIT_CARD_EARLY_SELLER",
"brand": "mastercard",
"authorizationCode": "145632",
"nsu": "927461",
"tid": "0000001000001234",
"status": "CAPTURED"
}
}
Campos podem variar conforme o provedor de pagamento.
Códigos de Resposta
HTTP
Motivo
Quando acontece
201 Created
Ordem criada com sucesso.
Dados válidos e pagamento aprovado ou em avaliação.
202 Accepted
Ordem criada, pagamento pendente.
Métodos assíncronos (ex.: boleto) ou análise antifraude.
400 Bad Request
Erro de validação.
Campo ausente, formato inválido etc.
401 Unauthorized
Falha de autenticação.
X-Token-Api
inválido/expirado.
409 Conflict
Ordem já existe.
Mesmo x-idempotency-key
/attemptReference
enviado antes.
422 Unprocessable Entity
Pagamento recusado.
Cartão negado, saldo insuficiente, antifraude reprovou.
500 Internal Server Error
Erro inesperado.
Contate o suporte se persistir.
Atualizado
Isto foi útil?