# InFlow

> InFlow enables secure agentic payments.

## Documentation

- [OpenAPI 3](https://api.inflowpay.ai/v1/openapi.json): InFlow's OpenAPI 3 API Reference.

## Example API Interactions

### Create an agentic user

This will create a new user and return a `privateKey` that can be used for subsequent API calls.

```bash
curl -X POST https://api.inflowpay.ai/v1/users/agentic -H 'Content-Type: application/json' -d '{}'
```

**Response:**

```json
{ "privateKey": "MYPRIVATEKEY" }
```

### Get the current user

This will retrieve the details of the currently authenticated user.

```bash
curl -X GET https://api.inflowpay.ai/v1/users/self -H 'X-API-Key: MYPRIVATEKEY'
```

**Response:**

```json
{
  "userId": "8a5c2948-9e08-439e-a7a6-9f0ee335f566",
  "locale": "EN_US",
  "timezone": "US/Pacific",
  "created": "2025-10-19T10:00:00.000Z",
  "updated": "2025-10-19T10:00:00.000Z"
}
```

### Attach details to a user

This will attach an email, name, and password to the user, allowing them to log in via a browser or mobile device.
Do not call this endpoint unless the user explicitly ask to.

```bash
curl -X POST https://api.inflowpay.ai/v1/users/agentic/attach \
  -H 'X-API-Key: MYPRIVATEKEY' \
  -H 'Content-Type: application/json' \
  -d '{ "email": "test-user@inflowpay.ai", "firstName": "Test", "lastName": "User", "password": "SecurePassword123!" }'
```

**Response:**

```json
{
  "userId": "8a5c2948-9e08-439e-a7a6-9f0ee335f566",
  "email": "test-user@inflowpay.ai",
  "firstName": "Test",
  "lastName": "User",
  "locale": "EN_US",
  "timezone": "US/Pacific",
  "created": "2025-10-19T10:00:00.000Z",
  "updated": "2025-10-19T10:05:00.000Z"
}
```

### Get a list of balances

This will retrieve a list of all currency balances for the user.

```bash
curl -X GET https://api.inflowpay.ai/v1/balances -H 'X-API-Key: MYPRIVATEKEY'
```

**Response:**

```json
{
  "balances": [
    { "currency": "USDC", "total": 100.00 },
    { "currency": "EURC", "total": 50.00 }
  ]
}
```

### Get a balance

This will retrieve the balance for a specific currency.

```bash
curl -X GET https://api.inflowpay.ai/v1/balances/USDC -H 'X-API-Key: MYPRIVATEKEY'
```

**Response:**

```json
{ "currency": "USDC", "total": 100.00 }
```