Criar Pedido

Criar pedido

post

Cria um novo pedido de pagamento

Autorizações

ApiKeyAuth

Parâmetros de cabeçalho

X-Token-ApistringObrigatório

Token de autenticação para acesso à API

Content-Typestring · enumOpcional

Tipo de conteúdo da requisição

Valores possíveis:

x-idempotency-keystringOpcional

Chave de idempotência para evitar duplicidade

x-ip-origin-requeststringOpcional

IP de origem da requisição

Corpo

application/json

startDatestring · dateObrigatórioExample: 2024-03-20

valuenumber · doubleObrigatórioExample: 100

installmentsinteger · mín: 1ObrigatórioExample: 1

titlestringObrigatórioExample: Compra de produto

descriptionstringOpcionalExample: Descrição da compra

uuidBuyerstring · uuidObrigatórioExample: 550e8400-e29b-41d4-a716-446655440000

Respostas

200

Pedido criado com sucesso

application/json

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

HTTPcURLJavaScriptPython

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

{
  "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": "05212972140",
      "name": "Christian Costa",
      "email": "[e-mail]",
      "phone": "62984812743",
      "billingAddress": {
        "country": "BR",
        "state": "Goiás",
        "city": "Goiânia",
        "district": "Setor Bueno",
        "street": "Rua t 65",
        "zipCode": "74230120",
        "number": "1061",
        "complement": "Ap 2301"
      }
    }
  },
  "uuidBuyer": "550e8400-e29b-41d4-a716-446655440000",
  "metadata": [
    {
      "key": "código",
      "value": "YMC"
    }
  ]
}

{
  "uuid": "550e8400-e29b-41d4-a716-446655440000",
  "status": "SENT",
  "startDate": "2024-03-20",
  "value": 100,
  "installments": 1,
  "title": "Compra de produto",
  "description": "Descrição da compra",
  "uuidBuyer": "550e8400-e29b-41d4-a716-446655440000",
  "createdAt": "2024-03-20T10:00:00Z",
  "updatedAt": "2024-03-20T10:00:00Z",
  "metadata": [
    {
      "key": "código",
      "value": "YMC"
    }
  ]
}