For the complete documentation index, see llms.txt. This page is also available as Markdown.

Buscar Pedido

Buscar pedido por UUID

get
/v2/orders/{uuid}

Retorna os detalhes de um pedido específico

Authorizations
X-Token-ApistringRequired

Token de autenticação para acesso à API

Path parameters
uuidstring · uuidRequired

UUID do pedido

Header parameters
X-Token-ApistringRequired

Token de autenticação para acesso à API

Content-Typestring · enumOptional

Tipo de conteúdo da requisição

Possible values:
Responses
200

Pedido encontrado com sucesso

application/json
uuidstring · uuidOptionalExample: e82c66cc-cdf6-4253-87b2-ed339d3b9669
statusstring · enumOptionalExample: PAIDPossible values:
titlestring · max: 255OptionalExample: 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
serialNumberstringOptional

Serial number do terminal que realizou a transação.

Example: 1234567890
terminalIdstringOptional

Identificador lógico do terminal que realizou a transação.

Example: 00000000
originRequeststring · enumOptional

Origem da order, obtida a partir da charge. Mesmo conceito recebido como originRequest no request.

Example: POSPossible values:
get/v2/orders/{uuid}
GET /v2/orders/{uuid} HTTP/1.1
Host: api.barte.com
X-Token-Api: text
Accept: */*
{
  "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": "Heyj5wohn4445@gmail.com",
    "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": "Heyj5wohn4445@gmail.com",
        "phone": "9409822523",
        "alternativeEmail": ""
      },
      "authorizationCode": "488713",
      "authorizationNsu": "154054",
      "refunds": [
        {}
      ],
      "retryable": false,
      "fee": 0.49
    }
  ],
  "serialNumber": "1234567890",
  "terminalId": "00000000",
  "originRequest": "POS"
}

Last updated

Was this helpful?