Pular para o conteúdo principal
POST
/
v1
/
refunds
Reembolsar Pix
curl --request POST \
  --url https://conta-public-api.kiwify.com/v1/refunds \
  --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 '
{
  "amount_in_cents": 15000,
  "external_reference_id": "refund-001",
  "message_to_payer": "Devolução parcial",
  "transaction_id": 123456789
}
'
import requests

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

payload = {
"amount_in_cents": 15000,
"external_reference_id": "refund-001",
"message_to_payer": "Devolução parcial",
"transaction_id": 123456789
}
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({
amount_in_cents: 15000,
external_reference_id: 'refund-001',
message_to_payer: 'Devolução parcial',
transaction_id: 123456789
})
};

fetch('https://conta-public-api.kiwify.com/v1/refunds', 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/refunds",
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([
'amount_in_cents' => 15000,
'external_reference_id' => 'refund-001',
'message_to_payer' => 'Devolução parcial',
'transaction_id' => 123456789
]),
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/refunds"

payload := strings.NewReader("{\n \"amount_in_cents\": 15000,\n \"external_reference_id\": \"refund-001\",\n \"message_to_payer\": \"Devolução parcial\",\n \"transaction_id\": 123456789\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/refunds")
.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 \"amount_in_cents\": 15000,\n \"external_reference_id\": \"refund-001\",\n \"message_to_payer\": \"Devolução parcial\",\n \"transaction_id\": 123456789\n}")
.asString();
require 'uri'
require 'net/http'

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

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 \"amount_in_cents\": 15000,\n \"external_reference_id\": \"refund-001\",\n \"message_to_payer\": \"Devolução parcial\",\n \"transaction_id\": 123456789\n}"

response = http.request(request)
puts response.read_body
{
  "created_at": "2026-05-28T14:30:00Z",
  "details": {
    "amount_in_cents": 123,
    "message_to_payer": "<string>"
  },
  "id": 123,
  "transaction_id": 123,
  "updated_at": "2026-05-28T14:30:00Z",
  "beneficiary": {
    "pix_key": "<string>",
    "resolved_account_number": "<string>",
    "resolved_branch": "<string>",
    "resolved_ispb": "<string>",
    "name": "<string>",
    "tax_id": "<string>"
  },
  "cancelled_at": "2026-05-28T14:30:00Z",
  "external_reference_id": "<string>"
}
{
"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 and payload return the same result. Without this header, duplicate external_reference_id values will fail with 400 Bad Request.

Corpo

application/json
transaction_id
integer<int64>
obrigatório

Identifier of the original PIX transaction to refund.

Exemplo:

123456789

amount_in_cents
integer<int64> | null

Refund amount in centavos. Optional — if omitted, defaults to 0 and is determined during async processing.

Intervalo obrigatório: x >= 1
Exemplo:

15000

external_reference_id
string | null

Client-provided unique reference for this refund within the account (1–127 characters).

Exemplo:

"refund-001"

message_to_payer
string | null

Message sent to the original payer (1–255 characters).

Exemplo:

"Devolução parcial"

Resposta

Refund request created successfully and will be processed asynchronously

created_at
string<date-time>
obrigatório

Refund creation timestamp (UTC, RFC 3339).

Exemplo:

"2026-05-28T14:30:00Z"

details
object
obrigatório

Refund amount and payer message.

id
integer<int64>
obrigatório

Refund identifier.

status
enum<string>
obrigatório

Current refund status.

Opções disponíveis:
awaiting_approval,
pending,
processing,
success,
cancelled,
failed
transaction_id
integer<int64>
obrigatório

Original transaction identifier.

updated_at
string<date-time>
obrigatório

Last update timestamp (UTC, RFC 3339).

Exemplo:

"2026-05-28T14:30:00Z"

beneficiary
Chave Pix · object

Beneficiary details, populated after processing.

cancelled_at
string<date-time> | null

Cancellation timestamp (UTC, RFC 3339), if cancelled.

Exemplo:

"2026-05-28T14:30:00Z"

external_reference_id
string | null

Client-provided reference identifier.