Criar Pedido com Token do Cartão

Criar pedido

post

/v2/orders

Cria um novo pedido de pagamento

Authorizations

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

startDatestring · dateRequiredExample: 2024-03-20

valuenumber · doubleRequiredExample: 100

installmentsinteger · min: 1RequiredExample: 1

titlestringRequiredExample: Compra de produto

descriptionstringOptionalExample: Descrição da compra

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

Responses

200

Pedido criado com sucesso

application/json

uuidstring · uuidOptionalExample: 550e8400-e29b-41d4-a716-446655440000

statusstring · enumOptionalExample: SENTPossible values:

startDatestring · dateOptionalExample: 2024-03-20

valuenumber · doubleOptionalExample: 100

installmentsintegerOptionalExample: 1

titlestringOptionalExample: Compra de produto

descriptionstringOptionalExample: Descrição da compra

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

createdAtstring · date-timeOptionalExample: 2024-03-20T10:00:00Z

updatedAtstring · date-timeOptionalExample: 2024-03-20T10:00:00Z

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

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

{
  "startDate": "2024-03-20",
  "value": 100,
  "installments": 1,
  "title": "Compra de produto",
  "description": "Descrição da compra",
  "payment": {
    "method": "CREDIT_CARD",
    "capture": true,
    "softDescriptor": "Soft Descriptor 123456",
    "card": {
      "cardToken": "7dcf9e7f-c306-4df2-b61a-f774e7d2f1a9",
      "cvv": "220"
    },
    "fraudData": {
      "document": "0521297210",
      "name": "JOSE DAS NEVES TEST",
      "email": "[e-mail]",
      "phone": "62984812743",
      "billingAddress": {
        "country": "BR",
        "state": "Rio Grande do Sul",
        "city": "Caxias do Sul",
        "district": "Santa Catarina",
        "street": "Rua Emílio Ribas",
        "zipCode": "95032350",
        "number": "347",
        "complement": ""
      },
      "internationalDocument": {
        "documentType": "CPF, CNPJ, SSN",
        "documentNumber": "79478638068",
        "documentNation": "BR"
      },
      "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": "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"
    }
  ]
}