Sign in

v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB
Disputes

List disputes

Get disputes with paging and filter options.

get/v1/disputes

Query parameters

beginDatestring
Example:2020-01-31

Beginning date filter, format= yyyy-mm-dd

endDatestring
Example:2020-02-15

End date filter, format= yyyy-mm-dd.

pageinteger
Example:2

Page to return.

perPageinteger
Example:20

Number of items per page

accountIdinteger
Example:123

Account ID filter

isNetworkboolean
Example:true

Return only network disputes? Default is false.

isDisputeMigratedboolean
Example:true

Return only migrated disputes? Default is false.

isDisputeInvalidTransactionboolean
Example:true

Return only disputes with invalid transaction? Default is false.

group'OPEN' | 'APPROVED' | 'DENIED' | 'CARDNETWORK_CHARGEBACK' | 'ANALYSING' | 'CARDNETWORK_SECOND_PRESENTMENT' | 'FAILED' | 'CARDNETWORK_PREARBITRATION' | 'RESEND' | 'LOSS' | 'WON' | 'REJECTED' | 'FAILED_PROCESSED'
Example:CARDNETWORK_CHARGEBACK

Status group filter, i.e., OPEN.

status'OPENED' | 'PENDING' | 'CANCELED' | 'FAILED' | 'CHARGEBACK_REJECTED' | 'CHARGEBACK_CREATED' | 'CHARGEBACK_ACCEPTED' | 'CHARGEBACK_CLOSED' | 'SECOND_PRESENTMENT' | 'PRE_ARBITRATION_OPENED' | 'PRE_ARBITRATION_ACCEPTED' | 'PRE_ARBITRATION_DECLINED' | 'PRE_ARBITRATION_RECALL' | 'PRE_ARB_ALLOCATION_OPENED' | 'FAILED_PRE_ARBITRATION' | 'PRE_ARB_ALLOCATION_ACCEPTED' | 'PRE_ARB_ALLOCATION_DECLINED' | 'PRE_ARB_ALLOCATION_RECALLED' | 'FAILED_DECLINE_PRE_ARB' | 'FAILED_ACCEPT_PRE_ARB' | 'FAILED_ON_CLOSE' | 'EXPIRED' | 'ISSUER_LOSS' | 'MIGRATION' | 'FAILED_MIGRATION'
Example:OPENED

Status filter

Headers

Authorizationstring required
Example:Bearer eyJhbGci...IUzUx

Account token - an access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a <b>401 Unauthorized</b> message.

Response

OK

idnumber

Dispute ID

org_idstring

Organization ID

account_idinteger

Account ID

authorization_idinteger

Authorization ID.

disputed_amountnumber

Disputed amount.

commentstring nullable

Client custom dispute comment.

REQUIRED for Visa partial dispute to explain why partial.

airport_taxboolean

For ELO card network, should dispute for airport tax be created? Default is true for ELO.

airport_tax_partialboolean

For ELO card network, should airport tax be partially disputed? Default is false.

airport_tax_amountnumber

Airport tax amount to be disputed. REQUIRED if airport_tax_partial is true.

dispute_reasonnumber

Each card network, such as Visa or Mastercard, defines and maintains their own unique set of reason codes, which banks that issue credit and debit cards under their brands apply to disputes. Here's a reason code quick reference for the major credit card networks.

For Visa, this would be either 10 (fraud - card present), 11 (authorization), 12 (processing error), or 13 (consumer dispute).

For more infomation, refer to the Visa or Mastercard chargeback quides.

For example - 4853 (Mastercard - cardholder dispute), 12 (Visa - processing error) or 72 (ELO - denied authorization)

modalitynumber

Dispute modality - legacy term for reason code to file the dispute.

