---
title: "Compra"
description: "Criação de compras e checkout."
---
<div class="lm-ref-kicker"><code>purchase</code><span>namespace</span></div>

Criação de compras e checkout.

<div class="lm-ref-stats lm-ref-stats--compact">
  <div class="lm-ref-stat"><strong>1</strong><span>método</span></div>
  <div class="lm-ref-stat"><code>purchase</code><span>namespace</span></div>
</div>

> Esta página é gerada automaticamente pelo `@luckymaker/sdk-generator`. Não edite manualmente.

## `createPurchase`

<div class="lm-endpoint"><span class="lm-http lm-http--post">POST</span><code>/purchase</code></div>

Assinatura:

```ts
createPurchase(body?: CreatePurchaseBody, settings?: SdkSettings<CreatePurchaseQuery>): Promise<CreatePurchaseResponse>
```

### Query

| Nome | Tipo | Obrigatório |
|---|---|---|
| `utm_source` | `string` | não |
| `utm_medium` | `string` | não |
| `utm_campaign` | `string` | não |
| `utm_term` | `string` | não |
| `utm_content` | `string` | não |
| `utm_id` | `string` | não |
| `affiliate_id` | `string \| number` | não |
| `reseller_id` | `string \| number` | não |
| `reseller_slug` | `string \| number` | não |
| `reseller_uuid` | `string` | não |
| `referrer_domain` | `string` | não |
| `lm_medium` | `string` | não |
| `lm_source` | `string` | não |
| `lm_purchase_source` | `"APP" \| "API" \| "PHYSICAL" \| "DESKTOP_WEB" \| "MOBILE_WEB" \| "TABLET_WEB" \| "EMBED" \| "LANDING_PAGE" \| "WEBSITE" \| "UNKNOWN" \| "STUB" \| "SUBSCRIPTION"` | não |
| `lm_cohort` | `string` | não |
| `device_id` | `string` | não |
| `onesignal_player_id` | `string` | não |
| `fbclid` | `string` | não |
| `click_id` | `string` | não |
| `gclid` | `string` | não |
| `ttclid` | `string` | não |

### Body

| Nome | Tipo | Obrigatório |
|---|---|---|
| `captcha` | `string` | sim |
| `cart` | `{ "uuid": string; "offers"?: Array<string>; }` | não |
| `userData` | `{ "id"?: number; "email"?: string; "password"?: string; "name"?: string; "originalName"?: string; "socialName"?: string \| null; "cpf"?: string; "idd"?: string; "tel"?: string; "birthdate"?: string; "gender"?: "M" \| "F" \| "O" \| "N" \| null; "address"?: { "cep": string; "streetName": string; "number"?: string; "neighborhood": string; "complement"?: string; "city": string; "state": string; }; "creditsAmount"?: number; "checkingAccountAmount"?: number; }` | não |
| `resellerData` | `{ "id"?: number; "email"?: string; "password"?: string; "name"?: string; "document"?: string; }` | não |
| `purchaseData` | `{ "cartItemId"?: string; "type": "RAFFLE_NUMBERS"; "raffleUUID": string; "amount": number; } \| { "cartItemId"?: string; "type": "CREDITS"; "amount": number; } \| { "cartItemId"?: string; "type": "RAFFLE_NUMBERS"; "kind": "GAMBLING"; "raffleUUID": string; "priceMultiplier": number; "amount": number; } \| { "cartItemId"?: string; "type": "ECOMMERCE_ITEM"; "amount": number; "itemId": string \| number; } \| { "cartItemId"?: string; "type": "SUBSCRIPTION"; "amount": number; "planId": string; } \| { "items": Array<{ "cartItemId"?: string; "type": "RAFFLE_NUMBERS"; "raffleUUID": string; "amount": number; } \| { "cartItemId"?: string; "type": "CREDITS"; "amount": number; } \| { "cartItemId"?: string; "type": "RAFFLE_NUMBERS"; "kind": "GAMBLING"; "raffleUUID": string; "priceMultiplier": number; "amount": number; } \| { "cartItemId"?: string; "type": "ECOMMERCE_ITEM"; "amount": number; "itemId": string \| number; } \| { "cartItemId"?: string; "type": "SUBSCRIPTION"; "amount": number; "planId": string; }>; }` | não |
| `shippingData` | `{ "addressId": string; "serviceId": string; "provider": "MELHOR_ENVIO" \| "CUSTOM" \| "melhor_envio" \| "custom"; "quoteId": string; }` | não |
| `paymentData` | `{ "type": "PIX"; "gateway"?: "MERCADOPAGO" \| "PICPAY" \| "PAYBROKERS" \| "SAQPAY" \| "EFIPAY" \| "SULCREDI" \| "STARKBANK" \| "NONE" \| "STRIPE"; } \| { "type": "PICPAY" \| "CREDITS"; } \| { "type": "POINTS"; "gateway"?: "MERCADOPAGO" \| "PICPAY" \| "PAYBROKERS" \| "SAQPAY" \| "EFIPAY" \| "SULCREDI" \| "STARKBANK" \| "NONE" \| "STRIPE"; } \| { "type": "DIGITAL_WALLET"; "confirmationTokenId": string; "expectedAmount": number; } \| { "type": "CARD"; "id": string; "token"?: string; }` | sim |

### Tipos

