ToffeePay

https://docs.toffeepay.com
Admin
ToffeePay is a payment processing platform and wallet solution for games that enables developers to...
Tokens:62,215
Snippets:388
Trust Score:5.9
Update:4 weeks ago
Show doc for...
Tokens:
Raw
### Install

Source: https://docs.toffeepay.com/sdks/go

Install the ToffeePay Go SDK using go get.

```APIDOC
## Install

```bash
go get github.com/toffeepay/sdk-go
```
```

--------------------------------

### Install Go SDK

Source: https://docs.toffeepay.com/sdks/go

Use the go get command to install the ToffeePay SDK for Go.

```bash
go get github.com/toffeepay/sdk-go
```

--------------------------------

### Setup Go SDK

Source: https://docs.toffeepay.com/getting-started

Install the Go SDK and initialize the Toffee client with an access token and sandbox environment. Omit the environment option for production.

```bash
go get github.com/toffeepay/sdk-go
```

```go
import sdk "github.com/toffeepay/sdk-go"

toffee := sdk.New(sdk.Config{
  AccessToken: "your-access-token",
  Environment: sdk.Sandbox, // omit for production
})
```

--------------------------------

### Setup Python SDK

Source: https://docs.toffeepay.com/getting-started

Install the Python SDK and initialize the Toffee client with an access token and sandbox environment. Omit the environment option for production.

```bash
pip install toffeepay-sdk
```

```python
from toffeepay import Toffee

toffee = Toffee(
    access_token="your-access-token",
    environment="sandbox",  # omit for production
)
```

--------------------------------

### Setup TypeScript SDK

Source: https://docs.toffeepay.com/getting-started

Install the TypeScript SDK and initialize the Toffee client with an access token and sandbox environment. Omit the environment option for production.

```bash
npm install @toffeepay/sdk
```

```typescript
import { Toffee } from "@toffeepay/sdk";

const toffee = new Toffee({
  accessToken: "your-access-token",
  environment: "sandbox", // omit for production
});
```

--------------------------------

### Installation

Source: https://docs.toffeepay.com/sdks/python

Install the ToffeePay SDK via pip.

```APIDOC
## Install

```bash
pip install toffeepay-sdk
```
```

--------------------------------

### Install ToffeePay SDK with pip

Source: https://docs.toffeepay.com/sdks/python

Install the ToffeePay Python SDK using pip.

```bash
pip install toffeepay-sdk
```

--------------------------------

### Get Account Response JSON

Source: https://docs.toffeepay.com/wallet

Example JSON response for the Get Account endpoint. Shows the account object with id, users array, currency, and balance split into real and bonus amounts.

```json
{
  "id": "acc_xyz123",
  "users": [
    { "game_id": "space_shooter", "user_id": "player_42" }
  ],
  "currency": "USD",
  "balance": {
    "real": 2499,
    "bonus": 500
  }
}
```

--------------------------------

### Install @toffeepay/sdk

Source: https://docs.toffeepay.com/sdks/typescript

Install the ToffeePay TypeScript SDK via npm.

```bash
npm install @toffeepay/sdk
```

--------------------------------

### Get Session (Full Details) - Response

Source: https://docs.toffeepay.com/payments

Example JSON response for the Get Session endpoint, showing a paid session with full details including item, tax, and timestamps.

```json
{
  "id": "sess_abc123",
  "url": "https://pay.toffeepay.com/sess_abc123",
  "status": "paid",
  "user_id": "player_42",
  "game_id": "space_shooter",
  "item": {
    "title": "50 Gold Coins",
    "price": 499,
    "currency": "USD"
  },
  "tax": {
    "amount": 50
  },
  "created_at": "2023-06-01T12:00:00Z",
  "paid_at": "2023-06-01T12:05:00Z"
}
```

--------------------------------

### Get Payment Details - JSON Response

Source: https://docs.toffeepay.com/payments

Example JSON response for the get payment operation, showing payment details including status, amount, and extra_data.

