Skip to main content
POST
/
v1
/
boleto-payments
Create Boleto Payment
curl --request POST \
  --url https://conta-public-api.kiwify.com/v1/boleto-payments \
  --header 'Content-Type: application/json' \
  --header 'X-PoP-Challenge: <api-key>' \
  --header 'X-PoP-Format: <api-key>' \
  --header 'X-PoP-Signature: <api-key>' \
  --header 'x-access-id: <api-key>' \
  --data '
{
  "payments": [
    {
      "line": "<string>",
      "tax_id": "<string>",
      "amount_in_cents": 123,
      "description": "<string>",
      "external_reference_id": "<string>",
      "scheduled_date": "2023-12-25"
    }
  ],
  "allowed_tax_ids": [
    "<string>"
  ]
}
'
{
  "batch": {
    "created_at": "2023-11-07T05:31:56Z",
    "id": 123,
    "origin_bank_account_id": 123,
    "payment_type": "pix_transfer",
    "status": "created",
    "total_amount_in_cents": 123,
    "total_items": 123,
    "allowed_tax_ids": [
      "<string>"
    ],
    "idempotency_key": "<string>"
  },
  "payments": [
    {
      "barcode_line": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "id": 123,
      "status": "awaiting_approval",
      "tax_id": "<string>",
      "amount_in_cents": 123,
      "description": "<string>",
      "external_reference_id": "<string>",
      "scheduled_date": "2023-12-25"
    }
  ]
}

Authorizations

x-access-id
string
header
required

UUID of the service account (e.g., 550e8400-e29b-41d4-a716-446655440000)

X-PoP-Challenge
string
header
required

Unix timestamp in milliseconds (e.g., 1704636800000). Must be within 5 minutes of server time.

X-PoP-Format
string
header
required

Must be 'service-account' for service account authentication

X-PoP-Signature
string
header
required

EdDSA signature of the request in base64 format. Signs: uri:method:body:timestamp

Headers

X-Idempotency-Key
string | null

Optional idempotency key for safe retries. When provided, requests with the same key return the same result. Without this header, duplicate external_reference_id values will fail with 400 Bad Request.

Body

application/json
payments
object[]
required
allowed_tax_ids
string[]

Response

Boleto payments batch created successfully

batch
object
required
payments
object[]
required