```ts
type CreatePurchaseQuery = { "utm_source"?: string; "utm_medium"?: string; "utm_campaign"?: string; "utm_term"?: string; "utm_content"?: string; "utm_id"?: string; "affiliate_id"?: string | number; "reseller_id"?: string | number; "reseller_slug"?: string | number; "reseller_uuid"?: string; "referrer_domain"?: string; "lm_medium"?: string; "lm_source"?: string; "lm_purchase_source"?: "APP" | "API" | "PHYSICAL" | "DESKTOP_WEB" | "MOBILE_WEB" | "TABLET_WEB" | "EMBED" | "LANDING_PAGE" | "WEBSITE" | "UNKNOWN" | "STUB" | "SUBSCRIPTION"; "lm_cohort"?: string; "device_id"?: string; "onesignal_player_id"?: string; "fbclid"?: string; "click_id"?: string; "gclid"?: string; "ttclid"?: string; };
type CreatePurchaseBody = { "captcha": string; "cart"?: { "uuid": string; "offers"?: Array<string>; }; "userData"?: { "id"?: number; "email"?: string; "password"?: string; "name"?: string; "originalName"?: string; "socialName"?: string | null; "cpf"?: string; "idd"?: string; "tel"?: string; "birthdate"?: string; "gender"?: "M" | "F" | "O" | "N" | null; "address"?: { "cep": string; "streetName": string; "number"?: string; "neighborhood": string; "complement"?: string; "city": string; "state": string; }; "creditsAmount"?: number; "checkingAccountAmount"?: number; }; "resellerData"?: { "id"?: number; "email"?: string; "password"?: string; "name"?: string; "document"?: string; }; "purchaseData"?: { "cartItemId"?: string; "type": "RAFFLE_NUMBERS"; "raffleUUID": string; "amount": number; } | { "cartItemId"?: string; "type": "CREDITS"; "amount": number; } | { "cartItemId"?: string; "type": "RAFFLE_NUMBERS"; "kind": "GAMBLING"; "raffleUUID": string; "priceMultiplier": number; "amount": number; } | { "cartItemId"?: string; "type": "ECOMMERCE_ITEM"; "amount": number; "itemId": string | number; } | { "cartItemId"?: string; "type": "SUBSCRIPTION"; "amount": number; "planId": string; } | { "items": Array<{ "cartItemId"?: string; "type": "RAFFLE_NUMBERS"; "raffleUUID": string; "amount": number; } | { "cartItemId"?: string; "type": "CREDITS"; "amount": number; } | { "cartItemId"?: string; "type": "RAFFLE_NUMBERS"; "kind": "GAMBLING"; "raffleUUID": string; "priceMultiplier": number; "amount": number; } | { "cartItemId"?: string; "type": "ECOMMERCE_ITEM"; "amount": number; "itemId": string | number; } | { "cartItemId"?: string; "type": "SUBSCRIPTION"; "amount": number; "planId": string; }>; }; "shippingData"?: { "addressId": string; "serviceId": string; "provider": "MELHOR_ENVIO" | "CUSTOM" | "melhor_envio" | "custom"; "quoteId": string; }; "paymentData": { "type": "PIX"; "gateway"?: "MERCADOPAGO" | "PICPAY" | "PAYBROKERS" | "SAQPAY" | "EFIPAY" | "SULCREDI" | "STARKBANK" | "NONE" | "STRIPE"; } | { "type": "PICPAY" | "CREDITS"; } | { "type": "POINTS"; "gateway"?: "MERCADOPAGO" | "PICPAY" | "PAYBROKERS" | "SAQPAY" | "EFIPAY" | "SULCREDI" | "STARKBANK" | "NONE" | "STRIPE"; } | { "type": "DIGITAL_WALLET"; "confirmationTokenId": string; "expectedAmount": number; } | { "type": "CARD"; "id": string; "token"?: string; }; };
type CreatePurchaseResponse = { "id": number; "uuid": string; "method": unknown; "methods": Array<"CARD" | "PICPAY" | "PIX" | "CREDITS" | "API" | "POINTS" | "DIGITAL_WALLET">; "value": number; "originalValue"?: number; "pointsValue"?: number; "source": "APP" | "API" | "PHYSICAL" | "DESKTOP_WEB" | "MOBILE_WEB" | "TABLET_WEB" | "EMBED" | "LANDING_PAGE" | "WEBSITE" | "UNKNOWN" | "STUB" | "SUBSCRIPTION"; "status": "CREATED" | "PENDING" | "ANALYSIS" | "APPROVED" | "REFUSED" | "CANCELLED" | "REFUNDED" | "CHARGEDBACK"; "expiresAt"?: string; "canChangPaymentMethod": boolean; "authorizationOnly"?: boolean; "instantPrizesWon"?: number; "appliedOffers"?: Array<unknown>; "unlockedOffers"?: Array<unknown>; "bonds"?: { "count": number; }; "data": { "involvedRaffles"?: Record<string, unknown>; "statusMessage"?: string; "user"?: { "name": string; "cpf"?: string; "needNewPassword"?: boolean; }; "reseller"?: { "name": string; }; }; "payer"?: { "id": number; "name": string; "document": string; "email": string; "phone"?: string; "address": { "streetName": string; "number"?: string; "complement"?: string; "neighborhood": string; "city": string; "state": string; "cep": string; }; }; "blocks"?: unknown; "items": unknown; "instructions"?: { "code": string; } | { "url": string; } | { "clientSecret": string; }; "createdAt": string; "updatedAt": string; "token"?: string; "links"?: { "self": string; }; "subscriptionAuthorization"?: { "planName": string; "recurringValue": number; "billingLabel": string; "firstChargeAt"?: string; }; "externalServices"?: Array<{ "name": string; "data"?: Record<string, unknown>; }>; };
```

### Exemplo

```ts
const response = await sdk.purchase.createPurchase({ "captcha": "string", "paymentData": { "type": "PIX" } });
```

<a class="lm-playground-link" href="/docs/guias/playground/?namespace=purchase&method=createPurchase">Testar esta função no playground <svg class="lm-arrow-icon" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><path d="M5 12h14"/><path d="m12 5 7 7-7 7"/></svg></a>