Pular para o conteúdo principal
POST
/
v1
/
boleto-payments
Pagar boleto
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 '
{
  "allowed_tax_ids": [
    "12345678909"
  ],
  "payments": [
    {
      "amount_in_cents": 11631,
      "description": "Pagamento boleto",
      "external_reference_id": "boleto-001",
      "line": "34191091070544794730971544640008884660000011631",
      "tax_id": "12345678909"
    }
  ]
}
'
import requests

url = "https://conta-public-api.kiwify.com/v1/boleto-payments"

payload = {
    "allowed_tax_ids": ["12345678909"],
    "payments": [
        {
            "amount_in_cents": 11631,
            "description": "Pagamento boleto",
            "external_reference_id": "boleto-001",
            "line": "34191091070544794730971544640008884660000011631",
            "tax_id": "12345678909"
        }
    ]
}
headers = {
    "x-access-id": "<api-key>",
    "X-PoP-Challenge": "<api-key>",
    "X-PoP-Format": "<api-key>",
    "X-PoP-Signature": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {
    'x-access-id': '<api-key>',
    'X-PoP-Challenge': '<api-key>',
    'X-PoP-Format': '<api-key>',
    'X-PoP-Signature': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    allowed_tax_ids: ['12345678909'],
    payments: [
      {
        amount_in_cents: 11631,
        description: 'Pagamento boleto',
        external_reference_id: 'boleto-001',
        line: '34191091070544794730971544640008884660000011631',
        tax_id: '12345678909'
      }
    ]
  })
};

fetch('https://conta-public-api.kiwify.com/v1/boleto-payments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://conta-public-api.kiwify.com/v1/boleto-payments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'allowed_tax_ids' => [
        '12345678909'
    ],
    'payments' => [
        [
                'amount_in_cents' => 11631,
                'description' => 'Pagamento boleto',
                'external_reference_id' => 'boleto-001',
                'line' => '34191091070544794730971544640008884660000011631',
                'tax_id' => '12345678909'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-PoP-Challenge: <api-key>",
    "X-PoP-Format: <api-key>",
    "X-PoP-Signature: <api-key>",
    "x-access-id: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://conta-public-api.kiwify.com/v1/boleto-payments"

	payload := strings.NewReader("{\n  \"allowed_tax_ids\": [\n    \"12345678909\"\n  ],\n  \"payments\": [\n    {\n      \"amount_in_cents\": 11631,\n      \"description\": \"Pagamento boleto\",\n      \"external_reference_id\": \"boleto-001\",\n      \"line\": \"34191091070544794730971544640008884660000011631\",\n      \"tax_id\": \"12345678909\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-access-id", "<api-key>")
	req.Header.Add("X-PoP-Challenge", "<api-key>")
	req.Header.Add("X-PoP-Format", "<api-key>")
	req.Header.Add("X-PoP-Signature", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://conta-public-api.kiwify.com/v1/boleto-payments")
  .header("x-access-id", "<api-key>")
  .header("X-PoP-Challenge", "<api-key>")
  .header("X-PoP-Format", "<api-key>")
  .header("X-PoP-Signature", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"allowed_tax_ids\": [\n    \"12345678909\"\n  ],\n  \"payments\": [\n    {\n      \"amount_in_cents\": 11631,\n      \"description\": \"Pagamento boleto\",\n      \"external_reference_id\": \"boleto-001\",\n      \"line\": \"34191091070544794730971544640008884660000011631\",\n      \"tax_id\": \"12345678909\"\n    }\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://conta-public-api.kiwify.com/v1/boleto-payments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-access-id"] = '<api-key>'
request["X-PoP-Challenge"] = '<api-key>'
request["X-PoP-Format"] = '<api-key>'
request["X-PoP-Signature"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"allowed_tax_ids\": [\n    \"12345678909\"\n  ],\n  \"payments\": [\n    {\n      \"amount_in_cents\": 11631,\n      \"description\": \"Pagamento boleto\",\n      \"external_reference_id\": \"boleto-001\",\n      \"line\": \"34191091070544794730971544640008884660000011631\",\n      \"tax_id\": \"12345678909\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body
{
  "batch": {
    "created_at": "2026-05-28T14:30:00Z",
    "id": 123,
    "origin_bank_account_id": 123,
    "total_amount_in_cents": 123,
    "total_items": 123,
    "allowed_tax_ids": [
      "<string>"
    ],
    "idempotency_key": "<string>"
  },
  "payments": [
    {
      "barcode_line": "<string>",
      "created_at": "2026-05-28T14:30:00Z",
      "id": 123,
      "tax_id": "<string>",
      "amount_in_cents": 123,
      "description": "<string>",
      "external_reference_id": "<string>",
      "failed_message": "<string>",
      "scheduled_date": "2026-06-01",
      "transaction_id": 123
    }
  ]
}
{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "<string>",
    "details": {}
  },
  "timestamp": "2026-05-28T14:30:00Z"
}
{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "<string>",
    "details": {}
  },
  "timestamp": "2026-05-28T14:30:00Z"
}
{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "<string>",
    "details": {}
  },
  "timestamp": "2026-05-28T14:30:00Z"
}
{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "<string>",
    "details": {}
  },
  "timestamp": "2026-05-28T14:30:00Z"
}
{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "<string>",
    "details": {}
  },
  "timestamp": "2026-05-28T14:30:00Z"
}
{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "<string>",
    "details": {}
  },
  "timestamp": "2026-05-28T14:30:00Z"
}

Autorizações

​
x-access-id
string
header
obrigatório

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

​
X-PoP-Challenge
string
header
obrigatório

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

​
X-PoP-Format
string
header
obrigatório

Must be 'service-account' for service account authentication

​
X-PoP-Signature
string
header
obrigatório

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

Cabeçalhos

​
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.

Corpo

application/json
​
payments
object[]
obrigatório

Boleto payments to create in this batch (1–100 items).

​
allowed_tax_ids
string[]

Optional list of CPF/CNPJ that restricts the allowed beneficiary documents for this batch. When provided, the tax_id in each payment must be present in the list. When empty, payments to any document are accepted.

Resposta

Boleto payments batch created successfully

​
batch
object
obrigatório
​
payments
object[]
obrigatório