KIkiwify
Vendas

GET /sales/{id}

Changed on

Request

  • Base URL
    https://public-api.kiwify.com/v1
  • URL
    https://public-api.kiwify.com/v1/sales/{id}
  • Auth
    API key in header x-kiwify-account-id and OAuth 2
    Client credentials
    Token URL: /oauth/token scopes: sales

Path parameters

idstring required

Response

Response description

idstring
referencestring
typestring
created_atstring
updated_atstring
statusstring
payment_methodstring
net_amountnumber
approved_datestring
boleto_urlunknown
card_last_digitsstring
card_rejection_reasonunknown
card_typestring
installmentsnumber
is_one_clickboolean
parent_order_idunknown
refunded_atunknown
sale_typestring
two_cardsboolean

Example response

{
  "id": "588aa8f4-fb61-4d26-bf61-ad4cd6de42cd",
  "reference": "9dAQA5a",
  "type": "product",
  "created_at": "2023-10-31T16:53:05.119Z",
  "updated_at": "2023-10-31T16:53:05.119Z",
  "product": {
    "id": "2e1d37f7-3c68-4712-907f-a14368302e69",
    "name": "Meu Produto"
  },
  "status": "paid",
  "payment_method": "credit_card",
  "customer": {
    "id": "3319e377-912c-405c-9d98-34ac241da46b",
    "name": "Meu Cliente",
    "email": "meucliente@mail.com",
    "cpf": "99999999999",
    "mobile": "+5599999999999"
  },
  "approved_date": "2023-10-31T16:34:35.491Z",
  "card_last_digits": "1115",
  "card_type": "mastercard",
  "installments": 12,
  "is_one_click": true,
  "payment": {
    "charge_amount": 12048,
    "fee": 1348,
    "net_amount": 8652,
    "product_base_price": 10000
  },
  "sale_type": "producer",
  "affiliate_commission": {
    "name": "My Affiliate",
    "document": "123456789",
    "email": "myaffiliate@email.com"
  },
  "scheduled_installment": {
    "id": "b8f0c2b4-2f1e-4a2c-9d3a-1f2e3d4c5b6a",
    "status": "active",
    "installment_number": 2,
    "installment_quantity": 12,
    "due_date": "2026-02-10",
    "next_charge_date": "2026-03-10",
    "installment_amount": 10000,
    "total_amount": 120000,
    "customer_access": {
      "has_access": true
    },
    "charges": {
      "completed": [
        {
          "installment_number": 4,
          "due_date": "2026-04-10",
          "amount": 10000,
          "status": "open"
        }
      ],
      "future": [
        {
          "installment_number": 4,
          "due_date": "2026-04-10",
          "amount": 10000,
          "status": "open"
        }
      ]
    }
  }
}

Changes