```json
{
  "id": "pay_xyz789",
  "session_id": "sess_abc123",
  "status": "succeeded",
  "amount": 499,
  "currency": "USD",
  "method": "apple_pay",
  "details": "50 Gold Coins",
  "created_at": "2023-06-01T12:05:00Z",
  "succeeded_at": "2023-06-01T12:05:30Z",
  "extra_data": {
    "real_amount": 499
  }
}
```

--------------------------------

### Tax Example - JSON

Source: https://docs.toffeepay.com/payments

Example of a tax object in a session response for a $4.99 item with $0.50 tax. The `amount` field is in cents. The customer is charged the total amount (item price + tax).

```json
{
  "item": {
    "price": 499,
    "currency": "USD"
  },
  "tax": {
    "amount": 50
  }
}
```

--------------------------------

### Return URL deep link example

Source: https://docs.toffeepay.com/getting-started

Example of a custom deep link used as the return_url after a successful payment. The player is redirected to this URI, and the mobile client must be set up to handle and parse this scheme.

```json
"return_url": "mygame://payment-complete"
```

--------------------------------

### Get Session Status (Status Only) - Response

Source: https://docs.toffeepay.com/payments

Example JSON response for the Get Session Status endpoint, showing a paid session with only the id and status fields.

```json
{
  "id": "sess_abc123",
  "status": "paid"
}
```

--------------------------------

### Image URL Format Example

Source: https://docs.toffeepay.com/payments

Shows the alternative format for providing an item image via a direct URL. Use this when the image is hosted externally.

```text
https://yourgame.com/images/gold-coins.png
```

--------------------------------

### Use different idempotency keys per operation

Source: https://docs.toffeepay.com/idempotency

TypeScript example showing good practice of using distinct keys for different operations, and a bad example of reusing the same key.

```typescript
// Good: Different keys for different operations
const sessionKey = `session-${userId}-${itemId}-${Date.now()}`;
const refundKey = `refund-${paymentId}-${Date.now()}`;

// Bad: Reusing the same key across different operations
const key = "my-operation-key"; // Don't do this
```

--------------------------------

### Account resource methods

Source: https://docs.toffeepay.com/sdks/typescript

Account resource methods: get and list.

```typescript
const { account } = await toffee.accounts.get({ id: "acc_123" });
const { accounts } = await toffee.accounts.list({ gameId: "game_1" });
```

--------------------------------

### Create a payment session with the Toffee SDK (Go)

Source: https://docs.toffeepay.com/payments

Use the Go SDK to create a payment session. The example uses sdk.CreateSessionRequest and sdk.Item structs, with camelCase field names. The response is obtained via resp.GetSession().

```go
resp, err := toffee.Sessions.Create(ctx, &sdk.CreateSessionRequest{
  GameId: "space_shooter",
  UserId: "player_42",
  Item: &sdk.Item{
    Title:    "50 Gold Coins",
    Price:    499,
    Currency: "USD",
    Image:    "data:image/png;base64,...",
  },
  ReturnUrl:     "mygame://payment-complete",
  WalletEnabled: true,
})
session := resp.GetSession()
```

--------------------------------

### Deposit resource methods

Source: https://docs.toffeepay.com/sdks/typescript

Deposit resource methods: get and list.

```typescript
const { deposit } = await toffee.deposits.get({ id: "dep_123" });
const { deposits } = await toffee.deposits.list({ gameId: "game_1" });
```

--------------------------------

### Refund resource methods

Source: https://docs.toffeepay.com/sdks/typescript

Refund resource methods: create, get, and list.

```typescript
const { refund } = await toffee.refunds.create({ paymentId: "pay_123" });
const { refund } = await toffee.refunds.get({ id: "ref_123" });
const { refunds } = await toffee.refunds.list({ paymentId: "pay_123" });
```

--------------------------------

### Payment session response (JSON)

Source: https://docs.toffeepay.com/payments

Example response from creating a payment session. Contains the session ID, payment URL, status, user and game IDs, item details, and creation timestamp.

```json
{
  "id": "sess_abc123",
  "url": "https://pay.toffeepay.com/sess_abc123",
  "status": "pending",
  "user_id": "player_42",
  "game_id": "space_shooter",
  "item": {
    "title": "50 Gold Coins",
    "price": 499,
    "currency": "USD"
  },
  "created_at": "2023-06-01T12:00:00Z"
}
```

