Create dispute.

post

http://<host-url>/disputes

Creates a dispute with status C (Created).

Allowed transitions:

C (Created) -> P (Processed)
C (Created) -> A (Accepted)
C (Created) -> S (Partial win)
C (Created) -> R (Rejected)
C (Created) -> E (Expired)
C (Created) -> D (Deleted)
P (Processed) -> A (Accepted)
P (Processed) -> S (Partial win)
P (Processed) -> R (Rejected)
E (Expired) -> D (Deleted)

A (Accepted), S (Partial win), R (Rejected), and D (Deleted) are terminal statuses with no allowed outgoing transitions.

Body Params

account_id

int32

required

PayCredit account identifier associated with the disputed transaction.

amount

number

required

Amount being disputed. If amount is less than the original transaction amount, the dispute is considered a partial dispute. Total amount disputed across all disputes for a transaction cannot exceed the original transaction amount.

chargeback_id

string

The identifier of the chargeback associated with this dispute, as provided by the caller. Required for Mastercard disputes; optional for Visa disputes.

claim_id

string

required

The identifier of the claim associated with this dispute, as provided by the caller. Required for both Mastercard and Visa disputes.

description

string

required

Description of the dispute.

transaction_reference

string

required

Reference identifying the original transaction (TID).

Headers

unique-request-id

string

Unique identifier of a request.

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Dispute was created successfully.

404Unexpected error.