### Get Setup Guide - Smart Fields

Source: https://docs.dlocal.com/docs/manage-funds-platforms

This endpoint provides the setup guide for Smart Fields.

```APIDOC
## GET /api/smart-fields/setup

### Description
Provides the setup guide for the Smart Fields feature.

### Method
GET

### Endpoint
/api/smart-fields/setup

### Parameters

#### Query Parameters
(No query parameters defined)

#### Request Body
(No request body)

### Request Example
(No request example provided)

### Response
#### Success Response (200)
- **guide** (string) - Contains the setup instructions for Smart Fields.

#### Response Example
```json
{
  "guide": "" 
}
```
```

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

### Smart Fields Setup Guide

Source: https://docs.dlocal.com/docs/africa-payouts

Guides on how to set up and configure smart fields for dLocal LLM text processing.

```APIDOC
## GET /api/smart-fields/setup

### Description
Provides a setup guide for the smart fields feature.

### Method
GET

### Endpoint
/api/smart-fields/setup

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **(object)** - Setup instructions for smart fields.

#### Response Example
```json
{}
```
```

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

### Get Examples - Smart Fields

Source: https://docs.dlocal.com/docs/manage-funds-platforms

This endpoint retrieves examples for Smart Fields functionality.

```APIDOC
## GET /api/smart-fields/examples

### Description
Retrieves examples for the Smart Fields feature.

### Method
GET

### Endpoint
/api/smart-fields/examples

### Parameters

#### Query Parameters
(No query parameters defined)

#### Request Body
(No request body)

### Request Example
(No request example provided)

### Response
#### Success Response (200)
- **data** (object) - Contains example data for Smart Fields.

#### Response Example
```json
{
  "data": {}
}
```
```

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

### API Reference - Get Request Example

Source: https://docs.dlocal.com/docs/payouts-integrations

This snippet demonstrates a GET request example for the dLocal API. It includes a placeholder for the URL and specifies that authentication is required. The 'results' field shows expected JSON responses for success (200) and error (400) cases, both represented as empty objects.

```json
{
  "api": {
    "method": "get",
    "url": "",
    "auth": "required",
    "results": {
      "codes": [
        {
          "name": "",
          "code": "{}",
          "language": "json",
          "status": 200
        },
        {
          "name": "",
          "code": "{}",
          "language": "json",
          "status": 400
        }
      ]
    },
    "params": [],
    "examples": {
      "codes": []
    }
  },
  "title": "API Reference",
  "slug": "api"
}
```

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

### Malaysia API Configuration (JSON)

Source: https://docs.dlocal.com/docs/africa-payins

Configuration for the Malaysia API endpoint. It includes GET method, requires authentication, and provides example JSON responses for success (200) and error (400) statuses. No parameters or examples are defined.

```json
{
  "_id": "61f94a079b4418000fbd3a73",
  "api": {
    "method": "get",
    "url": "",
    "auth": "required",
    "results": {
      "codes": [
        {
          "name": "",
          "code": "{}",
          "language": "json",
          "status": 200
        },
        {
          "name": "",
          "code": "{}",
          "language": "json",
          "status": 400
        }
      ]
    },
    "params": [],
    "examples": {
      "codes": []
    }
  },
  "title": "Malaysia",
  "type": "basic",
  "slug": "malaysia",
  "order": 4,
  "isReference": false,
  "deprecated": false,
  "hidden": false,
  "sync_unique": "",
  "link_url": "",
  "link_external": false,
  "previousSlug": "",
  "createdAt": "2022-02-01T15:03:42.057Z",
  "parentDoc": "65b0158f9b4418000fbd3a74",
  "category": "61f94c5b554fcf0370b53aa0",
  "icon": "",
  "mdx": {},
  "isBodyEmpty": false,
  "children": []
}
```

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

### Vietnam API Configuration (JSON)

Source: https://docs.dlocal.com/docs/africa-payins

Defines the API configuration for Vietnam, including a GET method and mandatory authentication. It provides example JSON responses for successful (200) and error (400) scenarios, but no specific parameters or examples are listed.

```json
{
  "_id": "61f94c2591b18302ca4c55e8",
  "api": {
    "method": "get",
    "url": "",
    "auth": "required",
    "results": {
      "codes": [
        {
          "name": "",
          "code": "{}",
          "language": "json",
          "status": 200
        },
        {
          "name": "",
          "code": "{}",
          "language": "json",
          "status": 400
        }
      ]
    },
    "params": [],
    "examples": {
      "codes": []
    }
  },
  "title": "Vietnam"
}
```

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