--------------------------------

### Create a payment session with the Toffee SDK (Python)

Source: https://docs.toffeepay.com/payments

Use the Python SDK to create a payment session. The example uses CreateSessionRequest and Item objects, with snake_case parameter names. The response is accessed via resp.session.

```python
resp = await toffee.sessions.create(CreateSessionRequest(
    game_id="space_shooter",
    user_id="player_42",
    item=Item(
        title="50 Gold Coins",
        price=499,
        currency="USD",
        image="data:image/png;base64,...",
    ),
    return_url="mygame://payment-complete",
    wallet_enabled=True,
))
session = resp.session
```

--------------------------------

### Session resource methods

Source: https://docs.toffeepay.com/sdks/typescript

Session resource methods: create, get, status, list, and cancel.

```typescript
const { session } = await toffee.sessions.create({ ... });
const { session } = await toffee.sessions.get({ id: "sess_123" });
const { status }  = await toffee.sessions.status({ id: "sess_123" });
const { sessions } = await toffee.sessions.list({ gameId: "game_1" });
await toffee.sessions.cancel({ id: "sess_123" });
```

--------------------------------

### Get Payment Details - REST API

Source: https://docs.toffeepay.com/payments

Sends a GET request to the ToffeePay REST API to retrieve a payment by ID. The 'with_extra_data' query parameter includes additional data in the response.

```http
GET /v1/payments/pay_xyz789?with_extra_data=true
Authorization: Bearer <your_access_token>
```

--------------------------------

### Base64 Image Format Example

Source: https://docs.toffeepay.com/payments

Shows the required format for embedding an image as a Base64 string with a MIME prefix. Use this when providing item images directly in the request payload.

```text
data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...
```

--------------------------------

### Create a payment session with the Toffee SDK (TypeScript)

Source: https://docs.toffeepay.com/payments

Use the TypeScript SDK to create a payment session. The example sets gameId, userId, item details, returnUrl, and walletEnabled. The response contains the session object with the payment URL.

```typescript
const { session } = await toffee.sessions.create({
  gameId: "space_shooter",
  userId: "player_42",
  item: {
    title: "50 Gold Coins",
    price: 499,
    currency: "USD",
    image: "data:image/png;base64,...",
  },
  returnUrl: "mygame://payment-complete",
  walletEnabled: true,
});
```

--------------------------------

### List Disputes - TypeScript

Source: https://docs.toffeepay.com/disputes

Server-side TypeScript example using the ToffeePay SDK to list disputes, filtering by payment ID and limiting results.

```typescript
const { disputes } = await toffee.disputes.list({
  paymentId: "pay_xyz789",
  limit: 50,
});
```

--------------------------------

### Get Session (Full Details) - Python

Source: https://docs.toffeepay.com/payments

Use this to fetch full session details in Python. The response includes the session object with fields like id, url, status, user_id, game_id, item, tax, and timestamps.

```python
resp = await toffee.sessions.get(GetSessionRequest(id="sess_abc123"))
session = resp.session
```

--------------------------------

### GET /v1/accounts

Source: https://docs.toffeepay.com/api-reference/accounts/list

Lists accounts. Requires a game_id query parameter. Returns an array of account objects with id, users, currency, and balance.

