Loading...
Loading...
Guide for managing Pix charges, accounts, and payments using Kobana API. Use when the user wants to create, list, update, or cancel Pix charges, manage Pix accounts, or handle charge payments.
npx skill4agent add universokobana/kobana-agent-skills api-charge-pixProduction: https://api.kobana.com.br
Sandbox: https://api-sandbox.kobana.com.brAuthorization: Bearer {your_api_token}| Method | Endpoint | Description |
|---|---|---|
| GET | | List all Pix accounts |
| POST | | Create a new Pix account |
| GET | | Get a specific Pix account |
| PUT | | Update a Pix account |
| DELETE | | Delete a Pix account |
| Method | Endpoint | Description |
|---|---|---|
| GET | | List all Pix charges |
| POST | | Create a new Pix charge |
| GET | | Get a specific Pix charge |
| PUT | | Update a Pix charge |
| DELETE | | Delete a Pix charge |
| POST | | Cancel a Pix charge |
| Method | Endpoint | Description |
|---|---|---|
| GET | | List commands for a Pix charge |
| GET | | Get a specific command |
| Method | Endpoint | Description |
|---|---|---|
| GET | | List all payments |
| POST | | Create a new payment |
| GET | | Get a specific payment |
| DELETE | | Delete a payment |
POST /v2/charge/pix
{
"amount": 100.50,
"pix_account_uid": "018df180-7208-727b-...",
"expire_at": "2026-12-02T10:03:56-03:00"
}POST /v2/charge/pix
{
"amount": 500.00,
"pix_account_uid": "018df180-7208-727b-...",
"expire_at": "2026-02-10T23:59:59-03:00",
"registration_kind": "billing",
"payer": {
"document_number": "12.345.678/0001-90",
"name": "Company LTDA",
"email": "finance@company.com"
},
"fine_type": "percentage",
"fine_percentage": 2.0,
"interest_type": "monthly_percentage_calendar",
"interest_percentage": 1.0,
"discount_type": "advance_percentage_calendar",
"discount_first_percentage": 5.0,
"discount_first_days": 5,
"revoke_days": 30,
"external_id": "invoice_2026_001",
"tags": ["monthly", "subscription"],
"message": "Invoice January/2026"
}registration_kind: "instant"registration_kind: "billing"revoke_days/v2/charge/pix/{uid}registration_statusconfirmedpix.register.confirmedGET /v2/charge/pix?status=opened&created_from=2026-01-01&per_page=50| Parameter | Description |
|---|---|
| Filter by status (opened, paid, overdue, canceled) |
| Filter by registration status |
| Filter by Pix account |
| Filter by creation date |
| Filter by expiration date |
| Filter by payment date |
| Filter by TXID |
| Filter by external ID |
| Filter by tags |
| Pagination |
GET /v2/charge/pix_accountsPUT /v2/charge/pix/{uid}/update
{
"amount": 550.00,
"expire_at": "2026-02-15T23:59:59-03:00"
}POST /v2/charge/pix/{uid}/cancelopenedpaidoverduecanceledgeneration_failedpendingconfirmedrejectedfailed{
"fine_type": "percentage", // or "amount"
"fine_percentage": 2.0
}{
"interest_type": "monthly_percentage_calendar",
"interest_percentage": 1.0
}daily_amount_calendardaily_percentage_calendarmonthly_percentage_calendaryearly_percentage_calendardaily_amount_businessdaily_percentage_businessmonthly_percentage_businessyearly_percentage_business{
"discount_type": "advance_percentage_calendar",
"discount_first_percentage": 5.0,
"discount_first_days": 5
}{
"revoke_days": 30
}