Skip to main content
GET
/
v1
/
refunds
/
{id}
Get Refund
curl --request GET \
  --url https://conta-public-api.kiwify.com/v1/refunds/{id} \
  --header 'X-PoP-Challenge: <api-key>' \
  --header 'X-PoP-Format: <api-key>' \
  --header 'X-PoP-Signature: <api-key>' \
  --header 'x-access-id: <api-key>'
{
  "created_at": "2023-11-07T05:31:56Z",
  "details": {
    "amount_in_cents": 123,
    "message_to_payer": "<string>"
  },
  "id": 123,
  "transaction_id": 123,
  "updated_at": "2023-11-07T05:31:56Z",
  "beneficiary": {
    "pix_key": "<string>",
    "resolved_account_number": "<string>",
    "resolved_branch": "<string>",
    "resolved_ispb": "<string>",
    "name": "<string>",
    "tax_id": "<string>"
  },
  "cancelled_at": "2023-11-07T05:31:56Z",
  "external_reference_id": "<string>",
  "failed_message": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.kiwify.com.br/llms.txt

Use this file to discover all available pages before exploring further.

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

Path Parameters

​
id
integer<int64>
required

Refund identifier

Response

Refund retrieved successfully

​
created_at
string<date-time>
required

Timestamp when the refund was created

​
details
object
required

Refund details (amount, message)

​
id
integer<int64>
required

Refund identifier

​
status
enum<string>
required

Current status of the refund

Available options:
pending,
processing,
success,
cancelled,
failed
​
transaction_id
integer<int64>
required

Original transaction identifier

​
updated_at
string<date-time>
required

Timestamp when the refund was last updated

​
beneficiary
Chave Pix · object

Beneficiary information (payer of original transfer)

​
cancelled_at
string<date-time> | null

Timestamp when the refund was cancelled (if applicable)

​
external_reference_id
string | null

External reference identifier provided by the client

​
failed_message
string | null

Error message if the refund failed