```APIDOC
## GET /v1/accounts

### Description
List accounts

### Method
GET

### Endpoint
/v1/accounts

### Parameters
#### Query Parameters
- **game_id** (string) - Required - The game identifier to filter accounts.
- **user_id** (string) - Optional - The user identifier to filter accounts.
- **limit** (integer, int32) - Optional - Maximum number of accounts to return. Default: 100. Maximum: 250. Must be greater than 0.
- **offset** (integer, int32) - Optional - Number of accounts to skip. Minimum: 0.
- **from** (string, date-time) - Optional - Start date for filtering accounts.
- **to** (string, date-time) - Optional - End date for filtering accounts.

### Response
#### Success Response (200)
Returns an array of account objects. Each account has the following properties:
- **id** (string) - Required - Account identifier.
- **users** (array of GameUser) - Optional - All game users linked to this account. Each GameUser has:
  - **game_id** (string) - Required - Game identifier.
  - **user_id** (string) - Required - User identifier.
- **currency** (string) - Required - Currency of the account. Enum: USD, GBP, EUR.
- **balance** (Balance) - Required - Balance details. Contains:
  - **real** (integer, int32) - Optional - Real balance. Minimum: 0.
  - **bonus** (integer, int32) - Optional - Bonus balance. Minimum: 0.

#### Response Example
```json
[
  {
    "id": "string",
    "users": [
      {
        "game_id": "string",
        "user_id": "string"
      }
    ],
    "currency": "USD",
    "balance": {
      "real": 0,
      "bonus": 0
    }
  }
]
```

### Authentication
Bearer token (JWT) required.
```

--------------------------------

### Get Session (Full Details) - Go

Source: https://docs.toffeepay.com/payments

Use this to fetch full session details in Go. The response includes the session object with fields like id, url, status, user_id, game_id, item, tax, and timestamps.

```go
resp, err := toffee.Sessions.Get(ctx, &sdk.GetSessionRequest{Id: "sess_abc123"})
session := resp.GetSession()
```

--------------------------------

### Configure SDK

Source: https://docs.toffeepay.com/sdks/go

Initialize the SDK client with your access token.

```go
import sdk "github.com/toffeepay/sdk-go"

toffee := sdk.New(sdk.Config{
    AccessToken: "your-access-token",
})
```

--------------------------------

### List Sessions - JSON Response

Source: https://docs.toffeepay.com/payments

Example JSON response for the list sessions operation, showing an array of session objects with item and tax details.

```json
[
  {
    "id": "sess_abc123",
    "status": "paid",
    "user_id": "player_42",
    "game_id": "space_shooter",
    "item": {
      "title": "50 Gold Coins",
      "price": 499,
      "currency": "USD"
    },
    "tax": {
      "amount": 50
    },
    "created_at": "2023-06-01T12:00:00Z",
    "paid_at": "2023-06-01T12:05:00Z"
  }
]
```

--------------------------------

### List Sessions - REST API

Source: https://docs.toffeepay.com/payments

Sends a GET request to the ToffeePay REST API to list sessions with query parameters for game, user, and date range.

```http
GET /v1/sessions?game_id=space_shooter&user_id=player_42&status=paid&limit=50&offset=0
Authorization: Bearer <your_access_token>
```

--------------------------------

### GET /v1/sessions

Source: https://docs.toffeepay.com/payments

Retrieves a list of historical sessions for audit and analytics purposes. Supports filtering by game, user, status, and date range.

```APIDOC
## GET /v1/sessions

### Description
Retrieves a list of historical sessions for audit and analytics purposes. Supports filtering by game, user, status, and date range.

### Method
GET

### Endpoint
/v1/sessions

### Parameters
#### Query Parameters
- **game_id** (string) - Optional - The game identifier to filter sessions.
- **user_id** (string) - Optional - The user identifier to filter sessions.
- **status** (string) - Optional - The session status (e.g., "paid").
- **limit** (integer) - Optional - Maximum number of sessions to return.
- **offset** (integer) - Optional - Number of sessions to skip.
- **from** (string) - Optional - Start date in RFC 3339 format to filter sessions created after this timestamp.
- **to** (string) - Optional - End date in RFC 3339 format to filter sessions created before this timestamp.

### Request Example
```http
GET /v1/sessions?game_id=space_shooter&user_id=player_42&status=paid&limit=50&offset=0
Authorization: Bearer <your_access_token>
```

### Response
#### Success Response (200)
An array of session objects, each containing:
- **id** (string) - The session ID.
- **status** (string) - The session status.
- **user_id** (string) - The user ID.
- **game_id** (string) - The game ID.
- **item** (object) - The purchased item details.
  - **title** (string) - Item title.
  - **price** (number) - Item price.
  - **currency** (string) - Currency code.
- **tax** (object) - Tax details.
  - **amount** (number) - Tax amount.
- **created_at** (string) - Creation timestamp.
- **paid_at** (string) - Payment timestamp.

#### Response Example
```json
[
  {
    "id": "sess_abc123",
    "status": "paid",
    "user_id": "player_42",
    "game_id": "space_shooter",
    "item": {
      "title": "50 Gold Coins",
      "price": 499,
      "currency": "USD"
    },
    "tax": {
      "amount": 50
    },
    "created_at": "2023-06-01T12:00:00Z",
    "paid_at": "2023-06-01T12:05:00Z"
  }
]
```

### Filtering by Date
You can use the `from` and `to` parameters (in RFC 3339 format) to retrieve records created within a specific timeframe. This works identically across both Sessions and Payments.

#### Request Example with Date Filter
```http
GET /v1/sessions?game_id=space_shooter&from=2024-05-01T00:00:00Z&to=2024-05-31T23:59:59Z
Authorization: Bearer <your_access_token>
```
```

