openapi: 3.2.0
info:
title: Dispute API 2.0 Intake Flow API
version: '1.0'
servers:
- url: dispute-api-{corename}.{env}.gpsrv.com/
tags:
- name: Intake Flow
paths:
/submitCase:
post:
summary: Submit Case
description: '> 👍 Availability
>
> No new clients will be set up with Dispute API 2.0. Legacy clients will eventually be migrated to Dispute API 3.0.
Use the Submit Case endpoint to finalize a dispute case when the account holder presses a "submit" button on your user interface.
This endpoint is part of a conversational API—a series of endpoint calls that must be made in a certain order. For instructions see the Creating an API 2.0 Dispute guide.
- **Previous endpoint:** Get Case Summary
- **Next endpoint:** _Optional_. Get Case Confirmation'
parameters: []
tags:
- Intake Flow
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
apiLogin:
type: string
description: 'Provider''s web service username, as provided by Galileo for the requesting IP address.
Pattern: Max 50 characters
Example: `"AbC123-9999"`'
example: AbC123-9999
apiTransKey:
type: string
description: 'Web service password, as provided by Galileo for the requesting IP address.
Pattern: Max 15 characters
Example: `"4sb62fh6w4h7w34g"`'
example: 4sb62fh6w4h7w34g
providerId:
type: integer
format: int32
description: 'Galileo-issued unique provider identifier.
Pattern: Max 10 digits
Example: `9999`'
example: 9999
transactionId:
type: string
minimum: 1
maximum: 60
description: 'A provider-generated ID that is unique to each API call. A UUID is preferred. Do not reuse this identifier for multiple API calls.
Pattern: 60 characters or less
Example: `"9845dk-39fdk3fj3-4483483478"`'
example: 9845dk-39fdk3fj3-4483483478
caseId:
type: string
pattern: ^$|^([0-9]{11}[A-Z]{1})$
description: 'Case identifier as returned by Create Case.
Pattern: Max 11 digits with a letter
Example: "`22021000017C`"'
example: 22021000017C
questionnaire:
type: string
description: 'Array of `identifier`/`answerValue` pairs from the questionnaire returned by Get Case Summary. Populate this field with answers about updating the contact date. Do not permit the account holder to update the contact date. Answers about contact information should be passed in `correspondenceDetails`.
Pattern: JSON array
Example: ` [{"identifier": "", "answerValue": ""}, {"identifier": "", "answerValue": ""}]`'
example: " [\n {\n \"identifier\": \"OverrideContactDate\",\n \"answerValue\": \"8/18/23\"\n },\n {\n \"identifier\": \"IsContactDateOverridden\",\n \"answerValue\": \"True\"\n },\n {\n \"identifier\": \"ContactDateOverrideReason\",\n \"answerValue\": \"Application error\"\n }\n ]"
correspondenceDetails:
type: string
description: 'Populate this field to change contact information just for this case. This value updates the contact information for this case only, not the account holder''s existing record. See `correspondenceDetails` Subfields for valid values.
Pattern: JSON array
Example: `''{''selectedChannel'': ''Email'', ''emailAddress'': ''test@example.com''}''`'
example: "\n {\n \"selectedChannel\":\"Mail\",\n \"address\": {\n \"line1\":\"123 Crimson St\",\n \"line2\":\"Apt B6\",\n \"line3\":\"ATTN: Supervisor\",\n \"city\":\"Seattle\",\n \"state\":\"WA\",\n \"zip\":\"98109-0032\",\n \"country\":\"USA\"\n }\n }\n "
required:
- apiLogin
- apiTransKey
- caseId
- providerId
- transactionId
responses:
default:
description: ''
content:
application/json:
schema:
type: object
properties:
statusCode:
type:
- integer
- 'null'
format: int32
description: The response status code
status:
type:
- string
- 'null'
description: The condition of a process or response
processingTime:
type:
- number
- 'null'
format: float
description: The time elapsed in processing the transaction
echo:
description: A structure that contains transaction ID information
type:
- object
- 'null'
properties:
transactionId:
type:
- string
- 'null'
description: The `transactionId` that was passed in the API request
required:
- transactionId
systemTimestamp:
type:
- string
- 'null'
format: date-time
description: A system generated timestamp
rtoken:
type:
- string
- 'null'
description: A Galileo-generated ID used for tracking
errors:
type: array
description: A list of errors generated while the request was processed
items:
type: string
responseData:
description: A structure for the response data. This endpoint does not return response data, so it will always be empty.
type: object
properties: {}
required:
- echo
- processingTime
- responseData
- rtoken
- status
- statusCode
- systemTimestamp
examples:
response:
value: "{\n \"statusCode\": 0,\n \"status\": \"Success\",\n \"processingTime\": 0.081,\n \"responseData\": {},\n \"echo\": {\n \"transactionId\": \"9845dk-39fdk3fj3-4483483478\"\n },\n \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\",\n \"systemTimestamp\": \"2020-07-13 10:38:13\"\n}\n"
operationId: dispute_post_submitcase
/createCase:
post:
summary: Create Case
description: '> 👍 Availability
>
> No new clients will be set up with Dispute API 2.0. Legacy clients will eventually be migrated to Dispute API 3.0.
Use the Create Case endpoint to initiate a dispute claim. A single claim may contain multiple disputed transactions. Call this endpoint when the account holder initiates a claim by clicking a "dispute a transaction" control on your interface.
This endpoint returns a case number (`caseId`) that you pass with all subsequent endpoint calls that are related to this dispute.
This endpoint is part of a conversational API—a series of endpoint calls that must be made in a certain order. For instructions see the Creating an API 2.0 Dispute guide.
- **Next endpoint:** Get Case Reasons'
parameters: []
tags:
- Intake Flow
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
apiLogin:
type: string
description: 'Provider''s web service username, as provided by Galileo for the requesting IP address.
Pattern: Max 50 characters
Example: `"AbC123-9999"`'
example: AbC123-9999
apiTransKey:
type: string
description: 'Web service password, as provided by Galileo for the requesting IP address.
Pattern: Max 15 characters
Example: `"4sb62fh6w4h7w34g"`'
example: 4sb62fh6w4h7w34g
providerId:
type: integer
format: int32
description: 'Galileo-issued unique provider identifier.
Pattern: Max 10 digits
Example: `9999`'
example: 9999
transactionId:
type: string
minimum: 1
maximum: 60
description: 'A provider-generated ID that is unique to each API call. A UUID is preferred. Do not reuse this identifier for multiple API calls.
Pattern: 60 characters or less
Example: `"9845dk-39fdk3fj3-4483483478"`'
example: 9845dk-39fdk3fj3-4483483478
accountNo:
type: string
pattern: ^$|^([0-9]{12}|[0-9]{16})$
description: 'The <> or <> of the account. If more than one card is associated with the PRN, use the PAN.
Pattern: PAN or PRN
Example: `"074103447228"`'
example: 074103447228
required:
- accountNo
- apiLogin
- apiTransKey
- providerId
- transactionId
responses:
default:
description: ''
content:
application/json:
schema:
type: object
properties:
statusCode:
type:
- integer
- 'null'
format: int32
description: The response status code
status:
type:
- string
- 'null'
description: The condition of a process or response
processingTime:
type:
- number
- 'null'
format: float
description: The time elapsed in processing the transaction
echo:
description: A structure that contains transaction ID information
type:
- object
- 'null'
properties:
transactionId:
type:
- string
- 'null'
description: The `transactionId` that was passed in the API request
required:
- transactionId
systemTimestamp:
type:
- string
- 'null'
format: date-time
description: A system generated timestamp
rtoken:
type:
- string
- 'null'
description: A Galileo-generated ID used for tracking
errors:
type: array
description: A list of errors generated while the request was processed
items:
type: string
responseData:
description: A structure for the response data. It can be empty but usually will contain information.
type:
- object
- 'null'
properties:
caseId:
type: string
description: The case identifier that you will use in all subsequent calls for the dispute that you initiated with this call. This number is unique across Galileo.
required:
- caseId
required:
- echo
- processingTime
- responseData
- rtoken
- status
- statusCode
- systemTimestamp
examples:
response:
value: "{\n \"statusCode\": 0,\n \"status\": \"Success\",\n \"processingTime\": 0.081,\n \"responseData\": {\n \"caseId\":\"12345678\"\n },\n \"echo\": {\n \"transactionId\": \"9845dk-39fdk3fj3-4483483478\"\n },\n \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\",\n \"systemTimestamp\": \"2020-07-13 10:38:13\"\n}\n"
operationId: dispute_post_createcase
/getCaseReasons:
post:
summary: Get Case Reasons
description: '> 👍 Availability
>
> No new clients will be set up with Dispute API 2.0. Legacy clients will eventually be migrated to Dispute API 3.0.
Use the Get Case Reasons endpoint to retrieve the case reasons, which are questions and answers that you display to the account holder during the creation of a dispute case. The answers to these questions classify the type of dispute and provide a reason for the dispute. The case reasons are radio buttons so that the account holder can select only one option.
This endpoint is part of a conversational API—a series of endpoint calls that must be made in a certain order. For instructions see the Creating an API 2.0 Dispute guide.
- **Previous endpoint:** Create Case
- **Next endpoint:** Add Case Reasons'
parameters: []
tags:
- Intake Flow
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
apiLogin:
type: string
description: 'Provider''s web service username, as provided by Galileo for the requesting IP address.
Pattern: Max 50 characters
Example: `"AbC123-9999"`'
example: AbC123-9999
apiTransKey:
type: string
description: 'Web service password, as provided by Galileo for the requesting IP address.
Pattern: Max 15 characters
Example: `"4sb62fh6w4h7w34g"`'
example: 4sb62fh6w4h7w34g
providerId:
type: integer
format: int32
description: 'Galileo-issued unique provider identifier.
Pattern: Max 10 digits
Example: `9999`'
example: 9999
transactionId:
type: string
minimum: 1
maximum: 60
description: 'A provider-generated ID that is unique to each API call. A UUID is preferred. Do not reuse this identifier for multiple API calls.
Pattern: 60 characters or less
Example: `"9845dk-39fdk3fj3-4483483478"`'
example: 9845dk-39fdk3fj3-4483483478
caseId:
type: string
pattern: ^$|^([0-9]{11}[A-Z]{1})$
description: 'Case identifier as returned by Create Case.
Pattern: Max 11 digits with a letter
Example: "`22021000017C`"'
example: 22021000017C
required:
- apiLogin
- apiTransKey
- caseId
- providerId
- transactionId
responses:
default:
description: ''
content:
application/json:
schema:
type: object
properties:
statusCode:
type:
- integer
- 'null'
format: int32
description: The response status code
status:
type:
- string
- 'null'
description: The condition of a process or response
processingTime:
type:
- number
- 'null'
format: float
description: The time elapsed in processing the transaction
echo:
description: A structure that contains transaction ID information
type:
- object
- 'null'
properties:
transactionId:
type:
- string
- 'null'
description: The `transactionId` that was passed in the API request
required:
- transactionId
systemTimestamp:
type:
- string
- 'null'
format: date-time
description: A system generated timestamp
rtoken:
type:
- string
- 'null'
description: A Galileo-generated ID used for tracking
errors:
type: array
description: A list of errors generated while the request was processed
items:
type: string
responseData:
description: A structure for the response data. It can be empty but usually will contain information.
type:
- object
- 'null'
properties:
questionList:
type: object
properties:
questionList:
type: array
description: List of questions to present
items:
type: object
properties:
identifier:
type: string
description: Tag for the question
format:
type: string
enum:
- Caption
- Default
- Internal
- Notification
- Warning
description: Metadata describing the question format. It can be used to optionally provide different visual treatment
dataType:
type: string
description: Data type for the question
answerList:
type: array
description: List of answers for a question
items:
type: object
properties:
identifier:
type: string
description: Tag for the answer
questionList:
type: array
description: List of questions to present
items:
type: object
properties: {}
displayText:
type: string
description: Text to display of the question or answer
required:
- displayText
- identifier
isOptional:
type: boolean
description: Is this question an optional?
selectedAnswer:
type: string
description: The selected answer to this question. This could be a default for an initially loaded questionnaire or a persisted previous answer.
type:
type: string
enum:
- YesNo
- Date
- DateTime
- Text
- TextMulti
- Dropdown
- AutoComplete
- RadioButtons
- Checkboxes
- MultiSelect
- Decimal
- Integer
- Currency
- RichText
- Nothing
- Section
- Questionnaire
description: Type of question
apiDocumentationList:
type: array
description: This is returned for questions of type Section. It contains the implementation details to provide the answer to the questions.
items:
type: object
properties:
implementationNotes:
type: string
description: Description of the connector.
method:
type: string
description: Method for REST connector (always 'post').
endpoint:
type: string
description: REST connector endpoint suffix.
required:
- endpoint
- implementationNotes
displayText:
type: string
description: Text of the question to display
required:
- answerList
- dataType
- displayText
- identifier
- type
required:
- questionList
required:
- echo
- processingTime
- responseData
- rtoken
- status
- statusCode
- systemTimestamp
examples:
response:
value: "{\n \"statusCode\": 0,\n \"status\": \"Success\",\n \"processingTime\": 24.609,\n \"responseData\": {\n \"questionList\": [\n {\n \"type\": \"RadioButtons\",\n \"identifier\": \"ClaimReasonType\",\n \"displayText\": \"Which of the following would you like to report?\",\n \"dataType\": \"String\",\n \"answerList\": [\n {\n \"questionList\": [\n {\n \"type\": \"RadioButtons\",\n \"identifier\": \"ClaimReason\",\n \"displayText\": \"Which of the following best describes the reason for your dispute?\",\n \"dataType\": \"String\",\n \"answerList\": [\n {\n \"identifier\": \"MerchantDuplicate\",\n \"displayText\": \"I was charged more than once.\"\n },\n {\n \"identifier\": \"MerchantNotProvided\",\n \"displayText\": \"I haven't received merchandise or a service I purchased.\"\n },\n {\n \"identifier\": \"MerchantCreditNotIssued\",\n \"displayText\": \"I cancelled or returned the merchandise or service and have not received the expected credit.\"\n },\n {\n \"identifier\": \"MerchantRecurring\",\n \"displayText\": \"I have an issue with a recurring transaction on my account.\"\n },\n {\n \"identifier\": \"MerchandiseServiceIssue\",\n \"displayText\": \"I am dissatisfied with the merchandise or a service I received.\"\n },\n {\n \"identifier\": \"ChargedCreditedIncorrect\",\n \"displayText\": \"I was charged or credited incorrectly.\"\n }\n ]\n }\n ],\n \"identifier\": \"NonFraud\",\n \"displayText\": \"I made this purchase, but there is a problem and I need to dispute it.\"\n },\n {\n \"questionList\": [\n {\n \"type\": \"RadioButtons\",\n \"identifier\": \"ClaimReason\",\n \"displayText\": \"Which of the following best describes the reason for your dispute?\",\n \"dataType\": \"String\",\n \"answerList\": [\n {\n \"identifier\": \"CardLost\",\n \"displayText\": \"I lost my card.\"\n },\n {\n \"identifier\": \"CardStolen\",\n \"displayText\": \"My card was stolen.\"\n },\n {\n \"identifier\": \"CardNotReceived\",\n \"displayText\": \"I did not receive my card.\"\n },\n {\n \"identifier\": \"CardSecure\",\n \"displayText\": \"I didn't make the purchase, but I still have my card.\"\n }\n ]\n }\n ],\n \"identifier\": \"Fraud\",\n \"displayText\": \"I did not authorize this transaction. I suspect fraud.\"\n },\n {\n \"questionList\": [\n {\n \"type\": \"RadioButtons\",\n \"identifier\": \"ClaimReason\",\n \"displayText\": \"Tell us about the reason behind the dispute.\",\n \"dataType\": \"String\",\n \"answerList\": [\n {\n \"identifier\": \"ATMPar\",\n \"displayText\": \"I did not receive cash or received partial cash at an ATM.\"\n }\n ]\n }\n ],\n \"identifier\": \"NonFraudATM\",\n \"displayText\": \"I had an issue while using my card at an ATM.\"\n },\n {\n \"identifier\": \"AuthChargeback\",\n \"displayText\": \"There is an authorization issue.\"\n }\n ]\n }\n ]\n },\n \"echo\": {\n \"transactionId\": \"fa93a690-0b4a-4039-8437-fac9ffc1cbaa\"\n },\n \"systemTimestamp\": \"2022-04-14 14:52:55\",\n \"rtoken\": \"3f6fa179-c510-4214-b96b-8f0a03d0912c\"\n}\n"
operationId: dispute_post_getcasereasons
/addCaseReasons:
post:
summary: Add Case Reasons
description: '> 👍 Availability
>
> No new clients will be set up with Dispute API 2.0. Legacy clients will eventually be migrated to Dispute API 3.0.
Use the Add Case Reasons endpoint to submit the account holder''s answers to the case-reason questions while creating a dispute claim.
This endpoint is part of a conversational API—a series of endpoint calls that must be made in a certain order. For instructions see the Creating an API 2.0 Dispute guide.
- **Previous endpoint:** Get Case Reasons
- **Next endpoint:** Get Transactions'
parameters: []
tags:
- Intake Flow
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
apiLogin:
type: string
description: 'Provider''s web service username, as provided by Galileo for the requesting IP address.
Pattern: Max 50 characters
Example: `"AbC123-9999"`'
example: AbC123-9999
apiTransKey:
type: string
description: 'Web service password, as provided by Galileo for the requesting IP address.
Pattern: Max 15 characters
Example: `"4sb62fh6w4h7w34g"`'
example: 4sb62fh6w4h7w34g
providerId:
type: integer
format: int32
description: 'Galileo-issued unique provider identifier.
Pattern: Max 10 digits
Example: `9999`'
example: 9999
transactionId:
type: string
minimum: 1
maximum: 60
description: 'A provider-generated ID that is unique to each API call. A UUID is preferred. Do not reuse this identifier for multiple API calls.
Pattern: 60 characters or less
Example: `"9845dk-39fdk3fj3-4483483478"`'
example: 9845dk-39fdk3fj3-4483483478
caseId:
type: string
pattern: ^$|^([0-9]{11}[A-Z]{1})$
description: 'Case identifier as returned by Create Case.
Pattern: Max 11 digits with a letter
Example: "`22021000017C`"'
example: 22021000017C
questionnaire:
type: string
description: 'Array of `identifier`/`answerValue` pairs.
Pattern: JSON array
Example: `[{"identifier": "", "answerValue": ""}]`'
example: "[\n {\n \"Identifier\": \"ClaimTransType\",\n \"AnswerValue\": \"true\"\n },\n {\n \"Identifier\": \"ClaimReasonType\",\n \"AnswerValue\": \"Fraud\"\n },\n {\n \"Identifier\": \"ClaimReason\",\n \"AnswerValue\": \"CardSecure\"\n }\n ]"
required:
- apiLogin
- apiTransKey
- caseId
- providerId
- transactionId
responses:
default:
description: ''
content:
application/json:
schema:
type: object
properties:
statusCode:
type:
- integer
- 'null'
format: int32
description: The response status code
status:
type:
- string
- 'null'
description: The condition of a process or response
processingTime:
type:
- number
- 'null'
format: float
description: The time elapsed in processing the transaction
echo:
description: A structure that contains transaction ID information
type:
- object
- 'null'
properties:
transactionId:
type:
- string
- 'null'
description: The `transactionId` that was passed in the API request
required:
- transactionId
systemTimestamp:
type:
- string
- 'null'
format: date-time
description: A system generated timestamp
rtoken:
type:
- string
- 'null'
description: A Galileo-generated ID used for tracking
errors:
type: array
description: A list of errors generated while the request was processed
items:
type: string
responseData:
description: A structure for the response data. This endpoint does not return response data, so it will always be empty.
type: object
properties: {}
required:
- echo
- processingTime
- responseData
- rtoken
- status
- statusCode
- systemTimestamp
examples:
response:
value: "{\n \"statusCode\": 0,\n \"status\": \"Success\",\n \"processingTime\": 0.081,\n \"responseData\": {},\n \"echo\": {\n \"transactionId\": \"9845dk-39fdk3fj3-4483483478\"\n },\n \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\",\n \"systemTimestamp\": \"2020-07-13 10:38:13\"\n}\n"
operationId: dispute_post_addcasereasons
/getTransactions:
post:
summary: Get Transactions
description: '> 👍 Availability
>
> No new clients will be set up with Dispute API 2.0. Legacy clients will eventually be migrated to Dispute API 3.0.
Use the Get Transactions endpoint to retrieve the account holder transactions that are eligible to be disputed. You can filter the results by start date, end date, amount, and merchant name.
This endpoint is part of a conversational API—a series of endpoint calls that must be made in a certain order. For instructions see the Creating an API 2.0 Dispute guide.
- **Previous endpoint:** Add Case Reasons
- **Next endpoint:** Add Transactions'
parameters: []
tags:
- Intake Flow
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
apiLogin:
type: string
description: 'Provider''s web service username, as provided by Galileo for the requesting IP address.
Pattern: Max 50 characters
Example: `"AbC123-9999"`'
example: AbC123-9999
apiTransKey:
type: string
description: 'Web service password, as provided by Galileo for the requesting IP address.
Pattern: Max 15 characters
Example: `"4sb62fh6w4h7w34g"`'
example: 4sb62fh6w4h7w34g
providerId:
type: integer
format: int32
description: 'Galileo-issued unique provider identifier.
Pattern: Max 10 digits
Example: `9999`'
example: 9999
transactionId:
type: string
minimum: 1
maximum: 60
description: 'A provider-generated ID that is unique to each API call. A UUID is preferred. Do not reuse this identifier for multiple API calls.
Pattern: 60 characters or less
Example: `"9845dk-39fdk3fj3-4483483478"`'
example: 9845dk-39fdk3fj3-4483483478
caseId:
type: string
pattern: ^$|^([0-9]{11}[A-Z]{1})$
description: 'Case identifier as returned by Create Case.
Pattern: Max 11 digits with a letter
Example: "`22021000017C`"'
example: 22021000017C
startDate:
type: string
format: date
description: 'The starting date for the transactions to return.
Pattern: YYYY-MM-DD
Example: `"2023-11-01"`'
example: '2023-11-01'
endDate:
type: string
format: date
description: 'The ending date of the transactions to return.
Pattern: YYYY-MM-DD
Example: `"2023-11-30"`'
example: '2023-11-30'
amount:
type: number
format: float
minimum: 0.01
maximum: 999999999999.99
description: 'Amount of the transaction to return.
Pattern: Positive integer or decimal number
Example: `100.00`, `100`, or `100.73`'
example: 25.5
merchantName:
type: string
description: 'Name of the merchant that performed the transaction.
Pattern: string
Example: `"DoorDash"`'
example: DoorDash
required:
- apiLogin
- apiTransKey
- caseId
- providerId
- transactionId
responses:
default:
description: ''
content:
application/json:
schema:
type: object
properties:
statusCode:
type:
- integer
- 'null'
format: int32
description: The response status code
status:
type:
- string
- 'null'
description: The condition of a process or response
processingTime:
type:
- number
- 'null'
format: float
description: The time elapsed in processing the transaction
echo:
description: A structure that contains transaction ID information
type:
- object
- 'null'
properties:
transactionId:
type:
- string
- 'null'
description: The `transactionId` that was passed in the API request
required:
- transactionId
systemTimestamp:
type:
- string
- 'null'
format: date-time
description: A system generated timestamp
rtoken:
type:
- string
- 'null'
description: A Galileo-generated ID used for tracking
errors:
type: array
description: A list of errors generated while the request was processed
items:
type: string
responseData:
description: A structure for the response data. It can be empty but usually will contain information.
type:
- object
- 'null'
properties:
transactionList:
type: array
description: JSON list of transactions and their attributes
items:
type: object
properties:
selectMode:
type: string
description: 'The selection mode for the dispute: `Multi` — Multiple transactions can be selected for this claim type. `Single` — Only one transaction can be selected for this claim type.'
amount:
type: string
description: Amount of the transaction
transactionDateTime:
type: string
description: 'The date-time when the transaction was authorized. Format: yyyyMMdd`T`HHmmss.SSS z'
cardNumberEndingIn:
type: string
description: Last four digits of the PAN
authorizationStatus:
type: string
description: Whether the transaction is `Posted` or `Pending`
amountInfo:
description: Description of the currency of `amount`
type: object
properties:
isoCurrencyName:
type: string
description: Currency name.
amount:
type: string
description: Amount of the transaction in this currency.
isoCodeAlpha:
type: string
description: ISO 4217 alphabetic currency code.
isoCodeNumeric:
type: string
description: ISO 4217 numeric currency code.
exponent:
type: string
description: Number of places after the decimal that the currency uses.
transactionType:
type: string
description: Type of transaction. See Transaction entries in *Creating a Dispute* for definitions.
description:
type: string
description: Description of the transaction
debitCredit:
type: string
description: Whether the transaction debits or credits the account
date:
type: string
description: 'Date of the transaction: YYYYMMDD'
postingDateTime:
type: string
description: 'The date-time when the transaction was posted (settled). Format: yyyyMMdd`T`HHmmss.SSS z'
transactionId:
type: string
description: Identifier provided by the disputes engine for the transaction
required:
- amount
- authorizationStatus
- cardNumberEndingIn
- date
- debitCredit
- description
- postingDateTime
- selectMode
- transactionDateTime
- transactionId
- transactionType
required:
- echo
- processingTime
- responseData
- rtoken
- status
- statusCode
- systemTimestamp
examples:
response:
value: "{\n \"StatusList\": [\n {\n \"Type\": \"Success\",\n \"Message\": \"Success\",\n \"Code\": \"200\"\n }\n ],\n \"TransactionList\": [\n {\n \"AuthorizationStatus\": \"Pending\",\n \"DebitCredit\": \"Debit\",\n \"TransactionType\": \"CardPinless\",\n \"Description\": \"LA VICTORIA NO 3 (10.1)\",\n \"Amount\": \"99.97\",\n \"AmountInfo\": {\n \"Exponent\": 2,\n \"ISOCodeNumeric\": \"840\",\n \"Amount\": 99.97,\n \"ISOCurrencyName\": \"US Dollar\",\n \"ISOCodeAlpha\": \"USD\"\n },\n \"CardNumberEndingIn\": \"7413\",\n \"Date\": \"20210627\",\n \"TransactionDateTime\": \"20210627T130621.123 GMT\",\n \"SelectMode\": \"Multi\",\n \"TransactionId\": \"5\"\n },\n {\n \"AuthorizationStatus\": \"Posted\",\n \"DebitCredit\": \"Debit\",\n \"TransactionType\": \"ATMWD\",\n \"Description\": \"7-ELEVEN 22177 (CHIP)\",\n \"Amount\": \"27.50\",\n \"AmountInfo\": {\n \"Exponent\": 2,\n \"ISOCodeNumeric\": \"840\",\n \"Amount\": 27.5,\n \"ISOCurrencyName\": \"US Dollar\",\n \"ISOCodeAlpha\": \"USD\"\n },\n \"CardNumberEndingIn\": \"7413\",\n \"Date\": \"20210626\",\n \"TransactionDateTime\": \"20210625T130621.123 GMT\",\n \"PostingDateTime\": \"20210626T050000.000 GMT\",\n \"SelectMode\": \"Multi\",\n \"TransactionId\": \"460268821703314\"\n },\n {\n \"AuthorizationStatus\": \"Posted\",\n \"DebitCredit\": \"Debit\",\n \"TransactionType\": \"CardPinless\",\n \"Description\": \"LA VICTORIA NO 3 (10.1)\",\n \"Amount\": \"30.97\",\n \"AmountInfo\": {\n \"Exponent\": 2,\n \"ISOCodeNumeric\": \"840\",\n \"Amount\": 30.97,\n \"ISOCurrencyName\": \"US Dollar\",\n \"ISOCodeAlpha\": \"USD\"\n },\n \"CardNumberEndingIn\": \"7413\",\n \"Date\": \"20210624\",\n \"TransactionDateTime\": \"20210623T130621.123 GMT\",\n \"PostingDateTime\": \"20210624T050000.000 GMT\",\n \"SelectMode\": \"Multi\",\n \"TransactionId\": \"5\"\n },\n {\n \"AuthorizationStatus\": \"Posted\",\n \"DebitCredit\": \"Debit\",\n \"TransactionType\": \"CardPinless\",\n \"Description\": \"CRUNCH BELLE ISLE (10.3)\",\n \"Amount\": \"26.57\",\n \"AmountInfo\": {\n \"Exponent\": 2,\n \"ISOCodeNumeric\": \"840\",\n \"Amount\": 26.57,\n \"ISOCurrencyName\": \"US Dollar\",\n \"ISOCodeAlpha\": \"USD\"\n },\n \"CardNumberEndingIn\": \"7413\",\n \"Date\": \"20210617\",\n \"TransactionDateTime\": \"20210616T130621.123 GMT\",\n \"PostingDateTime\": \"20210617T050000.000 GMT\",\n \"SelectMode\": \"Multi\",\n \"TransactionId\": \"8\"\n },\n {\n \"AuthorizationStatus\": \"Posted\",\n \"DebitCredit\": \"Debit\",\n \"TransactionType\": \"CardPinless\",\n \"Description\": \"Chargeback Response E-900000049\",\n \"Amount\": \"98.99\",\n \"AmountInfo\": {\n \"Exponent\": 2,\n \"ISOCodeNumeric\": \"840\",\n \"Amount\": 98.99,\n \"ISOCurrencyName\": \"US Dollar\",\n \"ISOCodeAlpha\": \"USD\"\n },\n \"CardNumberEndingIn\": \"7413\",\n \"Date\": \"20210611\",\n \"TransactionDateTime\": \"20210610T130621.123 GMT\",\n \"PostingDateTime\": \"20210611T050000.000 GMT\",\n \"SelectMode\": \"Multi\",\n \"TransactionId\": \"13\"\n },\n {\n \"AuthorizationStatus\": \"Posted\",\n \"DebitCredit\": \"Debit\",\n \"TransactionType\": \"CardPinless\",\n \"Description\": \"123.COM (10.4)\",\n \"Amount\": \"39.99\",\n \"AmountInfo\": {\n \"Exponent\": 2,\n \"ISOCodeNumeric\": \"840\",\n \"Amount\": 39.99,\n \"ISOCurrencyName\": \"US Dollar\",\n \"ISOCodeAlpha\": \"USD\"\n },\n \"CardNumberEndingIn\": \"7413\",\n \"Date\": \"20210602\",\n \"TransactionDateTime\": \"20210601T130621.123 GMT\",\n \"PostingDateTime\": \"20210602T050000.000 GMT\",\n \"SelectMode\": \"Multi\",\n \"TransactionId\": \"3\"\n },\n {\n \"AuthorizationStatus\": \"Posted\",\n \"DebitCredit\": \"Debit\",\n \"TransactionType\": \"CardPinless\",\n \"Description\": \"123.COM2\",\n \"Amount\": \"39.99\",\n \"AmountInfo\": {\n \"Exponent\": 2,\n \"ISOCodeNumeric\": \"840\",\n \"Amount\": 39.99,\n \"ISOCurrencyName\": \"US Dollar\",\n \"ISOCodeAlpha\": \"USD\"\n },\n \"CardNumberEndingIn\": \"7413\",\n \"Date\": \"20210602\",\n \"TransactionDateTime\": \"20210601T130621.123 GMT\",\n \"PostingDateTime\": \"20210602T050000.000 GMT\",\n \"SelectMode\": \"Multi\",\n \"TransactionId\": \"4\"\n },\n {\n \"AuthorizationStatus\": \"Posted\",\n \"DebitCredit\": \"Debit\",\n \"TransactionType\": \"CardPinless\",\n \"Description\": \"BASECAMP FITNESS (10.1)\",\n \"Amount\": \"79.99\",\n \"AmountInfo\": {\n \"Exponent\": 2,\n \"ISOCodeNumeric\": \"840\",\n \"Amount\": 79.99,\n \"ISOCurrencyName\": \"US Dollar\",\n \"ISOCodeAlpha\": \"USD\"\n },\n \"CardNumberEndingIn\": \"7413\",\n \"Date\": \"20210408\",\n \"TransactionDateTime\": \"20210407T130621.123 GMT\",\n \"PostingDateTime\": \"20210408T050000.000 GMT\",\n \"SelectMode\": \"Multi\",\n \"TransactionId\": \"2\"\n },\n {\n \"AuthorizationStatus\": \"Pending\",\n \"DebitCredit\": \"Debit\",\n \"TransactionType\": \"CardPinless\",\n \"Description\": \"LA VICTORIA NO 3\",\n \"Amount\": \"30.97\",\n \"AmountInfo\": {\n \"Exponent\": 2,\n \"ISOCodeNumeric\": \"840\",\n \"Amount\": 30.97,\n \"ISOCurrencyName\": \"US Dollar\",\n \"ISOCodeAlpha\": \"USD\"\n },\n \"CardNumberEndingIn\": \"7413\",\n \"Date\": \"20201123\",\n \"TransactionDateTime\": \"20201123T130621.123 GMT\",\n \"PostingDateTime\": \"20201123T050000.000 GMT\",\n \"SelectMode\": \"Multi\",\n \"TransactionId\": \"10\"\n },\n {\n \"AuthorizationStatus\": \"Posted\",\n \"DebitCredit\": \"Credit\",\n \"TransactionType\": \"CardPinless\",\n \"Description\": \"BIODIETSUPPLEMENTS.COM (10.4)\",\n \"Amount\": \"91.74\",\n \"AmountInfo\": {\n \"Exponent\": 2,\n \"ISOCodeNumeric\": \"840\",\n \"Amount\": 91.74,\n \"ISOCurrencyName\": \"US Dollar\",\n \"ISOCodeAlpha\": \"USD\"\n },\n \"CardNumberEndingIn\": \"7413\",\n \"Date\": \"20201115\",\n \"TransactionDateTime\": \"20201115T130621.123 GMT\",\n \"PostingDateTime\": \"20201115T050000.000 GMT\",\n \"SelectMode\": \"Multi\",\n \"TransactionId\": \"11\"\n },\n {\n \"AuthorizationStatus\": \"Posted\",\n \"DebitCredit\": \"Debit\",\n \"TransactionType\": \"CardPinless\",\n \"Description\": \"BIODIETSUPPLEMENTS.COM (10.4)\",\n \"Amount\": \"91.74\",\n \"AmountInfo\": {\n \"Exponent\": 2,\n \"ISOCodeNumeric\": \"840\",\n \"Amount\": 91.74,\n \"ISOCurrencyName\": \"US Dollar\",\n \"ISOCodeAlpha\": \"USD\"\n },\n \"CardNumberEndingIn\": \"7411\",\n \"Date\": \"20200615\",\n \"TransactionDateTime\": \"20200615T130621.123 GMT\",\n \"PostingDateTime\": \"20200615T050000.000 GMT\",\n \"SelectMode\": \"Multi\",\n \"TransactionId\": \"6\"\n },\n {\n \"AuthorizationStatus\": \"Posted\",\n \"DebitCredit\": \"Credit\",\n \"TransactionType\": \"CardPinless\",\n \"Description\": \"BIODIETSUPPLEMENTS.COM (10.4)\",\n \"Amount\": \"30\",\n \"AmountInfo\": {\n \"Exponent\": 2,\n \"ISOCodeNumeric\": \"840\",\n \"Amount\": 30,\n \"ISOCurrencyName\": \"US Dollar\",\n \"ISOCodeAlpha\": \"USD\"\n },\n \"CardNumberEndingIn\": \"7413\",\n \"Date\": \"20200615\",\n \"TransactionDateTime\": \"20200615T130621.123 GMT\",\n \"PostingDateTime\": \"20200615T050000.000 GMT\",\n \"SelectMode\": \"Multi\",\n \"TransactionId\": \"7\"\n },\n {\n \"AuthorizationStatus\": \"Posted\",\n \"DebitCredit\": \"Debit\",\n \"TransactionType\": \"CardPinless\",\n \"Description\": \"BIODIETSUPPLEMENTS.COM (10.4) 2\",\n \"Amount\": \"91.74\",\n \"CardNumberEndingIn\": \"7413\",\n \"Date\": \"20200612\",\n \"TransactionDateTime\": \"20200611T130621.123 GMT\",\n \"PostingDateTime\": \"20200612T050000.000 GMT\",\n \"SelectMode\": \"Multi\",\n \"TransactionId\": \"12\"\n }\n ]\n}"
operationId: dispute_post_gettransactions
/getQuestionnaire:
post:
summary: Get Questionnaire
description: '> 👍 Availability
>
> No new clients will be set up with Dispute API 2.0. Legacy clients will eventually be migrated to Dispute API 3.0.
Use the Get Questionnaire endpoint to retrieve the follow-up questions for a dispute. The questions are based on the answer submitted by Add Case Reasons.
This endpoint is part of a conversational API—a series of endpoint calls that must be made in a certain order. For instructions see the Creating an API 2.0 Dispute guide.
- **Previous endpoint:** Add Transactions
- **Next endpoint:**
- **Required**. Add Questionnaire
- _Optional_. Get Other Accounts
- _Optional_. Get Similar Transactions
- _Optional_. Get Credit Transactions'
parameters: []
tags:
- Intake Flow
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
apiLogin:
type: string
description: 'Provider''s web service username, as provided by Galileo for the requesting IP address.
Pattern: Max 50 characters
Example: `"AbC123-9999"`'
example: AbC123-9999
apiTransKey:
type: string
description: 'Web service password, as provided by Galileo for the requesting IP address.
Pattern: Max 15 characters
Example: `"4sb62fh6w4h7w34g"`'
example: 4sb62fh6w4h7w34g
providerId:
type: integer
format: int32
description: 'Galileo-issued unique provider identifier.
Pattern: Max 10 digits
Example: `9999`'
example: 9999
transactionId:
type: string
minimum: 1
maximum: 60
description: 'A provider-generated ID that is unique to each API call. A UUID is preferred. Do not reuse this identifier for multiple API calls.
Pattern: 60 characters or less
Example: `"9845dk-39fdk3fj3-4483483478"`'
example: 9845dk-39fdk3fj3-4483483478
caseId:
type: string
pattern: ^$|^([0-9]{11}[A-Z]{1})$
description: 'Case identifier as returned by Create Case.
Pattern: Max 11 digits with a letter
Example: "`22021000017C`"'
example: 22021000017C
required:
- apiLogin
- apiTransKey
- caseId
- providerId
- transactionId
responses:
default:
description: ''
content:
application/json:
schema:
type: object
properties:
statusCode:
type:
- integer
- 'null'
format: int32
description: The response status code
status:
type:
- string
- 'null'
description: The condition of a process or response
processingTime:
type:
- number
- 'null'
format: float
description: The time elapsed in processing the transaction
echo:
description: A structure that contains transaction ID information
type:
- object
- 'null'
properties:
transactionId:
type:
- string
- 'null'
description: The `transactionId` that was passed in the API request
required:
- transactionId
systemTimestamp:
type:
- string
- 'null'
format: date-time
description: A system generated timestamp
rtoken:
type:
- string
- 'null'
description: A Galileo-generated ID used for tracking
errors:
type: array
description: A list of errors generated while the request was processed
items:
type: string
responseData:
description: A structure for the response data. It can be empty but usually will contain information.
type:
- object
- 'null'
properties:
postQuestionnaire:
type: object
properties:
questionList:
type: array
description: List of questions to present
items:
type: object
properties:
identifier:
type: string
description: Tag for the question
format:
type: string
enum:
- Caption
- Default
- Internal
- Notification
- Warning
description: Metadata describing the question format. It can be used to optionally provide different visual treatment
dataType:
type: string
description: Data type for the question
answerList:
type: array
description: List of answers for a question
items:
type: object
properties:
identifier:
type: string
description: Tag for the answer
questionList:
type: array
description: List of questions to present
items:
type: object
properties: {}
displayText:
type: string
description: Text to display of the question or answer
required:
- displayText
- identifier
isOptional:
type: boolean
description: Is this question an optional?
selectedAnswer:
type: string
description: The selected answer to this question. This could be a default for an initially loaded questionnaire or a persisted previous answer.
type:
type: string
enum:
- YesNo
- Date
- DateTime
- Text
- TextMulti
- Dropdown
- AutoComplete
- RadioButtons
- Checkboxes
- MultiSelect
- Decimal
- Integer
- Currency
- RichText
- Nothing
- Section
- Questionnaire
description: Type of question
apiDocumentationList:
type: array
description: This is returned for questions of type Section. It contains the implementation details to provide the answer to the questions.
items:
type: object
properties:
implementationNotes:
type: string
description: Description of the connector.
method:
type: string
description: Method for REST connector (always 'post').
endpoint:
type: string
description: REST connector endpoint suffix.
required:
- endpoint
- implementationNotes
displayText:
type: string
description: Text of the question to display
required:
- answerList
- dataType
- displayText
- identifier
- type
required:
- questionList
questionnaire:
type: object
properties:
questionList:
type: array
description: List of questions to present
items:
type: object
properties:
identifier:
type: string
description: Tag for the question
format:
type: string
enum:
- Caption
- Default
- Internal
- Notification
- Warning
description: Metadata describing the question format. It can be used to optionally provide different visual treatment
dataType:
type: string
description: Data type for the question
answerList:
type: array
description: List of answers for a question
items:
type: object
properties:
identifier:
type: string
description: Tag for the answer
questionList:
type: array
description: List of questions to present
items:
type: object
properties: {}
displayText:
type: string
description: Text to display of the question or answer
required:
- displayText
- identifier
isOptional:
type: boolean
description: Is this question an optional?
selectedAnswer:
type: string
description: The selected answer to this question. This could be a default for an initially loaded questionnaire or a persisted previous answer.
type:
type: string
enum:
- YesNo
- Date
- DateTime
- Text
- TextMulti
- Dropdown
- AutoComplete
- RadioButtons
- Checkboxes
- MultiSelect
- Decimal
- Integer
- Currency
- RichText
- Nothing
- Section
- Questionnaire
description: Type of question
apiDocumentationList:
type: array
description: This is returned for questions of type Section. It contains the implementation details to provide the answer to the questions.
items:
type: object
properties:
implementationNotes:
type: string
description: Description of the connector.
method:
type: string
description: Method for REST connector (always 'post').
endpoint:
type: string
description: REST connector endpoint suffix.
required:
- endpoint
- implementationNotes
displayText:
type: string
description: Text of the question to display
required:
- answerList
- dataType
- displayText
- identifier
- type
required:
- questionList
required:
- echo
- processingTime
- responseData
- rtoken
- status
- statusCode
- systemTimestamp
examples:
response:
value: "{\n \"statusCode\": 0,\n \"status\": \"Success\",\n \"processingTime\": 308.655,\n \"responseData\": {\n \"questionnaire\": {\n \"questionList\": [\n {\n \"questionList\": [\n {\n \"questionList\": [\n {\n \"type\": \"YesNo\",\n \"identifier\": \"CardPossessionInd\",\n \"displayText\": \"Do you always have possession of the card?\",\n \"dataType\": \"String\",\n \"answerList\": [\n {\n \"identifier\": \"Yes\",\n \"displayText\": \"Yes\"\n },\n {\n \"questionList\": [\n {\n \"type\": \"Text\",\n \"identifier\": \"CardLocation\",\n \"displayText\": \"Where is the card usually kept?\",\n \"dataType\": \"String\"\n },\n {\n \"type\": \"Text\",\n \"identifier\": \"CardNoPossession\",\n \"displayText\": \"In what circumstances do you not have the card in your possession?\",\n \"dataType\": \"String\"\n }\n ],\n \"identifier\": \"No\",\n \"displayText\": \"No\"\n }\n ]\n },\n {\n \"questionList\": [\n {\n \"type\": \"YesNo\",\n \"identifier\": \"HasAuthorizedOthers\",\n \"displayText\": \"Have you ever authorized another person to use your card?\",\n \"dataType\": \"String\",\n \"answerList\": [\n {\n \"questionList\": [\n {\n \"type\": \"Text\",\n \"identifier\": \"AuthorizedName\",\n \"displayText\": \"Who has authorization to use your card?\",\n \"dataType\": \"String\"\n }\n ],\n \"identifier\": \"Yes\",\n \"displayText\": \"Yes\"\n },\n {\n \"identifier\": \"No\",\n \"displayText\": \"No\"\n }\n ]\n },\n {\n \"type\": \"YesNo\",\n \"identifier\": \"HasSharedPIN\",\n \"displayText\": \"Have you ever shared your Personal Identification Number (PIN)?\",\n \"dataType\": \"String\",\n \"answerList\": [\n {\n \"questionList\": [\n {\n \"type\": \"Text\",\n \"identifier\": \"SharedPINName\",\n \"displayText\": \"Who did you share it with?\",\n \"dataType\": \"String\"\n }\n ],\n \"identifier\": \"Yes\",\n \"displayText\": \"Yes\"\n },\n {\n \"identifier\": \"No\",\n \"displayText\": \"No\"\n }\n ]\n },\n {\n \"type\": \"YesNo\",\n \"identifier\": \"AuthorizedPerson\",\n \"displayText\": \"Have you confirmed that this purchase was not made by the authorized person?\",\n \"dataType\": \"String\",\n \"answerList\": [\n {\n \"identifier\": \"Yes\",\n \"displayText\": \"Yes\"\n },\n {\n \"identifier\": \"No\",\n \"displayText\": \"No\"\n }\n ]\n },\n {\n \"questionList\": [\n {\n \"type\": \"Dropdown\",\n \"identifier\": \"WherePinKept\",\n \"displayText\": \"Where do you keep your PIN?\",\n \"dataType\": \"String\",\n \"answerList\": [\n {\n \"identifier\": \"InMemory\",\n \"displayText\": \"In memory\"\n },\n {\n \"identifier\": \"WrittenOnCard\",\n \"displayText\": \"Written on card\"\n },\n {\n \"identifier\": \"InWalletOrPurse\",\n \"displayText\": \"In wallet or purse\"\n },\n {\n \"identifier\": \"AtHome\",\n \"displayText\": \"At home\"\n },\n {\n \"questionList\": [\n {\n \"type\": \"Text\",\n \"identifier\": \"WhereIsPinKeptOtherDetails\",\n \"displayText\": \"Other details.\",\n \"dataType\": \"String\"\n }\n ],\n \"identifier\": \"Other\",\n \"displayText\": \"Other\"\n }\n ]\n },\n {\n \"questionList\": [\n {\n \"type\": \"YesNo\",\n \"identifier\": \"CancelCardInd\",\n \"displayText\": \"Due to the fraud on your account, would you like to cancel your card now?\",\n \"dataType\": \"String\",\n \"answerList\": [\n {\n \"identifier\": \"Yes\",\n \"displayText\": \"Yes\"\n },\n {\n \"identifier\": \"No\",\n \"displayText\": \"No\"\n }\n ]\n },\n {\n \"type\": \"Nothing\",\n \"identifier\": \"\",\n \"displayText\": \"Due to the fraud on your account, we are stopping your card from accepting more charges.\",\n \"dataType\": \"String\"\n },\n {\n \"type\": \"YesNo\",\n \"identifier\": \"ReissueCard\",\n \"displayText\": \"Would you like us to send you a replacement card?\",\n \"dataType\": \"String\",\n \"answerList\": [\n {\n \"questionList\": [\n {\n \"questionList\": [\n {\n \"questionList\": [\n {\n \"questionList\": [\n {\n \"type\": \"AutoComplete\",\n \"identifier\": \"IdentifyBranchPlasticLocation\",\n \"displayText\": \"What branch would you like the card sent to?\",\n \"dataType\": \"String\"\n }\n ],\n \"identifier\": \"IdentifyCustomerPlasticMailingAddressList\",\n \"displayText\": \"\",\n \"dataType\": \"String\",\n \"type\": \"Questionnaire\"\n },\n {\n \"questionList\": [\n {\n \"type\": \"RadioButtons\",\n \"identifier\": \"IdentifyCustomerAddressList\",\n \"displayText\": \"\",\n \"dataType\": \"String\",\n \"answerList\": [\n {\n \"identifier\": \"Other\",\n \"displayText\": \"Other\"\n }\n ]\n }\n ],\n \"identifier\": \"IdentifyCustomerAddressList\",\n \"displayText\": \"Okay, where should we send your card?\",\n \"dataType\": \"String\",\n \"type\": \"Questionnaire\"\n },\n {\n \"questionList\": [\n {\n \"questionList\": [\n {\n \"type\": \"AutoComplete\",\n \"identifier\": \"IdentifyBranchPlasticLocation\",\n \"displayText\": \"What branch would you like the card sent to?\",\n \"dataType\": \"String\"\n }\n ],\n \"identifier\": \"IdentifyBranchLocation\",\n \"displayText\": \"\",\n \"dataType\": \"String\",\n \"type\": \"Questionnaire\"\n },\n {\n \"questionList\": [\n {\n \"type\": \"YesNo\",\n \"identifier\": \"ConfirmOptionalBranchPlasticMailingAddress\",\n \"displayText\": \"Would you like your card mailed to a branch address?\",\n \"dataType\": \"String\",\n \"answerList\": [\n {\n \"questionList\": [\n {\n \"questionList\": [\n {\n \"type\": \"AutoComplete\",\n \"identifier\": \"IdentifyBranchPlasticLocation\",\n \"displayText\": \"What branch would you like the card sent to?\",\n \"dataType\": \"String\"\n }\n ],\n \"identifier\": \"IdentifyBranchLocation\",\n \"displayText\": \"\",\n \"dataType\": \"String\",\n \"type\": \"Questionnaire\"\n }\n ],\n \"identifier\": \"Yes\",\n \"displayText\": \"Yes\"\n },\n {\n \"questionList\": [\n {\n \"questionList\": [\n {\n \"type\": \"Text\",\n \"identifier\": \"PlasticMailingAddressLine1\",\n \"displayText\": \"Line 1\",\n \"dataType\": \"String\"\n },\n {\n \"type\": \"Text\",\n \"identifier\": \"PlasticMailingAddressLine2\",\n \"displayText\": \"Line 2\",\n \"dataType\": \"String\"\n },\n {\n \"type\": \"Text\",\n \"identifier\": \"PlasticMailingAddressLine3\",\n \"displayText\": \"Line 3\",\n \"dataType\": \"String\"\n },\n {\n \"type\": \"Text\",\n \"identifier\": \"PlasticMailingAddressCity\",\n \"displayText\": \"City\",\n \"dataType\": \"String\"\n },\n {\n \"type\": \"Dropdown\",\n \"identifier\": \"PlasticMailingAddressState\",\n \"displayText\": \"State\",\n \"dataType\": \"String\",\n \"answerList\": \"redacted to remove 50 states\"\n },\n {\n \"type\": \"Text\",\n \"identifier\": \"PlasticMailingAddressZip\",\n \"displayText\": \"Zip\",\n \"dataType\": \"String\"\n }\n ],\n \"identifier\": \"AdHocPlasticMailingAddress\",\n \"displayText\": \"Okay, where should we send your card?\",\n \"dataType\": \"String\",\n \"type\": \"Questionnaire\"\n }\n ],\n \"identifier\": \"No\",\n \"displayText\": \"No\"\n }\n ]\n }\n ],\n \"identifier\": \"ConfirmOptionalBranchPlasticMailingAddress\",\n \"displayText\": \"\",\n \"dataType\": \"String\",\n \"type\": \"Questionnaire\"\n }\n ],\n \"identifier\": \"OtherSelectedFromConfirmPlasticMailingAddressFromList\",\n \"displayText\": \"\",\n \"dataType\": \"String\",\n \"type\": \"Questionnaire\"\n }\n ],\n \"identifier\": \"ConfirmPlasticMailingAddress\",\n \"displayText\": \"\",\n \"dataType\": \"String\",\n \"type\": \"Questionnaire\"\n },\n {\n \"type\": \"RadioButtons\",\n \"identifier\": \"CardShippingMethods\",\n \"displayText\": \"How would you like the card to be delivered (Please note that a fee may apply)?\",\n \"dataType\": \"String\"\n },\n {\n \"type\": \"YesNo\",\n \"identifier\": \"RushCard\",\n \"displayText\": \"Would you like your card request to be expedited for a fee of $18, with an estimated delivery timeframe of 3 business days?\",\n \"dataType\": \"String\",\n \"answerList\": [\n {\n \"identifier\": \"Yes\",\n \"displayText\": \"Yes\"\n },\n {\n \"questionList\": [\n {\n \"type\": \"Nothing\",\n \"identifier\": \"\",\n \"displayText\": \"Your new card will be delivered within 7-10 business days.\",\n \"dataType\": \"String\"\n }\n ],\n \"identifier\": \"No\",\n \"displayText\": \"No\"\n }\n ]\n },\n {\n \"type\": \"YesNo\",\n \"identifier\": \"ShouldWaiveCardDeliveryFee\",\n \"displayText\": \"Would you like to waive the card delivery fee?\",\n \"dataType\": \"String\",\n \"answerList\": [\n {\n \"identifier\": \"Yes\",\n \"displayText\": \"Yes\"\n },\n {\n \"identifier\": \"No\",\n \"displayText\": \"No\"\n }\n ]\n },\n {\n \"type\": \"YesNo\",\n \"identifier\": \"ShouldWaiveCardReplacementFee\",\n \"displayText\": \"Would you like to waive the card replacement fee?\",\n \"dataType\": \"String\",\n \"answerList\": [\n {\n \"identifier\": \"Yes\",\n \"displayText\": \"Yes\"\n },\n {\n \"identifier\": \"No\",\n \"displayText\": \"No\"\n }\n ]\n },\n {\n \"type\": \"Nothing\",\n \"identifier\": \"\",\n \"displayText\": \"\",\n \"dataType\": \"String\"\n }\n ],\n \"identifier\": \"ReissueDetail\",\n \"displayText\": \"\",\n \"dataType\": \"String\",\n \"type\": \"Questionnaire\"\n }\n ],\n \"identifier\": \"Yes\",\n \"displayText\": \"Yes\"\n },\n {\n \"questionList\": [\n {\n \"questionList\": [\n {\n \"type\": \"YesNo\",\n \"identifier\": \"ConfirmAccountClosure\",\n \"displayText\": \"Should the account be closed permanently?\",\n \"dataType\": \"String\",\n \"answerList\": [\n {\n \"identifier\": \"Yes\",\n \"displayText\": \"Yes\"\n },\n {\n \"identifier\": \"No\",\n \"displayText\": \"No\"\n }\n ]\n }\n ],\n \"identifier\": \"ConfirmAccountClosure\",\n \"displayText\": \"\",\n \"dataType\": \"String\",\n \"type\": \"Questionnaire\"\n },\n {\n \"type\": \"Nothing\",\n \"identifier\": \"\",\n \"displayText\": \"No new card will be issued at this time. If you change your mind, please contact customer service at the number on the back of your card or cardholder website to request a new card.\",\n \"dataType\": \"String\"\n }\n ],\n \"identifier\": \"No\",\n \"displayText\": \"No\"\n }\n ]\n },\n {\n \"questionList\": [\n {\n \"questionList\": [\n {\n \"questionList\": [\n {\n \"type\": \"AutoComplete\",\n \"identifier\": \"IdentifyBranchPlasticLocation\",\n \"displayText\": \"What branch would you like the card sent to?\",\n \"dataType\": \"String\"\n }\n ],\n \"identifier\": \"IdentifyCustomerPlasticMailingAddressList\",\n \"displayText\": \"\",\n \"dataType\": \"String\",\n \"type\": \"Questionnaire\"\n },\n {\n \"questionList\": [\n {\n \"type\": \"RadioButtons\",\n \"identifier\": \"IdentifyCustomerAddressList\",\n \"displayText\": \"\",\n \"dataType\": \"String\",\n \"answerList\": [\n {\n \"identifier\": \"Other\",\n \"displayText\": \"Other\"\n }\n ]\n }\n ],\n \"identifier\": \"IdentifyCustomerAddressList\",\n \"displayText\": \"Okay, where should we send your card?\",\n \"dataType\": \"String\",\n \"type\": \"Questionnaire\"\n },\n {\n \"questionList\": [\n {\n \"questionList\": [\n {\n \"type\": \"AutoComplete\",\n \"identifier\": \"IdentifyBranchPlasticLocation\",\n \"displayText\": \"What branch would you like the card sent to?\",\n \"dataType\": \"String\"\n }\n ],\n \"identifier\": \"IdentifyBranchLocation\",\n \"displayText\": \"\",\n \"dataType\": \"String\",\n \"type\": \"Questionnaire\"\n },\n {\n \"questionList\": [\n {\n \"type\": \"YesNo\",\n \"identifier\": \"ConfirmOptionalBranchPlasticMailingAddress\",\n \"displayText\": \"Would you like your card mailed to a branch address?\",\n \"dataType\": \"String\",\n \"answerList\": [\n {\n \"questionList\": [\n {\n \"questionList\": [\n {\n \"type\": \"AutoComplete\",\n \"identifier\": \"IdentifyBranchPlasticLocation\",\n \"displayText\": \"What branch would you like the card sent to?\",\n \"dataType\": \"String\"\n }\n ],\n \"identifier\": \"IdentifyBranchLocation\",\n \"displayText\": \"\",\n \"dataType\": \"String\",\n \"type\": \"Questionnaire\"\n }\n ],\n \"identifier\": \"Yes\",\n \"displayText\": \"Yes\"\n },\n {\n \"questionList\": [\n {\n \"questionList\": [\n {\n \"type\": \"Text\",\n \"identifier\": \"PlasticMailingAddressLine1\",\n \"displayText\": \"Line 1\",\n \"dataType\": \"String\"\n },\n {\n \"type\": \"Text\",\n \"identifier\": \"PlasticMailingAddressLine2\",\n \"displayText\": \"Line 2\",\n \"dataType\": \"String\"\n },\n {\n \"type\": \"Text\",\n \"identifier\": \"PlasticMailingAddressLine3\",\n \"displayText\": \"Line 3\",\n \"dataType\": \"String\"\n },\n {\n \"type\": \"Text\",\n \"identifier\": \"PlasticMailingAddressCity\",\n \"displayText\": \"City\",\n \"dataType\": \"String\"\n },\n {\n \"type\": \"Dropdown\",\n \"identifier\": \"PlasticMailingAddressState\",\n \"displayText\": \"State\",\n \"dataType\": \"String\",\n \"answerList\": \"redacted to remove 50 states\"\n },\n {\n \"type\": \"Text\",\n \"identifier\": \"PlasticMailingAddressZip\",\n \"displayText\": \"Zip\",\n \"dataType\": \"String\"\n }\n ],\n \"identifier\": \"AdHocPlasticMailingAddress\",\n \"displayText\": \"Okay, where should we send your card?\",\n \"dataType\": \"String\",\n \"type\": \"Questionnaire\"\n }\n ],\n \"identifier\": \"No\",\n \"displayText\": \"No\"\n }\n ]\n }\n ],\n \"identifier\": \"ConfirmOptionalBranchPlasticMailingAddress\",\n \"displayText\": \"\",\n \"dataType\": \"String\",\n \"type\": \"Questionnaire\"\n }\n ],\n \"identifier\": \"OtherSelectedFromConfirmPlasticMailingAddressFromList\",\n \"displayText\": \"\",\n \"dataType\": \"String\",\n \"type\": \"Questionnaire\"\n }\n ],\n \"identifier\": \"ConfirmPlasticMailingAddress\",\n \"displayText\": \"\",\n \"dataType\": \"String\",\n \"type\": \"Questionnaire\"\n },\n {\n \"type\": \"RadioButtons\",\n \"identifier\": \"CardShippingMethods\",\n \"displayText\": \"How would you like the card to be delivered (Please note that a fee may apply)?\",\n \"dataType\": \"String\"\n },\n {\n \"type\": \"YesNo\",\n \"identifier\": \"RushCard\",\n \"displayText\": \"Would you like your card request to be expedited for a fee of $18, with an estimated delivery timeframe of 3 business days?\",\n \"dataType\": \"String\",\n \"answerList\": [\n {\n \"identifier\": \"Yes\",\n \"displayText\": \"Yes\"\n },\n {\n \"questionList\": [\n {\n \"type\": \"Nothing\",\n \"identifier\": \"\",\n \"displayText\": \"Your new card will be delivered within 7-10 business days.\",\n \"dataType\": \"String\"\n }\n ],\n \"identifier\": \"No\",\n \"displayText\": \"No\"\n }\n ]\n },\n {\n \"type\": \"YesNo\",\n \"identifier\": \"ShouldWaiveCardDeliveryFee\",\n \"displayText\": \"Would you like to waive the card delivery fee?\",\n \"dataType\": \"String\",\n \"answerList\": [\n {\n \"identifier\": \"Yes\",\n \"displayText\": \"Yes\"\n },\n {\n \"identifier\": \"No\",\n \"displayText\": \"No\"\n }\n ]\n },\n {\n \"type\": \"YesNo\",\n \"identifier\": \"ShouldWaiveCardReplacementFee\",\n \"displayText\": \"Would you like to waive the card replacement fee?\",\n \"dataType\": \"String\",\n \"answerList\": [\n {\n \"identifier\": \"Yes\",\n \"displayText\": \"Yes\"\n },\n {\n \"identifier\": \"No\",\n \"displayText\": \"No\"\n }\n ]\n },\n {\n \"type\": \"Nothing\",\n \"identifier\": \"\",\n \"displayText\": \"\",\n \"dataType\": \"String\"\n }\n ],\n \"identifier\": \"ReissueDetail\",\n \"displayText\": \"\",\n \"dataType\": \"String\",\n \"type\": \"Questionnaire\"\n }\n ],\n \"identifier\": \"BlockAndReissueCard\",\n \"displayText\": \"\",\n \"dataType\": \"String\",\n \"type\": \"Questionnaire\"\n }\n ],\n \"identifier\": \"WherePinIsKept\",\n \"displayText\": \"\",\n \"dataType\": \"String\",\n \"type\": \"Questionnaire\"\n }\n ],\n \"identifier\": \"vsq1\",\n \"displayText\": \"\",\n \"dataType\": \"String\",\n \"type\": \"Questionnaire\"\n }\n ],\n \"identifier\": \"CardPossession\",\n \"displayText\": \"\",\n \"dataType\": \"String\",\n \"type\": \"Questionnaire\"\n }\n ],\n \"identifier\": \"\",\n \"displayText\": \"“I didn't make the purchase, but I still have my card.”\",\n \"dataType\": \"String\",\n \"type\": \"Nothing\"\n }\n ],\n \"identifier\": \"FraudCardSecure\"\n },\n \"postQuestionnaire\": {\n \"questionList\": [\n {\n \"questionList\": [\n {\n \"type\": \"YesNo\",\n \"identifier\": \"AddlInfo\",\n \"displayText\": \"Do you have any additional information to provide about this dispute?\",\n \"dataType\": \"String\",\n \"answerList\": [\n {\n \"questionList\": [\n {\n \"type\": \"Nothing\",\n \"identifier\": \"AttachIntakeDocs\",\n \"displayText\": \"Custom Section\",\n \"dataType\": \"String\"\n },\n {\n \"type\": \"TextMulti\",\n \"identifier\": \"AddlInfoDetails\",\n \"displayText\": \"Please provide any additional information\",\n \"dataType\": \"String\"\n }\n ],\n \"identifier\": \"Yes\",\n \"displayText\": \"Yes\"\n },\n {\n \"identifier\": \"No\",\n \"displayText\": \"No\"\n }\n ]\n }\n ],\n \"type\": \"YesNo\",\n \"answerList\": [\n {\n \"questionList\": [\n {\n \"type\": \"TextMulti\",\n \"identifier\": \"AdditionalDisputeNotes\",\n \"displayText\": \"Please provide any additional information. This will be provided to the merchant.\",\n \"dataType\": \"String\"\n }\n ],\n \"identifier\": \"Yes\",\n \"displayText\": \"Yes\"\n },\n {\n \"identifier\": \"No\",\n \"displayText\": \"No\"\n }\n ],\n \"identifier\": \"HasVisaComments\",\n \"displayText\": \"Do you have any additional information that should be provided to the merchant regarding your dispute?\",\n \"dataType\": \"String\"\n }\n ],\n \"identifier\": \"GFT_Extensions_PostQns\"\n }\n },\n \"echo\": {\n \"transactionId\": \"849d99d7-1af6-4c40-9b18-3c9ac4f1ccdb\"\n },\n \"systemTimestamp\": \"2022-04-13 17:25:12\",\n \"rtoken\": \"fcb068c5-c0dc-4bf7-909b-2f4fa5e70dc9\"\n}\n"
operationId: dispute_post_getquestionnaire
/addQuestionnaire:
post:
summary: Add Questionnaire
description: '> 👍 Availability
>
> No new clients will be set up with Dispute API 2.0. Legacy clients will eventually be migrated to Dispute API 3.0.
Use the Add Questionnaire endpoint to submit the account-holder answers to questions presented by Get Questionnaire.
This endpoint is part of a conversational API—a series of endpoint calls that must be made in a certain order. For instructions see the Creating an API 2.0 Dispute guide.
- **Previous endpoint:** Get Questionnaire
- **Next endpoint:** _Optional_. Get Doc Requirements'
parameters: []
tags:
- Intake Flow
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
apiLogin:
type: string
description: 'Provider''s web service username, as provided by Galileo for the requesting IP address.
Pattern: Max 50 characters
Example: `"AbC123-9999"`'
example: AbC123-9999
apiTransKey:
type: string
description: 'Web service password, as provided by Galileo for the requesting IP address.
Pattern: Max 15 characters
Example: `"4sb62fh6w4h7w34g"`'
example: 4sb62fh6w4h7w34g
providerId:
type: integer
format: int32
description: 'Galileo-issued unique provider identifier.
Pattern: Max 10 digits
Example: `9999`'
example: 9999
transactionId:
type: string
minimum: 1
maximum: 60
description: 'A provider-generated ID that is unique to each API call. A UUID is preferred. Do not reuse this identifier for multiple API calls.
Pattern: 60 characters or less
Example: `"9845dk-39fdk3fj3-4483483478"`'
example: 9845dk-39fdk3fj3-4483483478
caseId:
type: string
pattern: ^$|^([0-9]{11}[A-Z]{1})$
description: 'Case identifier as returned by Create Case.
Pattern: Max 11 digits with a letter
Example: "`22021000017C`"'
example: 22021000017C
questionnaire:
type: string
description: "Array of `identifier`/`answerValue` pairs. For `List` data types, consult these instructions. \nPattern: JSON array\nExample: ` [{\"identifier\": \"\", \"answerValue\": \"\"}, {\"identifier\": \"\", \"answerValue\": \"\"}]`"
example: " [\n {\n \"identifier\": \"BothTransactionsOnSameAcctNumberInd\",\n \"answerValue\": \"No\"\n },\n {\n \"identifier\": \"IssuerOrCardholderOtherAcctWithDiffMCCardInd\",\n \"answerValue\": \"Yes\"\n },\n {\n \"identifier\": \"TrxOtherAccount\",\n \"answerValue\": \"Selected\"\n },\n {\n \"identifier\": \"IsDisputeRegardingAirlineTicketsInd\",\n \"answerValue\": \"No\"\n },\n {\n \"identifier\": \"WasResolveAttempted\",\n \"answerValue\": \"Yes\"\n },\n {\n \"identifier\": \"ResolveWithMerchantExplanation\",\n \"answerValue\": \"I walked up to the guy and asked him but he said no.\"\n },\n {\n \"identifier\": \"AddlInfo\",\n \"answerValue\": \"No\"\n }\n ]"
required:
- apiLogin
- apiTransKey
- caseId
- providerId
- questionnaire
- transactionId
responses:
default:
description: ''
content:
application/json:
schema:
type: object
properties:
statusCode:
type:
- integer
- 'null'
format: int32
description: The response status code
status:
type:
- string
- 'null'
description: The condition of a process or response
processingTime:
type:
- number
- 'null'
format: float
description: The time elapsed in processing the transaction
echo:
description: A structure that contains transaction ID information
type:
- object
- 'null'
properties:
transactionId:
type:
- string
- 'null'
description: The `transactionId` that was passed in the API request
required:
- transactionId
systemTimestamp:
type:
- string
- 'null'
format: date-time
description: A system generated timestamp
rtoken:
type:
- string
- 'null'
description: A Galileo-generated ID used for tracking
errors:
type: array
description: A list of errors generated while the request was processed
items:
type: string
responseData:
description: A structure for the response data. This endpoint does not return response data, so it will always be empty.
type: object
properties: {}
required:
- echo
- processingTime
- responseData
- rtoken
- status
- statusCode
- systemTimestamp
examples:
response:
value: "{\n \"statusCode\": 0,\n \"status\": \"Success\",\n \"processingTime\": 0.081,\n \"responseData\": {},\n \"echo\": {\n \"transactionId\": \"9845dk-39fdk3fj3-4483483478\"\n },\n \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\",\n \"systemTimestamp\": \"2020-07-13 10:38:13\"\n}\n"
operationId: dispute_post_addquestionnaire
/getDocRequirements:
post:
summary: Get Doc Requirements
description: '> 👍 Availability
>
> No new clients will be set up with Dispute API 2.0. Legacy clients will eventually be migrated to Dispute API 3.0.
Use the Get Doc Requirements endpoint to retrieve any required documents for the account holder to fill out, depending on the nature of the dispute. If there is a document to fill out, this endpoint returns a `templateDocumentStream` of a PDF form for the account holder to fill out.
This endpoint is part of a conversational API—a series of endpoint calls that must be made in a certain order. If you call this endpoint, it must be during the intake flow; you cannot call it after the case has been submitted. To get the required documents for a case that has already been submitted, use the Get Documents endpoint.
For instructions see the Creating an API 2.0 Dispute guide.
- **Previous endpoint:** Add Questionnaire
- **Next endpoint:** Add Required Docs'
parameters: []
tags:
- Intake Flow
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
apiLogin:
type: string
description: 'Provider''s web service username, as provided by Galileo for the requesting IP address.
Pattern: Max 50 characters
Example: `"AbC123-9999"`'
example: AbC123-9999
apiTransKey:
type: string
description: 'Web service password, as provided by Galileo for the requesting IP address.
Pattern: Max 15 characters
Example: `"4sb62fh6w4h7w34g"`'
example: 4sb62fh6w4h7w34g
providerId:
type: integer
format: int32
description: 'Galileo-issued unique provider identifier.
Pattern: Max 10 digits
Example: `9999`'
example: 9999
transactionId:
type: string
minimum: 1
maximum: 60
description: 'A provider-generated ID that is unique to each API call. A UUID is preferred. Do not reuse this identifier for multiple API calls.
Pattern: 60 characters or less
Example: `"9845dk-39fdk3fj3-4483483478"`'
example: 9845dk-39fdk3fj3-4483483478
caseId:
type: string
pattern: ^$|^([0-9]{11}[A-Z]{1})$
description: 'Case identifier as returned by Create Case.
Pattern: Max 11 digits with a letter
Example: "`22021000017C`"'
example: 22021000017C
required:
- apiLogin
- apiTransKey
- caseId
- providerId
- transactionId
responses:
default:
description: ''
content:
application/json:
schema:
type: object
properties:
statusCode:
type:
- integer
- 'null'
format: int32
description: The response status code
status:
type:
- string
- 'null'
description: The condition of a process or response
processingTime:
type:
- number
- 'null'
format: float
description: The time elapsed in processing the transaction
echo:
description: A structure that contains transaction ID information
type:
- object
- 'null'
properties:
transactionId:
type:
- string
- 'null'
description: The `transactionId` that was passed in the API request
required:
- transactionId
systemTimestamp:
type:
- string
- 'null'
format: date-time
description: A system generated timestamp
rtoken:
type:
- string
- 'null'
description: A Galileo-generated ID used for tracking
errors:
type: array
description: A list of errors generated while the request was processed
items:
type: string
responseData:
description: A structure for the response data. It can be empty but usually will contain information.
type:
- object
- 'null'
properties:
identifier:
type: string
description: Identifier for the PDF
label:
type: string
description: Display text for the PDF
isRequired:
type: boolean
description: Whether the completed form is required for the dispute
validAttachmentCategoryList:
type: array
description: Metadata for the PDF
items:
type: object
properties:
value:
type: string
key:
type: string
isSatisfied:
type: boolean
description: Whether the document requirement has been satisfied.
templateDocumentStream:
type: string
description: Base64-encoded PDF form
required:
- identifier
- isRequired
- isSatisfied
- label
- templateDocumentStream
- validAttachmentCategoryList
required:
- echo
- processingTime
- responseData
- rtoken
- status
- statusCode
- systemTimestamp
examples:
response:
value: "{\n \"statusCode\": 0,\n \"status\": \"Success\",\n \"processingTime\": 0.081,\n \"responseData\": {\n \"templateDocumentStream\": \"JVBERi0xLjQKJcfl9OXwCjEgMCBvYmoKPDwKL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAxMTc1Cj4+CnN0cmVolJUVPRgo=\",\n \"isSatisfied\": false,\n \"identifier\": \"StatementOfDispute\",\n \"isRequired\": true,\n \"label\": \"Statement of Dispute\",\n \"validAttachmentCategoryList\": [\n {\n \"value\": \"Accountholder\",\n \"key\": \"Accountholder\"\n },\n {\n \"value\": \"Supporting Documentation\",\n \"key\": \"SupportingDocumentation\"\n }\n ]\n\n},\n \"echo\": {\n \"transactionId\": \"9845dk-39fdk3fj3-4483483478\"\n },\n \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\",\n \"systemTimestamp\": \"2020-07-13 10:38:13\"\n}\n"
operationId: dispute_post_getdocrequirements
/addRequiredDocs:
post:
summary: Add Required Docs
description: '> 👍 Availability
>
> No new clients will be set up with Dispute API 2.0. Legacy clients will eventually be migrated to Dispute API 3.0.
Use the Add Required Docs endpoint to submit the PDF form that the account holder filled out, if a form was returned by Get Doc Requirements.
This endpoint is part of a conversational API—a series of endpoint calls that must be made in a certain order. If you call this endpoint, it must be during the intake flow; you cannot call it after the case has been submitted.
To attach multiple documents with this endpoint, call the endpoint once for each document. If you need to attach documents after the case has been submitted, use the Add Documents endpoint.
For instructions see the Creating a Dispute guide.
- **Previous endpoint:** Get Doc Requirements
- **Next endpoint:** _Optional._ Get Case Summary'
parameters: []
tags:
- Intake Flow
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
apiLogin:
type: string
description: 'Provider''s web service username, as provided by Galileo for the requesting IP address.
Pattern: Max 50 characters
Example: `"AbC123-9999"`'
example: AbC123-9999
apiTransKey:
type: string
description: 'Web service password, as provided by Galileo for the requesting IP address.
Pattern: Max 15 characters
Example: `"4sb62fh6w4h7w34g"`'
example: 4sb62fh6w4h7w34g
providerId:
type: integer
format: int32
description: 'Galileo-issued unique provider identifier.
Pattern: Max 10 digits
Example: `9999`'
example: 9999
transactionId:
type: string
minimum: 1
maximum: 60
description: 'A provider-generated ID that is unique to each API call. A UUID is preferred. Do not reuse this identifier for multiple API calls.
Pattern: 60 characters or less
Example: `"9845dk-39fdk3fj3-4483483478"`'
example: 9845dk-39fdk3fj3-4483483478
caseId:
type: string
pattern: ^$|^([0-9]{11}[A-Z]{1})$
description: 'Case identifier as returned by Create Case.
Pattern: Max 11 digits with a letter
Example: "`22021000017C`"'
example: 22021000017C
documents:
type: string
description: 'JSON array containing the required document and metadata. Pass only one document per endpoint call. See `documents` Subfields for the fields to include.
Pattern: JSON string
Example: `[{"documentStream": "","identifier": "StatementOfDispute","attachmentCategory": "SupportingDocumentation","fileName": "StatementOfDispute.pdf","attachmentLabel": "Statement of Dispute"}]`'
example: "\n [{\n \"documentStream\": \"JVBERi0xLjQKJcfl9OXwCjEgMCBvYmoKPDwKL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAxMjU4Cj4+CnN0cmVhbQp42s1YW3PTOBR+r+\",\n \"identifier\": \"StatementOfDispute\",\n \"attachmentCategory\": \"SupportingDocumentation\",\n \"fileName\": \"StatementOfDispute.pdf\",\n \"attachmentLabel\": \"Statement of Dispute\"\n }]\n "
required:
- apiLogin
- apiTransKey
- caseId
- documents
- providerId
- transactionId
responses:
default:
description: ''
content:
application/json:
schema:
type: object
properties:
statusCode:
type:
- integer
- 'null'
format: int32
description: The response status code
status:
type:
- string
- 'null'
description: The condition of a process or response
processingTime:
type:
- number
- 'null'
format: float
description: The time elapsed in processing the transaction
echo:
description: A structure that contains transaction ID information
type:
- object
- 'null'
properties:
transactionId:
type:
- string
- 'null'
description: The `transactionId` that was passed in the API request
required:
- transactionId
systemTimestamp:
type:
- string
- 'null'
format: date-time
description: A system generated timestamp
rtoken:
type:
- string
- 'null'
description: A Galileo-generated ID used for tracking
errors:
type: array
description: A list of errors generated while the request was processed
items:
type: string
responseData:
description: A structure for the response data. It can be empty but usually will contain information.
type:
- object
- 'null'
properties:
message:
type: string
description: The status of the file upload.
required:
- message
required:
- echo
- processingTime
- responseData
- rtoken
- status
- statusCode
- systemTimestamp
examples:
response:
value: "{\n \"status\": \"Success\",\n \"statusCode\": 0,\n \"processingTime\": 0.518,\n \"responseData\": {\n \"message\": \"Success\"\n },\n \"echo\": {\n \"transactionId\": \"9e9639fc-c58f-4495-ae8e-3251f5387b8e\"\n },\n \"rtoken\": \"e7f854e0-5f06-4782-a683-6086ebd397fb\",\n \"systemTimestamp\": \"2022-04-19 11:32:44\"\n}\n"
operationId: dispute_post_addrequireddocs
/addTransactions:
post:
summary: Add Transactions
description: '> 👍 Availability
>
> No new clients will be set up with Dispute API 2.0. Legacy clients will eventually be migrated to Dispute API 3.0.
Use the Add Transactions endpoint to attach the transactions that the account holder selects. Specify the `transactionId` as returned by Get Transactions (which is not the `transactionId` that you pass to identify a unique endpoint request).
This endpoint is part of a conversational API—a series of endpoint calls that must be made in a certain order. For instructions see the Creating an API 2.0 Dispute guide.
- **Previous endpoint:** Get Transactions
- **Next endpoint:** Get Questionnaire'
parameters: []
tags:
- Intake Flow
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
apiLogin:
type: string
description: 'Provider''s web service username, as provided by Galileo for the requesting IP address.
Pattern: Max 50 characters
Example: `"AbC123-9999"`'
example: AbC123-9999
apiTransKey:
type: string
description: 'Web service password, as provided by Galileo for the requesting IP address.
Pattern: Max 15 characters
Example: `"4sb62fh6w4h7w34g"`'
example: 4sb62fh6w4h7w34g
providerId:
type: integer
format: int32
description: 'Galileo-issued unique provider identifier.
Pattern: Max 10 digits
Example: `9999`'
example: 9999
transactionId:
type: string
minimum: 1
maximum: 60
description: 'A provider-generated ID that is unique to each API call. A UUID is preferred. Do not reuse this identifier for multiple API calls.
Pattern: 60 characters or less
Example: `"9845dk-39fdk3fj3-4483483478"`'
example: 9845dk-39fdk3fj3-4483483478
caseId:
type: string
pattern: ^$|^([0-9]{11}[A-Z]{1})$
description: 'Case identifier as returned by Create Case.
Pattern: Max 11 digits with a letter
Example: "`22021000017C`"'
example: 22021000017C
transactionsList:
type: string
description: 'A list of one or more transaction IDs to attach to the case. Use the `transactionId` as returned in the `transactionList` of Get Transactions. The format for a `transactionId` is `P`{prog_id}|{prn}|{auth_id}|{network_id}
.Pattern: JSON list
Example: `[{"transactionId": "P111|999156868254|798657228|M"}, {“transactionId”: "P111|999156868254|797295274|M"}]`'
example: "[\n {\n \"TransactionId\": \"P643|162983403900|4742|M\"\n }\n ]"
required:
- apiLogin
- apiTransKey
- caseId
- providerId
- transactionId
- transactionsList
responses:
default:
description: ''
content:
application/json:
schema:
type: object
properties:
statusCode:
type:
- integer
- 'null'
format: int32
description: The response status code
status:
type:
- string
- 'null'
description: The condition of a process or response
processingTime:
type:
- number
- 'null'
format: float
description: The time elapsed in processing the transaction
echo:
description: A structure that contains transaction ID information
type:
- object
- 'null'
properties:
transactionId:
type:
- string
- 'null'
description: The `transactionId` that was passed in the API request
required:
- transactionId
systemTimestamp:
type:
- string
- 'null'
format: date-time
description: A system generated timestamp
rtoken:
type:
- string
- 'null'
description: A Galileo-generated ID used for tracking
errors:
type: array
description: A list of errors generated while the request was processed
items:
type: string
responseData:
description: A structure for the response data. This endpoint does not return response data, so it will always be empty.
type: object
properties: {}
required:
- echo
- processingTime
- responseData
- rtoken
- status
- statusCode
- systemTimestamp
examples:
response:
value: "{\n \"statusCode\": 0,\n \"status\": \"Success\",\n \"processingTime\": 0.081,\n \"responseData\": {},\n \"echo\": {\n \"transactionId\": \"9845dk-39fdk3fj3-4483483478\"\n },\n \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\",\n \"systemTimestamp\": \"2020-07-13 10:38:13\"\n}\n"
operationId: dispute_post_addtransactions
/getCaseSummary:
post:
summary: Get Case Summary
description: '> 👍 Availability
>
> No new clients will be set up with Dispute API 2.0. Legacy clients will eventually be migrated to Dispute API 3.0.
Use the Get Case Summary endpoint to retrieve a summary of the case.
This endpoint is part of a conversational API—a series of endpoint calls that must be made in a certain order. If this endpoint returns `CustomerContactOverrideDate`, do not display it to account holders on your interface.
For instructions see the Creating an API 2.0 Dispute guide.
- **Previous endpoint:** _Optional_. Add Required Docs
- **Next endpoint:** Submit Case'
parameters: []
tags:
- Intake Flow
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
apiLogin:
type: string
description: 'Provider''s web service username, as provided by Galileo for the requesting IP address.
Pattern: Max 50 characters
Example: `"AbC123-9999"`'
example: AbC123-9999
apiTransKey:
type: string
description: 'Web service password, as provided by Galileo for the requesting IP address.
Pattern: Max 15 characters
Example: `"4sb62fh6w4h7w34g"`'
example: 4sb62fh6w4h7w34g
providerId:
type: integer
format: int32
description: 'Galileo-issued unique provider identifier.
Pattern: Max 10 digits
Example: `9999`'
example: 9999
transactionId:
type: string
minimum: 1
maximum: 60
description: 'A provider-generated ID that is unique to each API call. A UUID is preferred. Do not reuse this identifier for multiple API calls.
Pattern: 60 characters or less
Example: `"9845dk-39fdk3fj3-4483483478"`'
example: 9845dk-39fdk3fj3-4483483478
caseId:
type: string
pattern: ^$|^([0-9]{11}[A-Z]{1})$
description: 'Case identifier as returned by Create Case.
Pattern: Max 11 digits with a letter
Example: "`22021000017C`"'
example: 22021000017C
required:
- apiLogin
- apiTransKey
- caseId
- providerId
- transactionId
responses:
default:
description: ''
content:
application/json:
schema:
type: object
properties:
statusCode:
type:
- integer
- 'null'
format: int32
description: The response status code
status:
type:
- string
- 'null'
description: The condition of a process or response
processingTime:
type:
- number
- 'null'
format: float
description: The time elapsed in processing the transaction
echo:
description: A structure that contains transaction ID information
type:
- object
- 'null'
properties:
transactionId:
type:
- string
- 'null'
description: The `transactionId` that was passed in the API request
required:
- transactionId
systemTimestamp:
type:
- string
- 'null'
format: date-time
description: A system generated timestamp
rtoken:
type:
- string
- 'null'
description: A Galileo-generated ID used for tracking
errors:
type: array
description: A list of errors generated while the request was processed
items:
type: string
responseData:
description: A structure for the response data. It can be empty but usually will contain information.
type:
- object
- 'null'
properties:
summaryContactHeader:
type: string
description: Contains the string to communicate the cardholder's preferred contact channel
transactionDetails:
description: Object containing disputed transaction details.
type: object
properties:
summaryHeader:
type:
- string
- 'null'
description: Contains the summary header
selectedPostedTransactionList:
type: array
description: JSON list of disputed transactions and their attributes
items:
type: object
properties:
selectMode:
type: string
description: 'The selection mode for the dispute: `Multi` — Multiple transactions can be selected for this claim type. `Single` — Only one transaction can be selected for this claim type.'
amount:
type: string
description: Amount of the transaction
transactionDateTime:
type: string
description: 'The date-time when the transaction was authorized. Format: yyyyMMdd`T`HHmmss.SSS z'
cardNumberEndingIn:
type: string
description: Last four digits of the PAN
authorizationStatus:
type: string
description: Whether the transaction is `Posted` or `Pending`
amountInfo:
description: Description of the currency of `amount`
type: object
properties:
isoCurrencyName:
type: string
description: Currency name.
amount:
type: string
description: Amount of the transaction in this currency.
isoCodeAlpha:
type: string
description: ISO 4217 alphabetic currency code.
isoCodeNumeric:
type: string
description: ISO 4217 numeric currency code.
exponent:
type: string
description: Number of places after the decimal that the currency uses.
transactionType:
type: string
description: Type of transaction. See Transaction entries in *Creating a Dispute* for definitions.
description:
type: string
description: Description of the transaction
debitCredit:
type: string
description: Whether the transaction debits or credits the account
date:
type: string
description: 'Date of the transaction: YYYYMMDD'
postingDateTime:
type: string
description: 'The date-time when the transaction was posted (settled). Format: yyyyMMdd`T`HHmmss.SSS z'
transactionId:
type: string
description: Identifier provided by the disputes engine for the transaction
required:
- amount
- authorizationStatus
- cardNumberEndingIn
- date
- debitCredit
- description
- postingDateTime
- selectMode
- transactionDateTime
- transactionId
- transactionType
required:
- selectedPostedTransactionList
- summaryHeader
summaryQuestionnaire:
description: Object containing the questionnaire answers provided by the cardholder.
type: object
properties:
questionList:
type: array
description: List of questions to present
items:
type: object
properties:
identifier:
type: string
description: Tag for the question
format:
type: string
enum:
- Caption
- Default
- Internal
- Notification
- Warning
description: Metadata describing the question format. It can be used to optionally provide different visual treatment
dataType:
type: string
description: Data type for the question
answerList:
type: array
description: List of answers for a question
items:
type: object
properties:
identifier:
type: string
description: Tag for the answer
questionList:
type: array
description: List of questions to present
items:
type: object
properties: {}
displayText:
type: string
description: Text to display of the question or answer
required:
- displayText
- identifier
isOptional:
type: boolean
description: Is this question an optional?
selectedAnswer:
type: string
description: The selected answer to this question. This could be a default for an initially loaded questionnaire or a persisted previous answer.
type:
type: string
enum:
- YesNo
- Date
- DateTime
- Text
- TextMulti
- Dropdown
- AutoComplete
- RadioButtons
- Checkboxes
- MultiSelect
- Decimal
- Integer
- Currency
- RichText
- Nothing
- Section
- Questionnaire
description: Type of question
apiDocumentationList:
type: array
description: This is returned for questions of type Section. It contains the implementation details to provide the answer to the questions.
items:
type: object
properties:
implementationNotes:
type: string
description: Description of the connector.
method:
type: string
description: Method for REST connector (always 'post').
endpoint:
type: string
description: REST connector endpoint suffix.
required:
- endpoint
- implementationNotes
displayText:
type: string
description: Text of the question to display
required:
- answerList
- dataType
- displayText
- identifier
- type
required:
- questionList
correspondenceDetails:
description: Object containing the details of the case correspondence.
type: object
properties:
canIgnoreCorrespondencePreference:
type: boolean
description: Specifies whether the correspondence preferences can be ignored
emailAddress:
type: string
description: Cardholder email address
selectedChannel:
type: string
description: Contains the selected channel for correspondence
channelList:
type: array
description: A list with all of the contact channels
items:
type: object
properties:
value:
type: string
key:
type: string
required:
- canIgnoreCorrespondencePreference
- channelList
- emailAddress
- selectedChannel
required:
- correspondenceDetails
- summaryContactHeader
- summaryQuestionnaire
- transactionDetails
required:
- echo
- processingTime
- responseData
- rtoken
- status
- statusCode
- systemTimestamp
examples:
response:
value: "{\n\t\"statusCode\": 0,\n\t\"status\": \"Success\",\n\t\"processingTime\": 0.081,\n \"responseData\": {\n\t\"correspondenceDetails\": {\n\t\t\"addressDetails\": {},\n\t\t\"canIgnoreCorrespondencePreference\": \"false\",\n\t\t\"selectedChannel\": \"Mail\",\n\t\t\"channelList\": [{\n\t\t\t\t\"value\": \"Email\",\n\t\t\t\t\"key\": \"Email\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"value\": \"Mail\",\n\t\t\t\t\"key\": \"Mail\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"value\": \"Manual\",\n\t\t\t\t\"key\": \"Manual\"\n\t\t\t}\n\t\t]\n\t},\n\t\"summaryContactHeader\": \"If we need to contact you, it will be at this address: \",\n\t\"summaryQuestionnaire\": {\n\t\t\"questionList\": [{\n\t\t\t\"questionList\": [{\n\t\t\t\t\"questionList\": [{\n\t\t\t\t\t\"questionList\": [{\n\t\t\t\t\t\t\"questionList\": [{\n\t\t\t\t\t\t\t\"type\": \"YesNo\",\n\t\t\t\t\t\t\t\"answerList\": [{\n\t\t\t\t\t\t\t\t\t\"questionList\": [{\n\t\t\t\t\t\t\t\t\t\t\t\"type\": \"TextMulti\",\n\t\t\t\t\t\t\t\t\t\t\t\"identifier\": \"ContactDateOverrideReason\",\n\t\t\t\t\t\t\t\t\t\t\t\"displayText\": \"Please provide a reason:\",\n\t\t\t\t\t\t\t\t\t\t\t\"dataType\": \"String\"\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"type\": \"Date\",\n\t\t\t\t\t\t\t\t\t\t\t\"identifier\": \"OverrideContactDate\",\n\t\t\t\t\t\t\t\t\t\t\t\"displayText\": \"Enter the new date:\",\n\t\t\t\t\t\t\t\t\t\t\t\"dataType\": \"Date\"\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"type\": \"Nothing\",\n\t\t\t\t\t\t\t\t\t\t\t\"identifier\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"displayText\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"dataType\": \"String\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t],\n\t\t\t\t\t\t\t\t\t\"identifier\": \"true\",\n\t\t\t\t\t\t\t\t\t\"displayText\": \"Yes\"\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\"identifier\": \"false\",\n\t\t\t\t\t\t\t\t\t\"displayText\": \"No\"\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t],\n\t\t\t\t\t\t\t\"identifier\": \"IsContactDateOverridden\",\n\t\t\t\t\t\t\t\"format\": \"Internal\",\n\t\t\t\t\t\t\t\"displayText\": \"The contact date assigned to the claim is 8/21/23. Would you like to override this date? Note: Changing the date may have regulatory impacts.\",\n\t\t\t\t\t\t\t\"dataType\": \"String\",\n\t\t\t\t\t\t\t\"selectedAnswer\": \"false\"\n\t\t\t\t\t\t}],\n\t\t\t\t\t\t\"type\": \"Questionnaire\",\n\t\t\t\t\t\t\"identifier\": \"ContactDateOverride\",\n\t\t\t\t\t\t\"displayText\": \"\",\n\t\t\t\t\t\t\"dataType\": \"String\"\n\t\t\t\t\t}],\n\t\t\t\t\t\"type\": \"Questionnaire\",\n\t\t\t\t\t\"identifier\": \"FCRAClaimDetails\",\n\t\t\t\t\t\"displayText\": \"\",\n\t\t\t\t\t\"dataType\": \"String\"\n\t\t\t\t}],\n\t\t\t\t\"type\": \"Questionnaire\",\n\t\t\t\t\"identifier\": \"ManualPCWithhold\",\n\t\t\t\t\"displayText\": \"\",\n\t\t\t\t\"dataType\": \"String\"\n\t\t\t}],\n\t\t\t\"type\": \"Questionnaire\",\n\t\t\t\"identifier\": \"Decree587Declared\",\n\t\t\t\"displayText\": \"\",\n\t\t\t\"dataType\": \"String\"\n\t\t}],\n\t\t\"identifier\": \"SummaryQuestions\"\n\t},\n\t\"transactionDetails\": {\n\t\t\"pendingSummaryHeader\": \"You are disputing the following pending transaction(s):\",\n\t\t\"selectedPendingTransactionList\": [{\n\t\t\t\"debitCredit\": \"Debit\",\n\t\t\t\"authorizationStatus\": \"Pending\",\n\t\t\t\"transactionType\": \"ATMWD\",\n\t\t\t\"description\": \"LOPEZ LLC #9556, NORTH JOHN, DE\",\n\t\t\t\"amount\": \"439.78\",\n\t\t\t\"cardNumberEndingIn\": \"5898\",\n\t\t\t\"amountInfo\": {\n\t\t\t\t\"exponent\": 2,\n\t\t\t\t\"iSOCodeNumeric\": \"840\",\n\t\t\t\t\"amount\": 439.78,\n\t\t\t\t\"iSOCurrencyName\": \"US Dollar\",\n\t\t\t\t\"iSOCodeAlpha\": \"USD\"\n\t\t\t},\n\t\t\t\"date\": \"20210303\",\n\t\t\t\"transactionId\": \"P643|162983403900|4813|M|AUW\"\n\t\t}]\n }\n\t},\n\t\"echo\": {\n\t\t\"transactionId\": \"9845dk-39fdk3fj3-4483483478\"\n\t},\n\t\"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\",\n\t\"systemTimestamp\": \"2020-07-13 10:38:13\"\n}"
operationId: dispute_post_getcasesummary
/getSimilarTransactions:
post:
summary: Get Similar Transactions
description: '> 👍 Availability
>
> No new clients will be set up with Dispute API 2.0. Legacy clients will eventually be migrated to Dispute API 3.0.
Use the Get Similar Transactions endpoint to retrieve transactions that are similar to the one the account holder is currently disputing. Call this endpoint when the account holder answers **Yes** to the question "Is the valid transaction on this same account?" (`BothTransactionsOnSameAcctNumberInd`)
This endpoint is part of a conversational API—a series of endpoint calls that must be made in a certain order. For instructions see the Creating an API 2.0 Dispute guide.
- **Previous endpoint:** Get Questionnaire
- **Next endpoint:** Add Similar Transactions'
parameters: []
tags:
- Intake Flow
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
apiLogin:
type: string
description: 'Provider''s web service username, as provided by Galileo for the requesting IP address.
Pattern: Max 50 characters
Example: `"AbC123-9999"`'
example: AbC123-9999
apiTransKey:
type: string
description: 'Web service password, as provided by Galileo for the requesting IP address.
Pattern: Max 15 characters
Example: `"4sb62fh6w4h7w34g"`'
example: 4sb62fh6w4h7w34g
providerId:
type: integer
format: int32
description: 'Galileo-issued unique provider identifier.
Pattern: Max 10 digits
Example: `9999`'
example: 9999
transactionId:
type: string
minimum: 1
maximum: 60
description: 'A provider-generated ID that is unique to each API call. A UUID is preferred. Do not reuse this identifier for multiple API calls.
Pattern: 60 characters or less
Example: `"9845dk-39fdk3fj3-4483483478"`'
example: 9845dk-39fdk3fj3-4483483478
caseId:
type: string
pattern: ^$|^([0-9]{11}[A-Z]{1})$
description: 'Case identifier as returned by Create Case.
Pattern: Max 11 digits with a letter
Example: "`22021000017C`"'
example: 22021000017C
otherAccountNo:
type: string
pattern: ^$|^([0-9]{12}|[0-9]{16})$
description: 'The `accountNumber` of the other account, as returned by Get Other Accounts. **Required** if the account holder needs to add transactions that are on a different account than the current account.
Pattern: PRN
Example: `"074103447228"`'
example: 074103447228
startDate:
type: string
format: date
description: 'The starting date for the transactions to return.
Pattern: YYYY-MM-DD
Example: `"2023-11-01"`'
example: '2023-11-01'
endDate:
type: string
format: date
description: 'The ending date of the transactions to return.
Pattern: YYYY-MM-DD
Example: `"2023-11-30"`'
example: '2023-11-30'
amount:
type: number
format: float
minimum: 0.01
maximum: 999999999999.99
description: 'Amount of the transaction to return.
Pattern: Positive integer or decimal number
Example: `100.00`, `100`, or `100.73`'
example: 25.5
merchantName:
type: string
description: 'Name of the merchant that performed the transaction.
Pattern: string
Example: `"DoorDash"`'
example: DoorDash
required:
- apiLogin
- apiTransKey
- caseId
- providerId
- transactionId
responses:
default:
description: ''
content:
application/json:
schema:
type: object
properties:
statusCode:
type:
- integer
- 'null'
format: int32
description: The response status code
status:
type:
- string
- 'null'
description: The condition of a process or response
processingTime:
type:
- number
- 'null'
format: float
description: The time elapsed in processing the transaction
echo:
description: A structure that contains transaction ID information
type:
- object
- 'null'
properties:
transactionId:
type:
- string
- 'null'
description: The `transactionId` that was passed in the API request
required:
- transactionId
systemTimestamp:
type:
- string
- 'null'
format: date-time
description: A system generated timestamp
rtoken:
type:
- string
- 'null'
description: A Galileo-generated ID used for tracking
errors:
type: array
description: A list of errors generated while the request was processed
items:
type: string
responseData:
description: A structure for the response data. It can be empty but usually will contain information.
type:
- object
- 'null'
properties:
transactionList:
type: array
description: List of transactions
items:
type: object
properties:
selectMode:
type: string
description: 'The selection mode for the dispute: `Multi` — Multiple transactions can be selected for this claim type. `Single` — Only one transaction can be selected for this claim type.'
amount:
type: string
description: Amount of the transaction
transactionDateTime:
type: string
description: 'The date-time when the transaction was authorized. Format: yyyyMMdd`T`HHmmss.SSS z'
cardNumberEndingIn:
type: string
description: Last four digits of the PAN
authorizationStatus:
type: string
description: Whether the transaction is `Posted` or `Pending`
amountInfo:
description: Description of the currency of `amount`
type: object
properties:
isoCurrencyName:
type: string
description: Currency name.
amount:
type: string
description: Amount of the transaction in this currency.
isoCodeAlpha:
type: string
description: ISO 4217 alphabetic currency code.
isoCodeNumeric:
type: string
description: ISO 4217 numeric currency code.
exponent:
type: string
description: Number of places after the decimal that the currency uses.
transactionType:
type: string
description: Type of transaction. See Transaction entries in *Creating a Dispute* for definitions.
description:
type: string
description: Description of the transaction
debitCredit:
type: string
description: Whether the transaction debits or credits the account
date:
type: string
description: 'Date of the transaction: YYYYMMDD'
postingDateTime:
type: string
description: 'The date-time when the transaction was posted (settled). Format: yyyyMMdd`T`HHmmss.SSS z'
transactionId:
type: string
description: Identifier provided by the disputes engine for the transaction
required:
- amount
- authorizationStatus
- cardNumberEndingIn
- date
- debitCredit
- description
- postingDateTime
- selectMode
- transactionDateTime
- transactionId
- transactionType
required:
- echo
- processingTime
- responseData
- rtoken
- status
- statusCode
- systemTimestamp
examples:
response:
value: "{\n\t\"statusCode\": 0,\n\t \"status\": \"Success\",\n\t \"processingTime\": 1.209,\n\t \"responseData\": {\n\t\t\"transactionList\": [\n {\n \"transactionAmount\": \"439.780000000\",\n \"cardLastFourDigits\": \"5898\",\n \"disputedAmount\": \"439.780000000\",\n \"description\": \"LOPEZ LLC #9556, NORTH JOHN, DE\",\n \"extDisputeId\": \"23091300088D\",\n \"postingDate\": \"1970-01-01\",\n \"disputeStatus\": \"Pending-TempMatching\",\n \"currentStage\": \"Enhance\",\n \"lastCommitDate\": \"2023-09-13T22:15:54.954Z\",\n \"transactionId\": \"P643|162983403900|4813|M|AUW\"\n },\n {\n \"transactionAmount\": \"57.960000000\",\n \"cardLastFourDigits\": \"5898\",\n \"disputedAmount\": \"57.960000000\",\n \"description\": \"OLSON INC #8253, STEVENBOROUG, CT\",\n \"extDisputeId\": \"23091300089D\",\n \"postingDate\": \"2021-03-02\",\n \"disputeStatus\": \"New\",\n \"currentStage\": \"Enhance\",\n \"lastCommitDate\": \"2023-09-13T22:16:27.705Z\",\n \"postingDateTime\": \"2021-03-02T00:00:00.000Z\",\n \"transactionId\": \"P643|162983403900|4803|M\"\n }\n \t]\t\n\t},\n\t \"echo\": {\"transactionId\": \"ccc6bcfd-588a-4beb-8e4f-13d109e097c0\"}, \n\t\"systemTimestamp\": \"2023-05-17 15:45:29\", \n\t\"rtoken\": \"d4effa49-8c29-46f2-8d27-60c113f7d6f5\"\n}"
operationId: dispute_post_getsimilartransactions
/getOtherAccounts:
post:
summary: Get Other Accounts
description: '> 👍 Availability
>
> No new clients will be set up with Dispute API 2.0. Legacy clients will eventually be migrated to Dispute API 3.0.
Use the Get Other Accounts endpoint to get a list of other accounts for this account holder. Call this endpoint when the account holder answers **Yes** to the question "Is the other transaction on a [your brand] Card?" (`IssuerOrCardholderOtherAcctWithDiff[MC|Visa]CardInd`)
This endpoint is part of a conversational API—a series of endpoint calls that must be made in a certain order. For instructions see the Creating an API 2.0 Dispute guide.
- **Previous endpoint:** Get Questionnaire
- **Next endpoint:** Get Similar Transactions'
parameters: []
tags:
- Intake Flow
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
apiLogin:
type: string
description: 'Provider''s web service username, as provided by Galileo for the requesting IP address.
Pattern: Max 50 characters
Example: `"AbC123-9999"`'
example: AbC123-9999
apiTransKey:
type: string
description: 'Web service password, as provided by Galileo for the requesting IP address.
Pattern: Max 15 characters
Example: `"4sb62fh6w4h7w34g"`'
example: 4sb62fh6w4h7w34g
providerId:
type: integer
format: int32
description: 'Galileo-issued unique provider identifier.
Pattern: Max 10 digits
Example: `9999`'
example: 9999
transactionId:
type: string
minimum: 1
maximum: 60
description: 'A provider-generated ID that is unique to each API call. A UUID is preferred. Do not reuse this identifier for multiple API calls.
Pattern: 60 characters or less
Example: `"9845dk-39fdk3fj3-4483483478"`'
example: 9845dk-39fdk3fj3-4483483478
caseId:
type: string
pattern: ^$|^([0-9]{11}[A-Z]{1})$
description: 'Case identifier as returned by Create Case.
Pattern: Max 11 digits with a letter
Example: "`22021000017C`"'
example: 22021000017C
required:
- apiLogin
- apiTransKey
- caseId
- providerId
- transactionId
responses:
default:
description: ''
content:
application/json:
schema:
type: object
properties:
statusCode:
type:
- integer
- 'null'
format: int32
description: The response status code
status:
type:
- string
- 'null'
description: The condition of a process or response
processingTime:
type:
- number
- 'null'
format: float
description: The time elapsed in processing the transaction
echo:
description: A structure that contains transaction ID information
type:
- object
- 'null'
properties:
transactionId:
type:
- string
- 'null'
description: The `transactionId` that was passed in the API request
required:
- transactionId
systemTimestamp:
type:
- string
- 'null'
format: date-time
description: A system generated timestamp
rtoken:
type:
- string
- 'null'
description: A Galileo-generated ID used for tracking
errors:
type: array
description: A list of errors generated while the request was processed
items:
type: string
responseData:
description: A structure for the response data. It can be empty but usually will contain information.
type:
- object
- 'null'
properties:
accountList:
type: array
description: List of accounts
items:
type: object
properties:
balance:
type: number
format: float
description: The current account balance
description:
type:
- string
- 'null'
description: Description of the product
accountNumber:
type: string
description: The PRN of the account
openDate:
type:
- string
- 'null'
description: Date the account was activated
required:
- accountNumber
- balance
- description
- openDate
required:
- accountList
required:
- echo
- processingTime
- responseData
- rtoken
- status
- statusCode
- systemTimestamp
examples:
response:
value: "{\n\t\"statusCode\": 0,\n\t \"status\": \"Success\",\n\t \"processingTime\": 1.209,\n\t \"responseData\": {\n\t\t\"accountList\": [\n \t\t{\n \t\t\t\"description\": \"Mastercard Rewards\",\n \t\t\t\"openDate\": \"20200701\",\n \t\t\t\"balance\": 702.12,\n \t\t\t\"accountNumber\": \"5555555555554444\"\n \t\t}\n \t\t]\t\n\t },\n\t\"echo\": {\"transactionId\": \"ccc6bcfd-588a-4beb-8e4f-13d109e097c0\"}, \n\t\"systemTimestamp\": \"2023-05-17 15:45:29\", \n\t\"rtoken\": \"d4effa49-8c29-46f2-8d27-60c113f7d6f5\"\n}"
operationId: dispute_post_getotheraccounts
/addSimilarTransactions:
post:
summary: Add Similar Transactions
description: '> 👍 Availability
>
> No new clients will be set up with Dispute API 2.0. Legacy clients will eventually be migrated to Dispute API 3.0.
Use the Add Similar Transactions endpoint to add transactions to the dispute as returned by Get Similar Transactions or Get Credit Transactions
This endpoint is part of a conversational API—a series of endpoint calls that must be made in a certain order.For instructions see the Creating an API 2.0 Dispute guide.
- **Previous endpoints:**
- Get Similar Transactions
- Get Credit Transactions'
parameters: []
tags:
- Intake Flow
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
apiLogin:
type: string
description: 'Provider''s web service username, as provided by Galileo for the requesting IP address.
Pattern: Max 50 characters
Example: `"AbC123-9999"`'
example: AbC123-9999
apiTransKey:
type: string
description: 'Web service password, as provided by Galileo for the requesting IP address.
Pattern: Max 15 characters
Example: `"4sb62fh6w4h7w34g"`'
example: 4sb62fh6w4h7w34g
providerId:
type: integer
format: int32
description: 'Galileo-issued unique provider identifier.
Pattern: Max 10 digits
Example: `9999`'
example: 9999
transactionId:
type: string
minimum: 1
maximum: 60
description: 'A provider-generated ID that is unique to each API call. A UUID is preferred. Do not reuse this identifier for multiple API calls.
Pattern: 60 characters or less
Example: `"9845dk-39fdk3fj3-4483483478"`'
example: 9845dk-39fdk3fj3-4483483478
caseId:
type: string
pattern: ^$|^([0-9]{11}[A-Z]{1})$
description: 'Case identifier as returned by Create Case.
Pattern: Max 11 digits followed by an upper-case letter
Example: `"22021000017C"`'
example: 22021000017C
transactionList:
type: array
description: 'Array of transaction IDs, as returned by a transaction-retrieval endpoint.
Pattern: String array
Example: `["P111|999123456789|0199|M", "P111|999123456789|0156|M"]`'
example: '["P111|999123456789|0156|M", "P111|999123456789|0169|M"]'
items:
type: string
required:
- apiLogin
- apiTransKey
- caseId
- providerId
- transactionId
- transactionList
responses:
default:
description: ''
content:
application/json:
schema:
type: object
properties:
statusCode:
type:
- integer
- 'null'
format: int32
description: The response status code
status:
type:
- string
- 'null'
description: The condition of a process or response
processingTime:
type:
- number
- 'null'
format: float
description: The time elapsed in processing the transaction
echo:
description: A structure that contains transaction ID information
type:
- object
- 'null'
properties:
transactionId:
type:
- string
- 'null'
description: The `transactionId` that was passed in the API request
required:
- transactionId
systemTimestamp:
type:
- string
- 'null'
format: date-time
description: A system generated timestamp
rtoken:
type:
- string
- 'null'
description: A Galileo-generated ID used for tracking
errors:
type: array
description: A list of errors generated while the request was processed
items:
type: string
responseData:
description: A structure for the response data. This endpoint does not return response data, so it will always be empty.
type: object
properties: {}
required:
- echo
- processingTime
- responseData
- rtoken
- status
- statusCode
- systemTimestamp
examples:
response:
value: "{\n\t\"statusCode\": 0,\n\t \"status\": \"Success\",\n\t \"processingTime\": 2.453,\n\t \"responseData\": {},\n\t \"echo\": {\"transactionId\": \"6986e14f-6151-45a4-b451-7212d4ed791a\"},\n \"systemTimestamp\": \"2023-05-17 15:22:57\", \n\"rtoken\": \"18eda716-bf42-4d6e-8357-95ada375adc7\"\n}"
operationId: dispute_post_addsimilartransactions
/getCreditTransactions:
post:
summary: Get Credit Transactions
description: '> 👍 Availability
>
> No new clients will be set up with Dispute API 2.0. Legacy clients will eventually be migrated to Dispute API 3.0.
Use the Get Credit Transactions endpoint to retrieve transactions that credit the customer account. Call this endpoint when the account holder answers **Yes** to the question "Were you issued a partial credit?" (`IssuedPartialCredit`).
This endpoint is part of a conversational API—a series of endpoint calls that must be made in a certain order. For instructions see the Creating an API 2.0 Dispute guide.
- **Previous endpoint:** Get Questionnaire
- **Next endpoint:** Add Similar Transactions'
parameters: []
tags:
- Intake Flow
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
apiLogin:
type: string
description: 'Provider''s web service username, as provided by Galileo for the requesting IP address.
Pattern: Max 50 characters
Example: `"AbC123-9999"`'
example: AbC123-9999
apiTransKey:
type: string
description: 'Web service password, as provided by Galileo for the requesting IP address.
Pattern: Max 15 characters
Example: `"4sb62fh6w4h7w34g"`'
example: 4sb62fh6w4h7w34g
providerId:
type: integer
format: int32
description: 'Galileo-issued unique provider identifier.
Pattern: Max 10 digits
Example: `9999`'
example: 9999
transactionId:
type: string
minimum: 1
maximum: 60
description: 'A provider-generated ID that is unique to each API call. A UUID is preferred. Do not reuse this identifier for multiple API calls.
Pattern: 60 characters or less
Example: `"9845dk-39fdk3fj3-4483483478"`'
example: 9845dk-39fdk3fj3-4483483478
caseId:
type: string
pattern: ^$|^([0-9]{11}[A-Z]{1})$
description: 'Case identifier as returned by Create Case.
Pattern: Max 11 digits with a letter
Example: "`22021000017C`"'
example: 22021000017C
otherAccountNo:
type: string
pattern: ^$|^([0-9]{12}|[0-9]{16})$
description: 'The `accountNumber` of the other account, as returned by Get Other Accounts. **Required** if the account holder needs to add transactions that are on a different account than the current account.
Pattern: PRN
Example: `"074103447228"`'
example: 074103447228
startDate:
type: string
format: date
description: 'The starting date for the transactions to return.
Pattern: YYYY-MM-DD
Example: `"2023-11-01"`'
example: '2023-11-01'
endDate:
type: string
format: date
description: 'The ending date of the transactions to return.
Pattern: YYYY-MM-DD
Example: `"2023-11-30"`'
example: '2023-11-30'
amount:
type: number
format: float
minimum: 0.01
maximum: 999999999999.99
description: 'Amount of the transaction to return.
Pattern: Positive integer or decimal number
Example: `100.00`, `100`, or `100.73`'
example: 25.5
merchantName:
type: string
description: 'Name of the merchant that performed the transaction.
Pattern: string
Example: `"DoorDash"`'
example: DoorDash
required:
- apiLogin
- apiTransKey
- caseId
- providerId
- transactionId
responses:
default:
description: ''
content:
application/json:
schema:
type: object
properties:
statusCode:
type:
- integer
- 'null'
format: int32
description: The response status code
status:
type:
- string
- 'null'
description: The condition of a process or response
processingTime:
type:
- number
- 'null'
format: float
description: The time elapsed in processing the transaction
echo:
description: A structure that contains transaction ID information
type:
- object
- 'null'
properties:
transactionId:
type:
- string
- 'null'
description: The `transactionId` that was passed in the API request
required:
- transactionId
systemTimestamp:
type:
- string
- 'null'
format: date-time
description: A system generated timestamp
rtoken:
type:
- string
- 'null'
description: A Galileo-generated ID used for tracking
errors:
type: array
description: A list of errors generated while the request was processed
items:
type: string
responseData:
description: A structure for the response data. It can be empty but usually will contain information.
type:
- object
- 'null'
properties:
transactionList:
type: array
description: List of transactions
items:
type: object
properties:
selectMode:
type: string
description: 'The selection mode for the dispute: `Multi` — Multiple transactions can be selected for this claim type. `Single` — Only one transaction can be selected for this claim type.'
amount:
type: string
description: Amount of the transaction
transactionDateTime:
type: string
description: 'The date-time when the transaction was authorized. Format: yyyyMMdd`T`HHmmss.SSS z'
cardNumberEndingIn:
type: string
description: Last four digits of the PAN
authorizationStatus:
type: string
description: Whether the transaction is `Posted` or `Pending`
amountInfo:
description: Description of the currency of `amount`
type: object
properties:
isoCurrencyName:
type: string
description: Currency name.
amount:
type: string
description: Amount of the transaction in this currency.
isoCodeAlpha:
type: string
description: ISO 4217 alphabetic currency code.
isoCodeNumeric:
type: string
description: ISO 4217 numeric currency code.
exponent:
type: string
description: Number of places after the decimal that the currency uses.
transactionType:
type: string
description: Type of transaction. See Transaction entries in *Creating a Dispute* for definitions.
description:
type: string
description: Description of the transaction
debitCredit:
type: string
description: Whether the transaction debits or credits the account
date:
type: string
description: 'Date of the transaction: YYYYMMDD'
postingDateTime:
type: string
description: 'The date-time when the transaction was posted (settled). Format: yyyyMMdd`T`HHmmss.SSS z'
transactionId:
type: string
description: Identifier provided by the disputes engine for the transaction
required:
- amount
- authorizationStatus
- cardNumberEndingIn
- date
- debitCredit
- description
- postingDateTime
- selectMode
- transactionDateTime
- transactionId
- transactionType
required:
- echo
- processingTime
- responseData
- rtoken
- status
- statusCode
- systemTimestamp
examples:
response:
value: "{\n\t\"statusCode\": 0,\n\t \"status\": \"Success\",\n\t \"processingTime\": 1.209,\n\t \"responseData\": {\n\t \"transactionList\": [\n {\n \"transactionAmount\": \"439.780000000\",\n \"cardLastFourDigits\": \"5898\",\n \"disputedAmount\": \"439.780000000\",\n \"description\": \"LOPEZ LLC #9556, NORTH JOHN, DE\",\n \"extDisputeId\": \"23091300088D\",\n \"postingDate\": \"1970-01-01\",\n \"disputeStatus\": \"Pending-TempMatching\",\n \"currentStage\": \"Enhance\",\n \"lastCommitDate\": \"2023-09-13T22:15:54.954Z\",\n \"transactionId\": \"P643|162983403900|4813|M|AUW\"\n },\n {\n \"transactionAmount\": \"57.960000000\",\n \"cardLastFourDigits\": \"5898\",\n \"disputedAmount\": \"57.960000000\",\n \"description\": \"OLSON INC #8253, STEVENBOROUG, CT\",\n \"extDisputeId\": \"23091300089D\",\n \"postingDate\": \"2021-03-02\",\n \"disputeStatus\": \"New\",\n \"currentStage\": \"Enhance\",\n \"lastCommitDate\": \"2023-09-13T22:16:27.705Z\",\n \"postingDateTime\": \"2021-03-02T00:00:00.000Z\",\n \"transactionId\": \"P643|162983403900|4803|M\"\n }\n \t ]\t\n\t},\n\t\"echo\": {\"transactionId\": \"ccc6bcfd-588a-4beb-8e4f-13d109e097c0\"}, \n\t\"systemTimestamp\": \"2023-05-17 15:45:29\", \n\t\"rtoken\": \"d4effa49-8c29-46f2-8d27-60c113f7d6f5\"\n}"
operationId: dispute_post_getcredittransactions
x-readme:
explorer-enabled: true
proxy-enabled: true