### The Installment Object API Details (JSON)

Source: https://docs.dlocal.com/docs/asia-payins

Provides API information for the Installment Object, specifying a GET request method, authentication requirement, and JSON response codes for success (200) and error (400) scenarios. It does not include any request parameters or examples.

```json
{
  "_id": "620141999354d6001ce0bb95",
  "api": {
    "method": "get",
    "url": "",
    "auth": "required",
    "results": {
      "codes": [
        {
          "name": "",
          "code": "{}",
          "language": "json",
          "status": 200
        },
        {
          "name": "",
          "code": "{}",
          "language": "json",
          "status": 400
        }
      ]
    },
    "params": [],
    "examples": {
      "codes": []
    }
  },
  "title": "The Installment Object",
  "type": "basic",
  "slug": "the-installment-object"
}
```

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

### Set Up Guide Smart Fields API

Source: https://docs.dlocal.com/docs/payouts-integrations

Instructions and guidance on how to set up and configure Smart Fields for use.

```APIDOC
## GET /api/smart-fields/setup

### Description
Provides a guide on how to set up Smart Fields.

### Method
GET

### Endpoint
/api/smart-fields/setup

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **guide** (object) - Contains setup instructions for Smart Fields.

#### Response Example
```json
{}
```
```

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

### The Installment Plan Object API Details (JSON)

Source: https://docs.dlocal.com/docs/asia-payins

Details the API for the Installment Plan Object, including a GET method, mandatory authentication, and JSON response codes for success (200) and failure (400). No specific parameters or example codes are provided.

```json
{
  "_id": "62014169588296003acd292c",
  "api": {
    "method": "get",
    "url": "",
    "auth": "required",
    "results": {
      "codes": [
        {
          "name": "",
          "code": "{}",
          "language": "json",
          "status": 200
        },
        {
          "name": "",
          "code": "{}",
          "language": "json",
          "status": 400
        }
      ]
    },
    "params": [],
    "examples": {
      "codes": []
    }
  },
  "title": "The Installment Plan Object",
  "type": "basic",
  "slug": "the-installment-plan-object"
}
```

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

### Onboarding Process API (GET)

Source: https://docs.dlocal.com/docs/africa-payins

Retrieves information about the onboarding process for platforms. It includes API details such as method, authentication requirements, and possible response codes (200 for success, 400 for bad request).

```json
{
  "api": {
    "method": "get",
    "url": "",
    "auth": "required",
    "results": {
      "codes": [
        {
          "name": "",
          "code": "{}",
          "language": "json",
          "status": 200
        },
        {
          "name": "",
          "code": "{}",
          "language": "json",
          "status": 400
        }
      ]
    },
    "params": [],
    "examples": {
      "codes": []
    }
  },
  "title": "Onboarding process",
  "type": "basic"
}
```

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

### Initialize dLocal Smart Fields

Source: https://docs.dlocal.com/docs/set-up-smart-fields

Initialize the dLocal helper and create an instance of Smart Fields by calling the `fields()` method with your API key and desired locale and country configurations. Ensure your API key is kept secure.

```javascript
var dlocal = dlocal('your_API_key');
var fields = dlocal.fields({
            locale: 'en',
            country: 'BR'
        });
```

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

### Vietnam Payouts API Configuration (JSON)

Source: https://docs.dlocal.com/docs/latin-america-payouts

This entry details the API setup for Vietnam payouts, utilizing the GET method with authentication as a requirement. It provides example JSON response codes for successful (200) and failed (400) API calls. The URL and examples are not included.

```json
{
  "api": {
    "method": "get",
    "url": "",
    "auth": "required",
    "results": {
      "codes": [
        {
          "name": "",
          "code": "{}",
          "language": "json",
          "status": 200
        },
        {
          "name": "",
          "code": "{}",
          "language": "json",
          "status": 400
        }
      ]
    },
    "params": [],
    "examples": {
      "codes": []
    }
  },
  "title": "Vietnam",
  "icon": "",
  "type": "basic",
  "slug": "vietnam-payouts",
  "order": 9,
  "isReference": false,
  "deprecated": false,
  "hidden": false,
  "sync_unique": "",
  "link_url": "",
  "link_external": false,
  "previousSlug": "vietnam-1",
  "createdAt": "2022-10-28T16:51:18.536Z",
  "parentDoc": "65b14e4b196093000ffe538e",
  "category": "62cb5e3358f4200027316d15",
  "mdx": {},
  "isBodyEmpty": false,
  "children": []
}
```

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

