openapi: 3.0.0
servers:
- url: https://oberon-beta.quavo.net/prweb/PRRestService/QFDAPI/v1/
description: ''
variables: {}
info:
version: 1.0.0
title: QFD APIs
description: ''
termsOfService: ''
contact: {}
license:
name: ''
paths:
"/customer/retrieve":
post:
summary: postCustomerRetrieve
operationId: postCustomerRetrieve
parameters: []
responses:
'200':
description: Successful customer retrieve request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/CustomerRetrieveResponse'
examples:
successExample:
$ref: '#/components/examples/postCustomerRetrieveRequestSuccess'
'400':
description: Error retrieving Customer Information
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/StatusListResponse'
examples:
error1Example:
$ref: '#/components/examples/postRequestError1'
error5Example:
$ref: '#/components/examples/postRequestError5'
error14Example:
$ref: '#/components/examples/postRequestError14'
'500':
description: Server Connection Error
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/StatusListResponse'
examples:
errorExample:
$ref: '#/components/examples/postRequestError500'
requestBody:
$ref: '#/components/requestBodies/postCustomerRetrieveRequest'
tags:
- Customer
"/claim/reopenRequest":
post:
summary: postClaimReopenRequest
operationId: postClaimReopenRequest
parameters: []
responses:
'200':
description: Successful claim reopen request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/StatusList'
examples:
successExample:
$ref: '#/components/examples/SuccessStatusList'
'400':
description: Error reopening claim
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/StatusListResponse'
examples:
reopenErrorExample:
value:
StatusList:
- Type: Error
Message: Error occurred while requesting reopen
summary: A sample Reopen Error Response
error4Example:
$ref: '#/components/examples/postRequestError4'
error5Example:
$ref: '#/components/examples/postRequestError5'
error14Example:
$ref: '#/components/examples/postRequestError14'
'500':
description: Server connection error
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/StatusListResponse'
examples:
errorExample:
$ref: '#/components/examples/postRequestError500'
requestBody:
$ref: '#/components/requestBodies/postClaimReopenRequestRequest'
tags:
- Claim
"/claim/withdrawRequest":
post:
summary: postClaimWithdrawRequest
operationId: postClaimWithdrawRequest
parameters: []
responses:
'200':
description: Successful claim withdraw request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/StatusList'
examples:
successExample:
$ref: '#/components/examples/SuccessStatusList'
'400':
description: Error withdrawing claim
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/StatusListResponse'
examples:
WithdrawErrorExample:
value:
StatusList:
- Type: Error
Message: Withdraw Request Error
summary: A sample Withdraw Request Error Response
error4Example:
$ref: '#/components/examples/postRequestError4'
error5Example:
$ref: '#/components/examples/postRequestError5'
error14Example:
$ref: '#/components/examples/postRequestError14'
'500':
description: Error reopen claim request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/StatusListResponse'
examples:
errorExample:
$ref: '#/components/examples/postRequestError500'
requestBody:
$ref: '#/components/requestBodies/postClaimWithdrawRequestRequest'
tags:
- Claim
"/claim/list":
post:
summary: postClaimList
operationId: postClaimList
parameters: []
responses:
'200':
description: Successful claim list request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ClaimListResponse'
examples:
successExample:
$ref: '#/components/examples/postClaimListRequestSuccess'
'400':
description: Error claim list request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/StatusListResponse'
examples:
ClaimRetrieveErrorExample:
value:
StatusList:
- Type: Error
Message: Error Retrieving Claim List
summary: A sample retrieve claim list Error Response
error1Example:
$ref: '#/components/examples/postRequestError1'
error2Example:
$ref: '#/components/examples/postRequestError2'
error4Example:
$ref: '#/components/examples/postRequestError4'
error5Example:
$ref: '#/components/examples/postRequestError5'
error14Example:
$ref: '#/components/examples/postRequestError14'
error18Example:
$ref: '#/components/examples/postRequestError18'
'500':
description: Error claim list request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/StatusListResponse'
examples:
errorExample:
$ref: '#/components/examples/postRequestError500'
requestBody:
$ref: '#/components/requestBodies/postClaimListRequest'
tags:
- Claim
"/claim/attachments/add":
post:
summary: postClaimAttachmentsAdd
operationId: postClaimAttachmentsAdd
parameters: []
responses:
'200':
description: Successful add attachments request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/StatusListResponse'
examples:
successExample:
$ref: '#/components/examples/SuccessStatusList'
'400':
description: Error add attachment request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/StatusListResponse'
examples:
attachmentAddError:
value:
StatusList:
- Type: Error
Message: fail, Error adding the attachment
summary: A sample add attachment Error Response
error4Example:
$ref: '#/components/examples/postRequestError4'
error5Example:
$ref: '#/components/examples/postRequestError5'
error14Example:
$ref: '#/components/examples/postRequestError14'
'500':
description: Error add attachments request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/StatusListResponse'
examples:
errorExample:
$ref: '#/components/examples/postRequestError500'
requestBody:
$ref: '#/components/requestBodies/postAttachmentsAddRequest'
tags:
- Attachments
"/claim/attachments/list":
post:
summary: postClaimAttachmentsList
operationId: postClaimAttachmentsList
parameters: []
responses:
'200':
description: Successful attachments list request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/AttachmentsListResponse'
examples:
successExample:
$ref: '#/components/examples/postAttachmentsListRequestSuccess'
'400':
description: Error add attachment request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/StatusListResponse'
examples:
error4Example:
$ref: '#/components/examples/postRequestError4'
error5Example:
$ref: '#/components/examples/postRequestError5'
error14Example:
$ref: '#/components/examples/postRequestError14'
'500':
description: Error retrieve accounts request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/StatusListResponse'
examples:
errorExample:
$ref: '#/components/examples/postRequestError500'
requestBody:
$ref: '#/components/requestBodies/postAttachmentsListRequest'
tags:
- Attachments
"/claim/attachments/retrieve":
post:
summary: postClaimAttachmentsRetrieve
operationId: postClaimAttachmentsRetrieve
parameters: []
responses:
'200':
description: Successful attachments list request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/AttachmentsRetrieveResponse'
examples:
successExample:
$ref: '#/components/examples/postAttachmentsRetrieveRequestSuccess'
'400':
description: Error retrieve attachment request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/StatusListResponse'
examples:
attachmentRetrieveError:
value:
StatusList:
- Type: Error
Message: Error Retrieving Attachment
Code: 500
summary: A sample attachment retrieve Error Response
error5Example:
$ref: '#/components/examples/postRequestError5'
error14Example:
$ref: '#/components/examples/postRequestError14'
'500':
description: Error retrieve attachments request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/StatusListResponse'
examples:
errorExample:
$ref: '#/components/examples/postRequestError500'
requestBody:
$ref: '#/components/requestBodies/postAttachmentsRetrieveRequest'
tags:
- Attachments
"/claim/notes/add":
post:
summary: postClaimNotesAdd
operationId: postClaimNotesAdd
parameters: []
responses:
'200':
description: Successful add notes request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/StatusListResponse'
examples:
successExample:
$ref: '#/components/examples/SuccessStatusList'
'400':
description: Error add notes request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/StatusListResponse'
examples:
addnoteError:
value:
StatusList:
- Type: Error
Message: "fail Error Adding Note: {message}"
summary: A sample add note error Response
error4Example:
$ref: '#/components/examples/postRequestError4'
error5Example:
$ref: '#/components/examples/postRequestError5'
error14Example:
$ref: '#/components/examples/postRequestError14'
'500':
description: Server Connection Error
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/StatusListResponse'
examples:
errorExample:
$ref: '#/components/examples/postRequestError500'
requestBody:
$ref: '#/components/requestBodies/postNotesAddRequest'
tags:
- Notes
"/claim/notes/list":
post:
summary: postClaimNotesList
operationId: postClaimNotesList
parameters: []
responses:
'200':
description: Successful attachments list request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/NotesListResponse'
examples:
successExample:
$ref: '#/components/examples/postNotesListRequestSuccess'
'400':
description: Error add attachment request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/StatusListResponse'
examples:
error4Example:
$ref: '#/components/examples/postRequestError4'
error5Example:
$ref: '#/components/examples/postRequestError5'
error14Example:
$ref: '#/components/examples/postRequestError14'
'500':
description: Error retrieve accounts request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/StatusListResponse'
examples:
errorExample:
$ref: '#/components/examples/postRequestError500'
requestBody:
$ref: '#/components/requestBodies/postNotesListRequest'
tags:
- Notes
"/claim/notes/retrieve":
post:
summary: postClaimNotesRetrieve
operationId: postClaimNotesRetrieve
parameters: []
responses:
'200':
description: Successful notes retrieve request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/NotesRetrieveResponse'
examples:
successExample:
$ref: '#/components/examples/postNotesRetrieveRequestSuccess'
'400':
description: Error retrieve notes request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/StatusListResponse'
examples:
retrieveNoteError:
value:
StatusList:
- Type: Error
Message: Error Retrieving Note
summary: A sample retrieve note error Response
error4Example:
$ref: '#/components/examples/postRequestError4'
error14Example:
$ref: '#/components/examples/postRequestError14'
'500':
description: Error retrieve notes request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/StatusListResponse'
examples:
errorExample:
$ref: '#/components/examples/postRequestError500'
requestBody:
$ref: '#/components/requestBodies/postNotesRetrieveRequest'
tags:
- Notes
"/claim/correspondence/list":
post:
summary: postClaimCorrespondenceList
operationId: postClaimCorrespondenceList
parameters: []
responses:
'200':
description: Successful correspondence list request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/CorrespondenceListResponse'
examples:
successExample:
$ref: '#/components/examples/postCorrespondenceListRequestSuccess'
'400':
description: Error correspondence list request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/StatusListResponse'
examples:
correspondenceListError:
value:
StatusList:
- Type: Error
Message: "Error Retrieving Correspondence List: {message}"
summary: A sample correspondence list error Response
error4Example:
$ref: '#/components/examples/postRequestError4'
error5Example:
$ref: '#/components/examples/postRequestError5'
error14Example:
$ref: '#/components/examples/postRequestError14'
'500':
description: Error correspondence list request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/StatusListResponse'
examples:
errorExample:
$ref: '#/components/examples/postRequestError500'
requestBody:
$ref: '#/components/requestBodies/postCorrespondenceListRequest'
tags:
- Correspondence
"/claim/correspondence/retrieve":
post:
summary: postClaimCorrespondenceRetrieve
operationId: postClaimCorrespondenceRetrieve
parameters: []
responses:
'200':
description: Successful attachments list request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/CorrespondenceRetrieveResponse'
examples:
successExample:
$ref: '#/components/examples/postCorrespondenceRetrieveRequestSuccess'
'400':
description: Error retrieve attachment request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/StatusListResponse'
examples:
retrieveCorrespondenceError:
value:
StatusList:
- Type: Error
Message: "Error Retrieving Correspondence: {message}"
summary: A sample retrieve correspondence error Response
error5Example:
$ref: '#/components/examples/postRequestError5'
error14Example:
$ref: '#/components/examples/postRequestError14'
'500':
description: Error retrieve attachments request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/StatusListResponse'
examples:
errorExample:
$ref: '#/components/examples/postRequestError500'
requestBody:
$ref: '#/components/requestBodies/postCorrespondenceRetrieveRequest'
tags:
- Correspondence
"/claim/correspondence/resend":
post:
summary: postClaimCorrespondenceResend
operationId: postClaimCorrespondenceResend
parameters: []
responses:
'200':
description: Successful correspondence resend request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/StatusList'
examples:
successExample:
$ref: '#/components/examples/SuccessStatusList'
'400':
description: Error correspondence resend request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/StatusListResponse'
examples:
correspondenceResendError:
value:
StatusList:
- Type: Error
Message: Error Resending Correspondence
summary: A sample correspondence resend error Response
emptyLinkError:
value:
StatusList:
- Type: Error
Message: Invalid LinkReference or LinkReference returned no results
summary: A sample failed linkreference error Response
error4Example:
$ref: '#/components/examples/postRequestError4'
error5Example:
$ref: '#/components/examples/postRequestError5'
error14Example:
$ref: '#/components/examples/postRequestError14'
'500':
description: Error correspondence resend request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/StatusListResponse'
examples:
errorExample:
$ref: '#/components/examples/postRequestError500'
requestBody:
$ref: '#/components/requestBodies/postClaimCorrespondenceResendRequest'
tags:
- Correspondence
"/claim/transactions/add":
post:
summary: postTransactionsAdd
operationId: postTransactionsAdd
parameters: []
responses:
'200':
description: Successful transaction add request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/StatusList'
examples:
successExample:
$ref: '#/components/examples/SuccessStatusList'
'400':
description: Error transaction add request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/StatusListResponse'
examples:
transactionAddError:
value:
StatusList:
- Type: Error
Message: "Error while adding transaction(s) to claim"
summary: A sample failed add transaction error Response
error4Example:
$ref: '#/components/examples/postRequestError4'
error5Example:
$ref: '#/components/examples/postRequestError5'
error14Example:
$ref: '#/components/examples/postRequestError14'
'500':
description: Error transaction add request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/StatusListResponse'
examples:
errorExample:
$ref: '#/components/examples/postRequestError500'
requestBody:
$ref: '#/components/requestBodies/postClaimTransactionAddRequest'
tags:
- Transactions
"/claim/transactions/list":
post:
summary: postTransactionsList
operationId: postTransactionsList
parameters: []
responses:
'200':
description: Successful transaction list request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/TransactionListResponse'
examples:
successExample:
$ref: '#/components/examples/postTransactionListRequestSuccess'
'400':
description: Error transaction list request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/StatusListResponse'
examples:
transactionListError:
value:
StatusList:
- Type: Error
Message: "Error Retrieving Transactions List: {message}"
summary: A sample failed list transaction error Response
error4Example:
$ref: '#/components/examples/postRequestError4'
error5Example:
$ref: '#/components/examples/postRequestError5'
error14Example:
$ref: '#/components/examples/postRequestError14'
'500':
description: Error transaction list request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/StatusListResponse'
examples:
errorExample:
$ref: '#/components/examples/postRequestError500'
requestBody:
$ref: '#/components/requestBodies/postTransactionListRequest'
tags:
- Transactions
"/transactions/retrieve":
post:
summary: This endpoint does not exist yet
operationId: postTransactionsRetrieve
parameters: []
responses:
'200':
description: ''
headers: {}
requestBody:
required: true
content:
text/plain:
schema:
type: string
example:
claimId: ''
transactionId: ''
example: "{\r\n \"claimId\": \"\",\r\n \"transactionId\": \"\"\r\n}"
tags:
- Transactions
"/claim/retrieve":
post:
summary: postClaimRetrieve
operationId: postClaimRetrieve
parameters: []
responses:
'200':
description: Successful status retrieve request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/StatusRetrieveResponse'
examples:
successExample:
$ref: '#/components/examples/postStatusRetrieveRequestSuccess'
'400':
description: Error retrieve status request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/StatusListResponse'
examples:
claimRetrievalError:
value:
StatusList:
- Type: Error
Message: "Error Retrieving Claim Status"
summary: A sample failed claim retrieval error Response
error4Example:
$ref: '#/components/examples/postRequestError4'
error5Example:
$ref: '#/components/examples/postRequestError5'
error14Example:
$ref: '#/components/examples/postRequestError14'
'500':
description: Error retrieve status request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/StatusListResponse'
examples:
errorExample:
$ref: '#/components/examples/postRequestError500'
requestBody:
$ref: '#/components/requestBodies/postStatusRetrieveRequest'
tags:
- Status
"/claim/intake/retrieveCustomers":
post:
summary: postRetrieveCustomrs
description: "Retrieve customers for provided search criteria."
operationId: postRetrieveCustomers
parameters: []
responses:
'200':
description: Successful retrieve customers request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/RetrieveCustomersResponse'
examples:
successExample:
$ref: '#/components/examples/postRetrieveCustomersRequestSuccess'
'400':
description: Error retrieve customers request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/RetrieveCustomersResponse'
examples:
error4Example:
$ref: '#/components/examples/postRequestError4'
error5Example:
$ref: '#/components/examples/postRequestError5'
error13Example:
$ref: '#/components/examples/postRequestError13'
error14Example:
$ref: '#/components/examples/postRequestError14'
error17Example:
$ref: '#/components/examples/postRequestError17'
'500':
description: Error retrieve customers request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/RetrieveCustomersResponse'
examples:
errorExample:
$ref: '#/components/examples/postRequestError500'
requestBody:
$ref: '#/components/requestBodies/postRetrieveCustomersRequest'
tags:
- Intake
"/claim/intake/retrieveAccounts":
post:
summary: postRetrieveAccounts
description: "Retrieve accounts for provided customer id."
operationId: postRetrieveAccounts
parameters: []
responses:
'200':
description: Successful retrieve accounts request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/RetrieveAccountsResponse'
examples:
successExample:
$ref: '#/components/examples/postRetrieveAccountsRequestSuccess'
'400':
description: Error retrieve accounts request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/RetrieveAccountsResponse'
examples:
error1Example:
$ref: '#/components/examples/postRequestError1'
error4Example:
$ref: '#/components/examples/postRequestError4'
error5Example:
$ref: '#/components/examples/postRequestError5'
error13Example:
$ref: '#/components/examples/postRequestError13'
error14Example:
$ref: '#/components/examples/postRequestError14'
'500':
description: Error retrieve accounts request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/RetrieveAccountsResponse'
examples:
errorExample:
$ref: '#/components/examples/postRequestError500'
requestBody:
$ref: '#/components/requestBodies/postRetrieveAccountsRequest'
tags:
- Intake
"/claim/intake/create":
post:
summary: postClaimCreate
description: |-
Creates a new claim in QFD. A claim is a unit of work that will contain one or more specific transaction disputes.
The API is called by passing in key information required to create a shell claim.
operationId: postClaimCreate
parameters: []
responses:
'200':
description: Successful claim initiation request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/CreateClaimResponse'
examples:
successExample:
$ref: '#/components/examples/postCreateClaimRequestSuccess'
'400':
description: Error claim initiation request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/CreateClaimResponse'
examples:
error1Example:
$ref: '#/components/examples/postRequestError1'
error2Example:
$ref: '#/components/examples/postRequestError2'
error5Example:
$ref: '#/components/examples/postRequestError5'
error13Example:
$ref: '#/components/examples/postRequestError13'
error14Example:
$ref: '#/components/examples/postRequestError14'
postRequestError:
value:
StatusList:
- Type: Error
Message: "Error creating Claim: {message}"
Code: '3'
summary: A sample Claim creation error
'500':
description: Error claim initiation request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/CreateClaimResponse'
examples:
errorExample:
$ref: '#/components/examples/postRequestError500'
requestBody:
$ref: '#/components/requestBodies/postCreateClaimRequest'
tags:
- Intake
"/claim/intake/retrieveReasons":
post:
summary: postRetrieveReasons
description: |-
This API retrieves the reason questionnaire for a given claim ID.
These are questions to display so the user can classify the type and
reason for the claim. Since QFD now knows the customer account type and user
type, it will return the appropriate questions.
This first question drives the core type of dispute, which is one of the following five:
1. I made this purchase, but there is a problem and I need to dispute it.
2. I did not authorize this transaction. I suspect fraud.
3. I had an issue while using my card at an ATM.
4. There is an issue with the account.
5. There is an authorization issue.
The next set of questions is based on the answer to above, and is specific for each. This is a description of the reason for the type of claim.
Prerequisite API calls:
- postClaimCreate
operationId: postRetrieveReasons
parameters: []
responses:
'200':
description: Successful retrieve reasons request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/RetrieveReasonsResponse'
examples:
successExample:
$ref: '#/components/examples/postRetrieveReasonsRequestSuccess'
'400':
description: Error retrieve reasons request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/RetrieveReasonsResponse'
examples:
error4Example:
$ref: '#/components/examples/postRequestError4'
error5Example:
$ref: '#/components/examples/postRequestError5'
error6Example:
$ref: '#/components/examples/postRequestError6'
error13Example:
$ref: '#/components/examples/postRequestError13'
error14Example:
$ref: '#/components/examples/postRequestError14'
error15Example:
$ref: '#/components/examples/postRequestError15'
error16Example:
$ref: '#/components/examples/postRequestError16'
'500':
description: Error retrieve reasons request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/RetrieveReasonsResponse'
examples:
errorExample:
$ref: '#/components/examples/postRequestError500'
requestBody:
$ref: '#/components/requestBodies/postRetrieveReasonsRequest'
tags:
- Intake
"/claim/intake/addClaimReasons":
post:
summary: postClaimReasonsAdd
description: |-
This API posts the answers to the claim type and reason questionnaire received from the postRetrieveReasons API.
Prerequisite API call:
- postClaimCreate
operationId: postClaimReasonsAdd
parameters: []
responses:
'200':
description: Successful retrieve reasons request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/StatusListResponse'
examples:
successExample:
$ref: '#/components/examples/SuccessStatusList'
'400':
description: Error retrieve reasons request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/StatusListResponse'
examples:
error4Example:
$ref: '#/components/examples/postRequestError4'
error5Example:
$ref: '#/components/examples/postRequestError5'
error7Example:
$ref: '#/components/examples/postRequestError7'
error13Example:
$ref: '#/components/examples/postRequestError13'
error14Example:
$ref: '#/components/examples/postRequestError14'
error15Example:
$ref: '#/components/examples/postRequestError15'
error16Example:
$ref: '#/components/examples/postRequestError16'
'500':
description: Error retrieve reasons request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/StatusListResponse'
examples:
errorExample:
$ref: '#/components/examples/postRequestError500'
requestBody:
$ref: '#/components/requestBodies/postAddClaimReasonsRequest'
tags:
- Intake
"/claim/intake/retrieveTransactions":
post:
summary: postRetrieveTransactions
description: |-
This API retrieves transactions from the account number for the
customer id using claim ID.
A default date range is built into QFD, so most inputs below are optional.
This API can be called multiple times if ad hoc searching
is being performed.
Prerequisite API call:
- postRetrieveReasons
operationId: postRetrieveTransactions
parameters: []
responses:
'200':
description: postRetrieveTransactions
content:
application/json:
schema:
$ref: '#/components/schemas/RetrieveTransactionsResponse'
examples:
successExample:
$ref: '#/components/examples/postRetrieveTransactionsRequestSuccess'
'400':
description: Error retrieve transactions request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/StatusListResponse'
examples:
error4Example:
$ref: '#/components/examples/postRequestError4'
error5Example:
$ref: '#/components/examples/postRequestError5'
error6Example:
$ref: '#/components/examples/postRequestError6'
error8Example:
$ref: '#/components/examples/postRequestError8'
error13Example:
$ref: '#/components/examples/postRequestError13'
error14Example:
$ref: '#/components/examples/postRequestError14'
error15Example:
$ref: '#/components/examples/postRequestError15'
error16Example:
$ref: '#/components/examples/postRequestError16'
'500':
description: Error retrieve transactions request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/StatusListResponse'
examples:
errorExample:
$ref: '#/components/examples/postRequestError500'
requestBody:
$ref: '#/components/requestBodies/postRetrieveTransactionsRequest'
tags:
- Intake
"/claim/intake/addTransactions":
post:
summary: postClaimTransactionsAdd
description: |-
This API allows for transaction retrieved from postRetrieveTransactions to be marked for dispute.
Multiple transactions can be added.
Prerequisite API call:
- postRetrieveTransactions
operationId: postClaimTransactionsAdd
parameters: []
responses:
'200':
description: postAddTransactions
content:
application/json:
schema:
$ref: '#/components/schemas/StatusListResponse'
examples:
successExample:
$ref: '#/components/examples/SuccessStatusList'
'400':
description: Error add transactions request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/AddTransactionsResponse'
examples:
error4Example:
$ref: '#/components/examples/postRequestError4'
error5Example:
$ref: '#/components/examples/postRequestError5'
error6Example:
$ref: '#/components/examples/postRequestError6'
error9Example:
$ref: '#/components/examples/postRequestError9'
error13Example:
$ref: '#/components/examples/postRequestError13'
error14Example:
$ref: '#/components/examples/postRequestError14'
error15Example:
$ref: '#/components/examples/postRequestError15'
error16Example:
$ref: '#/components/examples/postRequestError16'
'500':
description: Error add transactions request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/StatusListResponse'
examples:
errorExample:
$ref: '#/components/examples/postRequestError500'
requestBody:
$ref: '#/components/requestBodies/postClaimTransactionAddRequest'
tags:
- Intake
"/claim/intake/retrieveQuestionnaire":
post:
summary: postRetrieveQuestionnaire
description: |-
This API retrieves the questionnaire for a given claim so it can be displayed and acted upon by the intended user interface.
Prerequisite API call:
- postClaimTransactionsAdd
operationId: postRetrieveQuestionnaire
parameters: []
responses:
'200':
description: Successful retrieve questionnaire request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/RetrieveQuestionnaireResponse'
examples:
successExample:
$ref: '#/components/examples/postRetrieveQuestionnaireRequestSuccess'
'400':
description: Error retrieve questionnaire request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/RetrieveQuestionnaireResponse'
examples:
error4Example:
$ref: '#/components/examples/postRequestError4'
error5Example:
$ref: '#/components/examples/postRequestError5'
error6Example:
$ref: '#/components/examples/postRequestError6'
error13Example:
$ref: '#/components/examples/postRequestError13'
error14Example:
$ref: '#/components/examples/postRequestError14'
error15Example:
$ref: '#/components/examples/postRequestError15'
error16Example:
$ref: '#/components/examples/postRequestError16'
'500':
description: Error retrieve questionnaire request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/StatusListResponse'
examples:
errorExample:
$ref: '#/components/examples/postRequestError500'
requestBody:
$ref: '#/components/requestBodies/postRetrieveQuestionnaireRequest'
tags:
- Intake
"/claim/intake/retrieveOtherAccounts":
post:
summary: postRetrieveOtherAccounts
description: |-
Get a list of other accounts for this customer.
Must call retrieveQuestionnaire with a question response indicating in APIDocumentationList that this method is required
Prerequisite API call:
- retrieveQuestionnaire
operationId: postRetrieveOtherAccounts
parameters: []
responses:
'200':
description: postRetrieveOtherAccounts
content:
application/json:
schema:
$ref: '#/components/schemas/RetrieveOtherAccountsResponse'
examples:
successExample:
$ref: '#/components/examples/postRetrieveOtherAccountRequestSuccess'
'400':
description: Error retrieve other accounts request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/StatusListResponse'
examples:
error2Example:
$ref: '#/components/examples/postRequestError2'
error5Example:
$ref: '#/components/examples/postRequestError5'
error6Example:
$ref: '#/components/examples/postRequestError6'
error13Example:
$ref: '#/components/examples/postRequestError13'
error14Example:
$ref: '#/components/examples/postRequestError14'
error15Example:
$ref: '#/components/examples/postRequestError15'
error16Example:
$ref: '#/components/examples/postRequestError16'
'500':
description: Error retrieve other accounts request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/StatusListResponse'
examples:
errorExample:
$ref: '#/components/examples/postRequestError500'
requestBody:
$ref: '#/components/requestBodies/postRetrieveOtherAccountsRequest'
tags:
- Intake
"/claim/intake/retrieveCreditTransactions":
post:
summary: postRetrieveCreditTransactions
description: |-
Gets list of credits within date range for claim
Requires a question response indicating in APIDocumentationList that this method is required
Prerequisite API call:
- retrieveQuestionnaire
operationId: postRetrieveCreditTransactions
parameters: []
responses:
'200':
description: postRetrieveCreditTransactions
content:
application/json:
schema:
$ref: '#/components/schemas/RetrieveTransactionsResponse'
examples:
successExample:
$ref: '#/components/examples/postRetrieveTransactionsRequestSuccess'
'400':
description: Error retrieve credit transactions request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/StatusListResponse'
examples:
error4Example:
$ref: '#/components/examples/postRequestError4'
error5Example:
$ref: '#/components/examples/postRequestError5'
error6Example:
$ref: '#/components/examples/postRequestError6'
error13Example:
$ref: '#/components/examples/postRequestError13'
error14Example:
$ref: '#/components/examples/postRequestError14'
error15Example:
$ref: '#/components/examples/postRequestError15'
error16Example:
$ref: '#/components/examples/postRequestError16'
'500':
description: Error retrieve credit transactions request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/StatusListResponse'
examples:
errorExample:
$ref: '#/components/examples/postRequestError500'
requestBody:
$ref: '#/components/requestBodies/postRetrieveTransactionsRequest'
tags:
- Intake
"/claim/intake/retrieveSimilarTransactions":
post:
summary: postRetrieveSimilarTransactions
description: |-
Get list of similar transactions within search criteria.
Other account numbers are required if the customer identified that the transaction was on a different account.
Requires a question response indicating in APIDocumentationList that this method is required.
Prerequisite API call:
- retrieveQuestionnaire
operationId: postRetrieveSimilarTransactions
parameters: []
responses:
'200':
description: postRetrieveSimilarTransactions
content:
application/json:
schema:
$ref: '#/components/schemas/RetrieveTransactionsResponse'
examples:
successExample:
$ref: '#/components/examples/postRetrieveTransactionsRequestSuccess'
'400':
description: Error retrieve similar transactions request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/StatusListResponse'
examples:
error4Example:
$ref: '#/components/examples/postRequestError4'
error5Example:
$ref: '#/components/examples/postRequestError5'
error6Example:
$ref: '#/components/examples/postRequestError6'
error13Example:
$ref: '#/components/examples/postRequestError13'
error14Example:
$ref: '#/components/examples/postRequestError14'
error15Example:
$ref: '#/components/examples/postRequestError15'
error16Example:
$ref: '#/components/examples/postRequestError16'
'500':
description: Error retrieve similar transactions request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/StatusListResponse'
examples:
errorExample:
$ref: '#/components/examples/postRequestError500'
requestBody:
$ref: '#/components/requestBodies/postRetrieveTransactionsRequest'
tags:
- Intake
"/claim/intake/addSimilarTransactions":
post:
summary: postClaimAddSimilarTransactions
description: |-
Add selected duplicate transaction to claim.
Requires a question response indicating in APIDocumentationList that this method is required
Prerequisite API call:
- retrieveQuestionnaire
operationId: postClaimTransactionsAddSimilar
parameters: []
responses:
'200':
description: postClaimTransactionsAddSimilar
content:
application/json:
schema:
$ref: '#/components/schemas/StatusListResponse'
examples:
successExample:
$ref: '#/components/examples/SuccessStatusList'
'400':
description: Error add similar transactions request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/AddTransactionsResponse'
examples:
error4Example:
$ref: '#/components/examples/postRequestError4'
error5Example:
$ref: '#/components/examples/postRequestError5'
error6Example:
$ref: '#/components/examples/postRequestError6'
error13Example:
$ref: '#/components/examples/postRequestError13'
error14Example:
$ref: '#/components/examples/postRequestError14'
error15Example:
$ref: '#/components/examples/postRequestError15'
error16Example:
$ref: '#/components/examples/postRequestError16'
'500':
description: Error add similar transactions request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/StatusListResponse'
examples:
errorExample:
$ref: '#/components/examples/postRequestError500'
requestBody:
$ref: '#/components/requestBodies/postAddSimilarTransactionRequest'
tags:
- Intake
"/claim/intake/recognizeDisputedTransactions":
post:
summary: postClaimTransactionsRecognize
description: |-
If any selected transactions contain merchants that the customer recognizes, they can be identified with this method.
This is only required if the retrieveQuestionnaire method returns a question identifying this method.
Prerequisite API call:
- retrieveQuestionnaire with a question response indicating in APIDocumentationList that this method is required
operationId: postClaimTransactionsRecognize
parameters: []
responses:
'200':
description: postClaimTransactionsRecognize
content:
application/json:
schema:
$ref: '#/components/schemas/StatusListResponse'
examples:
successExample:
$ref: '#/components/examples/SuccessStatusList'
'400':
description: Error recognize transactions request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/AddTransactionsResponse'
examples:
error4Example:
$ref: '#/components/examples/postRequestError4'
error5Example:
$ref: '#/components/examples/postRequestError5'
error6Example:
$ref: '#/components/examples/postRequestError6'
error13Example:
$ref: '#/components/examples/postRequestError13'
error14Example:
$ref: '#/components/examples/postRequestError14'
error15Example:
$ref: '#/components/examples/postRequestError15'
error16Example:
$ref: '#/components/examples/postRequestError16'
'500':
description: Error recognize transactions request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/StatusListResponse'
examples:
errorExample:
$ref: '#/components/examples/postRequestError500'
requestBody:
$ref: '#/components/requestBodies/postAddSimilarTransactionRequest'
tags:
- Intake
"/claim/intake/addQuestionnaire":
post:
summary: postClaimQuestionnaireAdd
description: |-
This API is used to return the answers to the detailed questionnaire.
Prerequisite API call:
- postRetrieveQuestionnaire
operationId: postClaimQuestionnaireAdd
parameters: []
responses:
'200':
description: Successful add questionnaire request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/StatusListResponse'
examples:
successExample:
$ref: '#/components/examples/SuccessStatusList'
'400':
description: Error add questionnaire request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/StatusListResponse'
examples:
error4Example:
$ref: '#/components/examples/postRequestError4'
error5Example:
$ref: '#/components/examples/postRequestError5'
error6Example:
$ref: '#/components/examples/postRequestError6'
error13Example:
$ref: '#/components/examples/postRequestError13'
error14Example:
$ref: '#/components/examples/postRequestError14'
error15Example:
$ref: '#/components/examples/postRequestError15'
error16Example:
$ref: '#/components/examples/postRequestError16'
'500':
description: Error add questionnaire request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/StatusListResponse'
examples:
errorExample:
$ref: '#/components/examples/postRequestError500'
requestBody:
$ref: '#/components/requestBodies/postAddQuestionnaireRequest'
tags:
- Intake
"/claim/intake/retrieveDocRequirements":
post:
summary: postRetrieveDocRequirements
description: |-
This API retrieves the document requirements for a given claim so it can be displayed and acted upon by the intended user interface.
Prerequisite API call:
-postClaimQuestionnaireAdd
operationId: postRetrieveDocRequirements
parameters: []
responses:
'200':
description: Successful retrieve document requirements request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/RetrieveDocRequirementsResponse'
examples:
success - with requirements:
$ref: '#/components/examples/postRetrieveDocRequirementsRequestSuccess'
success - no requirements:
$ref: '#/components/examples/postRetrieveDocRequirementsRequestNoDocsSuccess'
'400':
description: Error retrieve document requirements request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/RetrieveDocRequirementsResponse'
examples:
error4Example:
$ref: '#/components/examples/postRequestError4'
error5Example:
$ref: '#/components/examples/postRequestError5'
error13Example:
$ref: '#/components/examples/postRequestError13'
error14Example:
$ref: '#/components/examples/postRequestError14'
'500':
description: Error retrieve document requirements request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/StatusListResponse'
examples:
errorExample:
$ref: '#/components/examples/postRequestError500'
requestBody:
$ref: '#/components/requestBodies/postRetrieveDocRequirementsRequest'
tags:
- Intake
"/claim/intake/addDocuments":
post:
summary: postClaimDocumentsAdd
description: |-
This API is used to upload the documents to the claim.
Prerequisite API call:
- postClaimQuestionnaireAdd
- postRetrieveDocRequirements if doc requirements are unknown
operationId: postClaimDocumentsAdd
parameters: []
responses:
'200':
description: Successful add documents request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/StatusListResponse'
examples:
successExample:
$ref: '#/components/examples/SuccessStatusList'
'400':
description: Error add documents request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/StatusListResponse'
examples:
error4Example:
$ref: '#/components/examples/postRequestError4'
error5Example:
$ref: '#/components/examples/postRequestError5'
error6Example:
$ref: '#/components/examples/postRequestError6'
error13Example:
$ref: '#/components/examples/postRequestError13'
error14Example:
$ref: '#/components/examples/postRequestError14'
error15Example:
$ref: '#/components/examples/postRequestError15'
error16Example:
$ref: '#/components/examples/postRequestError16'
'500':
description: Error add documents request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/StatusListResponse'
examples:
errorExample:
$ref: '#/components/examples/postRequestError500'
requestBody:
$ref: '#/components/requestBodies/postAddDocumentsRequest'
tags:
- Intake
"/claim/intake/retrieveCorrespondenceChannels":
post:
summary: postRetrieveChannelInfo
description: |-
This API retrieves the correspondence channel information for a given claim so it can be displayed and acted upon by the intended user interface.
Only required and supported if client has multi-channel verification enabled.
Prerequisite API call:
-postClaimQuestionnaireAdd"
operationId: postRetrieveChannelInfo
parameters: []
responses:
'200':
description: postRetrieveChannelInfo
content:
application/json:
schema:
$ref: '#/components/schemas/RetrieveCorrChannelResponse'
examples:
successExample:
$ref: '#/components/examples/postRetrieveChannelInfoRequestSuccess'
'400':
description: Error retrieve correspondence channels request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/RetrieveCorrChannelResponse'
examples:
error4Example:
$ref: '#/components/examples/postRequestError4'
error5Example:
$ref: '#/components/examples/postRequestError5'
error13Example:
$ref: '#/components/examples/postRequestError13'
error14Example:
$ref: '#/components/examples/postRequestError14'
'500':
description: Error retrieve correspondence channels request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/StatusListResponse'
examples:
errorExample:
$ref: '#/components/examples/postRequestError500'
requestBody:
$ref: '#/components/requestBodies/postRetrieveChannelInfoRequest'
tags:
- Intake
"/claim/intake/verifyCorrespondenceChannels":
post:
summary: postVerifyChannelInfo
description: |-
This API is used to verify or update (if editable) the communication channels for the customer on the claim. Only required and supported if client has multi-channel verification enabled.
Prerequisite API call:
- postRetrieveChannelInfo
operationId: postVerifyChannelInfo
parameters: []
responses:
'200':
description: Successful verify channels request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/StatusListResponse'
examples:
successExample:
$ref: '#/components/examples/SuccessStatusList'
'400':
description: Error verify channels request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/StatusListResponse'
examples:
error4Example:
$ref: '#/components/examples/postRequestError4'
error5Example:
$ref: '#/components/examples/postRequestError5'
error6Example:
$ref: '#/components/examples/postRequestError6'
error13Example:
$ref: '#/components/examples/postRequestError13'
error14Example:
$ref: '#/components/examples/postRequestError14'
error15Example:
$ref: '#/components/examples/postRequestError15'
error16Example:
$ref: '#/components/examples/postRequestError16'
'500':
description: Error verify channels request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/StatusListResponse'
examples:
errorExample:
$ref: '#/components/examples/postRequestError500'
requestBody:
$ref: '#/components/requestBodies/postVerifyChannelInfoRequest'
tags:
- Intake
"/claim/intake/retrieveSummary":
post:
summary: postRetrieveClaimIntakeSummary
description: |-
This API retrieves the questionnaire for a given claim so it can
be displayed and acted upon by the intended user interface.
Prerequisite API call:
- postClaimTransactionsAdd
operationId: postRetrieveClaimIntakeSummary
parameters: []
responses:
'200':
description: Successful retrieve summary request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/RetrieveSummaryResponse'
examples:
successExample:
$ref: '#/components/examples/postRetrieveSummaryRequestSuccess'
'400':
description: Error retrieve summary request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/StatusListResponse'
examples:
error4Example:
$ref: '#/components/examples/postRequestError4'
error5Example:
$ref: '#/components/examples/postRequestError5'
error6Example:
$ref: '#/components/examples/postRequestError6'
error13Example:
$ref: '#/components/examples/postRequestError13'
error14Example:
$ref: '#/components/examples/postRequestError14'
'500':
description: Error retrieve summary request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/StatusListResponse'
examples:
errorExample:
$ref: '#/components/examples/postRequestError500'
requestBody:
$ref: '#/components/requestBodies/postRetrieveSummaryRequest'
tags:
- Intake
"/claim/intake/submit":
post:
summary: postClaimSubmit
description: |-
This API allows for the claim to be finalized and documentation passed back to the requester.
Prerequisite API:
- postClaimQuestionnaireAdd
operationId: postClaimSubmit
parameters: []
responses:
'200':
description: Successful claim submission request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/StatusListResponse'
examples:
successExample:
$ref: '#/components/examples/SuccessStatusList'
'400':
description: Error Successful claim submission request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/StatusListResponse'
examples:
error4Example:
$ref: '#/components/examples/postRequestError4'
error5Example:
$ref: '#/components/examples/postRequestError5'
error6Example:
$ref: '#/components/examples/postRequestError6'
error13Example:
$ref: '#/components/examples/postRequestError13'
error14Example:
$ref: '#/components/examples/postRequestError14'
error15Example:
$ref: '#/components/examples/postRequestError15'
error16Example:
$ref: '#/components/examples/postRequestError16'
'500':
description: Error Successful claim submission request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/StatusListResponse'
examples:
errorExample:
$ref: '#/components/examples/postRequestError500'
requestBody:
$ref: '#/components/requestBodies/postClaimSubmitRequest'
tags:
- Intake
"/claim/intake/retrieveConfirmation":
post:
summary: postRetrieveClaimIntakeConfirmation
description: |-
This API retrieves the questionnaire for a given claim so it can be displayed and acted upon by the intended user interface.
Prerequisite API call:
- postClaimSubmit
operationId: postRetrieveClaimIntakeConfirmation
parameters: []
responses:
'200':
description: Successful retrieve confirmation request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/RetrieveConfirmationResponse'
examples:
successExample:
$ref: '#/components/examples/postRetrieveConfirmationRequestSuccess'
'400':
description: Error retrieve confirmation request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/StatusListResponse'
examples:
error4Example:
$ref: '#/components/examples/postRequestError4'
error5Example:
$ref: '#/components/examples/postRequestError5'
error11Example:
$ref: '#/components/examples/postRequestError11'
error13Example:
$ref: '#/components/examples/postRequestError13'
error14Example:
$ref: '#/components/examples/postRequestError14'
'500':
description: Error retrieve confirmation request
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/StatusListResponse'
examples:
errorExample:
$ref: '#/components/examples/postRequestError500'
requestBody:
$ref: '#/components/requestBodies/postRetrieveConfirmationRequest'
tags:
- Intake
components:
requestBodies:
postClaimCorrespondenceResendRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/CorrespondenceResendRequest'
postCustomerRetrieveRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/CustomerRetrieveRequest'
postTransactionListRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/TransactionListRequest'
postStatusRetrieveRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/StatusRetrieveRequest'
postClaimReopenRequestRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/ReopenRequestRequest'
postClaimWithdrawRequestRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/WithdrawRequestRequest'
postNotesRetrieveRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/NotesRetrieveRequest'
postNotesListRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/NotesListRequest'
postNotesAddRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/NotesAddRequest'
postClaimListRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/ClaimListRequest'
postCorrespondenceRetrieveRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/CorrespondenceRetrieveRequest'
postCorrespondenceListRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/CorrespondenceListRequest'
postAttachmentsAddRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/AttachmentsAddRequest'
postAttachmentsListRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/AttachmentsListRequest'
postAttachmentsRetrieveRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/AttachmentsRetrieveRequest'
postRetrieveAccountsRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/RetrieveAccountsRequest'
postRetrieveCustomersRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/RetrieveCustomersRequest'
postCreateClaimRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateClaimRequest'
postRetrieveReasonsRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/CorrelationIdClaimIdRequest'
postAddClaimReasonsRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/AddQuestionnaireRequest'
example:
CorrelationId: 123e4567-e89b-12d3-a456-426614174000
ClaimId: 2108160022C
Questionnaire:
QuestionList:
- Identifier: ClaimTransType
AnswerValue: 'true'
- Identifier: ClaimReasonType
AnswerValue: Fraud
- Identifier: ClaimReason
AnswerValue: CardSecure
postRetrieveTransactionsRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/RetrieveTransactionsRequest'
example:
CorrelationId: 123e4567-e89b-12d3-a456-426614174000
ClaimId: 2108160022C
SearchStartDate: '20210401'
SearchEndDate: '20210512'
SearchAmount: '2.09'
SearchMerchantName: Amazon
postClaimTransactionAddRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/AddTransactionsRequest'
example:
CorrelationId: 123-456-7890
ClaimId: 2108160022C
TransactionList:
- TransactionId: '6'
- TransactionId: '11'
postAddSimilarTransactionRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/AddTransactionsRequest'
example:
CorrelationId: 123e4567-e89b-12d3-a456-426614174000
ClaimId: 2108160022C
TransactionList:
- TransactionId: '6'
postRetrieveQuestionnaireRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/CorrelationIdClaimIdRequest'
postRetrieveOtherAccountsRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/CorrelationIdClaimIdRequest'
postAddQuestionnaireRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/AddQuestionnaireRequest'
example:
CorrelationId: 123e4567-e89b-12d3-a456-426614174000
ClaimId: 2108160022C
Questionnaire:
QuestionList:
- Identifier: EverDoneBusiness
AnswerValue: RecognizesMerchant
- Identifier: RecognizeDisputedMerchant
AnswerValue: 'No'
- Identifier: CardPossessionInd
AnswerValue: 'Yes'
- Identifier: HasAuthorizedOthers
AnswerValue: 'No'
- Identifier: HasSharedPIN
AnswerValue: 'No'
- Identifier: WherePinKept
AnswerValue: InMemory
- Identifier: ReissueCard
AnswerValue: 'No'
IgnoreVIsibilityConditions: 'true'
- Identifier: AddlInfo
AnswerValue: 'Yes'
- Identifier: AddlInfoDetails
AnswerValue: Please please please help me!!
postRetrieveDocRequirementsRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/CorrelationIdClaimIdRequest'
postAddDocumentsRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/AddDocumentsRequest'
postRetrieveChannelInfoRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/CorrelationIdClaimIdRequest'
postVerifyChannelInfoRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/VerifyChannelInfoRequest'
example:
CorrelationId: 123e4567-e89b-12d3-a456-426614174000
ClaimId: "2108160022C"
CorrespondenceChannelList:
- IsVerifiedCorrect: false
Name: Email
Address:
EmailAddress: TestCustomer@quavo.com
- IsVerifiedCorrect: true
Name: Mail
postRetrieveSummaryRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/CorrelationIdClaimIdRequest'
postClaimSubmitRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/ClaimSubmitRequest'
example:
CorrelationId: 123e4567-e89b-12d3-a456-426614174000
ClaimId: "2108160022C"
CorrespondenceDetails:
SelectedChannel: Mail
Address:
Line1: 6 ashbridge lane
Line2: ''
Line3: ''
City: Linwood
State: NJ
Zip: '08111'
Country: USA
Questionnaire:
QuestionList:
- Identifier: WithholdPC
AnswerValue: 'true'
- Identifier: PCOverrideReason
AnswerValue: This person seemed sus
postRetrieveConfirmationRequest:
content:
application/json:
schema:
$ref: '#/components/schemas/CorrelationIdClaimIdRequest'
examples:
postCustomerRetrieveRequestSuccess:
value:
Zip: 12345
StreetAddress: 123 Main St
FirstName: William
State: IL
StatusList:
- Type: Success
Message: Success
Code: '200'
Country: United States of America
PhoneNumber: 231-555-
LastName: Murray
City: Evanston
AccountList:
- Description: "Checking Account"
AccountType: "Deposit"
Balance: 1000
AccountNumber: 4447111111117413
- Description: "Visa CreditCard"
AccountType: "CreditCard"
Balance: 8564.74
AccountNumber: 3000763433
- Description: "Deposit Account"
AccountType: "Depsosit"
Balance: 0
AccountNumber: 4116000199012348
EmailAddress: BigBadBill@quavo.com
postTransactionListRequestSuccess:
value:
TransactionList:
- TransactionAmount: "100.000000000"
CardLastFourDigits: "8557"
DisputedAmount: "100.000000000"
Description: "Quavo Bank BRANCH #2145"
PostingDate: "20210727"
CurrentStage: "Analyze"
LastCommitDate: "20210728T020235.184 GMT"
TransactionId: "2"
StatusList:
- Type: Success
Message: Success
Code: '200'
postStatusRetrieveRequestSuccess:
value:
CardNumber: "562139058235"
ClaimId: "98245G"
Actions:
- Importance: other
ActionName: View Communication
StatusList:
- Type: Success
Message: Success
Code: '200'
Stages:
- Status: Current
Name: Received
- Status: Complete
Name: Investigating
CustomerContactDate: "20220323 GMT"
CreateName: "string"
AccountType: "CreditCard"
AccountNumber: "8025307835"
RequiredDocumentCount: "string"
ClaimStatus: "New"
TalkingPoints:
- DisplayText: We have created a claim ID, but the process is incomplete
AccountHolder: "string"
HeaderDisplay: "Transaction Dispute (claimId)"
postNotesListRequestSuccess:
value:
NotesList:
LinkReference: DATA-WORKATTACH-NOTE QVO-FW-FF-WORK-P-FB-CLAIMS-CLAIM 2106160003C!
CreateDateTime: 20210618T121038.925 GMT
CreateName: joe shmoe
Subject: Test Subject again
StatusList:
- Type: Success
Message: Success
Code: '200'
postNotesRetrieveRequestSuccess:
value:
Note: Test Note
Subject: Test Subject
StatusList:
- Type: Success
Message: Success
Code: '200'
postClaimListRequestSuccess:
value:
claimListResponse:
- accountHolder: "William James Murray"
requiredDocumentCount: 0
customerContactDate: "20211005T000000.000 GMT"
claimId: "2110050013C"
accountNumber: "4447111111117413"
claimStatus: "Open-Execute"
createName: "creat or"
StatusList:
- Type: Success
Message: Success
Code: '200'
postCorrespondenceRetrieveRequestSuccess:
value:
EmailStyleMarkup: .qvo-customercontent-table { border-collapse:collapse;
Body: <table class="qvoBodyContent"><tr><td> <!--qvoBodyContentBegin-->
StatusList:
- Type: Success
Message: Success
Code: '200'
postCorrespondenceListRequestSuccess:
value:
CorrespondenceList:
- TransmissionStatus: Failed
SaveDate: 20210811T172051.195 GMT
ThreadSubject: #Secure# Message from Quavo Bank 2108100024C
LinkReference: QVO-FW-FF-WORK-P-FB-CLAIMS-CLAIM 2108100024C!20210811T172051.157 GMT
Channel: Email
From: Default
To: carson@wentz.com
Document: Claim Reopen Request Confirmation
StatusList:
- Type: Success
Message: Success
Code: '200'
postAttachmentsRetrieveRequestSuccess:
value:
AttachmentName: TestFile.pdf
Note: Test File
DocumentStream: JVBERi0xLjcNCiW1tbW1DQoxIDAgb2JqDQo8PC
StatusList:
- Type: Success
Message: Success
Code: '200'
postAttachmentsListRequestSuccess:
value:
AttachmentsList:
- Category: Accountholder
LinkReference: DATA-WORKATTACH-FILE QVO-FW-FF-WORK-P-FB-CLAIMS-CLAIM 2106140039C!20210818T202237.387 GMT
CreateDateTime: 20210818T202237.554 GMT
CreateName: QFD API User
Name: This is a test file
StatusList:
- Type: Success
Message: Success
Code: '200'
summary: A sample success attachments list response
postCreateClaimRequestSuccess:
value:
ClaimId: 2108160022C
StatusList:
- Type: Success
Message: Success
Code: '200'
summary: A sample Success create response
postRetrieveReasonsRequestSuccess:
value:
Questionnaire:
QuestionList:
- Type: RadioButtons
AnswerList:
- QuestionList:
- Type: RadioButtons
AnswerList:
- Identifier: MerchantDuplicate
DisplayText: I was charged more than once.
- Identifier: MerchantNotProvided
DisplayText: I haven't received merchandise or a service I purchased.
- Identifier: MerchantCreditNotIssued
DisplayText: I cancelled or returned the merchandise or service and have
not received the expected credit.
- Identifier: MerchandiseServiceIssue
DisplayText: I am dissatisfied with the merchandise or a service I received.
- Identifier: ChargedCreditedIncorrect
DisplayText: I was charged or credited incorrectly.
Identifier: ClaimReason
DisplayText: Which of the following best describes the reason for your dispute?
DataType: String
Identifier: NonFraud
DisplayText: I made this purchase, but there is a problem and I need to dispute
it.
- QuestionList:
- Type: RadioButtons
AnswerList:
- Identifier: CardLost
DisplayText: I lost my card.
- Identifier: CardStolen
DisplayText: My card was stolen.
- Identifier: CardNotReceived
DisplayText: I did not receive my card.
- Identifier: CardSecure
DisplayText: I didn't make the purchase, but I still have my card.
Identifier: ClaimReason
DisplayText: Which of the following best describes the reason for your dispute?
DataType: String
Identifier: Fraud
DisplayText: I did not authorize this transaction. I suspect fraud.
- Identifier: AuthChargeback
DisplayText: There is an authorization issue.
Identifier: ClaimReasonType
DisplayText: Which of the following would you like to report?
DataType: String
Identifier: DisputeReasonCard
StatusList:
- Type: Success
Message: Success
Code: '200'
summary: A sample Success response
postRetrieveTransactionsRequestSuccess:
value:
StatusList:
- Type: Success
Message: Success
Code: '200'
TransactionList:
- AuthorizationStatus: Posted
DebitCredit: Debit
TransactionType: ATMWD
Description: 7-ELEVEN 22177 (CHIP)
Amount: '27.50'
CardNumberEndingIn: '7413'
Date: '20210626'
TransactionId: '460268821703314'
- AuthorizationStatus: Posted
DebitCredit: Debit
TransactionType: CardPinless
Description: LA VICTORIA NO 3 (10.1)
Amount: '30.97'
CardNumberEndingIn: '7413'
Date: '20210624'
TransactionId: '5'
- AuthorizationStatus: Posted
DebitCredit: Debit
TransactionType: CardPinless
Description: CRUNCH BELLE ISLE (10.3)
Amount: '26.57'
CardNumberEndingIn: '7413'
Date: '20210617'
TransactionId: '8'
- AuthorizationStatus: Posted
DebitCredit: Debit
TransactionType: CardPinless
Description: Chargeback Response E-900000049
Amount: '98.99'
CardNumberEndingIn: '7413'
Date: '20210611'
TransactionId: '13'
- AuthorizationStatus: Posted
DebitCredit: Debit
TransactionType: CardPinless
Description: 123.COM (10.4)
Amount: '39.99'
CardNumberEndingIn: '7413'
Date: '20210602'
TransactionId: '3'
- AuthorizationStatus: Posted
DebitCredit: Debit
TransactionType: CardPinless
Description: 123.COM2
Amount: '39.99'
CardNumberEndingIn: '7413'
Date: '20210602'
TransactionId: '4'
- AuthorizationStatus: Posted
DebitCredit: Debit
TransactionType: CardPinless
Description: BASECAMP FITNESS (10.1)
Amount: '79.99'
CardNumberEndingIn: '7413'
Date: '20210408'
TransactionId: '2'
- AuthorizationStatus: Pending
DebitCredit: Debit
TransactionType: CardPinless
Description: LA VICTORIA NO 3
Amount: '30.97'
CardNumberEndingIn: '7413'
Date: '20201123'
TransactionId: '10'
- AuthorizationStatus: Posted
DebitCredit: Credit
TransactionType: CardPinless
Description: BIODIETSUPPLEMENTS.COM (10.4)
Amount: '91.74'
CardNumberEndingIn: '7413'
Date: '20201115'
TransactionId: '11'
- AuthorizationStatus: Posted
DebitCredit: Debit
TransactionType: CardPinless
Description: BIODIETSUPPLEMENTS.COM (10.4)
Amount: '91.74'
CardNumberEndingIn: '7411'
Date: '20200615'
TransactionId: '6'
- AuthorizationStatus: Posted
DebitCredit: Credit
TransactionType: CardPinless
Description: BIODIETSUPPLEMENTS.COM (10.4)
Amount: '30'
CardNumberEndingIn: '7413'
Date: '20200615'
TransactionId: '7'
- AuthorizationStatus: Posted
DebitCredit: Debit
TransactionType: CardPinless
Description: BIODIETSUPPLEMENTS.COM (10.4) 2
Amount: '91.74'
CardNumberEndingIn: '7413'
Date: '20200612'
TransactionId: '12'
summary: A sample Success response
postRetrieveQuestionnaireRequestSuccess:
value:
Questionnaire:
QuestionList:
- QuestionList:
- QuestionList:
- QuestionList:
- Type: YesNo
AnswerList:
- Identifier: 'Yes'
DisplayText: 'Yes'
- QuestionList:
- Type: Text
Identifier: CardLocation
DisplayText: Where is the card usually kept?
DataType: String
- Type: Text
Identifier: CardNoPossession
DisplayText: In what circumstances do you not have the card in your possession?
DataType: String
Identifier: 'No'
DisplayText: 'No'
Identifier: CardPossessionInd
DisplayText: Do you always have possession of the card?
DataType: String
- QuestionList:
- Type: YesNo
AnswerList:
- QuestionList:
- Type: Text
Identifier: AuthorizedName
DisplayText: Who has authorization to use your card?
DataType: String
Identifier: 'Yes'
DisplayText: 'Yes'
- Identifier: 'No'
DisplayText: 'No'
Identifier: HasAuthorizedOthers
DisplayText: Have you ever authorized another person to use your card?
DataType: String
- Type: YesNo
AnswerList:
- QuestionList:
- Type: Text
Identifier: SharedPINName
DisplayText: Who did you share it with?
DataType: String
Identifier: 'Yes'
DisplayText: 'Yes'
- Identifier: 'No'
DisplayText: 'No'
Identifier: HasSharedPIN
DisplayText: Have you ever shared your Personal Identification Number (PIN)?
DataType: String
- QuestionList:
- QuestionList:
- Type: Nothing
Identifier: ''
DisplayText: ''
DataType: String
Type: Questionnaire
Identifier: BlockAndReissueCard
DisplayText: ''
DataType: String
Type: Questionnaire
Identifier: WherePinIsKept
DisplayText: ''
DataType: String
Type: Questionnaire
Identifier: vsq1
DisplayText: ''
DataType: String
Type: Questionnaire
Identifier: CardPossession
DisplayText: ''
DataType: String
Type: Section
AnswerList:
- QuestionList:
- Type: YesNo
AnswerList:
- QuestionList:
- Type: Nothing
Identifier: ''
DisplayText: Custom Section
DataType: String
Identifier: 'Yes'
DisplayText: 'Yes'
- Identifier: 'No'
DisplayText: 'No'
Identifier: RecognizeDisputedMerchant
DisplayText: 'Is it possible that this is a planned, recurring transaction, such as a monthly or yearly subscription?'
DataType: String
Identifier: RecognizesMerchant
DisplayText: ''
- Identifier: DoesNotRecognize
DisplayText: ''
Identifier: EverDoneBusiness
DisplayText: Have you ever done business with any of these disputed merchants?
DataType: String
APIDocumentationList:
- ImplementationNotes: 'If any selected transactions contain merchants that the customer recognizes, they can be identified with this method. In addition the answer to this question should be identified as ''RecognizesMerchant''. If the customer does not recognize any merchants, this question can be answered with ''DoesNotRecognize''.'
Endpoint: /claim/intake/recognizeDisputedTransactions
Method: post
Type: Nothing
Identifier: ''
DisplayText: '“I didn''t make the purchase, but I still have my card.”'
DataType: String
Identifier: FraudCardSecure
StatusList:
- Type: Success
Message: Success
Code: '200'
PostQuestionnaire:
QuestionList:
- Type: YesNo
AnswerList:
- QuestionList:
- Type: TextMulti
Identifier: AddlInfoDetails
DisplayText: Please provide any additional information
DataType: String
Identifier: 'Yes'
DisplayText: 'Yes'
- Identifier: 'No'
DisplayText: 'No'
Identifier: AddlInfo
DisplayText: Do you have any additional information to provide about this dispute?
DataType: String
Identifier: QFD_Extensions_PostQns
summary: A sample Success response
postRetrieveAccountsRequestSuccess:
value:
StatusList:
- Type: Success
Message: Success
Code: '200'
AccountList:
- Description: Mastercard Rewards
OpenDate: '20200701'
Balance: 702.12
AccountNumber: '5555555555554444'
- Description: Mastercard Platinum
OpenDate: '20210701'
Balance: 1702.23
AccountNumber: '5555555555554445'
postRetrieveCustomersRequestSuccess:
value:
StatusList:
- Type: Success
Message: Success
Code: '200'
CustomerList:
- SecondaryPhone:
Number: ''
Address:
Zip: '12345'
State: IL
LongAddress: 123 Main St Evanston IL 12345
Country: United States of America
City: Evanston
Line1: 123 Main St
Line2: ''
Line3: ''
Phone:
Number: 231-555-1234
CustomerId: '939472005'
EmailAddress: BigBadBill@quavo.com
Name:
Last: Murray
Suffix: ''
BusinessName: ''
FullName: William James Murray
Prefix: ''
First: William
Middle: James
postRetrieveOtherAccountRequestSuccess:
value:
StatusList:
- Type: Success
Message: Success
Code: '200'
AccountList:
- Description: Mastercard Rewards
OpenDate: '20200701'
Balance: 702.12
AccountNumber: '5555555555554444'
postRetrieveDocRequirementsRequestSuccess:
value:
StatusList:
- Type: Success
Message: Success
Code: '200'
DocumentRequirementList:
- TemplateDocumentStream: JVBERi0xLjQKJcfl9OXwCjEgMCBvYmoKPDwKL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAxMTc1Cj4+CnN0cmVolJUVPRgo=
IsSatisfied: false
Identifier: StatementOfDispute
IsRequired: true
Label: Statement of Dispute
ValidAttachmentCategoryList:
- Value: Accountholder
Key: Accountholder
- Value: Supporting Documentation
Key: SupportingDocumentation
summary: A sample Success response with document requirements
postRetrieveDocRequirementsRequestNoDocsSuccess:
value:
StatusList:
- Type: Success
Message: No documents are required for this case
Code: '201'
summary: A sample Success response with no document requirements
postRetrieveChannelInfoRequestSuccess:
value:
StatusList:
- Type: Success
Message: Success
Code: '200'
CorrespondenceChannelList:
- IsEditable: true
Address:
EmailAddress: TestCustomer@quavo.com
Name: Email
- IsEditable: false
Address:
Zip: '12345'
State: IL
LongAddress: 123 Main St IL 12345
Attention: ''
Country: United States of America
Line1: 123 Main St
Line2: ''
Line3: ''
Name: Mail
summary: A sample Success response with correspondence channel info
postRetrieveConfirmationRequestSuccess:
value:
ConfirmationDocumentStream: JVBERi0xLjQKJcfl9OXwCjEgMCBvYmoKPDwKL0ZpbHRlciAvUVPRgo=
ConfirmationMessageMarkup: PHRhYmxlIGNsYXNzPSJxdm9Cb2R5Q29udGVudCI+PHRyPjx0ZD4gPCEtLXF2b0JvZHlDb250ZW50=
StatusList:
- Type: Success
Message: Success
Code: '200'
ConfirmationHeader: 'Confirmation #: 2108240024C'
ConfirmationDocumentName: Confirmation.pdf
postRetrieveSummaryRequestSuccess:
value:
CorrespondenceDetails:
CanIgnoreCorrespondencePreference: 'false'
SelectedChannel: Email
ChannelList:
- Value: Email
Key: Email
- Value: Mail
Key: Mail
- Value: Manual
Key: Manual
EmailAddress: TestCustomer@quavo.com
SummaryContactHeader: 'If we need to contact you, it will be at this address: TestCustomer@quavo.com'
StatusList:
- Type: Success
Message: Success
Code: '200'
SummaryQuestionnaire:
QuestionList:
- QuestionList:
- Type: YesNo
AnswerList:
- QuestionList:
- Type: TextMulti
Identifier: PCOverrideReason
DisplayText: 'Please provide a reason:'
DataType: String
Identifier: 'true'
DisplayText: 'Yes'
- Identifier: 'false'
DisplayText: 'No'
Identifier: WithholdPC
DisplayText: Withold Provisional Credit?
DataType: String
- QuestionList:
- QuestionList:
- Type: YesNo
AnswerList:
- QuestionList:
- Type: TextMulti
Identifier: ContactDateOverrideReason
DisplayText: 'Please provide a reason:'
DataType: String
- Type: Date
Identifier: OverrideContactDate
DisplayText: 'Enter the new date:'
DataType: Date
- Type: Nothing
Identifier: ''
DisplayText: ''
DataType: String
Identifier: 'true'
DisplayText: 'Yes'
- Identifier: 'false'
DisplayText: 'No'
Identifier: IsContactDateOverridden
DisplayText: 'The contact date assigned to the claim is 8/24/21. Would you
like to override this date? Note: Changing the date may have regulatory
impacts.'
DataType: String
Type: Questionnaire
Identifier: ContactDateOverride
DisplayText: ''
DataType: String
Type: Questionnaire
Identifier: FCRAClaimDetails
DisplayText: ''
DataType: String
Type: Questionnaire
Identifier: ManualPCWithhold
DisplayText: ''
DataType: String
Identifier: SummaryQuestions
TransactionDetails:
SummaryHeader: ''
SelectedPostedTransactionList:
- AuthorizationStatus: Posted
DebitCredit: Debit
TransactionType: CardPinless
Description: 123.COM2
Amount: '39.99'
CardNumberEndingIn: '7413'
Date: '20210602'
TransactionId: '4'
- AuthorizationStatus: Posted
DebitCredit: Debit
TransactionType: CardPinless
Description: BASECAMP FITNESS (10.1)
Amount: '79.99'
CardNumberEndingIn: '7413'
Date: '20210408'
TransactionId: '2'
SuccessStatusList:
value:
StatusList:
- Type: Success
Message: Success
Code: '200'
summary: A sample Success response
#ErrorList
postRequestError1:
value:
StatusList:
- Type: Error
Message: Invalid CustomerId
Code: '1'
summary: A sample Error 1 response
postRequestError2:
value:
StatusList:
- Type: Error
Message: CustomerId or AccountNumber returned no claims
Code: '2'
summary: A sample Error 2 response
postRequestError4:
value:
StatusList:
- Type: Error
Message: Invalid ClaimId or ClaimId returned no results
Code: '4'
summary: A sample Error 4 response
postRequestError5:
value:
StatusList:
- Type: Error
Message: "Invalid Request: {message}"
Code: '5'
summary: A sample Error 5 response
postRequestError6:
value:
StatusList:
- Type: Error
Message: "Error saving claim: {message}"
Code: '6'
summary: A sample Error 6 response
postRequestError7:
value:
StatusList:
- Type: Error
Message: "Case not resumed due to incomplete questionnaire, message: {message}"
Code: '7'
summary: A sample Error 7 response
postRequestError8:
value:
StatusList:
- Type: Error
Message: "Problem validating search criteria: {message}"
Code: '8'
summary: A sample Error 8 response
postRequestError9:
value:
StatusList:
- Type: Error
Message: "Unable to resume flow: {message}"
Code: '9'
summary: A sample Error 9 response
postRequestError10:
value:
TranasctionList:
- NonDisputableMessageDetails: "Credits are not disputable for this claim reason"
TransactionId: '11'
StatusList:
- Type: Error
Message: "Unable to resume flow: {message}"
Code: '10'
summary: A sample Error 10 response
postRequestError11:
value:
StatusList:
- Type: Error
Message: "Error generating confirmation document"
Code: '11'
summary: A sample Error 11 response
postRequestError12:
value:
StatusList:
- Type: Error
Message: "Invalid Document Identifier or Identifier returned no results"
Code: '12'
summary: A sample Error 12 response
postRequestError13:
value:
StatusList:
- Type: Error
Message: "ClaimId references a claim that is currently locked"
Code: '13'
summary: A sample Error 13 response
postRequestError14:
value:
StatusList:
- Type: Error
Message: Invalid request message
Code: '14'
summary: A sample Error 14 response
postRequestError15:
value:
StatusList:
- Type: Error
Message: "This claim is already resolved with status: {message}"
Code: '15'
summary: A sample Error 15 response
postRequestError16:
value:
StatusList:
- Type: Error
Message: "This claim has been submitted for processing and this action can no longer be performed"
Code: '16'
summary: A sample Error 16 response
postRequestError17:
value:
StatusList:
- Type: Error
Message: "No customers were found with given search parameters"
Code: '17'
summary: A sample Error 17 response
postRequestError18:
value:
StatusList:
- Type: Error
Message: "AccountNumber is not found"
Code: '18'
summary: A sample Error 18 response
postRequestError500:
value:
StatusList:
- Type: Error
Message: Could not obtain a lock on the claim
Code: '500'
summary: A sample Error 500 response
schemas:
Account:
type: object
properties:
AccountNumber:
type: string
description: the account number
example: 5555555555554445
Balance:
type: string
description: the balance on the account
example: 701.12
Description:
type: string
description: The account description
example: Mastercard Rewards
OpenDate:
type: string
description: the date the account was opened in yyyyMMdd format
example: 20200701
AccountList:
type: array
items:
$ref: "#/components/schemas/Account"
AddDocumentsRequest:
type: object
properties:
CorrelationId:
type: string
description: a unique correlation ID for this message
example: 123e4567-e89b-12d3-a456-426614174000
ClaimId:
type: string
description: a unique claim identifier
example: 2108160022C
DocumentRequirementList:
$ref: "#/components/schemas/DocumentRequirementRequestList"
AddQuestionnaireRequest:
type: object
required:
- CorrelationId
- ClaimId
- Questionnaire
properties:
CorrelationId:
type: string
description: a unique correlation ID for this message
example: 123e4567-e89b-12d3-a456-426614174000
ClaimId:
type: string
description: a unique claim identifier
example: 2108160022C
Questionnaire:
$ref: "#/components/schemas/QuestionnaireRequest"
Address:
type: object
required:
- Line1
- City
- Zip
- Country
properties:
Line1:
type: string
description: mailing address line 1
example: 6 Ashbridge Lane
Line2:
type: string
description: mailing address line 2
Line3:
type: string
description: mailing address line 3
City:
type: string
description: mailing address City
example: Linwood
State:
type: string
description: mailing address 2 character State code
example: NJ
Zip:
type: string
description: mailing address zip code (5 digits or 5-4 digites)
example: 12345-4567
Country:
type: string
description: mailing address Country code
example: USA
AddTransaction:
type: object
required:
- TransactionId
properties:
TransactionId:
type: string
description: unique identifier for the transaction
example: 460268821703314
AddTransactionList:
type: array
items:
$ref: "#/components/schemas/AddTransaction"
AddTransactionListResponse:
type: array
items:
$ref: "#/components/schemas/AddTransactionResponse"
AddTransactionResponse:
type: object
properties:
TransactionId:
type: string
description: unique identifier for the transaction
example: 460268821703314
NonDisputableMessageDetails:
type: string
description: an error associated with a specific transaction
example: "Credits are not disputable for this claim reason"
AddTransactionsRequest:
type: object
required:
- ClaimId
- TransactionList
properties:
ClaimId:
type: string
description: a unique claim identifier
example: 2108160022C
TransactionList:
$ref: '#/components/schemas/AddTransactionList'
AddTransactionsResponse:
type: object
properties:
TransactionList:
$ref: '#/components/schemas/AddTransactionListResponse'
StatusList:
$ref: '#/components/schemas/StatusList'
Answer:
type: object
properties:
Identifier:
type: string
description: Unique answer identifier
example: MerchantDuplicate
DisplayText:
type: string
description: the answer text
example: I was charged more than once.
QuestionList:
$ref: "#/components/schemas/QuestionList"
AnswerList:
type: array
items:
$ref: "#/components/schemas/Answer"
AttachmentCategory:
type: object
properties:
Key:
type: string
description: key value, this is what is passed back in with the add document request
example: SupportingDocumentation
Value:
type: string
description: a user friendly display value
example: Supporting Documentation
AttachmentCategoryList:
type: array
items:
$ref: "#/components/schemas/AttachmentCategory"
AttachmentsAddRequest:
type: object
required:
- ClaimId
- AttachmentList
properties:
ClaimId:
type: string
AttachmentList:
type: array
items:
type: object
required:
- FileName
- Category
- Label
- DocumentStream
properties:
FileName:
type: string
Category:
type: string
enum:
- Accountholder
- Assocation
- Internal
- Supporting Documentation
Label:
type: string
DocumentStream:
type: string
AttachmentsListRequest:
type: object
required:
- ClaimId
properties:
ClaimId:
type: string
AttachmentsListResponse:
type: object
properties:
AttachmentsList:
type: array
items:
type: object
properties:
Category:
type: string
LinkReference:
type: string
CreateDateTime:
type: string
format: Date-Time
CreateName:
type: string
Name:
type: string
StatusList:
$ref: '#/components/schemas/StatusList'
AttachmentsRetrieveRequest:
type: object
required:
- LinkReference
properties:
LinkReference:
type: string
AttachmentsRetrieveResponse:
type: object
properties:
AttachmentName:
type: string
Note:
type: string
DocumentStream:
type: string
StatusList:
$ref: '#/components/schemas/StatusList'
Channel:
type: object
properties:
Key:
type: string
description: stored value
example: Email
Value:
type: string
description: display value
example: Email
ChannelList:
type: array
items:
$ref: "#/components/schemas/Channel"
ClaimListRequest:
type: object
properties:
daysToLookBack:
type: number
customerId, accountNumber, or claimId:
type: string
ClaimListResponse:
type: object
properties:
claimListResponse:
type: array
items:
type: object
properties:
accountHolder:
type: string
requiredDocumentCount:
type: number
customerContactDate:
type: string
format: Date-Time
claimId:
type: string
accountNumber:
type: string
claimStatus:
type: string
createName:
type: string
StatusList:
$ref: '#/components/schemas/StatusList'
ClaimSubmitRequest:
type: object
required:
- CorrelationId
- ClaimId
properties:
CorrelationId:
type: string
description: a unique correlation ID for this message
example: 123e4567-e89b-12d3-a456-426614174000
ClaimId:
type: string
description: a unique claim identifier
example: 2108160022C
CorrespondenceDetails:
$ref: '#/components/schemas/CorrespondenceDetailsRequest'
Questionnaire:
$ref: "#/components/schemas/QuestionnaireRequest"
CorrelationIdClaimIdRequest:
type: object
required:
- CorrelationId
- ClaimId
properties:
CorrelationId:
type: string
description: CorrelationId is used for idempotency. CorrelationIds are unique and can not be used multiple times on successful API calls. If an API call is unsuccessful the CorrelationId can be used again in future attempts. Once successful, the CorrelationId will no longer be valid and will prevent duplicate successful API calls.
example: 123e4567-e89b-12d3-a456-426614174000
ClaimId:
type: string
description: a unique claim identifier
example: 2108160022C
CorrespondenceChannelEmail:
allOf:
- $ref: '#/components/schemas/CorrespondenceChannel'
- type: object
properties:
Address:
$ref: '#/components/schemas/EmailAddress'
CorrespondenceChannelEmailRequest:
allOf:
- $ref: '#/components/schemas/CorrespondenceChannelRequest'
- type: object
properties:
Address:
$ref: '#/components/schemas/EmailAddress'
CorrespondenceChannelMail:
allOf:
- $ref: '#/components/schemas/CorrespondenceChannel'
- type: object
properties:
Address:
$ref: '#/components/schemas/Address'
CorrespondenceChannelMailRequest:
allOf:
- $ref: '#/components/schemas/CorrespondenceChannelRequest'
- type: object
properties:
Address:
$ref: '#/components/schemas/Address'
CorrespondenceChannel:
type: object
properties:
Name:
type: string
description: name of the channel
example: Email
enum:
- Email
- Mail
IsEditable:
type: boolean
description: Can this channel be modified
example: true
discriminator:
propertyName: Name
CorrespondenceChannelList:
type: array
items:
oneOf:
- $ref: '#/components/schemas/CorrespondenceChannelEmail'
- $ref: '#/components/schemas/CorrespondenceChannelMail'
discriminator:
propertyName: Name
CorrespondenceChannelListRequest:
type: array
items:
oneOf:
- $ref: '#/components/schemas/CorrespondenceChannelEmailRequest'
- $ref: '#/components/schemas/CorrespondenceChannelMailRequest'
discriminator:
propertyName: Name
CorrespondenceChannelRequest:
type: object
properties:
Name:
type: string
description: name of the channel
example: Email
enum:
- Email
- Mail
IsVerifiedCorrect:
type: boolean
description: Has this channel's details been confirmed to be correct
example: true
discriminator:
propertyName: Name
CorrespondenceDetails:
type: object
properties:
CanIgnoreCorrespondencePreference:
type: boolean
description: Can the client ignore the correspondence preference
example: false
SelectedChannel:
type: string
description: The default customer correspondence channel
example: Email
enum:
- Email
- Mail
- Manual
- Secure
ChannelList:
$ref: "#/components/schemas/ChannelList"
EmailAddress:
type: string
description: Customer email address
example: TestCustomer@quavo.com
Address:
$ref: "#/components/schemas/Address"
CorrespondenceDetailsRequest:
type: object
properties:
SelectedChannel:
type: string
description: The default customer correspondence channel
example: Email
enum:
- Email
- Mail
- Manual
- Secure
ChannelList:
$ref: "#/components/schemas/ChannelList"
EmailAddress:
type: string
description: Customer email address
example: TestCustomer@quavo.com
Address:
$ref: "#/components/schemas/Address"
CorrespondenceListRequest:
type: object
required:
- ClaimId
properties:
ClaimId:
type: string
CorrespondenceListResponse:
type: object
properties:
CorrespondenceList:
type: array
items:
type: object
properties:
TransmissionStatus:
type: string
SaveDate:
type: string
format: Date-Time
ThreadSubject:
type: string
LinkReference:
type: string
Channel:
type: string
From:
type: string
To:
type: string
Document:
type: string
StatusList:
$ref: '#/components/schemas/StatusList'
CorrespondenceResendRequest:
type: object
required:
- ClaimId
- LinkReference
properties:
ClaimId:
type: string
LinkReference:
type: string
CorrespondenceRetrieveRequest:
type: object
required:
- LinkReference
properties:
LinkReference:
type: string
CorrespondenceRetrieveResponse:
type: object
properties:
EmailStyleMarkup:
type: string
Body:
type: string
StatusList:
$ref: '#/components/schemas/StatusList'
CreateClaimRequest:
type: object
required:
- CorrelationId
- CustomerId
- AccountNumber
properties:
CorrelationId:
type: string
description: a unique correlation ID for this message
example: 123e4567-e89b-12d3-a456-426614174000
CustomerId:
type: string
description: the id that can be used to retrieve a customer record from the core banking system
example: 123
AccountNumber:
type: string
description: the account number the transaction dispute(s) are to be processed against
example: 5555555555554444
CreateClaimResponse:
type: object
properties:
ClaimId:
type: string
description: a unique claim identifier
example: 2108160022C
StatusList:
$ref: '#/components/schemas/StatusList'
Customer:
type: object
properties:
CustomerId:
type: string
description: the unique customer identifier
example: 939472005
Name:
$ref: '#/components/schemas/Name'
Address:
$ref: '#/components/schemas/Address'
Phone:
$ref: '#/components/schemas/Phone'
SecondaryPhone:
$ref: '#/components/schemas/Phone'
EmailAddress:
type: string
description: the customer's email address
example: TestCustomer@Quavo.com
CustomerList:
type: array
items:
$ref: "#/components/schemas/Customer"
CustomerRetrieveRequest:
type: object
required:
- CustomerId
properties:
CustomerId:
type: string
CustomerRetrieveResponse:
type: object
properties:
FirstName:
type: string
LastName:
type: string
StreetAddress:
type: string
City:
type: string
State:
type: string
Zip:
type: string
Country:
type: string
EmailAddress:
type: string
PhoneNumber:
type: string
AccountList:
type: array
items:
type: object
properties:
AccountNumber:
type: string
StatusList:
$ref: '#/components/schemas/StatusList'
CustomerSearchAddressReq:
type: object
properties:
Line1:
type: string
description: mailing address line 1
example: 6 Ashbridge Lane
City:
type: string
description: mailing address City
example: Linwood
State:
type: string
description: mailing address 2 character State code
example: NJ
Zip:
type: string
description: mailing address zip code (5 digits or 5-4 digites)
example: 12345-4567
CustomerSearchNameReq:
type: object
properties:
First:
type: string
description: the customer's first name
example: John
Last:
type: string
description: the customer's last name
example: Doe
DocumentRequirement:
type: object
properties:
TemplateDocumentStream:
type: string
description: byte stream of the template form pdf
example: "JVBERi0xLjQKJcfl9OXwCjEgMCBvYmoKPDwKL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAxMjU4Cj4+CnN0cmVhbQp42s1YW3PTOBR+r+"
IsSatisified:
type: boolean
description: has this document requirement been satisfied?
example: false
Identifier:
type: string
description: the document requirement identifier
example: StatementOfDispute
IsRequired:
type: boolean
description: Is this document required?
example: true
Label:
type: string
description: A user friendly label of the document requirement
example: Statement of Dispute
ValidAttachmentCategoryList:
$ref: '#/components/schemas/AttachmentCategoryList'
DocumentRequirementRequest:
type: object
properties:
DocumentStream:
type: string
description: byte stream of the form pdf being uploaded to satisfy the requirement
example: "JVBERi0xLjQKJcfl9OXwCjEgMCBvYmoKPDwKL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAxMjU4Cj4+CnN0cmVhbQp42s1YW3PTOBR+r+"
Identifier:
type: string
description: the document requirement identifier
example: StatementOfDispute
AttachmentCategory:
type: string
description: the attachment category (one of the subset of ValidAttachmentCategoryList in retrieveDocRequirements response)
example: SupportingDocumentation
FileName:
type: string
description: the name of the file being passed in DocumentStream param
example: StatementOfDispute.pdf
AttachmentLabel:
type: string
description: a user friendly attachment label
example: Statement of Dispute
DocumentRequirementList:
type: array
items:
$ref: '#/components/schemas/DocumentRequirement'
DocumentRequirementRequestList:
type: array
items:
$ref: '#/components/schemas/DocumentRequirementRequest'
EmailAddress:
type: object
properties:
EmailAddress:
type: string
description: email address
example: TestCustomer@quavo.com
Name:
type: object
properties:
Prefix:
type: string
description: the customer's prefix
example: Mr.
First:
type: string
description: the customer's first name
example: John
Middle:
type: string
description: the customer's middle name
example: Eugene
Last:
type: string
description: the customer's last name
example: Doe
Suffix:
type: string
description: the customer's suffix
example: Jr.
BusinessName:
type: string
description: the business name (for business entities)
example: Porkchop Express
FullName:
type: string
description: the customer's full name
example: Mr. John Eugene Doe Jr.
NotesAddRequest:
type: object
required:
- ClaimId
- Subject
- Note
properties:
ClaimId:
type: string
Subject:
type: string
Note:
type: string
NotesListRequest:
type: object
required:
- ClaimId
properties:
ClaimId:
type: string
NotesListResponse:
type: object
properties:
NotesList:
type: array
items:
type: object
properties:
LinkReference:
type: string
CreateDateTime:
type: string
format: Date-Time
CreateName:
type: string
Subject:
type: string
NotesRetrieveRequest:
type: object
required:
- LinkReference
properties:
LinkReference:
type: string
NotesRetrieveResponse:
type: object
properties:
Note:
type: string
Subject:
type: string
StatusList:
$ref: '#/components/schemas/StatusList'
Phone:
type: object
properties:
Number:
type: string
description: phone number
example: 555-123-1234
Question:
type: object
properties:
Identifier:
type: string
description: the question identifier
example: ClaimReason
DisplayText:
type: string
description: the question text
example: Which of the following best describes the reason for your dispute?
DataType:
type: string
description: the question datatype
example: String
Type:
type: string
description: the question type
example: RadioButtons
enum:
- YesNo
- Date
- DateTime
- Text
- TextMulti
- Dropdown
- AutoComplete
- RadioButtons
- Checkboxes
- MultiSelect
- Decimal
- Integer
- Currency
- RichText
- Nothing
- Section
- Questionnaire
AnswerList:
$ref: "#/components/schemas/AnswerList"
QuestionList:
type: array
items:
$ref: "#/components/schemas/Question"
QuestionListRequest:
type: array
items:
$ref: "#/components/schemas/QuestionRequest"
QuestionnaireRequest:
type: object
properties:
QuestionList:
$ref: '#/components/schemas/QuestionListRequest'
Questionnaire:
type: object
properties:
QuestionList:
$ref: '#/components/schemas/QuestionList'
QuestionRequest:
type: object
properties:
Identifier:
type: string
description: the question identifier
example: ClaimReason
AnswerValue:
type: string
description: the question text
example: CardSecure
ReopenRequestRequest:
type: object
required:
- ClaimId
- ReopenReason
properties:
ClaimId:
type: string
ReopenReason:
type: string
TransactionList:
$ref: '#/components/schemas/AddTransactionList'
RetrieveAccountsRequest:
type: object
required:
- CorrelationId
- CustomerId
properties:
CorrelationId:
type: string
description: a unique correlation ID for this message
example: 123e4567-e89b-12d3-a456-426614174000
CustomerId:
type: string
description: the id that can be used to retrieve a customer record from the core banking system
example: 123
RetrieveAccountsResponse:
type: object
properties:
AccountList:
$ref: '#/components/schemas/AccountList'
StatusList:
$ref: '#/components/schemas/StatusList'
RetrieveConfirmationResponse:
type: object
properties:
ConfirmationDocumentStream:
type: string
description: byte stream of the confirmation pdf
example: "JVBERi0xLjQKJcfl9OXwCjEgMCBvYmoKPDwKL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAxMjU4Cj4+CnN0cmVhbQp42s1YW3PTOBR+r+"
ConfirmationMessageMarkup:
type: string
description: byte stream of the confirmation message
example: "PHRhYmxlIGNsYXNzPSJxdm9Cb2R5Q29udGVudCI+PHRyPjx0ZD4gPCEtLXF+"
ConfirmationHeader:
type: string
description: Confirmation header
example: "Confirmation #: 2108240024C"
ConfirmationDocumentName:
type: string
description: Confirmation document name
example: "Confirmation.pdf"
StatusList:
$ref: '#/components/schemas/StatusList'
RetrieveCorrChannelResponse:
type: object
properties:
CorrespondenceChannelList:
$ref: '#/components/schemas/CorrespondenceChannelList'
StatusList:
$ref: '#/components/schemas/StatusList'
RetrieveCustomersRequest:
type: object
required:
- CorrelationId
properties:
CorrelationId:
type: string
description: a unique correlation ID for this message
example: 123e4567-e89b-12d3-a456-426614174000
CustomerId:
type: string
description: the id that can be used to retrieve a customer record from the core banking system
example: 123
ClientId:
type: string
description: In a multi-client system, this id is used in conjunction with AccountNumber to identify customers
example: ABC
AccountNumber:
type: string
description: the account number used to retrieve a customer record from the core banking system
example: 6523456789
SSNTIN:
type: string
description: the SSN/TIN used to retrieve a customer record from the core banking system
example: 1234567890
CardNumber:
type: string
description: the card number used to retrieve a customer record from the core banking system
example: 5555555555554445
RetrieveCustomersResponse:
type: object
properties:
CustomerList:
$ref: '#/components/schemas/CustomerList'
StatusList:
$ref: '#/components/schemas/StatusList'
RetrieveDocRequirementsResponse:
type: object
properties:
DocumentRequirementList:
$ref: '#/components/schemas/DocumentRequirementList'
StatusList:
$ref: '#/components/schemas/StatusList'
RetrieveOtherAccountsResponse:
type: object
properties:
AccountList:
$ref: '#/components/schemas/AccountList'
StatusList:
$ref: '#/components/schemas/StatusList'
RetrieveQuestionnaireResponse:
type: object
properties:
Questionnaire:
$ref: '#/components/schemas/Questionnaire'
PostQuestionnaire:
$ref: '#/components/schemas/Questionnaire'
StatusList:
$ref: '#/components/schemas/StatusList'
RetrieveReasonsResponse:
type: object
properties:
Questionnaire:
$ref: '#/components/schemas/Questionnaire'
StatusList:
$ref: '#/components/schemas/StatusList'
RetrieveSummaryResponse:
type: object
properties:
CorrespondenceDetails:
$ref: '#/components/schemas/CorrespondenceDetails'
SummaryContactHeader:
type: string
description: Summary information about our customer contact method
example: "If we need to contact you, it will be at this address: TestCustomer@quavo.com"
StatusList:
$ref: '#/components/schemas/StatusList'
SummaryQuestionnaire:
$ref: '#/components/schemas/Questionnaire'
TransactionDetails:
$ref: '#/components/schemas/SummaryTransactionDetails'
RetrieveTransactionsRequest:
type: object
required:
- CorrelationId
- ClaimId
properties:
CorrelationId:
type: string
description: a unique correlation ID for this message
example: 123e4567-e89b-12d3-a456-426614174000
ClaimId:
type: string
description: a unique claim identifier
example: 2108160022C
SearchStartDate:
type: string
description: From date, a yyyyMMdd formatted date string
example: 20200601
SearchEndDate:
type: string
description: To date, a yyyyMMdd formatted date string
example: 20210812
SearchAmount:
type: string
description: If this is entered, only transactions with this amount are passed back.
example: 2.09
SearchMerchantName:
type: string
description: Merchant name/Transaction description. If this is entered, transactions with this phrase (contains) are passed back.
example: Amazon
RetrieveTransactionsResponse:
type: object
properties:
TransactionList:
$ref: '#/components/schemas/TransactionList'
StatusList:
$ref: '#/components/schemas/StatusList'
Status:
type: object
properties:
Type:
type: string
description: the status of the request
example: Success
enum:
- Error
- Success
Message:
type: string
description: a message about the status
example: Success
Code:
type: string
description: a numeric code for the status
example: "200"
StatusList:
type: array
items:
$ref: '#/components/schemas/Status'
StatusListResponse:
type: object
properties:
StatusList:
$ref: '#/components/schemas/StatusList'
StatusRetrieveRequest:
type: object
required:
- claimId
- statusRole
properties:
claimId:
type: string
statusRole:
type: string
StatusRetrieveResponse:
type: object
properties:
HeaderDisplay:
type: string
Actions:
type: array
items:
type: object
properties:
Importance:
type: string
ActionName:
type: string
TalkingPoints:
type: array
items:
type: object
properties:
DisplayText:
type: string
Stages:
type: array
items:
type: object
properties:
Status:
type: string
Name:
type: string
StatusList:
$ref: '#/components/schemas/StatusList'
SummaryTransactionDetails:
type: object
properties:
SummaryHeader:
type: string
description: Transaction Details header
SelectedPendingTransactionList:
type: array
items:
$ref: "#/components/schemas/Transaction"
SelectedPostedTransactionList:
type: array
items:
$ref: "#/components/schemas/Transaction"
SelectedRecurringTransactionList:
type: array
items:
$ref: "#/components/schemas/Transaction"
DeflectedTransactionList:
type: array
items:
$ref: "#/components/schemas/Transaction"
Transaction:
type: object
properties:
Amount:
type: string
description: Amount of transaction
example: 27.50
AuthorizationStatus:
type: string
description: Authorization status of the transaction
example: Posted
enum:
- Pending
- Posted
CardNumberEndingIn:
type: string
description: last 4 digits of card number
example: 7413
Date:
type: string
description: date of transaction in yyyyMMdd formatted string
example: 20210626
DebitCredit:
type: string
description: Debit or Credit
example: Debit
enum:
- Debit
- Credit
Description:
type: string
description: transaction description, merchant name
example: 7-ELEVEN 22177 (CHIP)
TransactionId:
type: string
description: unique identifier for the transaction
example: 460268821703314
TransactionType:
type: string
description: Type of the transaction
example: CardPinless
enum:
- ACH
- ATMDEP
- ATMWD
- CardPinless
- CardPinned
- CHECK
- FEE
- P2P
- WIRE
TransactionList:
type: array
items:
$ref: "#/components/schemas/Transaction"
TransactionListRequest:
type: object
required:
- ClaimId
properties:
ClaimId:
type: string
TransactionListResponse:
type: object
properties:
TransactionList:
type: array
items:
type: object
properties:
TransactionAmount:
type: number
CardLastFourDigits:
type: string
DisputedAmount:
type: number
Description:
type: string
PostingDate:
type: string
format: Date
CurrentStage:
type: string
LastCommitDate:
type: string
format: Date-Time
TransactionId:
type: string
StatusList:
$ref: '#/components/schemas/StatusList'
VerifyChannelInfoRequest:
type: object
required:
- CorrelationId
- ClaimId
- CorrespondenceChannelList
properties:
CorrelationId:
type: string
description: a unique correlation ID for this message
example: 123e4567-e89b-12d3-a456-426614174000
ClaimId:
type: string
description: a unique claim identifier
example: 2108160022C
CorrespondenceChannelList:
$ref: "#/components/schemas/CorrespondenceChannelListRequest"
WithdrawRequestRequest:
type: object
required:
- ClaimId
- WithdrawalReason
properties:
ClaimId:
type: string
WithdrawalReason:
type: string
securitySchemes:
oauth2Req:
type: "oauth2"
flows:
clientCredentials:
tokenUrl: "https://oberon-beta.quavo.net/prweb/PRRestService/oauth2/v1/token"
refreshUrl: "https://oberon-beta.quavo.net/prweb/PRRestService/oauth2/v1/token"
scopes: {}
security:
- oauth2Req: []
tags:
- name: "QFDAPI"
externalDocs:
url: ''
description: '' | 