LIlightsparkdev
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.

idstring required

System-generated unique dispute identifier.

cardTransactionIdstring required

The id of the disputed CardTransaction.

cardIdstring

The id of the Card the disputed transaction was made on.

status'OPEN' | 'CLOSED' required

Whether the dispute is still active.

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

The outcome the dispute closes with.

openedAtstring date-time

When the card issuer opened the dispute.

issuerUpdatedAtstring date-time

When the card issuer last changed the dispute.

createdAtstring date-time required

When Grid first recorded the dispute.

updatedAtstring date-time required

When Grid last updated the dispute.

Example response

{
  "id": "CardDispute:019542f5-b3e7-1d02-0000-000000000200",
  "cardTransactionId": "Transaction:019542f5-b3e7-1d02-0000-000000000100",
  "cardId": "Card:019542f5-b3e7-1d02-0000-000000000010",
  "status": "OPEN",
  "disposition": "WON",
  "disputedAmount": {
    "amount": 12550,
    "currency": {
      "code": "USD",
      "name": "United States Dollar",
      "symbol": "$",
      "decimals": 2
    }
  },
  "provisionalCreditAmount": {
    "amount": 12550,
    "currency": {
      "code": "USD",
      "name": "United States Dollar",
      "symbol": "$",
      "decimals": 2
    }
  },
  "openedAt": "2026-05-08T14:30:00Z",
  "issuerUpdatedAt": "2026-05-09T09:12:44Z",
  "createdAt": "2026-05-08T14:30:05Z",
  "updatedAt": "2026-05-09T09:12:46Z"
}

Changes

  • d996ddfb9d2bRevision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • 5abf2bb56bcbRevision changes
    • warning

      added the new CORRIDOR_UNDER_MAINTENANCE enum value to the response property for the response status