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.

Show 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.

Show 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.

Show 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.

Show 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.

Show subscription

id · string

Identificador único da assinatura.

status · string

Status da assinatura.

discount · object

Desconto aplicado à venda, se houver.

Show 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.

Show 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

cURL

curl -X GET "https://api.chargefy.io/api/v1/sales/sale_01j9abc123" \
  -H "Authorization: Bearer $CHARGEFY_ACCESS_TOKEN"

​

Resposta de Exemplo

{
  "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": "[e-mail]",
    "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"
  }
}