> ## Documentation Index
> Fetch the complete documentation index at: https://scaleup-c34c4386.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# GET /api/v1/sales/:id

> Retorna os detalhes completos de uma venda específica pelo seu identificador único.

Retorna o objeto completo de uma venda, incluindo status, valor, tipo de pagamento, parcelamento, produto e informações do cliente.

## Autenticação

Requer **Organization Access Token** via header `Authorization: Bearer`.

Escopos aceitos: `web:read`, `web:write` ou `sales:read`.

## Parâmetros de Path

**id** `string` *required*

Identificador único da venda.

## Resposta

**id** `string`

Identificador único da venda.

**transaction\_id** `string`

Identificador da transação no processador de pagamento.

**marketplace\_id** `string`

Identificador do marketplace associado à venda.

**status** `string`

Status atual da venda. Valores possíveis: `new`, `pending`, `pre_authorized`, `succeeded`, `failed`, `canceled`, `refunded`, `partially_refunded`, `reversed`, `dispute`, `charged_back`.

**payment\_type** `string`

Tipo de pagamento utilizado: `credit`, `boleto` ou `pix`.

**installments** `integer`

Número de parcelas do pagamento.

**amount** `integer`

Valor total da venda em centavos.

**subtotal\_amount** `integer`

Valor subtotal antes de descontos e taxas, em centavos.

**discount\_amount** `integer`

Valor de desconto aplicado, em centavos.

**tax\_amount** `integer`

Valor de impostos cobrados, em centavos.

**platform\_fee\_amount** `integer`

Taxa da plataforma cobrada sobre a venda, em centavos.

**refunded\_amount** `integer`

Valor já estornado, em centavos.

**net\_amount** `integer`

Valor líquido recebido pelo vendedor, em centavos.

**currency** `string`

Código da moeda no formato ISO 4217 (ex.: `BRL`).

**description** `string`

Descrição da venda, se disponível.

**payment\_method\_id** `string`

Identificador do método de pagamento utilizado.

**card\_data** `object`

Dados do cartão de crédito utilizado. Presente quando `payment_type` é `credit`.

**card\_data**

**last4** `string`

Últimos 4 dígitos do cartão.

**first4** `string`

Primeiros 4 dígitos do cartão.

**holder\_name** `string`

Nome do titular do cartão.

**brand** `string`

Bandeira do cartão (ex.: `visa`, `mastercard`).

**expiration\_month** `string`

Mês de expiração do cartão.

**expiration\_year** `string`

Ano de expiração do cartão.

**boleto\_data** `object`

Dados do boleto bancário. Presente quando `payment_type` é `boleto`.

**boleto\_data**

**barcode** `string`

Código de barras do boleto.

**url** `string`

URL para visualização ou download do boleto.

**expiration\_date** `string`

Data de vencimento do boleto no formato ISO 8601.

**pix\_data** `object`

Dados do PIX. Presente quando `payment_type` é `pix`.

**pix\_data**

**qr\_code** `string`

Payload do QR Code PIX (copia e cola).

**qr\_code\_url** `string`

URL da imagem do QR Code PIX.

**expiration\_date** `string`

Data de expiração do QR Code no formato ISO 8601.

**billing\_name** `string`

Nome de cobrança do comprador.

**billing\_address** `object`

Endereço de cobrança do comprador.

**invoice\_number** `string`

Número da nota fiscal ou fatura associada à venda.

**user\_metadata** `object`

Metadados customizados definidos pelo usuário via API.

**metadata** `object`

Metadados internos da venda.

**is\_refund** `boolean`

Indica se esta venda é um registro de estorno (não a venda original).

**refund\_parent\_id** `string`

Identificador da venda original quando `is_refund` é `true`.

**can\_refund** `boolean`

Indica se a venda pode ser estornada. `true` quando o status é `succeeded`, não é um estorno, e o pagamento foi confirmado há menos de 30 dias.

