LIlightsparkdev
Sandbox

Simulate a provisional credit on a card dispute

Changed on

Instruct a provisional credit to the cardholder on the transaction's open dispute, as the card issuer does while a dispute runs. The credit is paid from the card's funding source when the platform is enabled for dispute funding.

Production returns 404 on this path.

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

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_provisional_credit
  • 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.

amountinteger required

The amount to credit, or to take back, in the smallest unit of the transaction's currency. Must not exceed the disputed amount.

Example request

{
  "cardTransactionId": "Transaction:019542f5-b3e7-1d02-0000-000000000100",
  "amount": 1500
}

Response

The credit was instructed.

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