Download OpenAPI specification:Download
Public API for submitting disputes and retrieving evaluation results.
Submit a dispute with evidence for automated evaluation.
required | object (Dispute) Dispute details including the disputed amount and currency. |
required | object (Transaction) Transaction being disputed. |
required | object (Card) Card snapshot for the disputed transaction. |
| category required | string (Category) Dispute category for cancelled transactions. Value: "cancelled" |
required | object (CancelledEvidences) Evidence for cancellation disputes. |
{- "dispute": {
- "disputed_amount": 149.99,
- "disputed_currency": "USD"
}, - "transaction": {
- "transaction_id": "txn_12345",
- "card_scheme": "VISA",
- "channel_type": "ATM",
- "merchant_name": "ACME Store",
- "merchant_country": "USA",
- "transaction_amount": 299.99,
- "transaction_currency": "USD",
- "merchant_id": "mid_123",
- "transaction_timestamp": "2024-01-20T00:00:00Z",
- "settlement_timestamp": "2024-01-22T00:00:00Z",
- "merchant_category_code": "5311",
- "arn": "12345678901234567890123",
- "rrn": "123456789012",
- "batch_id": "batch_001",
- "terminal_id": "term_01",
- "device_fingerprint": "dfp_abc123xyz",
- "device_location": "203.0.113.42",
- "avs_result": "MATCH",
- "cvv_match": true,
- "eci_code": "05",
- "pos_entry_type": "MANUAL",
- "terminal_entry_capability": "MSR_ONLY",
- "authorization_mode": "ONLINE",
- "is_network_tokenized": true
}, - "card": {
- "bin": "54133388",
- "last_4": "1234",
- "emv_chip_enabled": true,
- "emv_pin_preferring": false
}, - "category": "cancelled",
- "evidences": {
- "cardholder_statement": "I cancelled the booking in time but was charged a fee that does not match policy.",
- "purchase_type": "product",
- "cancelled_at": "2026-02-01",
- "additional_documentation": [
- "550e8400-e29b-41d4-a716-446655440000"
]
}
}Retrieve the evaluation confidence and any failed checks.
| evaluation_id required | string <uuid> (Evaluation Id) |
{- "id": "eval_a1b2c3",
- "confidence": "high",
- "reason_code": "10.4",
- "failed_checks": [
- {
- "loc": [
- "body",
- "payload",
- "fraud",
- "evidences",
- "cardholder_statement"
], - "msg": "Cardholder statement is too short.",
- "type": "error"
}
]
}Upload an evidence file and receive its id for use in evaluations.
| file required | string <binary> (File) |
{- "id": "550e8400-e29b-41d4-a716-446655440000",
- "original_name": "receipt.pdf",
- "mime_type": "application/pdf",
- "size": 123456
}Retrieve metadata and a signed URL for an evidence file.
| file_id required | string <uuid> (File Id) |
{- "id": "550e8400-e29b-41d4-a716-446655440000",
- "original_name": "receipt.pdf",
- "mime_type": "application/pdf",
- "size": 123456
}