**checkout\_id** `string`

Identificador do checkout que originou a venda.

**subscription\_id** `string`

Identificador da assinatura associada, se aplicável.

**discount\_id** `string`

Identificador do desconto aplicado, se houver.

**created\_at** `string`

Data e hora de criação da venda no formato ISO 8601.

**updated\_at** `string`

Data e hora da última atualização no formato ISO 8601.

**confirmed\_at** `string`

Data e hora da confirmação do pagamento no formato ISO 8601.

**failed\_at** `string`

Data e hora da falha no pagamento, quando aplicável.

**customer** `object`

Cliente que realizou a compra.

**customer**

**id** `string`

Identificador único do cliente.

**email** `string`

Endereço de e-mail do cliente.

**name** `string`

Nome do cliente.

**avatar\_url** `string`

URL do avatar do cliente.

**subscription** `object`

Assinatura associada à venda, se aplicável.

**subscription**

**id** `string`

Identificador único da assinatura.

**status** `string`

Status da assinatura.

**discount** `object`

Desconto aplicado à venda, se houver.

**discount**

**id** `string`

Identificador único do desconto.

**name** `string`

Nome do desconto.

**code** `string`

Código do cupom de desconto.

**seller** `object`

Vendedor responsável pela venda.

**seller**

**id** `string`

Identificador interno do seller.

**seller\_id** `string`

Identificador do seller no processador de pagamento.

**seller\_type** `string`

Tipo do seller (ex.: `individual`, `business`).

**status** `string`

Status do seller.

## Exemplo

```bash cURL theme={null}
curl -X GET "https://api.chargefy.io/api/v1/sales/sale_01j9abc123" \
  -H "Authorization: Bearer $CHARGEFY_ACCESS_TOKEN"
```

```typescript SDK theme={null}
import { Chargefy } from '@chargefy/sdk';
const chargefy = new Chargefy({ accessToken: process.env.CHARGEFY_ACCESS_TOKEN });
const result = await chargefy.sales.get('sale_01j9abc123');
```

## Resposta de Exemplo

```json theme={null}
{
  "id": "sale_01j9abc123",
  "transaction_id": "txn_zoop_abc123",
  "marketplace_id": "mkt_01j9xyz",
  "status": "succeeded",
  "payment_type": "credit",
  "installments": 3,
  "amount": 9900,
  "subtotal_amount": 10000,
  "discount_amount": 100,
  "tax_amount": 0,
  "platform_fee_amount": 300,
  "refunded_amount": 0,
  "net_amount": 9600,
  "currency": "BRL",
  "description": null,
  "is_refund": false,
  "refund_parent_id": null,
  "can_refund": true,
  "checkout_id": "chk_01j9abc",
  "subscription_id": null,
  "discount_id": null,
  "billing_name": "João Silva",
  "billing_address": {
    "line1": "Rua das Flores, 123",
    "city": "São Paulo",
    "state": "SP",
    "postal_code": "01310-100",
    "country": "BR"
  },
  "card_data": {
    "last4": "4242",
    "first4": "4111",
    "holder_name": "JOAO SILVA",
    "brand": "visa",
    "expiration_month": "12",
    "expiration_year": "2027"
  },
  "boleto_data": null,
  "pix_data": null,
  "user_metadata": {},
  "metadata": {},
  "created_at": "2024-11-01T12:00:00Z",
  "updated_at": "2024-11-01T12:05:00Z",
  "confirmed_at": "2024-11-01T12:05:00Z",
  "failed_at": null,
  "customer": {
    "id": "cust_01j9xyz",
    "email": "cliente@exemplo.com",
    "name": "João Silva",
    "avatar_url": null
  },
  "subscription": null,
  "discount": null,
  "seller": {
    "id": "sel_01j9xyz",
    "seller_id": "zoop_seller_abc",
    "seller_type": "business",
    "status": "active"
  }
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.