Ingest

Create a refund

Requires conversion.create. X-Api-Key is required; sessions are not accepted. Omit projectId only when the key is restricted to exactly one project; global and multiple-project keys must provide it. X-Team-Id is unnecessary and must match the key team when supplied. Value accepts numeric coercion and is rounded to two decimals, then converted into the project currency. An omitted source currency defaults to BRL. Missing transactionId, paymentMethod and visitorId read back as empty strings. Matches a paid conversion by transactionId; conversionId is null if none matches. A repeated nonempty transactionId returns DUPLICATE_REFUND (409). The shared input accepts status, but it does not affect the refund.

POST

refunds

A valid request URL is required to generate request examples

{
  "id": "11111111-1111-4111-8111-111111111111",
  "timestamp": "2026-06-01 12:00:00.000",
  "transactionId": "order-example-1",
  "value": 49.9,
  "currency": "BRL",
  "paymentMethod": "pix",
  "visitorId": "visitor-example-1",
  "conversionId": null
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "errors": {}
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

Authorizations

X-Api-Key

string

header

required

Body

application/json

value

number

required

projectId

string<uuid>

transactionId

string

currency

string

paymentMethod

string

status

enum<string>

default:paid

Available options:

paid,

pending

string

userAgent

string

visitorId

string

trafficSource

string

utmSource

string

utmMedium

string

utmCampaign

string

utmTerm

string

utmContent

string

clickId

string

sub1

string

sub2

string

sub3

string

sub4

string

sub5

string

sub6

string

sub7

string

sub8

string

Response

Created refund.

string

required

timestamp

string

required

ClickHouse UTC timestamp, for example 2026-06-01 12:00:00.000.

transactionId

string

required

value

number

required

currency

string

required

paymentMethod

string

required

visitorId

string

required

conversionId

string | null

required

Matched paid conversion, or null when no paid conversion matches the transaction.

A valid request URL is required to generate request examples

{
  "id": "11111111-1111-4111-8111-111111111111",
  "timestamp": "2026-06-01 12:00:00.000",
  "transactionId": "order-example-1",
  "value": 49.9,
  "currency": "BRL",
  "paymentMethod": "pix",
  "visitorId": "visitor-example-1",
  "conversionId": null
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "errors": {}
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

Projects

Conversions

Refunds

Chargebacks

Visitors

Requests

Analytics

Dashboards

Pixels

Triggers

Trigger logs

Links

Pages

Domains

Firewall rules

Sales platforms

Traffic sources

Assets

URLs

Ads manager

Ingest

Create a refund

Authorizations

Body

Response