### GET API Request for United Arab Emirates Payouts

Source: https://docs.dlocal.com/docs/asia-payouts

This snippet details the GET API request setup for United Arab Emirates payouts. It indicates that authentication is mandatory and includes example JSON responses for successful (200) and erroneous (400) outcomes. The request URL and specific parameters are omitted.

```json
{
  "api": {
    "method": "get",
    "url": "",
    "auth": "required",
    "results": {
      "codes": [
        {
          "name": "",
          "code": "{}",
          "language": "json",
          "status": 200
        },
        {
          "name": "",
          "code": "{}",
          "language": "json",
          "status": 400
        }
      ]
    },
    "params": []
  },
  "title": "United Arab Emirates",
  "slug": "united-arab-emirates-payouts"
}
```

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

### Onboarding Status Configuration

Source: https://docs.dlocal.com/docs/africa-payins

Configuration object tracking the completion status of various onboarding steps for the project, including API, appearance, documentation, domain, JWT, logs, and metrics SDK. This helps in monitoring the project setup progress.

```json
{
  "onboarding_completed": {
    "api": true,
    "appearance": true,
    "documentation": true,
    "domain": false,
    "jwt": true,
    "logs": true,
    "metricsSDK": false
  }
}
```

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

### Onboarding Process API

Source: https://docs.dlocal.com/docs/africa-payins

This API handles the onboarding process for platforms, allowing users to onboard accounts and manage KYC information.

```APIDOC
## GET /onboarding-process-platforms

### Description
Retrieves information about the onboarding process for platforms.

### Method
GET

### Endpoint
/onboarding-process-platforms

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **response** (object) - Details of the onboarding process.

#### Response Example
```json
{
  "message": "Onboarding process details retrieved successfully"
}
```
```

```APIDOC
## GET /onboard-user-accounts-platforms

### Description
Onboards user accounts for platforms.

### Method
GET

### Endpoint
/onboard-user-accounts-platforms

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **response** (object) - Confirmation of user account onboarding.

#### Response Example
```json
{
  "message": "User account onboarded successfully"
}
```
```

```APIDOC
## GET /account-status-platforms

### Description
Retrieves the status of user accounts on the platform.

### Method
GET

### Endpoint
/account-status-platforms

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **response** (object) - Account status details.

#### Response Example
```json
{
  "message": "Account status retrieved successfully"
}
```
```

```APIDOC
## GET /kyc-requirement-platforms

### Description
Provides information on KYC requirements for platforms.

### Method
GET

### Endpoint
/kyc-requirement-platforms

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **response** (object) - KYC requirement details.

#### Response Example
```json
{
  "message": "KYC requirements retrieved successfully"
}
```
```

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

### Mali Payouts API Configuration (JSON)

Source: https://docs.dlocal.com/docs/asia-payouts

Details the API setup for Mali payouts, including a GET method, mandatory authentication, and empty parameters. It does not specify any response codes or example data within the provided snippet.

```json
{
  "_id": "687ff7f445cd85cf89c39368",
  "title": "Mali",
  "icon": "",
  "type": "basic",
  "slug": "mali-payouts",
  "mdx": {},
  "category": "62cb5e3358f4200027316d15",
  "order": 7,
  "isReference": false,
  "deprecated": false,
  "api": {
    "method": "get",
    "url": "",
    "auth": "required",
    "params": []
  },
  "hidden": false,
  "sync_unique": "",
  "link_url": "",
  "link_external": false,
  "parentDoc": "65b14dc4a01e2300542f6334",
  "previousSlug": "mali",
  "createdAt": "2025-07-22T20:43:32.585Z",
  "isBodyEmpty": false,
  "children": []
}
```

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

### Configure initial settings

Source: https://docs.dlocal.com/docs/payouts-integrations

Configures the initial settings for dLocal LLM services.

