---
title: "Charge A Client"
method: POST
path: "/integration/charges"
tags: ["integration"]
---

# Charge A Client

`POST /integration/charges`

## Request

- Base URL: `https://app.orla.finance/api`
- URL: `https://app.orla.finance/api/integration/charges`
- Auth: HTTP bearer

Charge one call to a client's prepaid balance, or say what to pay first.

## Headers

- `Idempotency-Key` string, nullable

## Request body

- ChargeCreate: One call of the seller's service, charged to a named client.
  - `account_id` string, uuid, required
  - `amount` union, required
    - number
    - string
  - `client_ref` string, required
  - `currency` string
  - `memo` string
  - `resource` string
  - `top_up_amount` union
    - number
    - string

## Response `200`

Successful Response

- ChargeOut: Either the call is paid from credit, or here is what to pay to go on.
  - `balance_url` string, nullable
  - `balance_usd` string, required
  - `charged_usd` string, nullable
  - `client_ref` string, required
  - `entry_id` string, uuid, nullable
  - `paid` boolean, required
  - `top_up` PaymentRequestOut: What the server puts in its own 402, and reads back to see if it was paid.
    - `amount` string, required
    - `amount_received` string, nullable
    - `created_at` string, date-time, required
    - `currency` string, required
    - `expires_at` string, date-time, nullable
    - `id` string, uuid, required
    - `memo` string
    - `resource_id` string, uuid, nullable
    - `status` string, required
    - `token` string, required
    - `url` string, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/orla/apis/orla-api-agent-and-integration-doors.md) · [All operations](https://skmtc.dev/orla/apis/orla-api-agent-and-integration-doors/llms.txt) · [OpenAPI document](https://skmtc.dev/orla/apis/orla-api-agent-and-integration-doors/revisions/5c8a8112ea7c?raw)