ARMHED API

Collect with Pix and pay out to any Pix key from your own system. The API has four resources: charges, payouts, your balance and short-lived operation tokens. Status changes are pushed to you as signed webhook events.

Base URLs

Liveurl

https://api.armhed.lat

Sandboxurl

https://api.armhed.lat/sandbox

Conventions

Requests and responses are JSON with snake_case fields.
Every amount is an integer in cents of BRL: 500 is R$ 5,00.
Every object carries an object field (charge, payout, balance, list, event) and a string id.
Dates are ISO-8601 strings. Fields that have not happened yet (for example paid_at) are null.
Errors always use the same envelope, described in Errors.

Endpoints

POST /charges

Create a Pix charge

GET /charges/{id}

Retrieve a charge

GET /charges

List charges, newest first

GET /balance

Your current balance

POST /payouts

Send money to a Pix key

GET /payouts/{id}

Retrieve a payout

POST /tokens

Issue an operation token (optional second factor)

Quick start

Get your client_id and api_key in the dashboard under API keys, then create a R$ 5,00 charge:

Create a chargebash

curl https://api.armhed.lat/charges \
  -u "$CLIENT_ID:$API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: order-1042" \
  -d '{ "amount": 500, "reference": "order-1042" }'

201 Createdjson

{
  "object": "charge",
  "id": "6dcf2aee0d6148e1a12b78db78",
  "reference": "order-1042",
  "status": "pending",
  "amount": 500,
  "currency": "BRL",
  "pix": {
    "copy_paste": "00020126580014br.gov.bcb.pix...6304ABCD",
    "qr_code": "data:image/png;base64,iVBORw0KGgo...",
    "expires_at": "2026-11-01T12:00:00Z",
    "end_to_end_id": null
  },
  "created_at": "2026-10-31T12:00:00Z",
  "paid_at": null
}

Show pix.copy_paste or pix.qr_code to the payer. When the payment lands you receive a charge.paid event (see Webhooks).