--------------------------------

### Configure Sandbox Environment

Source: https://docs.toffeepay.com/sdks/go

Initialize the SDK client for the sandbox environment using a sandbox token.

```go
toffee := sdk.New(sdk.Config{
    AccessToken: "your-sandbox-token",
    Environment: sdk.Sandbox,
})
```

--------------------------------

### List Payments - Response

Source: https://docs.toffeepay.com/payments

Example response for a successful list payments request. The response is an array of payment objects, each containing payment details such as `id`, `status`, `amount`, `currency`, and `extra_data`.

```json
[
  {
    "id": "pay_xyz789",
    "session_id": "sess_abc123",
    "status": "succeeded",
    "amount": 499,
    "currency": "USD",
    "method": "apple_pay",
    "details": "50 Gold Coins",
    "created_at": "2023-06-01T12:05:00Z",
    "succeeded_at": "2023-06-01T12:05:30Z",
    "extra_data": {
      "real_amount": 499
    }
  }
]
```

--------------------------------

### GET /v1/sessions/{id}/status

Source: https://docs.toffeepay.com/payments

Retrieves only the session ID and status. Use this endpoint when you only need to check the payment status without full details.

```APIDOC
## [GET] /v1/sessions/{id}/status

### Description
Retrieves only the session ID and status. Use this endpoint when you only need to check the payment status without full details.

### Method
GET

### Endpoint
/v1/sessions/{id}/status

### Parameters
#### Path Parameters
- **id** (string) - Required - The session ID (e.g., "sess_abc123").

### Request Example
```http
GET /v1/sessions/sess_abc123/status
Authorization: Bearer <your_access_token>
```

### Response
#### Success Response (200)
- **id** (string) - Session ID.
- **status** (string) - Session status (e.g., "paid").

#### Response Example
```json
{
  "id": "sess_abc123",
  "status": "paid"
}
```

### Status Handling
- If `status` is `paid`, grant the items and show success.
- If `status` is `pending`, show a waiting screen.
- If `status` is `failed`, `cancelled` or `expired`, inform the user and offer to retry.
```

--------------------------------

### Webhook sample payload

Source: https://docs.toffeepay.com/payments

Example JSON payload sent by ToffeePay when a payment is completed. The payload includes the event type, timestamp, and a data object containing the payment details.

```json
{
  "type": "payment.succeeded",
  "timestamp": "2023-06-01T12:05:00Z",
  "data": {
    // Payment object
  }
}
```

--------------------------------

### Get Account by ID (TypeScript, Python, Go, API)

Source: https://docs.toffeepay.com/wallet

Retrieve account details by ID using the Toffee Wallet SDK. The TypeScript, Python, and Go examples call the accounts.get method with an account ID, while the API example shows the corresponding HTTP GET request. The response includes the account's balance split into real and bonus funds.

```typescript
const { account } = await toffee.accounts.get({ id: "acc_xyz123" });
```

```python
resp = await toffee.accounts.get(GetAccountRequest(id="acc_xyz123"))
account = resp.account
```

```go
resp, err := toffee.Accounts.Get(ctx, &sdk.GetAccountRequest{Id: "acc_xyz123"})
account := resp.GetAccount()
```