```APIDOC
## GET /api/initial-settings

### Description
Retrieves or configures the initial settings required for dLocal LLM services.

### Method
GET

### Endpoint
/api/initial-settings

### Parameters
#### Query Parameters
- **None**

#### Request Body
- **None**

### Request Example
```http
GET /api/initial-settings
```

### Response
#### Success Response (200)
- **settings** (object) - Contains various configuration parameters for LLM services.

#### Response Example
```json
{
  "settings": {
    "api_key": "your_api_key",
    "model_version": "v1.0"
  }
}
```

#### Error Response (400)
- **error** (string) - Description of the error.

#### Response Example
```json
{
  "error": "Failed to retrieve settings."
}
```
```

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

### Create Installment Plan Request Example

Source: https://docs.dlocal.com/docs/manage-funds-platforms

An example request body for creating an installment plan. It specifies the transaction amount, currency, country, and payer details, including card information.

```shell
{
    "amount": 1000,
    "currency" : "BRL",
    "country": "BR",
    "payment_method_id" : "VD",
    "payment_method_flow" : "DIRECT",
    "payer":{
        "name" : "Thiago Gabriel",
        "email" : "thiago@example.com",
        "document" : "53033315550"
    },
    "card":{
        "hol
```

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

### Uruguay Payouts GET API Example

Source: https://docs.dlocal.com/docs/manage-funds-platforms

This snippet shows an example GET request for Uruguay payouts. It specifies that authentication is required and provides example JSON responses for successful (200) and error (400) scenarios. The API URL is currently empty, indicating it needs to be defined.

```json
{
  "_id": "635c0638bde4e40010dfc217",
  "api": {
    "method": "get",
    "url": "",
    "auth": "required",
    "results": {
      "codes": [
        {
          "name": "",
          "code": "{}",
          "language": "json",
          "status": 200
        },
        {
          "name": "",
          "code": "{}",
          "language": "json",
          "status": 400
        }
      ]
    },
    "params": []
  },
  "title": "Uruguay"
}
```

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

### Onboarding Process Platforms

Source: https://docs.dlocal.com/docs/latin-america-payouts

Provides an overview of the onboarding process for platforms.

```APIDOC
## GET /llmstxt/dlocal_llms_txt/onboarding-process-platforms

### Description
Retrieves information about the onboarding process for platforms.

### Method
GET

### Endpoint
/llmstxt/dlocal_llms_txt/onboarding-process-platforms

### Parameters
#### Path Parameters
(None)

#### Query Parameters
(None)

#### Request Body
(None)

### Request Example
(None)

### Response
#### Success Response (200)
- **body** (object) - An empty JSON object indicating success.

#### Response Example
```json
{}
```
```

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

### Installment Object JSON Example

Source: https://docs.dlocal.com/reference/the-installment-object

This JSON object represents a sample Installment object, demonstrating its structure and expected values for properties like ID, installment amount, number of installments, and total amount.

```json
{
    "id" : "INS54434-2",
    "installment_amount" : 550.00,
    "installments" : 2,
    "total_amount" : 1100.00
}
```

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

### Onboarding Process API

Source: https://docs.dlocal.com/docs/africa-payouts

This API covers the general onboarding process for platforms. It includes endpoints for onboarding users and checking account status.

```APIDOC
## GET /api/onboarding-process-platforms

### Description
Retrieves information about the onboarding process for platforms.

### Method
GET

### Endpoint
/api/onboarding-process-platforms

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **(object)** - Details about the onboarding process.

#### Response Example
```json
{}
```

## GET /api/onboard-user-accounts-platforms

### Description
Onboards user accounts to the platform.

### Method
GET

### Endpoint
/api/onboard-user-accounts-platforms

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **(object)** - Confirmation of user account onboarding.

#### Response Example
```json
{}
```

## GET /api/account-status-platforms

### Description
Retrieves the status of a user account on the platform.

### Method
GET

### Endpoint
/api/account-status-platforms

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **(object)** - The current status of the user account.

#### Response Example
```json
{}
```

## GET /api/kyc-requirement-platforms

### Description
Provides information regarding KYC (Know Your Customer) requirements for platform accounts.

### Method
GET

### Endpoint
/api/kyc-requirement-platforms

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **(object)** - Details on KYC requirements.

#### Response Example
```json
{}
```
```

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

### Create Installment Plan Response - JSON

Source: https://docs.dlocal.com/docs/installments

This is an example response from the DLocal API after creating an installment plan. It returns a unique ID for the plan and lists various installment options, each with its own ID, installment amount, number of installments, and total amount.

