Criar Pedido

Criar pedido

post

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

/v2/orders

Cria um novo pedido de pagamento

Authorizations

ApiKeyAuth

X-Token-ApistringRequired

Token de autenticação para acesso à API

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 para evitar duplicidade

x-ip-origin-requeststringOptional

IP de origem da requisição

Body

application/json

startDatestring · dateOptional

Data de início da cobrança. Se não enviado, o startDate será a data atual

Example: 2024-03-20

valuenumber · doubleRequiredExample: 100

installmentsinteger · min: 1RequiredExample: 1

titlestring · max: 60RequiredExample: Compra de produto

descriptionstring · max: 300OptionalExample: Descrição da compra

uuidBuyerstring · uuidRequiredExample: 550e8400-e29b-41d4-a716-446655440000

Responses

200

Pedido criado com sucesso

application/json

uuidstring · uuidOptionalExample: e82c66cc-cdf6-4253-87b2-ed339d3b9669

statusstring · enumOptionalExample: PAIDPossible values:

titlestring · max: 60OptionalExample: Teste

descriptionstring · max: 300Optional

valuenumber · doubleOptionalExample: 100

installmentsintegerOptionalExample: 5

startDatestring · dateOptional

Data de início da cobrança.

Example: 2025-10-14

paymentstring · enumOptionalExample: CREDIT_CARD_EARLY_SELLERPossible values:

idempotencyKeystring · uuidOptionalExample: b6cf42ba-3b64-4587-ba91-eec18465d091

201

Pedido criado com sucesso

application/json

400

Erro de validação ou negócio

application/json

401

Token inativo ou inexistente

application/json

403

Acesso negado

application/json

404

Recurso não encontrado

application/json

429

Muitas requisições

application/json

500

Erro interno do servidor

application/json

post

/v2/orders

HTTPcURLJavaScriptPython

POST /v2/orders HTTP/1.1
Host: api.barte.com
X-Token-Api: text
Content-Type: application/json
Accept: */*
Content-Length: 1037

{
  "startDate": "2024-03-20",
  "value": 100,
  "installments": 1,
  "title": "Compra de produto",
  "description": "Descrição da compra",
  "payment": {
    "method": "CREDIT_CARD",
    "capture": true,
    "softDescriptor": "Testando Criação de Order",
    "card": {
      "holderName": "JOSE DAS NEVES TEST",
      "number": "5560738292679681",
      "expiration": "10/2026",
      "cvv": "290"
    },
    "fraudData": {
      "document": "79478638068",
      "name": "Captain Kirk",
      "email": "[email protected]",
      "phone": "62999998888",
      "internationalDocument": {
        "documentType": "CPF, CNPJ, SSN",
        "documentNumber": "79478638068",
        "documentNation": "BR"
      },
      "billingAddress": {
        "country": "BR",
        "state": "Minas Gerais",
        "city": "Uberlândia",
        "district": "Morada da Colina",
        "street": "Avenida Paulo Gracindo",
        "zipCode": "38411137",
        "number": "15",
        "complement": "Ap 204"
      },
      "additionalData": {
        "canal_venda": "app_mobile",
        "tipo_produto": "eletronico",
        "informacoes_dispositivo": {
          "so": "Android",
          "versao": "13"
        }
      }
    },
    "storedCredential": {
      "initiator": "MERCHANT",
      "reason": "RECURRING"
    }
  },
  "uuidBuyer": "550e8400-e29b-41d4-a716-446655440000",
  "metadata": [
    {
      "key": "código",
      "value": "YMC"
    }
  ]
}

{
  "uuid": "e82c66cc-cdf6-4253-87b2-ed339d3b9669",
  "status": "PAID",
  "title": "Teste",
  "description": "",
  "value": 100,
  "installments": 5,
  "startDate": "2025-10-14",
  "payment": "CREDIT_CARD_EARLY_SELLER",
  "customer": {
    "uuid": "",
    "document": "001052647",
    "type": "SSN",
    "documentCountry": "US",
    "name": "Joshua Henry",
    "email": "[email protected]",
    "phone": "9409822523",
    "alternativeEmail": ""
  },
  "idempotencyKey": "b6cf42ba-3b64-4587-ba91-eec18465d091",
  "subSellerPaymentResponse": [
    {
      "subSellerPaymentResponse": [
        {}
      ],
      "amountForSubSellers": 0
    }
  ],
  "charges": [
    {
      "uuid": "f337e5a4-62a3-41af-8449-c9898f1de66b",
      "title": "Teste",
      "expirationDate": "2025-10-14",
      "paidDate": "2025-10-14",
      "value": 100,
      "paymentMethod": "CREDIT_CARD_EARLY_SELLER",
      "status": "PAID",
      "customer": {
        "uuid": "",
        "document": "001052647",
        "type": "SSN",
        "documentCountry": "US",
        "name": "Joshua Henry",
        "email": "[email protected]",
        "phone": "9409822523",
        "alternativeEmail": ""
      },
      "authorizationCode": "488713",
      "authorizationNsu": "154054",
      "refunds": [
        {}
      ],
      "retryable": false,
      "fee": 0.49
    }
  ]
}