```http
GET /v1/accounts/acc_xyz123
Authorization: Bearer <your_access_token>
```

--------------------------------

### Get Session Status (Status Only) - Go

Source: https://docs.toffeepay.com/payments

Use this to fetch only the session status in Go. The response includes the status field, which can be 'paid', 'pending', 'failed', 'cancelled', or 'expired'.

```go
resp, err := toffee.Sessions.Status(ctx, &sdk.GetSessionStatusRequest{Id: "sess_abc123"})
status := resp.GetStatus()
```

--------------------------------

### Get Payment Details - Python

Source: https://docs.toffeepay.com/payments

Retrieves a payment by its ID using the ToffeePay Python SDK. The response contains the payment object with fields like status, amount, and extra_data.

```python
resp = await toffee.payments.get(GetPaymentRequest(id="pay_xyz789"))
payment = resp.payment
```

--------------------------------

### Confirm payment status with toffee.sessions.status

Source: https://docs.toffeepay.com/getting-started

Code examples for confirming payment status after returning to the game. The TypeScript, Python, and Go SDKs use the toffee.sessions.status method, while the API example uses a GET request to /v1/sessions/sess_123/status with an Authorization header. All examples check if the status is "paid" before granting items.

```typescript
const status = await toffee.sessions.status({ id: "sess_123" });

if (status.status === "paid") {
  // Grant items
}
```

```python
resp = await toffee.sessions.status(GetSessionStatusRequest(id="sess_123"))

if resp.status == "paid":
    # Grant items
```

```go
resp, err := toffee.Sessions.Status(ctx, &sdk.GetSessionStatusRequest{Id: "sess_123"})

if resp.GetStatus() == "paid" {
  // Grant items
}
```

```http
GET /v1/sessions/sess_123/status
Authorization: Bearer <your_access_token>
```

--------------------------------

### GET /v1/sessions/{id}

Source: https://docs.toffeepay.com/payments

Retrieves full session details including payment status, user, game, item, tax, and timestamps. Use this endpoint when you need complete information about a session.

```APIDOC
## [GET] /v1/sessions/{id}

### Description
Retrieves full session details including payment status, user, game, item, tax, and timestamps.

### Method
GET

### Endpoint
/v1/sessions/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The session ID (e.g., "sess_abc123").

### Request Example
```http
GET /v1/sessions/sess_abc123
Authorization: Bearer <your_access_token>
```

### Response
#### Success Response (200)
- **id** (string) - Session ID.
- **url** (string) - Payment URL.
- **status** (string) - Session status (e.g., "paid").
- **user_id** (string) - User identifier.
- **game_id** (string) - Game identifier.
- **item** (object) - Item details.
  - **title** (string) - Item title.
  - **price** (number) - Price in minor units.
  - **currency** (string) - Currency code.
- **tax** (object) - Tax details.
  - **amount** (number) - Tax amount.
- **created_at** (string) - Creation timestamp.
- **paid_at** (string) - Payment timestamp.

#### Response Example
```json
{
  "id": "sess_abc123",
  "url": "https://pay.toffeepay.com/sess_abc123",
  "status": "paid",
  "user_id": "player_42",
  "game_id": "space_shooter",
  "item": {
    "title": "50 Gold Coins",
    "price": 499,
    "currency": "USD"
  },
  "tax": {
    "amount": 50
  },
  "created_at": "2023-06-01T12:00:00Z",
  "paid_at": "2023-06-01T12:05:00Z"
}
```
```

--------------------------------

### Get Payment Details - Go

Source: https://docs.toffeepay.com/payments

Retrieves a payment by its ID using the ToffeePay Go SDK. The response contains the payment object with fields like status, amount, and extra_data.

```go
resp, err := toffee.Payments.Get(ctx, &sdk.GetPaymentRequest{Id: "pay_xyz789"})
payment := resp.GetPayment()
```

--------------------------------

### Get Session Status (Status Only) - Python

Source: https://docs.toffeepay.com/payments

Use this to fetch only the session status in Python. The response includes the status field, which can be 'paid', 'pending', 'failed', 'cancelled', or 'expired'.