dispute_status'OPENED' | 'PENDING' | 'CANCELED' | 'FAILED' | 'CHARGEBACK_REJECTED' | 'CHARGEBACK_CREATED' | 'CHARGEBACK_ACCEPTED' | 'CHARGEBACK_CLOSED' | 'SECOND_PRESENTMENT' | 'PRE_ARBITRATION_OPENED' | 'PRE_ARBITRATION_ACCEPTED' | 'PRE_ARBITRATION_DECLINED' | 'PRE_ARBITRATION_RECALL' | 'PRE_ARB_ALLOCATION_OPENED' | 'FAILED_PRE_ARBITRATION' | 'PRE_ARB_ALLOCATION_ACCEPTED' | 'PRE_ARB_ALLOCATION_DECLINED' | 'PRE_ARB_ALLOCATION_RECALLED' | 'FAILED_DECLINE_PRE_ARB' | 'FAILED_ACCEPT_PRE_ARB' | 'FAILED_ON_CLOSE' | 'EXPIRED' | 'ISSUER_LOSS' | 'MIGRATION' | 'FAILED_MIGRATION'

Dispute status enums.

dispute_group_status'OPEN' | 'APPROVED' | 'DENIED' | 'CARDNETWORK_CHARGEBACK' | 'ANALYSING' | 'CARDNETWORK_SECOND_PRESENTMENT' | 'FAILED' | 'CARDNETWORK_PREARBITRATION' | 'RESEND' | 'LOSS' | 'WON' | 'REJECTED' | 'FAILED_PROCESSED'

Group status enums

timelinestring

Client custom timeline information.

protocolstring

Client custom protocol ID. This is primarily for you to internally identify a request. If not provided, Pismo creates a CID (correlation ID) field for this purpose.

metadatastring

Any data object with key/value pairs. No limit on length.

Note: This field must not be used to send Personally Identifiable Information (PII), Payment Card Industry (PCI) data, or any sensitive/regulated information. Metadata fields are intended for operational, non-sensitive data only. For sensitive data, use the specific parameters designed for that purpose. For more information, refer to Get started with Pismo APIs.

created_atstring date-time

Datetime program calendar strategy was created. Format = YYYY-MM-DDTHH:MM:SS:MM.

updated_atstring date

Dispute last updated date, format = yyyy-mm-dd.

created_at_utcstring date-time

Dispute created in UTC date/time.

updated_at_utcstring

When dispute updated in UTC date/time.

is_networkboolean

Open a dispute over a network authorization.

is_dispute_migratedboolean

Has this dispute been migrated to the Pismo platform?

reversal_idnumber

Dispute credit reversal ID.

network_return_reason_codestring

Network reason code response.

network_brand_type'Visa' | 'Mastercard' | 'Elo'

Network brand

transaction_datestring

Transaction date related to authorization, format = yyyy-mm-dd

stop_automated_installmentboolean

Automated dispute installment control flag. If an issuer opens a dispute for a transaction that has more than one installment, with installments that can still be posted, the issuer will need to open a dispute for subsequent installments as well. With automated dispute installment control, once you open a chargeback for the first installment, the same information can be used for subsequent transaction installments.

card_hashstring

Card number hash.

authorization_codestring

Authorization code

transaction_amountnumber

Transaction amount

is_dispute_invalid_transactionboolean

Is this an invalid authorization dispute?

Example response

[
  {
    "id": 48670,
    "org_id": "TN-cc8f8b89-233a-4582-9f36-63ee85278d6d",
    "account_id": 6912345,
    "authorization_id": 4352243,
    "disputed_amount": 10,
    "comment": "Custom comment",
    "airport_tax_amount": 25,
    "dispute_reason": 4853,
    "modality": 4855,
    "dispute_status": "PENDING",
    "dispute_group_status": "OPEN",
    "timeline": "{ \"data\": \"test\"}",
    "protocol": "20251128111532456",
    "metadata": "{ \"key\": \"value\"}",
    "created_at": "2024-09-12T16:46:16.43663522",
    "updated_at": "2021-02-22",
    "created_at_utc": "2021-02-21T22:51:43.000000000Z",
    "updated_at_utc": "2022-10-13T19:56:010000000Z",
    "is_network": true,
    "reversal_id": 10042,
    "network_return_reason_code": "2833",
    "network_brand_type": "Visa",
    "transaction_date": "2021-02-02",
    "stop_automated_installment": true,
    "card_hash": "XYZddue74kd8",
    "authorization_code": "F0JR9H",
    "transaction_amount": 86753.09
  }
]