---
title: "Pedidos"
description: "Criação, autenticação e acompanhamento de pedidos."
---
ordersnamespace
Criação, autenticação e acompanhamento de pedidos.
> Esta página é gerada automaticamente pelo `@luckymaker/sdk-generator`. Não edite manualmente.
## `completeRegistrationPending`
PUT/orders/:payment/registration/pending
Assinatura:
```ts
completeRegistrationPending(payment: string, body?: CompleteRegistrationPendingBody, settings?: SdkSettings): Promise
```
### Parâmetros de rota
| Nome | Tipo |
|---|---|
| `payment` | `string` |
### Body
| Nome | Tipo | Obrigatório |
|---|---|---|
| `cpf` | `string` | sim |
| `formId` | `string` | não |
### Tipos
```ts
type CompleteRegistrationPendingParams = { "payment": string; };
type CompleteRegistrationPendingBody = { "cpf": string; "formId"?: string; [key: string]: unknown; };
type CompleteRegistrationPendingResponse = { "token": string; };
```
### Exemplo
```ts
const response = await sdk.orders.completeRegistrationPending("string", { "cpf": "string" });
```
Testar esta função no playground
## `createAuthentication`
POST/orders/:payment/authentication
Assinatura:
```ts
createAuthentication(payment: string, body?: CreateAuthenticationBody, settings?: SdkSettings): Promise
```
### Parâmetros de rota
| Nome | Tipo |
|---|---|
| `payment` | `string` |
### Body
| Nome | Tipo | Obrigatório |
|---|---|---|
| `clientSecret` | `string` | sim |
### Tipos
```ts
type CreateAuthenticationParams = { "payment": string; };
type CreateAuthenticationBody = { "clientSecret": string; };
type CreateAuthenticationResponse = { "status": "CREATED" | "PENDING" | "ANALYSIS" | "APPROVED" | "REFUSED" | "CANCELLED" | "REFUNDED" | "CHARGEDBACK"; "requiresAction": boolean; };
```
### Exemplo
```ts
const response = await sdk.orders.createAuthentication("string", { "clientSecret": "string" });
```
Testar esta função no playground
## `createBond`
POST/orders/:payment/bonds
Assinatura:
```ts
createBond(payment: string, body?: CreateBondBody, settings?: SdkSettings): Promise
```
### Parâmetros de rota
| Nome | Tipo |
|---|---|
| `payment` | `string` |
### Query
| Nome | Tipo | Obrigatório |
|---|---|---|
| `limit` | `number` | não |
| `raffleUUID` | `string` | não |
| `offset` | `number` | não |
### Body
| Nome | Tipo | Obrigatório |
|---|---|---|
| `cpf` | `string` | não |
| `token` | `string` | não |
### Tipos
```ts
type CreateBondParams = { "payment": string; };
type CreateBondQuery = { "limit"?: number; "raffleUUID"?: string; "offset"?: number; };
type CreateBondBody = { "cpf"?: string; "token"?: string; };
type CreateBondResponse = { "groups": Array<{ "raffle": { "uuid": string; }; "totalCount": number; "bonds": Array<{ "luckyNumber": string; }>; "tickets"?: Array<{ "luckyNumber": string; "chances": Array<{ "number": string; "numbers": Array; }>; }>; }>; };
```
### Exemplo
```ts
const response = await sdk.orders.createBond("string", { "cpf": "string", "token": "string" });
```
Testar esta função no playground
## `createCertificate`
POST/orders/:payment/certificates
Assinatura:
```ts
createCertificate(payment: string, body?: CreateCertificateBody, settings?: SdkSettings): Promise
```
### Parâmetros de rota
| Nome | Tipo |
|---|---|
| `payment` | `string` |
### Query
| Nome | Tipo | Obrigatório |
|---|---|---|
| `simplified` | `boolean` | não |
| `includeTickets` | `boolean` | não |
### Body
| Nome | Tipo | Obrigatório |
|---|---|---|
| `confirmationCPF` | `string` | sim |
### Tipos
```ts
type CreateCertificateParams = { "payment": string; };
type CreateCertificateQuery = { "simplified"?: boolean; "includeTickets"?: boolean; };
type CreateCertificateBody = { "confirmationCPF": string; };
type CreateCertificateResponse = { "user": { "name": string; "cpf": string; "city": null | string; "state": null | string; }; "bonds": Array<{ "raffle": string; "luckyNumber": string; "matrixNumbers"?: Array; }>; };
```
### Exemplo
```ts
const response = await sdk.orders.createCertificate("string", { "confirmationCPF": "string" });
```
Testar esta função no playground
## `createOrder`
POST/orders/:payment
Assinatura:
```ts
createOrder(payment: string, body?: CreateOrderBody, settings?: SdkSettings): Promise
```
### Parâmetros de rota
| Nome | Tipo |
|---|---|
| `payment` | `string` |
### Query
| Nome | Tipo | Obrigatório |
|---|---|---|
| `simplified` | `boolean` | não |
| `includeTickets` | `boolean` | não |
### Body
| Nome | Tipo | Obrigatório |
|---|---|---|
| `cpf` | `string` | não |
| `token` | `string` | não |
### Tipos
```ts
type CreateOrderParams = { "payment": string; };
type CreateOrderQuery = { "simplified"?: boolean; "includeTickets"?: boolean; };
type CreateOrderBody = { "cpf"?: string; "token"?: string; };
type CreateOrderResponse = { "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; "unlockedOffers"?: Array; "bonds"?: { "count": number; }; "data": { "involvedRaffles"?: Record; "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; }>; };
```
### Exemplo
```ts
const response = await sdk.orders.createOrder("string", { "cpf": "string", "token": "string" });
```
Testar esta função no playground
## `createRegistrationPending`
POST/orders/:payment/registration/pending
Assinatura:
```ts
createRegistrationPending(payment: string, body?: CreateRegistrationPendingBody, settings?: SdkSettings): Promise
```
### Parâmetros de rota
| Nome | Tipo |
|---|---|
| `payment` | `string` |
### Body
| Nome | Tipo | Obrigatório |
|---|---|---|
| `cpf` | `string` | sim |
### Tipos
```ts
type CreateRegistrationPendingParams = { "payment": string; };
type CreateRegistrationPendingBody = { "cpf": string; };
type CreateRegistrationPendingResponse = { "form": { [key: string]: unknown; } | null; };
```
### Exemplo
```ts
const response = await sdk.orders.createRegistrationPending("string", { "cpf": "string" });
```
Testar esta função no playground
## `getBonds`
GET/orders/:payment/bonds
Assinatura:
```ts
getBonds(payment: string, query?: GetBondsQuery, settings?: SdkSettings): Promise
```
### Parâmetros de rota
| Nome | Tipo |
|---|---|
| `payment` | `string` |
### Query
| Nome | Tipo | Obrigatório |
|---|---|---|
| `limit` | `number` | não |
| `raffleUUID` | `string` | não |
| `offset` | `number` | não |
### Tipos
```ts
type GetBondsParams = { "payment": string; };
type GetBondsQuery = { "limit"?: number; "raffleUUID"?: string; "offset"?: number; };
type GetBondsResponse = { "groups": Array<{ "raffle": { "uuid": string; }; "totalCount": number; "bonds": Array<{ "luckyNumber": string; }>; "tickets"?: Array<{ "luckyNumber": string; "chances": Array<{ "number": string; "numbers": Array; }>; }>; }>; };
```
### Exemplo
```ts
const response = await sdk.orders.getBonds("string");
```
Testar esta função no playground
## `getOrder`
GET/orders/:payment
Assinatura:
```ts
getOrder(payment: string, query?: GetOrderQuery, settings?: SdkSettings): Promise
```
### Parâmetros de rota
| Nome | Tipo |
|---|---|
| `payment` | `string` |
### Query
| Nome | Tipo | Obrigatório |
|---|---|---|
| `simplified` | `boolean` | não |
| `includeTickets` | `boolean` | não |
### Tipos
```ts
type GetOrderParams = { "payment": string; };
type GetOrderQuery = { "simplified"?: boolean; "includeTickets"?: boolean; };
type GetOrderResponse = { "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; "unlockedOffers"?: Array; "bonds"?: { "count": number; }; "data": { "involvedRaffles"?: Record; "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; }>; };
```
### Exemplo
```ts
const response = await sdk.orders.getOrder("string");
```
Testar esta função no playground