Sign in
Disputes

Get Questionnaire

Returns the intake questionnaire for the selected dispute reason and transaction context. Each question includes a unique questionUuid, the input type to render, and allowed answer options. The member's questionnaire answers determine the specific sub-reason. Submit question_uuid/answer pairs in Create.

get/v1/disputes/questionnaire

Query parameters

reason'DISPUTE_REASON_UNKNOWN' | 'DISPUTE_REASON_UNAUTH' | 'DISPUTE_REASON_MERCHANT_ISSUE' | 'DISPUTE_REASON_ATM_ISSUE' | 'DISPUTE_REASON_ACH_ISSUE' | 'DISPUTE_REASON_TRANSFER_ISSUE' | 'DISPUTE_REASON_ATM_ISSUE_CASH_NOT_DISPENSED' | 'DISPUTE_REASON_MERCHANT_ISSUE_GOODS_OR_SERVICES_NOT_RECEIVED' | 'DISPUTE_REASON_MERCHANT_ISSUE_GOODS_OR_SERVICES_NOT_AS_DESCRIBED' | 'DISPUTE_REASON_MERCHANT_ISSUE_RETURNED' | 'DISPUTE_REASON_MERCHANT_ISSUE_CANCELED_SUBSCRIPTION' | 'DISPUTE_REASON_MERCHANT_ISSUE_REFUND_NOT_RECEIVED' | 'DISPUTE_REASON_MERCHANT_ISSUE_CHARGED_INCORRECT_AMOUNT' | 'DISPUTE_REASON_MERCHANT_ISSUE_PAID_BY_OTHER_MEANS' | 'DISPUTE_REASON_TRANSFER_ISSUE_NOT_RECEIVED' | 'DISPUTE_REASON_TRANSFER_ISSUE_INCORRECT_RECIPIENT' | 'DISPUTE_REASON_TRANSFER_ISSUE_INCORRECT_AMOUNT' | 'DISPUTE_REASON_TRANSFER_ISSUE_DUPLICATE_CHARGE' | 'DISPUTE_REASON_ATM_ISSUE_PARTIAL_CASH' | 'DISPUTE_REASON_MERCHANT_ISSUE_DUPLICATE_CHARGE' | 'DISPUTE_REASON_ATM_ISSUE_CASH_NOT_DEPOSITED' | 'DISPUTE_REASON_TRANSFER_ISSUE_FAILED_CANCELLATION' | 'DISPUTE_REASON_ACH_ISSUE_REVOKED' | 'DISPUTE_REASON_ACH_ISSUE_GOODS_OR_SERVICES' | 'DISPUTE_REASON_ACH_ISSUE_INCOMPLETE_TRANSACTION' | 'DISPUTE_REASON_ACH_ISSUE_IMPROPER_CHECK_PROCESSED' | 'DISPUTE_REASON_ACH_ISSUE_INCORRECT_AMOUNT' | 'DISPUTE_REASON_ACH_ISSUE_INCORRECT_DATE' | 'DISPUTE_REASON_ACH_ISSUE_DEBITED_MORE_THAN_ONCE' | 'DISPUTE_REASON_ACH_ISSUE_UNPROMPTED_DEBIT' | 'DISPUTE_REASON_ATM_ISSUE_DEPOSIT_NOT_POSTED' | 'DISPUTE_REASON_IN_STORE_CASH_NOT_DEPOSITED' | 'DISPUTE_REASON_CHECK_ISSUE' | 'DISPUTE_REASON_CHECK_ISSUE_FORGED_DRAWER' | 'DISPUTE_REASON_CHECK_ISSUE_ENDORSEMENT_FORGED' | 'DISPUTE_REASON_CHECK_ISSUE_PAYEE_NAME_ALTERED' | 'DISPUTE_REASON_CHECK_ISSUE_NOT_ENDORSED_BY_PAYEE' | 'DISPUTE_REASON_CHECK_ISSUE_ALTERED_AMOUNT' | 'DISPUTE_REASON_CHECK_ISSUE_COUNTERFEIT_CHECK' | 'DISPUTE_REASON_CHECK_ISSUE_UNAUTHORIZED_DRAFT' | 'DISPUTE_REASON_ACH_CREDIT_ISSUE' | 'DISPUTE_REASON_CREDIT_NOT_PROCESSED' | 'DISPUTE_REASON_CANCELLED_TRANSACTION' | 'DISPUTE_REASON_MERCHANDISE_RETURNED'
  • DISPUTE_REASON_MERCHANT_ISSUE: Provisional/parent merchant reason returned by GetDisputeReasons. The specific sub-reason (MERCHANT_ISSUE_*) is resolved server-side from the questionnaire answers at Create time.
  • DISPUTE_REASON_ATM_ISSUE: Provisional/parent ATM reason returned by GetDisputeReasons. The specific sub-reason (ATM_ISSUE_*) is resolved server-side from the questionnaire answers at Create time.
  • DISPUTE_REASON_TRANSFER_ISSUE: Provisional/parent transfer reason returned by GetDisputeReasons. The specific sub-reason (TRANSFER_ISSUE_*) is resolved server-side from the questionnaire answers at Create time.
  • DISPUTE_REASON_ACH_ISSUE_REVOKED: ACH 2.0 canonical sub-reasons. DISPUTE_REASON_ACH_ISSUE remains the unauthorized-debit reason; the values below are its siblings for the other ACH dispute categories. Deprecated internal R-code reasons are normalized to these canonical values before mapping, so integrators only ever see this set.
  • DISPUTE_REASON_CHECK_ISSUE: Provisional/parent check reason. The specific sub-reason (CHECK_ISSUE_*) is resolved server-side from the questionnaire answers at Create time.
  • DISPUTE_REASON_ACH_CREDIT_ISSUE: Dispute about an ACH credit (incoming or outgoing credit entry), as opposed to the ACH_ISSUE_* family, which covers consumer debit disputes.
transactionType'TRANSACTION_TYPE_UNKNOWN' | 'TRANSACTION_TYPE_DEBIT_CARD' | 'TRANSACTION_TYPE_CREDIT_CARD' | 'TRANSACTION_TYPE_ATM' | 'TRANSACTION_TYPE_ACH' | 'TRANSACTION_TYPE_TRANSFER' | 'TRANSACTION_TYPE_CREDIT_ATM' | 'TRANSACTION_TYPE_CREDIT_ACH' | 'TRANSACTION_TYPE_CREDIT_TRANSFER'

Response

A successful response.