```json
{
    "id" : "INS54434",
    "country" : "BR",
    "bin" : "435921",
    "amount": 1000.00,
    "currency" : "BRL",
    "installments" : [
        {
            "id" : "INS54434-1",
            "installment_amount" : 1000.00,
            "installments" : 1,
            "total_amount" : 1000.00
        },
        {
            "id" : "INS54434-2",
            "installment_amount" : 550.00,
            "installments" : 2,
            "total_amount" : 1100.00
        },
        {
            "id" : "INS54434-3",
            "installment_amount" : 383.33,
            "installments" : 3,
            "total_amount" : 1150.00
        }
    ],
    "installments_by_bank": false
}
```

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

### Onboard User Accounts (JSON)

Source: https://docs.dlocal.com/docs/payouts-integrations

Initiates the onboarding process for user accounts. This GET request requires authentication and provides JSON responses for success (200) and failure (400). The code examples represent empty JSON objects, signifying the structure for these responses.

```json
{
  "api": {
    "method": "get",
    "url": "",
    "auth": "required",
    "results": {
      "codes": [
        {
          "name": "",
          "code": "{}",
          "language": "json",
          "status": 200
        },
        {
          "name": "",
          "code": "{}",
          "language": "json",
          "status": 400
        }
      ],
      "params": [],
      "examples": {
        "codes": []
      }
    }
  },
  "title": "Onboard User accounts",
  "icon": "",
  "type": "basic",
  "slug": "onboard-user-accounts-platforms",
  "order": 0,
  "isReference": false,
  "deprecated": false,
  "hidden": false,
  "sync_unique": "",
  "link_url": "",
  "link_external": false,
  "previousSlug": "onboard-user-accounts",
  "parentDoc": "64ed08047bb7de00464212e8",
  "category": "62715e2cb10bfb0306defd6e",
  "createdAt": "2023-08-28T20:49:58.300Z",
  "mdx": {},
  "isBodyEmpty": false,
  "children": []
}
```

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

### Include dLocal.js Script

Source: https://docs.dlocal.com/docs/set-up-smart-fields

Include the dLocal.js script in your HTML to enable Smart Fields functionality. Use the production URL for live environments and the sandbox URL for testing.

```html
<script src="https://js.dlocal.com/"></script>
```

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

### Get Balance Response Example (JSON)

Source: https://docs.dlocal.com/docs/manage-funds-platforms

This is an example JSON response for a GET balance request to the Dlocal API. It details the available balance, previous day's closing balance, and the date of the balance.

```json
{
   "currency": "USD",
   "available_balance": 42123.12,
   "previous_day_closing_balance": 200000.00,
   "current_balance_date": "2020-08-26"
}
```

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

### Manage Documentation Platform API Examples

Source: https://docs.dlocal.com/docs/africa-payins

This snippet shows example JSON responses for the 'Manage documentation' API endpoint. It includes a success response (status 200) and an error response (status 400), both represented as empty JSON objects.

```json
{
  "results": {
    "codes": [
      {
        "name": "",
        "code": "{}",
        "language": "json",
        "status": 200
      },
      {
        "name": "",
        "code": "{}",
        "language": "json",
        "status": 400
      }
    ]
  }
}
```

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

### Quotes Configuration GET API Example

Source: https://docs.dlocal.com/docs/manage-funds-platforms

This snippet describes a GET request for quotes configuration. It requires authentication and has no specified API URL or example response codes. This is a child resource of 'Before Payouts'.

```json
{
  "_id": "6658b28c1e423e0029df66e7",
  "api": {
    "method": "get",
    "url": "",
    "auth": "required",
    "params": []
  },
  "title": "Quotes configuration"
}
```

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

### Before Payouts Configuration GET API Example

Source: https://docs.dlocal.com/docs/manage-funds-platforms

This snippet outlines a GET request related to configurations before payouts. It requires authentication and has no specified API URL or example response codes, as the body is marked as empty.

```json
{
  "_id": "6658b165f4ffc50010c2f2a8",
  "api": {
    "method": "get",
    "url": "",
    "auth": "required",
    "params": []
  },
  "title": "Before payouts"
}
```

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

### Onboard User Accounts API (GET)

Source: https://docs.dlocal.com/docs/africa-payins

