Skip to main content

The Chargeback object

Chargeback entity

note

22 of 22 fields on this object have no description yet. Field documentation lives in the SDK types (types/chargeback.ts) so it stays in one place — this page is generated from it.

Fields

FieldTypeDescription
chargebackId
REQUIRED
string
merchantId
REQUIRED
string
transactionId
REQUIRED
string
customerId
OPTIONAL
string
amount
REQUIRED
number
currency
REQUIRED
string
status
REQUIRED
ChargebackStatusSee ChargebackStatus. ChargebackStatus
reason
REQUIRED
ChargebackReasonSee ChargebackReason. ChargebackReason
reasonCode
OPTIONAL
string
reasonDescription
OPTIONAL
string
source
REQUIRED
ChargebackSourceSee ChargebackSource. ChargebackSource
outcome
OPTIONAL
ChargebackOutcomeSee ChargebackOutcome. ChargebackOutcome
priority
OPTIONAL
ChargebackPrioritySee ChargebackPriority. ChargebackPriority
tspProvider
OPTIONAL
string
externalChargebackId
OPTIONAL
string
disputeDeadline
OPTIONAL
string
evidenceDeadline
OPTIONAL
string
evidenceSubmittedAt
OPTIONAL
string
resolvedAt
OPTIONAL
string
resolutionNotes
OPTIONAL
string
createdAt
REQUIRED
string
updatedAt
OPTIONAL
string

Example

{
"chargebackId": "chargeback_1a2b3c",
"merchantId": "merchant_1a2b3c",
"transactionId": "transaction_1a2b3c",
"customerId": "customer_1a2b3c",
"amount": 5000,
"currency": "USD",
"status": "initiated",
"reason": "fraudulent",
"source": "customer",
"createdAt": "2026-01-15T09:30:00Z"
}