Sign in
Sandbox

Simulate closing a card dispute

Changed on

Close the transaction's open dispute with a disposition, as the card issuer does when the network process ends. A PARTIALLY_WON close is the one outcome whose split the caller names, with recoveredAmount; every other disposition recovers all of the disputed amount or none of it.

Production returns 404 on this path.

post/sandbox/cards/{id}/simulate/dispute_close

Request

  • Base URL: https://api.lightspark.com/grid/2025-10-13
  • URL: https://api.lightspark.com/grid/2025-10-13/sandbox/cards/{id}/simulate/dispute_close
  • Auth: HTTP basic

Path parameters

idstring required

The id of the card the dispute is filed against.

Request body

cardTransactionIdstring required

The id of the disputed CardTransaction; it must have an open dispute.

disposition'WON' | 'PARTIALLY_WON' | 'LOST' | 'WITHDRAWN' | 'DENIED' required

The outcome the dispute closes with.

recoveredAmountinteger

For PARTIALLY_WON only, how much of the disputed amount the network gave back, in the smallest unit of the transaction's currency. Must be strictly between 0 and the disputed amount; defaults to half.

Example request

{
  "cardTransactionId": "Transaction:019542f5-b3e7-1d02-0000-000000000100",
  "disposition": "WON",
  "recoveredAmount": 400
}

Response

The dispute was closed.

disputeIdstring required

The id of the dispute record.

disputeTokenstring required

The card issuer's token for the dispute.

status'OPEN' | 'CLOSED' required

Whether the dispute is still active.

disposition'WON' | 'PARTIALLY_WON' | 'LOST' | 'WITHDRAWN' | 'DENIED' | 'null' nullable

The outcome once the dispute closes. Null while it is open.

Example response

{
  "disputeId": "019542f5-b3e7-1d02-0000-000000000200",
  "disputeToken": "dispute_transaction_sandbox_5f8d2c1a",
  "status": "OPEN",
  "disposition": "WON"
}

Changes