Handles the onboarding of user accounts. This API endpoint uses the GET method and requires authentication. It defines successful (200) and error (400) response structures.

```json
{
  "api": {
    "method": "get",
    "url": "",
    "auth": "required",
    "results": {
      "codes": [
        {
          "name": "",
          "code": "{}",
          "language": "json",
          "status": 200
        },
        {
          "name": "",
          "code": "{}",
          "language": "json",
          "status": 400
        }
      ]
    },
    "params": [],
    "examples": {
      "codes": []
    }
  },
  "title": "Onboard User accounts",
  "type": "basic"
}
```

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

### Reporting GET API Example

Source: https://docs.dlocal.com/docs/manage-funds-platforms

This snippet provides details for a GET request related to reporting. Authentication is required, and example JSON responses for success (200) and error (400) are included. The API URL is not specified.

```json
{
  "_id": "635c3de415cde500110fbfd3",
  "api": {
    "method": "get",
    "url": "",
    "auth": "required",
    "results": {
      "codes": [
        {
          "name": "",
          "code": "{}",
          "language": "json",
          "status": 200
        },
        {
          "name": "",
          "code": "{}",
          "language": "json",
          "status": 400
        }
      ]
    },
    "params": []
  },
  "title": "Reporting"
}
```

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

### Going Live Checklist

Source: https://docs.dlocal.com/docs/plugins-wallets

Steps to prepare for a live production environment, including requesting Google Production Access and configuring your integration.

```APIDOC
## Going Live Checklist

### Description
This section outlines the necessary steps to transition from a testing environment to a live production environment. It includes obtaining production access from Google and ensuring your dLocal integration is correctly configured.

### Steps
1.  **Request Google Production Access:**
    - Fill out the [Google Production Access form](https://services.google.com/fb/forms/googlepayAPIenable).
    - Refer to the Google [Web](https://developers.google.com/pay/api/web/guides/test-and-deploy/request-prod-access) and [Android](https://developers.google.com/pay/api/web/guides/test-and-deploy/request-prod-access) documentation for detailed instructions.
2.  **Update Google Integration Configuration:**
    - Update your Google integration settings to enable production environment access. Refer to [Step 1 - Google Integration](doc:google-pay#step-1---google-integration-span-classpill-primaryfrontendspan) for guidance.
3.  **Contact Technical Account Manager (TAM):**
    - Reach out to your TAM to verify all configurations are correct and confirm readiness for go-live.

```

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

### Examples Smart Fields API

Source: https://docs.dlocal.com/docs/payouts-integrations

Illustrative examples demonstrating the usage and capabilities of Smart Fields.

```APIDOC
## GET /api/smart-fields/examples

### Description
Provides examples of how to use Smart Fields.

### Method
GET

### Endpoint
/api/smart-fields/examples

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **examples** (object) - Contains various examples for Smart Fields.

#### Response Example
```json
{}
```
```

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

### Onboarding Process APIs

Source: https://docs.dlocal.com/docs/payouts-integrations

APIs related to the overall onboarding process for platforms.

```APIDOC
## GET /onboarding-process-platforms

### Description
Retrieves information about the onboarding process for platforms.

### Method
GET

### Endpoint
/onboarding-process-platforms

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **{}** (json) - Response body with onboarding process details.

#### Response Example
```json
{}
```

#### Error Response (400)
- **{}** (json) - Response body for bad requests.

#### Response Example
```json
{}
```
```

```APIDOC
## GET /onboard-user-accounts-platforms

### Description
Onboards user accounts for platforms.

### Method
GET

### Endpoint
/onboard-user-accounts-platforms

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **{}** (json) - Response body indicating successful onboarding.

#### Response Example
```json
{}
```

#### Error Response (400)
- **{}** (json) - Response body for bad requests.

#### Response Example
```json
{}
```
```

```APIDOC
## GET /account-status-platforms

### Description
Retrieves the status of an account on the platform.

### Method
GET

### Endpoint
/account-status-platforms

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **{}** (json) - Response body containing account status information.

#### Response Example
```json
{}
```

#### Error Response (400)
- **{}** (json) - Response body for bad requests.

#### Response Example
```json
{}
```
```

```APIDOC
## GET /kyc-requirement-platforms

### Description
Provides information on KYC (Know Your Customer) requirements for platforms.

### Method
GET

### Endpoint
/kyc-requirement-platforms

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **{}** (json) - Response body detailing KYC requirements.

#### Response Example
```json
{}
```

#### Error Response (400)
- **{}** (json) - Response body for bad requests.

#### Response Example
```json
{}
```
```

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