```python
resp = await toffee.sessions.status(GetSessionStatusRequest(id="sess_abc123"))
status = resp.status
```

--------------------------------

### Get Session (Full Details) - API

Source: https://docs.toffeepay.com/payments

Use this HTTP request to fetch full session details. The response includes the session object with fields like id, url, status, user_id, game_id, item, tax, and timestamps.

```http
GET /v1/sessions/sess_abc123
Authorization: Bearer <your_access_token>
```

--------------------------------

### GET /v1/payments/{id}

Source: https://docs.toffeepay.com/payments

Retrieves details of a specific payment by its unique identifier. This endpoint returns comprehensive payment information including status, amount, currency, and timestamps.

```APIDOC
## GET /v1/payments/{id}

### Description
Retrieves details of a specific payment by its unique identifier. This endpoint returns comprehensive payment information including status, amount, currency, and timestamps.

### Method
GET

### Endpoint
/v1/payments/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the payment (e.g., "pay_xyz789").

#### Query Parameters
- **with_extra_data** (boolean) - Optional - If true, includes additional data in the response.

### Request Example
```http
GET /v1/payments/pay_xyz789?with_extra_data=true
Authorization: Bearer <your_access_token>
```

### Response
#### Success Response (200)
- **id** (string) - The payment ID.
- **session_id** (string) - The associated session ID.
- **status** (string) - The payment status (e.g., "succeeded").
- **amount** (number) - The payment amount.
- **currency** (string) - The currency code (e.g., "USD").
- **method** (string) - The payment method (e.g., "apple_pay").
- **details** (string) - Description of the payment.
- **created_at** (string) - Timestamp when the payment was created.
- **succeeded_at** (string) - Timestamp when the payment succeeded.
- **extra_data** (object) - Additional data if requested.

#### Response Example
```json
{
  "id": "pay_xyz789",
  "session_id": "sess_abc123",
  "status": "succeeded",
  "amount": 499,
  "currency": "USD",
  "method": "apple_pay",
  "details": "50 Gold Coins",
  "created_at": "2023-06-01T12:05:00Z",
  "succeeded_at": "2023-06-01T12:05:30Z",
  "extra_data": {
    "real_amount": 499
  }
}
```
```

--------------------------------

### Expose Local Server with ngrok for Webhook Testing

Source: https://docs.toffeepay.com/sandbox

Command to start ngrok and create a public URL forwarding to local port 3000, used for receiving sandbox webhooks.

```bash
ngrok http 3000
```

--------------------------------

### Filter Sessions by Date - REST API

Source: https://docs.toffeepay.com/payments

Sends a GET request to the ToffeePay REST API to list sessions within a date range using query parameters.

```http
GET /v1/sessions?game_id=space_shooter&from=2024-05-01T00:00:00Z&to=2024-05-31T23:59:59Z
Authorization: Bearer <your_access_token>
```

--------------------------------

### Get Session (Full Details) - TypeScript

Source: https://docs.toffeepay.com/payments

Use this to fetch full session details in TypeScript. The response includes the session object with fields like id, url, status, user_id, game_id, item, tax, and timestamps.

```typescript
const { session } = await toffee.sessions.get({ id: "sess_abc123" });
```

--------------------------------

### Get Session Status (Status Only) - TypeScript

Source: https://docs.toffeepay.com/payments

Use this to fetch only the session status in TypeScript. The response includes the status field, which can be 'paid', 'pending', 'failed', 'cancelled', or 'expired'.

```typescript
const { status } = await toffee.sessions.status({ id: "sess_abc123" });
```

--------------------------------

### Configuration

Source: https://docs.toffeepay.com/sdks/go

Initialize the ToffeePay SDK client with an access token and optional environment.

```APIDOC
## Configuration

### Production
```go
import sdk "github.com/toffeepay/sdk-go"

toffee := sdk.New(sdk.Config{
    AccessToken: "your-access-token",
})
```

### Sandbox
```go
toffee := sdk.New(sdk.Config{
    AccessToken: "your-sandbox-token",
    Environment: sdk.Sandbox,
})
```
```
Tokens:
Raw