Sign in
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.

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