### Philippines Payouts API Configuration (JSON)

Source: https://docs.dlocal.com/docs/africa-payouts

Specifies the API setup for processing payouts in the Philippines. This configuration uses the GET method, requires authentication, and includes defined JSON responses for successful (200) and unsuccessful (400) API calls. It does not list any parameters or provide code examples.

```json
{
  "api": {
    "method": "get",
    "url": "",
    "auth": "required",
    "results": {
      "codes": [
        {
          "name": "",
          "code": "{}",
          "language": "json",
          "status": 200
        },
        {
          "name": "",
          "code": "{}",
          "language": "json",
          "status": 400
        }
      ]
    },
    "params": [],
    "examples": {
      "codes": []
    }
  },
  "title": "Philippines",
  "icon": "",
  "type": "basic",
  "slug": "philippines-payouts",
  "order": 7,
  "isReference": false,
  "deprecated": false,
  "hidden": false,
  "sync_unique": "",
  "link_url": "",
  "link_external": false,
  "previousSlug": "philippines-1",
  "createdAt": "2022-10-28T16:27:16.003Z",
  "parentDoc": "65b14e4b196093000ffe538e",
  "category": "62cb5e3358f4200027316d15",
  "mdx": {},
  "isBodyEmpty": false,
  "children": []
}
```

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

### GET /api/installment

Source: https://docs.dlocal.com/docs/africa-payins

Retrieves information about the Installment Object. This endpoint is used to fetch details regarding individual installments.

```APIDOC
## GET /api/installment

### Description
Retrieves information about the Installment Object. This endpoint is used to fetch details regarding individual installments.

### Method
GET

### Endpoint
/api/installment

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **object** (object) - Represents the Installment Object structure.

#### Response Example
```json
{}
```
```

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

### JavaScript: Create Installments Plan with DLocal SDK

Source: https://docs.dlocal.com/docs/set-up-smart-fields

This JavaScript code demonstrates how to create an installment plan using the DLocal SDK. It's designed to be triggered by the `brand` event from the card field. The function `createInstallmentsPlan` is called with the card field instance, total amount, and currency, then populates a select dropdown with available installment options based on the response.

```javascript
let actualBrand = null;
card.on('brand', function (event) {
    document.getElementById('card-errors').innerHTML = "";
    if (event.brand) {
        //when card brand changes
        actualBrand = cardStatus.brand;
        //totalAmount & currency of the purchase
        dlocal.createInstallmentsPlan(card, totalAmount, currency)
        .then((result) => {
            var installmentsSelect = document.getElementById('installments');
            buildInstallments(installmentsSelect, result.installments);
        }).catch((result) => {
            console.error(result);
        });
    }
});

function buildInstallments(installmentsInput, installmentsPlan) {
    const installmentsOptions = installmentsPlan.installments.reduce(function (options, plan) {
            options += "<option value=" + plan.id + ">" + plan.installments + " of " + currency + " " + plan.installment_amount + " (Total : " + currency + " " + plan.total_amount + ")</option>";
            return options;
    }, "");
    installmentsInput.disabled = false;
    installmentsInput.innerHTML = installmentsOptions;
}
```

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

### GET /api/installment-plan

Source: https://docs.dlocal.com/docs/africa-payins

Retrieves information about the Installment Plan Object. This endpoint provides details on installment plan configurations.

```APIDOC
## GET /api/installment-plan

### Description
Retrieves information about the Installment Plan Object. This endpoint provides details on installment plan configurations.

### Method
GET

### Endpoint
/api/installment-plan

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **object** (object) - Represents the Installment Plan Object structure.

#### Response Example
```json
{}
```
```

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

### Plugins and Wallets API Example (JSON)

Source: https://docs.dlocal.com/docs/africa-payins

This JSON snippet demonstrates the API response for plugins and wallets functionality, showing success (200) and error (400) codes. It is related to managing payment plugins and digital wallets.

