Skip to main content

Create Chargeback

Create a new chargeback record against a specific transaction.

POSThttps://api.zenpayz.com/merchant/api/v1/chargebacks
Bearer · API key

Request

Headers

HeaderDescription
Authorization
REQUIRED
Bearer {api_key}
X-Signature
REQUIRED
HMAC-SHA256 signature
X-Timestamp
REQUIRED
ISO 8601 timestamp
X-Secret-Salt
REQUIRED
Secret salt for HMAC validation
Content-Type
REQUIRED
application/json
X-Merchant-Id
REQUIRED
Merchant identifier
X-Request-Id
REQUIRED
Unique request identifier

Body Parameters

ParameterTypeDescription
transactionId
REQUIRED
stringID of the original transaction being disputed
amount
REQUIRED
numberChargeback amount
currency
REQUIRED
stringISO 4217 currency code
reason
REQUIRED
stringReason for the chargeback
source
REQUIRED
stringSource of the chargeback (e.g. card_network, customer, bank)
reasonCode
OPTIONAL
stringStandard reason code from the card network
reasonDescription
OPTIONAL
stringDetailed description of the reason
externalChargebackId
OPTIONAL
stringExternal chargeback identifier from the payment network
disputeDeadline
OPTIONAL
stringDeadline to respond to the dispute (ISO 8601)
evidenceDeadline
OPTIONAL
stringDeadline to submit evidence (ISO 8601)
priority
OPTIONAL
stringPriority level: low, medium, high, urgent

Response

Success (201 Created)

{
"success": true,
"data": {
"chargebackId": "cb_a1b2c3d4e5f6g7h8",
"transactionId": "txn_f8e7d6c5b4a39281",
"amount": 150.00,
"currency": "USD",
"reason": "fraudulent",
"source": "card_network",
"reasonCode": "10.4",
"reasonDescription": "Other Fraud - Card-Absent Environment",
"externalChargebackId": "ext_cb_12345",
"status": "initiated",
"outcome": "pending",
"priority": "high",
"disputeDeadline": "2024-02-15T23:59:59.000Z",
"evidenceDeadline": "2024-02-10T23:59:59.000Z",
"evidence": [],
"merchantResponse": null,
"createdAt": "2024-01-15T10:30:00.000Z",
"updatedAt": "2024-01-15T10:30:00.000Z"
},
"message": "Chargeback created successfully",
"error": null,
"meta": {
"request_id": "req_xxxxx",
"timestamp": "2024-01-15T10:30:00.000Z",
"processing_time_ms": 45,
"api_version": "v1",
"endpoint": "POST /chargebacks",
"user_type": "merchant"
}
}

Error Responses

CodeHTTPMessage
VALIDATION_ERROR400Invalid request parameters
UNAUTHORIZED401Invalid API key
TRANSACTION_NOT_FOUND404Referenced transaction does not exist
DUPLICATE_CHARGEBACK409A chargeback already exists for this transaction

Examples

curl -X POST https://api.zenpayz.com/merchant/api/v1/chargebacks \
-H "Authorization: Bearer zp_test_xxxxx" \
-H "X-Timestamp: 2024-01-15T10:30:00.000Z" \
-H "X-Signature: a1b2c3d4e5f6..." \
-H "X-Secret-Salt: your_secret_salt" \
-H "Content-Type: application/json" \
-H "X-Merchant-Id: merch_xxxxx" \
-H "X-Request-Id: req_xxxxx" \
-d '{
"transactionId": "txn_f8e7d6c5b4a39281",
"amount": 150.00,
"currency": "USD",
"reason": "fraudulent",
"source": "card_network",
"reasonCode": "10.4",
"priority": "high",
"disputeDeadline": "2024-02-15T23:59:59.000Z",
"evidenceDeadline": "2024-02-10T23:59:59.000Z"
}'