v1

latestOpenAPI 3.1.02026-07-2656258207.2 KB

Chargebacks

Create a chargeback

post/chargebacks

Headers

X-Trace-Idstring

A unique identifier to track this operation. It must be between 12 and 255 characters in length.

X-Idempotency-Keystring

A unique identifier to prevent duplicate requests. It must be between 12 and 255 characters in length.

Request body

charge_idstring required

ID of the charge tied to this chargeback

amountnumber required

The payment amount in decimals.

stage'new' | 'second' | 'pre-arbitration' | 'arbitration'

The stage describes the current phase of a chargeback dispute.

status'pending' | 'initiated'

The status indicates the current state or progress of the chargeback, showing whether it's awaiting action or has been formally started.

type'local' | 'international' required

The type categorizes the chargeback based on whether it originates from a transaction within the same country (local) or across different countries (international).

uploaded_proofstring

Link to proof against chargeback

commentstring

Additional comments for the chargeback

providerstring

Provider for the chargeback

arnstring

Acquirer reference number for transaction

initiatorstring

Initiator of the chargeback

expiryinteger required

Duration of chargeback in hours used in calculating due_datetime

Example request

{
  "charge_id": "chg_eahdhfThdHsgaSra",
  "amount": 12.34,
  "stage": "new",
  "status": "pending",
  "type": "international",
  "uploaded_proof": "https://example.com/proofs/proof_123.pdf",
  "comment": "Customer claims the charge was unauthorized.",
  "provider": "Visa",
  "arn": "1243453453434234534443423",
  "initiator": "customer",
  "expiry": 72
}

Response

status'success' | 'failed'

messagestring

metaobject

Example response

{
  "data": {
    "charge_id": "chg_eahdhfThdHsgaSra",
    "amount": 12.34,
    "stage": "new",
    "status": "new",
    "type": "local",
    "due_datetime": "2025-05-30T23:59:59Z",
    "created_datetime": "2025-06-01T23:59:59Z",
    "updated_datetime": "2025-06-01T23:59:59Z",
    "settlement_id": "SETTLEMENT-XYZ-12345",
    "uploaded_proof": "https://example.com/proofs/chargeback-ABC-67890.pdf",
    "comment": "Customer claims service not rendered. Attached signed delivery confirmation.",
    "provider": "Visa",
    "arn": "70010000000000000000001",
    "initiator": "Cardholder"
  }
}