```json
{
  "_id": "635c400079383e009aa2886b",
  "api": {
    "method": "get",
    "url": "",
    "auth": "required",
    "results": {
      "codes": [
        {
          "name": "",
          "code": "{}",
          "language": "json",
          "status": 200
        },
        {
          "name": "",
          "code": "{}",
          "language": "json",
          "status": 400
        }
      ],
      "params": [],
      "examples": {
        "codes": []
      }
    },
    "title": "Plugins and wallets",
    "icon": "",
    "type": "basic",
    "slug": "plugins-wallets",
    "order": 6,
    "isReference": false,
    "deprecated": false,
    "hidden": false,
    "sync_unique": "",
    "link_url": "",
    "link_external": false,
    "previousSlug": "plugins-and-wallets",
    "createdAt": "2022-10-28T20:48:00.876Z",
    "category": "61f94c5b554fcf0370b53aa0",
    "parentDoc": "640f6ae1f810a90055eb3dfc",
    "mdx": {},
    "isBodyEmpty": false,
    "children": []
  }
}
```

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

### GET / The Installment Object

Source: https://docs.dlocal.com/docs/asia-payins

Retrieves information for the Installment Object. This endpoint requires authentication and returns JSON.

```APIDOC
## GET / The Installment Object

### Description
Retrieves information for the Installment Object. This endpoint requires authentication and returns JSON.

### Method
GET

### Endpoint
/

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **(object)**: An object representing the Installment Object. (Details not provided in the source)

#### Response Example
```json
{}
```
```

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

### LLM Integration Guide

Source: https://docs.dlocal.com/docs/africa-payins

Directs users to the /llms.txt file, which contains specific instructions or data for integrating Language Models (LLMs) with dLocal's platform. This is crucial for developers working with AI-powered features.

```html
<a href="https://docs.dlocal.com/llms.txt" class="c-footer__quick-access-link">Read /llms.txt</a>
```

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

### Onboarding Process

Source: https://docs.dlocal.com/docs/asia-payouts

This section details the API endpoints related to the onboarding process for platforms.

```APIDOC
## GET /onboarding-process-platforms

### Description
Retrieves information about the onboarding process for platforms.

### Method
GET

### Endpoint
/onboarding-process-platforms

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **status** (integer) - HTTP status code of the response.
- **data** (object) - Contains the onboarding process details.

#### Response Example
```json
{
  "status": 200,
  "data": {}
}
```
```

```APIDOC
## GET /onboard-user-accounts-platforms

### Description
Onboards user accounts for platforms.

### Method
GET

### Endpoint
/onboard-user-accounts-platforms

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **status** (integer) - HTTP status code of the response.
- **data** (object) - Contains the onboarded user account details.

#### Response Example
```json
{
  "status": 200,
  "data": {}
}
```
```

```APIDOC
## GET /account-status-platforms

### Description
Retrieves the status of user accounts on platforms.

### Method
GET

### Endpoint
/account-status-platforms

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **status** (integer) - HTTP status code of the response.
- **data** (object) - Contains the account status details.

#### Response Example
```json
{
  "status": 200,
  "data": {}
}
```
```

```APIDOC
## GET /kyc-requirement-platforms

### Description
Retrieves information about KYC (Know Your Customer) requirements for platforms.

### Method
GET

### Endpoint
/kyc-requirement-platforms

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **status** (integer) - HTTP status code of the response.
- **data** (object) - Contains the KYC requirement details.

#### Response Example
```json
{
  "status": 200,
  "data": {}
}
```
```

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

### Payout Flows Status GET API Example

Source: https://docs.dlocal.com/docs/manage-funds-platforms

This snippet details a GET request for retrieving the status of payout flows. Authentication is required, and example JSON responses for success (200) and error (400) are provided. The API URL is not specified.

```json
{
  "_id": "62cc8086e41085005e5d5f6d",
  "api": {
    "method": "get",
    "url": "",
    "auth": "required",
    "results": {
      "codes": [
        {
          "name": "",
          "code": "{}",
          "language": "json",
          "status": 200
        },
        {
          "name": "",
          "code": "{}",
          "language": "json",
          "status": 400
        }
      ]
    },
    "params": []
  },
  "title": "Status payout flows"
}
```

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

### Get Verification Details Endpoint API Details

Source: https://docs.dlocal.com/docs/manage-funds-platforms

Details for the 'Get verification details' endpoint, which uses the GET method. Authentication is required, and there are no specified parameters or example responses.

```json
{
  "method": "get",
  "url": "",
  "auth": "required",
  "params": [],
  "results": {
    "codes": []
  }
}
```