Disputes
The disputes object represents transactions that were disputed by the credit card account holder. Dispute records are automatically submitted to Forte by the processor. Merchants can view these records and upload supporting documentation using the documents object.
Disputes Object
Parameter | Description | Type | Req |
dispute_id | A unique string defined by Forte that represents a dispute. For example, dsp_31wef05ABpV2eZvKYlo54. | string | R |
transaction_id | A 36-character string that uniquely identifies the original transaction associated with this dispute. | string | R |
dispute_number | A unique, processor-defined number that identifies the dispute record. | string | R |
organization_id | The identification number of the associated organization. For example, org_5551236. | string | R |
location_id | The identification number of the associated location. For example, loc_1234568. | string | R |
status | The current status of the dispute. Supported values include the following: documents_needed - The merchant needs to provide documents to Forte. | string | R |
dispute_amount | The amount the cardholder is disputing. This amount must match the value of the original_amount parameter. | decimal | R |
original_amount | The original amount of the transaction. | decimal | R |
action_code | A code that indicates what actions to take in resolving the dispute. Supported values include the following: CACP - Accept of Collection | string | R |
adjustment_type | A code indicating the type of adjustment to be made for this dispute. Supported values include the following: DRFT - Credit Card Draft Retrieval | string | R |
received_date | The date and time that Forte received the dispute record from the processor. | datetime | R |
due_date | The date and time the resolution to the dispute is due. This date varies depending on whether or not the merchant is classified as a government or non-government merchant. | datetime | R |
last_update_date | The date and time when the dispute was last updated. | datetime | R |
last_funding_date | The date and time when the dispute was last funded. | datetime | R |
comment_from_issuer | Comments provided to the processor by the card issuer. | string | R |
reason | The Reason Object. | object | R |
reason.code | A code that represents the reason for the dispute. This code varies between issuers; however, MasterCard reason codes are prefaced with an M (e.g.,M9999), VISA reason codes are prefaced with a V (e.g., V9999), and Discover reason codes are prefaced with a D (e.g., D9999) | string | O |
reason.title | The name of the dispute reason. | string | R |
reason.description | A brief description of the dispute reason. | string | R |
reason.info_required | A comment about the dispute by a member of Forte's Risk Department. | string | R |
card | The Card Object | object | R |
card.card_type | The type of credit card [max length = 6]. Options for this field include the following: visa | string | R |
card.name_on_card | The name printed on the credit card [max length = 50]. | string | R |
card.last_4_account_number | The last four digits of the redacted account number. [max length = 4] |
GET All Disputes for an Organization
{{baseURI}}/organizations/org_{{organizationID}}/disputes/
This URI returns all the dispute records associated with an organization. To narrow your search data using specific criteria, use the following filter parameters. NOTE: Dispute calls cannot be tested in Sandbox.
`dispute_number`
`location_id`
`start_due_date` / `end_due_date`
`start_last_update_date` / `end_last_update_date`
`start_received_date` / `end_received_date`
`status`
`amount`
`card_type`
`action_code`
`name_on_card`
`last_4_account_number`
NOTES:Â The following filter parameters support the listed values:
card_type
disc
mast
visa
action_code
CACP
Â
CBRV
CDNL
CHGM
COLL
DRFT
MREV
MDNL
IREP
MACP
PADM
PARE
PCCR
PCHG
PCMP
PICR
PIDB
PMCR
PMDB
RTLV
status
accepted
deleted
documents_needed
expired
lost
pending
recalled
reviewing
won
Please note that sending a request at the partner (org) level may result in a large data set and may cause timeout errors depending on the request. We recommend sending your GET request at the Merchant (Organization) level.
Example Request
curl --location -g 'https://api.forte.net/v3/organizations/org_{{organizationID}}/disputes/' \
--header 'Authorization: {{Authorization}}' \
--header 'Accept: application/json' \
--header 'X-Forte-Auth-Organization-Id: org_{{AuthOrganizationID}}'
Example Response
GET All Disputes with Filter
{{baseURI}}/organizations/org_{{organizationID}}/disputes?filter=start_received_date+eq+'2018-12-07'+and+end_received_date+eq+'2018-12-12'
This URI returns all the dispute records associated with an organization. To narrow your search data using specific criteria, use the following filter parameters. NOTE: Dispute calls cannot be tested in Sandbox.
last_4_account_number
card_type
name_on_card
start_last_update_date / end_last_update_date
start_due_date / end_due_date
start_received_date / end_received_date
action_code
dispute_amount
status
dispute_number
transaction_id
location_id
organization_id
NOTES: The following filter parameters support the listed values:
card_type
amex
disc
jcb
mast
visa
action_code
CACP
CBRV
CDNL
CHGM
COLL
DRFT
MREV
MDNL
IREP
MACP
PADM
PARE
PCCR
PCHG
PCMP
PICR
PIDB
PMCR
PMDB
RTLV
status
accepted
deleted
documents_needed
expired
lost
pending
recalled
reviewing
won
Note:Â Please note that sending a request at the partner (org) level may result in a large data set and may cause timeout errors depending on the request. We recommend sending your GET request at the Merchant (Organization) level.
Example Request
curl --location 'https://api.forte.net/v3/organizations/org_300005/disputes?filter=start_received_date%2Beq%2B%272018-12-07%27%2Band%2Bend_received_date%2Beq%2B%272018-12-12%27%0A' \
--header 'Authorization: {{Authorization}}' \
--header 'Accept: application/json' \
--header 'X-Forte-Auth-Organization-Id: org_{{AuthOrganizationID}}'
Example Response
GET Disputes by ID
{{baseURI}}/organizations/org_{{organizationID}}/disputes/dsp_{{disputeID}}
This URI returns all the details of a specific dispute using the dispute_id in the route. NOTE: Dispute calls cannot be tested in Sandbox.
Example Request
curl --location -g 'https://api.forte.net/v3/organizations/org_{{organizationID}}/disputes/dsp_{{disputeID}}' \
--header 'Authorization: {{Authorization}}' \
--header 'Accept: application/json' \
--header 'X-Forte-Auth-Organization-Id: org_{{AuthOrganizationID}}'
Example Response