---
title: "Pagamentos"
description: "Métodos de pagamento, histórico e rastreio."
---
paymentsnamespace
Métodos de pagamento, histórico e rastreio.
7métodos
paymentsnamespace
> Esta página é gerada automaticamente pelo `@luckymaker/sdk-generator`. Não edite manualmente.
## `addMethod`
POST/user/payment-method/add
Assinatura:
```ts
addMethod(body?: AddMethodBody, settings?: SdkSettings): Promise
```
### Body
| Nome | Tipo | Obrigatório |
|---|---|---|
| `captcha` | `string` | sim |
| `token` | `string` | sim |
### Tipos
```ts
type AddMethodBody = { "captcha": string; "token": string; };
type AddMethodResponse = null;
```
### Exemplo
```ts
const response = await sdk.payments.addMethod({ "captcha": "string", "token": "string" });
```
Testar esta função no playground
## `confirmMethod`
POST/user/payment-method/confirm
Assinatura:
```ts
confirmMethod(body?: ConfirmMethodBody, settings?: SdkSettings): Promise
```
### Body
| Nome | Tipo | Obrigatório |
|---|---|---|
| `captcha` | `string` | sim |
| `sessionId` | `string` | sim |
### Tipos
```ts
type ConfirmMethodBody = { "captcha": string; "sessionId": string; };
type ConfirmMethodResponse = { "cards": Array<{ "id": string; "lastDigits": string; "network": string; }>; };
```
### Exemplo
```ts
const response = await sdk.payments.confirmMethod({ "captcha": "string", "sessionId": "string" });
```
Testar esta função no playground
## `createMethodSession`
POST/user/payment-method/session
Assinatura:
```ts
createMethodSession(settings?: SdkSettings): Promise
```
### Tipos
```ts
type CreateMethodSessionResponse = { "sessionId": string; "uuid": string; "endpoint": string; };
```
### Exemplo
```ts
const response = await sdk.payments.createMethodSession();
```
Testar esta função no playground
## `deleteMethod`
DELETE/user/payment-method/:cardId
Assinatura:
```ts
deleteMethod(cardId: string, settings?: SdkSettings): Promise
```
### Parâmetros de rota
| Nome | Tipo |
|---|---|
| `cardId` | `string` |
### Tipos
```ts
type DeleteMethodParams = { "cardId": string; };
type DeleteMethodResponse = null;
```
### Exemplo
```ts
const response = await sdk.payments.deleteMethod("string");
```
Testar esta função no playground
## `getShipping`
GET/user/payments/:uuid/shipping
Assinatura:
```ts
getShipping(uuid: string, settings?: SdkSettings): Promise
```
### Parâmetros de rota
| Nome | Tipo |
|---|---|
| `uuid` | `string` |
### Tipos
```ts
type GetShippingParams = { "uuid": string; };
type GetShippingResponse = { "shipping": { "id": string; "paymentId": number; "shippingPrice": number; "provider": string; "providerServiceName": string | null; "status": "WAITING" | "LABEL_GENERATED" | "SHIPPED" | "EN_ROUTE" | "OUT_FOR_DELIVERY" | "DELIVERED" | "RETURNED" | "CANCELLED" | "EXPIRED" | "PAUSED" | "SUSPENDED"; "trackingCode": string | null; "labelUrl": string | null; "estimatedDeliveryDays": number | null; "logs": Array<{ "id": string; "type": "WAITING" | "LABEL_GENERATED" | "SHIPPED" | "EN_ROUTE" | "OUT_FOR_DELIVERY" | "DELIVERED" | "RETURNED" | "CANCELLED" | "EXPIRED" | "PAUSED" | "SUSPENDED"; "message": string; "createdAt": string; }>; "createdAt": string; "updatedAt": string; } | null; };
```
### Exemplo
```ts
const response = await sdk.payments.getShipping("string");
```
Testar esta função no playground
## `listHistory`
GET/user/payments
Assinatura:
```ts
listHistory(query?: ListHistoryQuery, settings?: SdkSettings): Promise
```
### Query
| Nome | Tipo | Obrigatório |
|---|---|---|
| `page` | `number` | não |
### Tipos
```ts
type ListHistoryQuery = { "page"?: number; };
type ListHistoryResponse = Array<{ "id": number; "uuid": string; "value": 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"; "createdAt": string; }>;
```
### Exemplo
```ts
const response = await sdk.payments.listHistory();
```
Testar esta função no playground
## `listMethods`
GET/user/payment-methods
Assinatura:
```ts
listMethods(settings?: SdkSettings): Promise
```
### Tipos
```ts
type ListMethodsResponse = Array<{ "type": "PICPAY" | "PIX" | "CREDITS" | "POINTS" | "DIGITAL_WALLET"; "disabled"?: boolean; "rules"?: Array<{ "type": "condition"; "condition": Array; "message"?: string; "hideIfNotMet"?: boolean; }>; } | { "type": "CARD"; "id": string; "expiration"?: string; "lastDigits": string; "issuer": string; "bankName"?: string; "securityCode"?: { "length": number; }; "rules"?: Array<{ "type": "condition"; "condition": Array; "message"?: string; "hideIfNotMet"?: boolean; }>; }>;
```
### Exemplo
```ts
const response = await sdk.payments.listMethods();
```
Testar esta função no playground