openapi: 3.1.0 info: description: Anything that you can achieve with PDFs, presence, and persistence in a bank branch you can do with our API. We've always wanted a fully programmatic bank so we built one. Our API faithfully exposes the data and capabilities of the Federal Reserve, Visa, The Clearing House, depository networks, and accounting tools. It's lovingly boring and exceptionally powerful. If you have any questions or want to get started, don't hesitate to ping us at sales@increase.com. We can't wait to see what you build! title: Increase Account Numbers Card Disputes API version: 0.0.1 servers: - url: https://api.increase.com - url: https://sandbox.increase.com security: - bearerAuth: [] tags: - description: If unauthorized activity occurs on a card, you can create a Card Dispute and we'll work with the card networks to return the funds if appropriate. name: Card Disputes paths: /card_disputes: get: operationId: list_card_disputes parameters: - in: query name: cursor required: false schema: description: Return the page of entries after this one. type: string x-documentation-priority: low - in: query name: limit required: false schema: description: Limit the size of the list that is returned. The default (and maximum) is 100 objects. minimum: 1 type: integer x-documentation-priority: low - in: query name: created_at.after required: false schema: description: Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. format: date-time type: string x-documentation-priority: low - in: query name: created_at.before required: false schema: description: Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. format: date-time type: string x-documentation-priority: low - in: query name: created_at.on_or_after required: false schema: description: Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. format: date-time type: string x-documentation-priority: low - in: query name: created_at.on_or_before required: false schema: description: Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. format: date-time type: string x-documentation-priority: low - in: query name: status.in required: false schema: description: Filter Card Disputes for those with the specified status or statuses. For GET requests, this should be encoded as a comma-delimited string, such as `?in=one,two,three`. items: enum: - user_submission_required - pending_user_submission_reviewing - pending_user_submission_submitting - pending_user_withdrawal_submitting - pending_response - lost - won type: string x-enum-descriptions: - A User Submission is required to continue with the Card Dispute. - The most recent User Submission is being reviewed. - The most recent User Submission is being submitted to the network. - The user's withdrawal of the Card Dispute is being submitted to the network. - The Card Dispute is pending a response from the network. - The Card Dispute has been lost and funds previously credited from the acceptance have been debited. - The Card Dispute has been won and no further action can be taken. type: array x-documentation-priority: default explode: false - in: query name: idempotency_key required: false schema: description: Filter records to the one with the specified `idempotency_key` you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys). maxLength: 200 minLength: 1 type: string x-documentation-priority: default responses: '200': content: application/json: schema: $ref: '#/components/schemas/card_dispute_list' description: Card Dispute List 4XX: $ref: '#/components/responses/errorResponse' 5XX: $ref: '#/components/responses/errorResponse' summary: List Card Disputes x-sandbox-only: false x-tag: Card Disputes tags: - Card Disputes post: operationId: create_a_card_dispute parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/create_a_card_dispute_parameters' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/card_dispute' description: Card Dispute 4XX: $ref: '#/components/responses/errorResponse' 5XX: $ref: '#/components/responses/errorResponse' summary: Create a Card Dispute x-sandbox-only: false x-tag: Card Disputes tags: - Card Disputes /card_disputes/{card_dispute_id}: get: operationId: retrieve_a_card_dispute parameters: - example: card_dispute_h9sc95nbl1cgltpp7men in: path name: card_dispute_id required: true schema: description: The identifier of the Card Dispute. type: string x-documentation-priority: default x-id-reference-to: Card Disputes responses: '200': content: application/json: schema: $ref: '#/components/schemas/card_dispute' description: Card Dispute 4XX: $ref: '#/components/responses/errorResponse' 5XX: $ref: '#/components/responses/errorResponse' summary: Retrieve a Card Dispute x-sandbox-only: false x-tag: Card Disputes tags: - Card Disputes /card_disputes/{card_dispute_id}/submit_user_submission: post: operationId: submit_a_user_submission_for_a_card_dispute parameters: - example: card_dispute_h9sc95nbl1cgltpp7men in: path name: card_dispute_id required: true schema: description: The identifier of the Card Dispute to submit a user submission for. type: string x-documentation-priority: default x-id-reference-to: Card Disputes requestBody: content: application/json: schema: $ref: '#/components/schemas/submit_a_user_submission_for_a_card_dispute_parameters' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/card_dispute' description: Card Dispute 4XX: $ref: '#/components/responses/errorResponse' 5XX: $ref: '#/components/responses/errorResponse' summary: Submit a User Submission for a Card Dispute x-sandbox-only: false x-tag: Card Disputes tags: - Card Disputes /card_disputes/{card_dispute_id}/withdraw: post: operationId: withdraw_a_card_dispute parameters: - example: card_dispute_h9sc95nbl1cgltpp7men in: path name: card_dispute_id required: true schema: description: The identifier of the Card Dispute to withdraw. type: string x-documentation-priority: default x-id-reference-to: Card Disputes requestBody: content: application/json: schema: $ref: '#/components/schemas/withdraw_a_card_dispute_parameters' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/card_dispute' description: Card Dispute 4XX: $ref: '#/components/responses/errorResponse' 5XX: $ref: '#/components/responses/errorResponse' summary: Withdraw a Card Dispute x-sandbox-only: false x-tag: Card Disputes tags: - Card Disputes components: schemas: card_dispute_visa_user_submission: additionalProperties: false properties: accepted_at: anyOf: - description: The date and time at which the Visa Card Dispute User Submission was reviewed and accepted. format: date-time type: string x-documentation-priority: default - type: 'null' amount: anyOf: - description: The amount of the dispute if it is different from the amount of a prior user submission or the disputed transaction. type: integer x-documentation-priority: default - type: 'null' attachment_files: description: The files attached to the Visa Card Dispute User Submission. items: $ref: '#/components/schemas/card_dispute_file_attachment' type: array x-documentation-priority: default category: description: The category of the user submission. We may add additional possible values for this enum over time; your application should be able to handle such additions gracefully. enum: - chargeback - merchant_prearbitration_decline - user_prearbitration type: string x-documentation-priority: default x-enum-descriptions: - 'Visa Card Dispute Chargeback User Submission Chargeback Details: details will be under the `chargeback` object.' - 'Visa Card Dispute Merchant Pre-Arbitration Decline User Submission: details will be under the `merchant_prearbitration_decline` object.' - 'Visa Card Dispute User-Initiated Pre-Arbitration User Submission: details will be under the `user_prearbitration` object.' chargeback: anyOf: - additionalProperties: false description: A Visa Card Dispute Chargeback User Submission Chargeback Details object. This field will be present in the JSON response if and only if `category` is equal to `chargeback`. Contains the details specific to a Visa chargeback User Submission for a Card Dispute. example: authorization: null category: fraud consumer_canceled_merchandise: null consumer_canceled_recurring_transaction: null consumer_canceled_services: null consumer_counterfeit_merchandise: null consumer_credit_not_processed: null consumer_damaged_or_defective_merchandise: null consumer_merchandise_misrepresentation: null consumer_merchandise_not_as_described: null consumer_merchandise_not_received: null consumer_non_receipt_of_cash: null consumer_original_credit_transaction_not_accepted: null consumer_quality_merchandise: null consumer_quality_services: null consumer_services_misrepresentation: null consumer_services_not_as_described: null consumer_services_not_received: null fraud: fraud_type: lost processing_error: null properties: authorization: anyOf: - additionalProperties: false description: Authorization. Present if and only if `category` is `authorization`. properties: account_status: description: Account status. enum: - account_closed - credit_problem - fraud type: string x-documentation-priority: default x-enum-descriptions: - Account closed. - Credit problem. - Fraud. required: - account_status title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Authorization type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Authorizations - type: 'null' category: description: Category. enum: - authorization - consumer_canceled_merchandise - consumer_canceled_recurring_transaction - consumer_canceled_services - consumer_counterfeit_merchandise - consumer_credit_not_processed - consumer_damaged_or_defective_merchandise - consumer_merchandise_misrepresentation - consumer_merchandise_not_as_described - consumer_merchandise_not_received - consumer_non_receipt_of_cash - consumer_original_credit_transaction_not_accepted - consumer_quality_merchandise - consumer_quality_services - consumer_services_misrepresentation - consumer_services_not_as_described - consumer_services_not_received - fraud - processing_error type: string x-documentation-priority: default x-enum-descriptions: - Authorization. - 'Consumer: canceled merchandise.' - 'Consumer: canceled recurring transaction.' - 'Consumer: canceled services.' - 'Consumer: counterfeit merchandise.' - 'Consumer: credit not processed.' - 'Consumer: damaged or defective merchandise.' - 'Consumer: merchandise misrepresentation.' - 'Consumer: merchandise not as described.' - 'Consumer: merchandise not received.' - 'Consumer: non-receipt of cash.' - 'Consumer: Original Credit Transaction (OCT) not accepted.' - 'Consumer: merchandise quality issue.' - 'Consumer: services quality issue.' - 'Consumer: services misrepresentation.' - 'Consumer: services not as described.' - 'Consumer: services not received.' - Fraud. - Processing error. consumer_canceled_merchandise: anyOf: - additionalProperties: false description: Canceled merchandise. Present if and only if `category` is `consumer_canceled_merchandise`. properties: cardholder_cancellation: anyOf: - additionalProperties: false description: Cardholder cancellation. properties: canceled_at: description: Canceled at. format: date type: string x-documentation-priority: default canceled_prior_to_ship_date: description: Canceled prior to ship date. enum: - canceled_prior_to_ship_date - not_canceled_prior_to_ship_date type: string x-documentation-priority: default x-enum-descriptions: - Canceled prior to ship date. - Not canceled prior to ship date. cancellation_policy_provided: description: Cancellation policy provided. enum: - not_provided - provided type: string x-documentation-priority: default x-enum-descriptions: - Not provided. - Provided. reason: description: Reason. type: string x-documentation-priority: default required: - canceled_at - canceled_prior_to_ship_date - cancellation_policy_provided - reason title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Canceled Merchandise Cardholder Cancellation type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Cardholder Cancellations - type: 'null' merchant_resolution_attempted: description: Merchant resolution attempted. enum: - attempted - prohibited_by_local_law type: string x-documentation-priority: default x-enum-descriptions: - Attempted. - Prohibited by local law. not_returned: anyOf: - additionalProperties: false description: Not returned. Present if and only if `return_outcome` is `not_returned`. properties: {} title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Canceled Merchandise Not Returned type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true x-title-plural: Not Returneds - type: 'null' purchase_explanation: description: Purchase explanation. type: string x-documentation-priority: default received_or_expected_at: description: Received or expected at. format: date type: string x-documentation-priority: default return_attempted: anyOf: - additionalProperties: false description: Return attempted. Present if and only if `return_outcome` is `return_attempted`. properties: attempt_explanation: description: Attempt explanation. type: string x-documentation-priority: default attempt_reason: description: Attempt reason. enum: - merchant_not_responding - no_return_authorization_provided - no_return_instructions - requested_not_to_return - return_not_accepted type: string x-documentation-priority: default x-enum-descriptions: - Merchant not responding. - No return authorization provided. - No return instructions. - Requested not to return. - Return not accepted. attempted_at: description: Attempted at. format: date type: string x-documentation-priority: default merchandise_disposition: description: Merchandise disposition. type: string x-documentation-priority: default required: - attempt_explanation - attempt_reason - attempted_at - merchandise_disposition title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Canceled Merchandise Return Attempted type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Return Attempteds - type: 'null' return_outcome: description: Return outcome. enum: - not_returned - returned - return_attempted type: string x-documentation-priority: default x-enum-descriptions: - Not returned. - Returned. - Return attempted. returned: anyOf: - additionalProperties: false description: Returned. Present if and only if `return_outcome` is `returned`. properties: merchant_received_return_at: anyOf: - description: Merchant received return at. format: date type: string x-documentation-priority: default - type: 'null' other_explanation: anyOf: - description: Other explanation. Required if and only if the return method is `other`. type: string x-documentation-priority: default - type: 'null' return_method: description: Return method. enum: - dhl - face_to_face - fedex - other - postal_service - ups type: string x-documentation-priority: default x-enum-descriptions: - DHL. - Face-to-face. - FedEx. - Other. - Postal service. - UPS. returned_at: description: Returned at. format: date type: string x-documentation-priority: default tracking_number: anyOf: - description: Tracking number. type: string x-documentation-priority: default - type: 'null' required: - merchant_received_return_at - other_explanation - return_method - returned_at - tracking_number title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Canceled Merchandise Returned type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Returneds - type: 'null' required: - cardholder_cancellation - merchant_resolution_attempted - not_returned - purchase_explanation - received_or_expected_at - return_attempted - return_outcome - returned title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Canceled Merchandise type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Consumer Canceled Merchandises - type: 'null' consumer_canceled_recurring_transaction: anyOf: - additionalProperties: false description: Canceled recurring transaction. Present if and only if `category` is `consumer_canceled_recurring_transaction`. properties: cancellation_target: description: Cancellation target. enum: - account - transaction type: string x-documentation-priority: default x-enum-descriptions: - Account. - Transaction. merchant_contact_methods: additionalProperties: false description: Merchant contact methods. properties: application_name: anyOf: - description: Application name. type: string x-documentation-priority: default - type: 'null' call_center_phone_number: anyOf: - description: Call center phone number. type: string x-documentation-priority: default - type: 'null' email_address: anyOf: - description: Email address. type: string x-documentation-priority: default - type: 'null' in_person_address: anyOf: - description: In person address. type: string x-documentation-priority: default - type: 'null' mailing_address: anyOf: - description: Mailing address. type: string x-documentation-priority: default - type: 'null' text_phone_number: anyOf: - description: Text phone number. type: string x-documentation-priority: default - type: 'null' required: - application_name - call_center_phone_number - email_address - in_person_address - mailing_address - text_phone_number title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Canceled Recurring Transaction Merchant Contact Methods type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Merchant Contact Methods other_form_of_payment_explanation: anyOf: - description: Other form of payment explanation. type: string x-documentation-priority: default - type: 'null' transaction_or_account_canceled_at: description: Transaction or account canceled at. format: date type: string x-documentation-priority: default required: - cancellation_target - merchant_contact_methods - other_form_of_payment_explanation - transaction_or_account_canceled_at title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Canceled Recurring Transaction type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Consumer Canceled Recurring Transactions - type: 'null' consumer_canceled_services: anyOf: - additionalProperties: false description: Canceled services. Present if and only if `category` is `consumer_canceled_services`. properties: cardholder_cancellation: additionalProperties: false description: Cardholder cancellation. properties: canceled_at: description: Canceled at. format: date type: string x-documentation-priority: default cancellation_policy_provided: description: Cancellation policy provided. enum: - not_provided - provided type: string x-documentation-priority: default x-enum-descriptions: - Not provided. - Provided. reason: description: Reason. type: string x-documentation-priority: default required: - canceled_at - cancellation_policy_provided - reason title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Canceled Services Cardholder Cancellation type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Cardholder Cancellations contracted_at: description: Contracted at. format: date type: string x-documentation-priority: default guaranteed_reservation: anyOf: - additionalProperties: false description: Guaranteed reservation explanation. Present if and only if `service_type` is `guaranteed_reservation`. properties: explanation: description: Explanation. enum: - cardholder_canceled_prior_to_service - cardholder_cancellation_attempt_within_24_hours_of_confirmation - merchant_billed_no_show type: string x-documentation-priority: default x-enum-descriptions: - Cardholder canceled prior to service. - Cardholder cancellation attempt within 24 hours of confirmation. - Merchant billed for no-show. required: - explanation title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Canceled Services Guaranteed Reservation type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Guaranteed Reservations - type: 'null' merchant_resolution_attempted: description: Merchant resolution attempted. enum: - attempted - prohibited_by_local_law type: string x-documentation-priority: default x-enum-descriptions: - Attempted. - Prohibited by local law. other: anyOf: - additionalProperties: false description: Other service type explanation. Present if and only if `service_type` is `other`. properties: {} title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Canceled Services Other type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true x-title-plural: Others - type: 'null' purchase_explanation: description: Purchase explanation. type: string x-documentation-priority: default service_type: description: Service type. enum: - guaranteed_reservation - other - timeshare type: string x-documentation-priority: default x-enum-descriptions: - Guaranteed reservation. - Other. - Timeshare. timeshare: anyOf: - additionalProperties: false description: Timeshare explanation. Present if and only if `service_type` is `timeshare`. properties: {} title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Canceled Services Timeshare type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true x-title-plural: Timeshares - type: 'null' required: - cardholder_cancellation - contracted_at - guaranteed_reservation - merchant_resolution_attempted - other - purchase_explanation - service_type - timeshare title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Canceled Services type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Consumer Canceled Services - type: 'null' consumer_counterfeit_merchandise: anyOf: - additionalProperties: false description: Counterfeit merchandise. Present if and only if `category` is `consumer_counterfeit_merchandise`. properties: counterfeit_explanation: description: Counterfeit explanation. type: string x-documentation-priority: default disposition_explanation: description: Disposition explanation. type: string x-documentation-priority: default order_explanation: description: Order explanation. type: string x-documentation-priority: default received_at: description: Received at. format: date type: string x-documentation-priority: default required: - counterfeit_explanation - disposition_explanation - order_explanation - received_at title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Counterfeit Merchandise type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Consumer Counterfeit Merchandises - type: 'null' consumer_credit_not_processed: anyOf: - additionalProperties: false description: Credit not processed. Present if and only if `category` is `consumer_credit_not_processed`. properties: canceled_or_returned_at: anyOf: - description: Canceled or returned at. format: date type: string x-documentation-priority: default - type: 'null' credit_expected_at: anyOf: - description: Credit expected at. format: date type: string x-documentation-priority: default - type: 'null' required: - canceled_or_returned_at - credit_expected_at title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Credit Not Processed type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Consumer Credit Not Processeds - type: 'null' consumer_damaged_or_defective_merchandise: anyOf: - additionalProperties: false description: Damaged or defective merchandise. Present if and only if `category` is `consumer_damaged_or_defective_merchandise`. properties: merchant_resolution_attempted: description: Merchant resolution attempted. enum: - attempted - prohibited_by_local_law type: string x-documentation-priority: default x-enum-descriptions: - Attempted. - Prohibited by local law. not_returned: anyOf: - additionalProperties: false description: Not returned. Present if and only if `return_outcome` is `not_returned`. properties: {} title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Damaged Or Defective Merchandise Not Returned type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true x-title-plural: Not Returneds - type: 'null' order_and_issue_explanation: description: Order and issue explanation. type: string x-documentation-priority: default received_at: description: Received at. format: date type: string x-documentation-priority: default return_attempted: anyOf: - additionalProperties: false description: Return attempted. Present if and only if `return_outcome` is `return_attempted`. properties: attempt_explanation: description: Attempt explanation. type: string x-documentation-priority: default attempt_reason: description: Attempt reason. enum: - merchant_not_responding - no_return_authorization_provided - no_return_instructions - requested_not_to_return - return_not_accepted type: string x-documentation-priority: default x-enum-descriptions: - Merchant not responding. - No return authorization provided. - No return instructions. - Requested not to return. - Return not accepted. attempted_at: description: Attempted at. format: date type: string x-documentation-priority: default merchandise_disposition: description: Merchandise disposition. type: string x-documentation-priority: default required: - attempt_explanation - attempt_reason - attempted_at - merchandise_disposition title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Damaged Or Defective Merchandise Return Attempted type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Return Attempteds - type: 'null' return_outcome: description: Return outcome. enum: - not_returned - returned - return_attempted type: string x-documentation-priority: default x-enum-descriptions: - Not returned. - Returned. - Return attempted. returned: anyOf: - additionalProperties: false description: Returned. Present if and only if `return_outcome` is `returned`. properties: merchant_received_return_at: anyOf: - description: Merchant received return at. format: date type: string x-documentation-priority: default - type: 'null' other_explanation: anyOf: - description: Other explanation. Required if and only if the return method is `other`. type: string x-documentation-priority: default - type: 'null' return_method: description: Return method. enum: - dhl - face_to_face - fedex - other - postal_service - ups type: string x-documentation-priority: default x-enum-descriptions: - DHL. - Face-to-face. - FedEx. - Other. - Postal service. - UPS. returned_at: description: Returned at. format: date type: string x-documentation-priority: default tracking_number: anyOf: - description: Tracking number. type: string x-documentation-priority: default - type: 'null' required: - merchant_received_return_at - other_explanation - return_method - returned_at - tracking_number title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Damaged Or Defective Merchandise Returned type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Returneds - type: 'null' required: - merchant_resolution_attempted - not_returned - order_and_issue_explanation - received_at - return_attempted - return_outcome - returned title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Damaged Or Defective Merchandise type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Consumer Damaged Or Defective Merchandises - type: 'null' consumer_merchandise_misrepresentation: anyOf: - additionalProperties: false description: Merchandise misrepresentation. Present if and only if `category` is `consumer_merchandise_misrepresentation`. properties: merchant_resolution_attempted: description: Merchant resolution attempted. enum: - attempted - prohibited_by_local_law type: string x-documentation-priority: default x-enum-descriptions: - Attempted. - Prohibited by local law. misrepresentation_explanation: description: Misrepresentation explanation. type: string x-documentation-priority: default not_returned: anyOf: - additionalProperties: false description: Not returned. Present if and only if `return_outcome` is `not_returned`. properties: {} title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Merchandise Misrepresentation Not Returned type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true x-title-plural: Not Returneds - type: 'null' purchase_explanation: description: Purchase explanation. type: string x-documentation-priority: default received_at: description: Received at. format: date type: string x-documentation-priority: default return_attempted: anyOf: - additionalProperties: false description: Return attempted. Present if and only if `return_outcome` is `return_attempted`. properties: attempt_explanation: description: Attempt explanation. type: string x-documentation-priority: default attempt_reason: description: Attempt reason. enum: - merchant_not_responding - no_return_authorization_provided - no_return_instructions - requested_not_to_return - return_not_accepted type: string x-documentation-priority: default x-enum-descriptions: - Merchant not responding. - No return authorization provided. - No return instructions. - Requested not to return. - Return not accepted. attempted_at: description: Attempted at. format: date type: string x-documentation-priority: default merchandise_disposition: description: Merchandise disposition. type: string x-documentation-priority: default required: - attempt_explanation - attempt_reason - attempted_at - merchandise_disposition title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Merchandise Misrepresentation Return Attempted type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Return Attempteds - type: 'null' return_outcome: description: Return outcome. enum: - not_returned - returned - return_attempted type: string x-documentation-priority: default x-enum-descriptions: - Not returned. - Returned. - Return attempted. returned: anyOf: - additionalProperties: false description: Returned. Present if and only if `return_outcome` is `returned`. properties: merchant_received_return_at: anyOf: - description: Merchant received return at. format: date type: string x-documentation-priority: default - type: 'null' other_explanation: anyOf: - description: Other explanation. Required if and only if the return method is `other`. type: string x-documentation-priority: default - type: 'null' return_method: description: Return method. enum: - dhl - face_to_face - fedex - other - postal_service - ups type: string x-documentation-priority: default x-enum-descriptions: - DHL. - Face-to-face. - FedEx. - Other. - Postal service. - UPS. returned_at: description: Returned at. format: date type: string x-documentation-priority: default tracking_number: anyOf: - description: Tracking number. type: string x-documentation-priority: default - type: 'null' required: - merchant_received_return_at - other_explanation - return_method - returned_at - tracking_number title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Merchandise Misrepresentation Returned type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Returneds - type: 'null' required: - merchant_resolution_attempted - misrepresentation_explanation - not_returned - purchase_explanation - received_at - return_attempted - return_outcome - returned title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Merchandise Misrepresentation type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Consumer Merchandise Misrepresentations - type: 'null' consumer_merchandise_not_as_described: anyOf: - additionalProperties: false description: Merchandise not as described. Present if and only if `category` is `consumer_merchandise_not_as_described`. properties: merchant_resolution_attempted: description: Merchant resolution attempted. enum: - attempted - prohibited_by_local_law type: string x-documentation-priority: default x-enum-descriptions: - Attempted. - Prohibited by local law. received_at: description: Received at. format: date type: string x-documentation-priority: default return_attempted: anyOf: - additionalProperties: false description: Return attempted. Present if and only if `return_outcome` is `return_attempted`. properties: attempt_explanation: description: Attempt explanation. type: string x-documentation-priority: default attempt_reason: description: Attempt reason. enum: - merchant_not_responding - no_return_authorization_provided - no_return_instructions - requested_not_to_return - return_not_accepted type: string x-documentation-priority: default x-enum-descriptions: - Merchant not responding. - No return authorization provided. - No return instructions. - Requested not to return. - Return not accepted. attempted_at: description: Attempted at. format: date type: string x-documentation-priority: default merchandise_disposition: description: Merchandise disposition. type: string x-documentation-priority: default required: - attempt_explanation - attempt_reason - attempted_at - merchandise_disposition title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Merchandise Not As Described Return Attempted type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Return Attempteds - type: 'null' return_outcome: description: Return outcome. enum: - returned - return_attempted type: string x-documentation-priority: default x-enum-descriptions: - Returned. - Return attempted. returned: anyOf: - additionalProperties: false description: Returned. Present if and only if `return_outcome` is `returned`. properties: merchant_received_return_at: anyOf: - description: Merchant received return at. format: date type: string x-documentation-priority: default - type: 'null' other_explanation: anyOf: - description: Other explanation. Required if and only if the return method is `other`. type: string x-documentation-priority: default - type: 'null' return_method: description: Return method. enum: - dhl - face_to_face - fedex - other - postal_service - ups type: string x-documentation-priority: default x-enum-descriptions: - DHL. - Face-to-face. - FedEx. - Other. - Postal service. - UPS. returned_at: description: Returned at. format: date type: string x-documentation-priority: default tracking_number: anyOf: - description: Tracking number. type: string x-documentation-priority: default - type: 'null' required: - merchant_received_return_at - other_explanation - return_method - returned_at - tracking_number title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Merchandise Not As Described Returned type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Returneds - type: 'null' required: - merchant_resolution_attempted - received_at - return_attempted - return_outcome - returned title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Merchandise Not As Described type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Consumer Merchandise Not As Describeds - type: 'null' consumer_merchandise_not_received: anyOf: - additionalProperties: false description: Merchandise not received. Present if and only if `category` is `consumer_merchandise_not_received`. properties: cancellation_outcome: description: Cancellation outcome. enum: - cardholder_cancellation_prior_to_expected_receipt - merchant_cancellation - no_cancellation type: string x-documentation-priority: default x-enum-descriptions: - Cardholder cancellation prior to expected receipt. - Merchant cancellation. - No cancellation. cardholder_cancellation_prior_to_expected_receipt: anyOf: - additionalProperties: false description: Cardholder cancellation prior to expected receipt. Present if and only if `cancellation_outcome` is `cardholder_cancellation_prior_to_expected_receipt`. properties: canceled_at: description: Canceled at. format: date type: string x-documentation-priority: default reason: anyOf: - description: Reason. type: string x-documentation-priority: default - type: 'null' required: - canceled_at - reason title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Merchandise Not Received Cardholder Cancellation Prior To Expected Receipt type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Cardholder Cancellation Prior To Expected Receipts - type: 'null' delayed: anyOf: - additionalProperties: false description: Delayed. Present if and only if `delivery_issue` is `delayed`. properties: explanation: description: Explanation. type: string x-documentation-priority: default not_returned: anyOf: - additionalProperties: false description: Not returned. Present if and only if `return_outcome` is `not_returned`. properties: {} title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Merchandise Not Received Delayed Not Returned type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true x-title-plural: Not Returneds - type: 'null' return_attempted: anyOf: - additionalProperties: false description: Return attempted. Present if and only if `return_outcome` is `return_attempted`. properties: attempted_at: description: Attempted at. format: date type: string x-documentation-priority: default required: - attempted_at title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Merchandise Not Received Delayed Return Attempted type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Return Attempteds - type: 'null' return_outcome: description: Return outcome. enum: - not_returned - returned - return_attempted type: string x-documentation-priority: default x-enum-descriptions: - Not returned. - Returned. - Return attempted. returned: anyOf: - additionalProperties: false description: Returned. Present if and only if `return_outcome` is `returned`. properties: merchant_received_return_at: description: Merchant received return at. format: date type: string x-documentation-priority: default returned_at: description: Returned at. format: date type: string x-documentation-priority: default required: - merchant_received_return_at - returned_at title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Merchandise Not Received Delayed Returned type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Returneds - type: 'null' required: - explanation - not_returned - return_attempted - return_outcome - returned title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Merchandise Not Received Delayed type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Delayeds - type: 'null' delivered_to_wrong_location: anyOf: - additionalProperties: false description: Delivered to wrong location. Present if and only if `delivery_issue` is `delivered_to_wrong_location`. properties: agreed_location: description: Agreed location. type: string x-documentation-priority: default required: - agreed_location title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Merchandise Not Received Delivered To Wrong Location type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Delivered To Wrong Locations - type: 'null' delivery_issue: description: Delivery issue. enum: - delayed - delivered_to_wrong_location type: string x-documentation-priority: default x-enum-descriptions: - Delayed. - Delivered to wrong location. last_expected_receipt_at: description: Last expected receipt at. format: date type: string x-documentation-priority: default merchant_cancellation: anyOf: - additionalProperties: false description: Merchant cancellation. Present if and only if `cancellation_outcome` is `merchant_cancellation`. properties: canceled_at: description: Canceled at. format: date type: string x-documentation-priority: default required: - canceled_at title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Merchandise Not Received Merchant Cancellation type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Merchant Cancellations - type: 'null' merchant_resolution_attempted: description: Merchant resolution attempted. enum: - attempted - prohibited_by_local_law type: string x-documentation-priority: default x-enum-descriptions: - Attempted. - Prohibited by local law. no_cancellation: anyOf: - additionalProperties: false description: No cancellation. Present if and only if `cancellation_outcome` is `no_cancellation`. properties: {} title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Merchandise Not Received No Cancellation type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true x-title-plural: No Cancellations - type: 'null' purchase_info_and_explanation: description: Purchase information and explanation. type: string x-documentation-priority: default required: - cancellation_outcome - cardholder_cancellation_prior_to_expected_receipt - delayed - delivered_to_wrong_location - delivery_issue - last_expected_receipt_at - merchant_cancellation - merchant_resolution_attempted - no_cancellation - purchase_info_and_explanation title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Merchandise Not Received type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Consumer Merchandise Not Receiveds - type: 'null' consumer_non_receipt_of_cash: anyOf: - additionalProperties: false description: Non-receipt of cash. Present if and only if `category` is `consumer_non_receipt_of_cash`. properties: {} title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Non Receipt Of Cash type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true x-title-plural: Consumer Non Receipt Of Cashes - type: 'null' consumer_original_credit_transaction_not_accepted: anyOf: - additionalProperties: false description: Original Credit Transaction (OCT) not accepted. Present if and only if `category` is `consumer_original_credit_transaction_not_accepted`. properties: explanation: description: Explanation. type: string x-documentation-priority: default reason: description: Reason. enum: - prohibited_by_local_laws_or_regulation - recipient_refused type: string x-documentation-priority: default x-enum-descriptions: - Prohibited by local laws or regulation. - Recipient refused. required: - explanation - reason title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Original Credit Transaction Not Accepted type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Consumer Original Credit Transaction Not Accepteds - type: 'null' consumer_quality_merchandise: anyOf: - additionalProperties: false description: Merchandise quality issue. Present if and only if `category` is `consumer_quality_merchandise`. properties: expected_at: description: Expected at. format: date type: string x-documentation-priority: default merchant_resolution_attempted: description: Merchant resolution attempted. enum: - attempted - prohibited_by_local_law type: string x-documentation-priority: default x-enum-descriptions: - Attempted. - Prohibited by local law. not_returned: anyOf: - additionalProperties: false description: Not returned. Present if and only if `return_outcome` is `not_returned`. properties: {} title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Quality Merchandise Not Returned type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true x-title-plural: Not Returneds - type: 'null' ongoing_negotiations: anyOf: - additionalProperties: false description: Ongoing negotiations. Exclude if there is no evidence of ongoing negotiations. properties: explanation: description: Explanation of the previous ongoing negotiations between the cardholder and merchant. type: string x-documentation-priority: default issuer_first_notified_at: description: Date the cardholder first notified the issuer of the dispute. format: date type: string x-documentation-priority: default started_at: description: Started at. format: date type: string x-documentation-priority: default required: - explanation - issuer_first_notified_at - started_at title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Quality Merchandise Ongoing Negotiations type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Ongoing Negotiations - type: 'null' purchase_info_and_quality_issue: description: Purchase information and quality issue. type: string x-documentation-priority: default received_at: description: Received at. format: date type: string x-documentation-priority: default return_attempted: anyOf: - additionalProperties: false description: Return attempted. Present if and only if `return_outcome` is `return_attempted`. properties: attempt_explanation: description: Attempt explanation. type: string x-documentation-priority: default attempt_reason: description: Attempt reason. enum: - merchant_not_responding - no_return_authorization_provided - no_return_instructions - requested_not_to_return - return_not_accepted type: string x-documentation-priority: default x-enum-descriptions: - Merchant not responding. - No return authorization provided. - No return instructions. - Requested not to return. - Return not accepted. attempted_at: description: Attempted at. format: date type: string x-documentation-priority: default merchandise_disposition: description: Merchandise disposition. type: string x-documentation-priority: default required: - attempt_explanation - attempt_reason - attempted_at - merchandise_disposition title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Quality Merchandise Return Attempted type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Return Attempteds - type: 'null' return_outcome: description: Return outcome. enum: - not_returned - returned - return_attempted type: string x-documentation-priority: default x-enum-descriptions: - Not returned. - Returned. - Return attempted. returned: anyOf: - additionalProperties: false description: Returned. Present if and only if `return_outcome` is `returned`. properties: merchant_received_return_at: anyOf: - description: Merchant received return at. format: date type: string x-documentation-priority: default - type: 'null' other_explanation: anyOf: - description: Other explanation. Required if and only if the return method is `other`. type: string x-documentation-priority: default - type: 'null' return_method: description: Return method. enum: - dhl - face_to_face - fedex - other - postal_service - ups type: string x-documentation-priority: default x-enum-descriptions: - DHL. - Face-to-face. - FedEx. - Other. - Postal service. - UPS. returned_at: description: Returned at. format: date type: string x-documentation-priority: default tracking_number: anyOf: - description: Tracking number. type: string x-documentation-priority: default - type: 'null' required: - merchant_received_return_at - other_explanation - return_method - returned_at - tracking_number title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Quality Merchandise Returned type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Returneds - type: 'null' required: - expected_at - merchant_resolution_attempted - not_returned - ongoing_negotiations - purchase_info_and_quality_issue - received_at - return_attempted - return_outcome - returned title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Quality Merchandise type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Consumer Quality Merchandises - type: 'null' consumer_quality_services: anyOf: - additionalProperties: false description: Services quality issue. Present if and only if `category` is `consumer_quality_services`. properties: cardholder_cancellation: additionalProperties: false description: Cardholder cancellation. properties: accepted_by_merchant: description: Accepted by merchant. enum: - accepted - not_accepted type: string x-documentation-priority: default x-enum-descriptions: - Accepted. - Not accepted. canceled_at: description: Canceled at. format: date type: string x-documentation-priority: default reason: description: Reason. type: string x-documentation-priority: default required: - accepted_by_merchant - canceled_at - reason title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Quality Services Cardholder Cancellation type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Cardholder Cancellations cardholder_paid_to_have_work_redone: anyOf: - description: Cardholder paid to have work redone. enum: - did_not_pay_to_have_work_redone - paid_to_have_work_redone type: string x-documentation-priority: default x-enum-descriptions: - Cardholder did not pay to have work redone. - Cardholder paid to have work redone. - type: 'null' non_fiat_currency_or_non_fungible_token_related_and_not_matching_description: description: Non-fiat currency or non-fungible token related and not matching description. enum: - not_related - related type: string x-documentation-priority: default x-enum-descriptions: - Not related. - Related. ongoing_negotiations: anyOf: - additionalProperties: false description: Ongoing negotiations. Exclude if there is no evidence of ongoing negotiations. properties: explanation: description: Explanation of the previous ongoing negotiations between the cardholder and merchant. type: string x-documentation-priority: default issuer_first_notified_at: description: Date the cardholder first notified the issuer of the dispute. format: date type: string x-documentation-priority: default started_at: description: Started at. format: date type: string x-documentation-priority: default required: - explanation - issuer_first_notified_at - started_at title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Quality Services Ongoing Negotiations type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Ongoing Negotiations - type: 'null' purchase_info_and_quality_issue: description: Purchase information and quality issue. type: string x-documentation-priority: default restaurant_food_related: anyOf: - description: Whether the dispute is related to the quality of food from an eating place or restaurant. Must be provided when Merchant Category Code (MCC) is 5812, 5813 or 5814. enum: - not_related - related type: string x-documentation-priority: default x-enum-descriptions: - Not related. - Related. - type: 'null' services_received_at: description: Services received at. format: date type: string x-documentation-priority: default required: - cardholder_cancellation - cardholder_paid_to_have_work_redone - non_fiat_currency_or_non_fungible_token_related_and_not_matching_description - ongoing_negotiations - purchase_info_and_quality_issue - restaurant_food_related - services_received_at title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Quality Services type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Consumer Quality Services - type: 'null' consumer_services_misrepresentation: anyOf: - additionalProperties: false description: Services misrepresentation. Present if and only if `category` is `consumer_services_misrepresentation`. properties: cardholder_cancellation: additionalProperties: false description: Cardholder cancellation. properties: accepted_by_merchant: description: Accepted by merchant. enum: - accepted - not_accepted type: string x-documentation-priority: default x-enum-descriptions: - Accepted. - Not accepted. canceled_at: description: Canceled at. format: date type: string x-documentation-priority: default reason: description: Reason. type: string x-documentation-priority: default required: - accepted_by_merchant - canceled_at - reason title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Services Misrepresentation Cardholder Cancellation type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Cardholder Cancellations merchant_resolution_attempted: description: Merchant resolution attempted. enum: - attempted - prohibited_by_local_law type: string x-documentation-priority: default x-enum-descriptions: - Attempted. - Prohibited by local law. misrepresentation_explanation: description: Misrepresentation explanation. type: string x-documentation-priority: default purchase_explanation: description: Purchase explanation. type: string x-documentation-priority: default received_at: description: Received at. format: date type: string x-documentation-priority: default required: - cardholder_cancellation - merchant_resolution_attempted - misrepresentation_explanation - purchase_explanation - received_at title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Services Misrepresentation type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Consumer Services Misrepresentations - type: 'null' consumer_services_not_as_described: anyOf: - additionalProperties: false description: Services not as described. Present if and only if `category` is `consumer_services_not_as_described`. properties: cardholder_cancellation: additionalProperties: false description: Cardholder cancellation. properties: accepted_by_merchant: description: Accepted by merchant. enum: - accepted - not_accepted type: string x-documentation-priority: default x-enum-descriptions: - Accepted. - Not accepted. canceled_at: description: Canceled at. format: date type: string x-documentation-priority: default reason: description: Reason. type: string x-documentation-priority: default required: - accepted_by_merchant - canceled_at - reason title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Services Not As Described Cardholder Cancellation type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Cardholder Cancellations explanation: description: Explanation of what was ordered and was not as described. type: string x-documentation-priority: default merchant_resolution_attempted: description: Merchant resolution attempted. enum: - attempted - prohibited_by_local_law type: string x-documentation-priority: default x-enum-descriptions: - Attempted. - Prohibited by local law. received_at: description: Received at. format: date type: string x-documentation-priority: default required: - cardholder_cancellation - explanation - merchant_resolution_attempted - received_at title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Services Not As Described type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Consumer Services Not As Describeds - type: 'null' consumer_services_not_received: anyOf: - additionalProperties: false description: Services not received. Present if and only if `category` is `consumer_services_not_received`. properties: cancellation_outcome: description: Cancellation outcome. enum: - cardholder_cancellation_prior_to_expected_receipt - merchant_cancellation - no_cancellation type: string x-documentation-priority: default x-enum-descriptions: - Cardholder cancellation prior to expected receipt. - Merchant cancellation. - No cancellation. cardholder_cancellation_prior_to_expected_receipt: anyOf: - additionalProperties: false description: Cardholder cancellation prior to expected receipt. Present if and only if `cancellation_outcome` is `cardholder_cancellation_prior_to_expected_receipt`. properties: canceled_at: description: Canceled at. format: date type: string x-documentation-priority: default reason: anyOf: - description: Reason. type: string x-documentation-priority: default - type: 'null' required: - canceled_at - reason title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Services Not Received Cardholder Cancellation Prior To Expected Receipt type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Cardholder Cancellation Prior To Expected Receipts - type: 'null' last_expected_receipt_at: description: Last expected receipt at. format: date type: string x-documentation-priority: default merchant_cancellation: anyOf: - additionalProperties: false description: Merchant cancellation. Present if and only if `cancellation_outcome` is `merchant_cancellation`. properties: canceled_at: description: Canceled at. format: date type: string x-documentation-priority: default required: - canceled_at title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Services Not Received Merchant Cancellation type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Merchant Cancellations - type: 'null' merchant_resolution_attempted: description: Merchant resolution attempted. enum: - attempted - prohibited_by_local_law type: string x-documentation-priority: default x-enum-descriptions: - Attempted. - Prohibited by local law. no_cancellation: anyOf: - additionalProperties: false description: No cancellation. Present if and only if `cancellation_outcome` is `no_cancellation`. properties: {} title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Services Not Received No Cancellation type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true x-title-plural: No Cancellations - type: 'null' purchase_info_and_explanation: description: Purchase information and explanation. type: string x-documentation-priority: default required: - cancellation_outcome - cardholder_cancellation_prior_to_expected_receipt - last_expected_receipt_at - merchant_cancellation - merchant_resolution_attempted - no_cancellation - purchase_info_and_explanation title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Services Not Received type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Consumer Services Not Receiveds - type: 'null' fraud: anyOf: - additionalProperties: false description: Fraud. Present if and only if `category` is `fraud`. properties: fraud_type: description: Fraud type. enum: - account_or_credentials_takeover - card_not_received_as_issued - fraudulent_application - fraudulent_use_of_account_number - incorrect_processing - issuer_reported_counterfeit - lost - manipulation_of_account_holder - merchant_misrepresentation - miscellaneous - stolen type: string x-documentation-priority: default x-enum-descriptions: - Account or credentials takeover. - Card not received as issued. - Fraudulent application. - Fraudulent use of account number. - Incorrect processing. - Issuer reported counterfeit. - Lost. - Manipulation of account holder. - Merchant misrepresentation. - Miscellaneous. - Stolen. required: - fraud_type title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Fraud type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Frauds - type: 'null' processing_error: anyOf: - additionalProperties: false description: Processing error. Present if and only if `category` is `processing_error`. properties: duplicate_transaction: anyOf: - additionalProperties: false description: Duplicate transaction. Present if and only if `error_reason` is `duplicate_transaction`. properties: other_transaction_id: description: Other transaction ID. type: string x-documentation-priority: default required: - other_transaction_id title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Processing Error Duplicate Transaction type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Duplicate Transactions - type: 'null' error_reason: description: Error reason. enum: - duplicate_transaction - incorrect_amount - paid_by_other_means type: string x-documentation-priority: default x-enum-descriptions: - Duplicate transaction. - Incorrect amount. - Paid by other means. incorrect_amount: anyOf: - additionalProperties: false description: Incorrect amount. Present if and only if `error_reason` is `incorrect_amount`. properties: expected_amount: description: Expected amount. type: integer x-documentation-priority: default required: - expected_amount title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Processing Error Incorrect Amount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Incorrect Amounts - type: 'null' merchant_resolution_attempted: description: Merchant resolution attempted. enum: - attempted - prohibited_by_local_law type: string x-documentation-priority: default x-enum-descriptions: - Attempted. - Prohibited by local law. paid_by_other_means: anyOf: - additionalProperties: false description: Paid by other means. Present if and only if `error_reason` is `paid_by_other_means`. properties: other_form_of_payment_evidence: description: Other form of payment evidence. enum: - canceled_check - card_transaction - cash_receipt - other - statement - voucher type: string x-documentation-priority: default x-enum-descriptions: - Canceled check. - Card transaction. - Cash receipt. - Other. - Statement. - Voucher. other_transaction_id: anyOf: - description: Other transaction ID. type: string x-documentation-priority: default - type: 'null' required: - other_form_of_payment_evidence - other_transaction_id title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Processing Error Paid By Other Means type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Paid By Other Means - type: 'null' required: - duplicate_transaction - error_reason - incorrect_amount - merchant_resolution_attempted - paid_by_other_means title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Processing Error type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Processing Errors - type: 'null' required: - authorization - category - consumer_canceled_merchandise - consumer_canceled_recurring_transaction - consumer_canceled_services - consumer_counterfeit_merchandise - consumer_credit_not_processed - consumer_damaged_or_defective_merchandise - consumer_merchandise_misrepresentation - consumer_merchandise_not_as_described - consumer_merchandise_not_received - consumer_non_receipt_of_cash - consumer_original_credit_transaction_not_accepted - consumer_quality_merchandise - consumer_quality_services - consumer_services_misrepresentation - consumer_services_not_as_described - consumer_services_not_received - fraud - processing_error title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Visa Card Dispute Chargeback User Submission Chargeback Details - type: 'null' created_at: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Visa Card Dispute User Submission was created. format: date-time type: string x-documentation-priority: default explanation: anyOf: - description: The free-form explanation provided to Increase to provide more context for the user submission. This field is not sent directly to the card networks. type: string x-documentation-priority: default - type: 'null' further_information_requested_at: anyOf: - description: The date and time at which Increase requested further information from the user for the Visa Card Dispute. format: date-time type: string x-documentation-priority: default - type: 'null' further_information_requested_reason: anyOf: - description: The reason for Increase requesting further information from the user for the Visa Card Dispute. type: string x-documentation-priority: default - type: 'null' merchant_prearbitration_decline: anyOf: - additionalProperties: false description: A Visa Card Dispute Merchant Pre-Arbitration Decline User Submission object. This field will be present in the JSON response if and only if `category` is equal to `merchant_prearbitration_decline`. Contains the details specific to a merchant prearbitration decline Visa Card Dispute User Submission. example: reason: I do not believe the explanation given by the merchant is valid. properties: reason: description: The reason the user declined the merchant's request for pre-arbitration in their favor. type: string x-documentation-priority: default required: - reason title: Visa Card Dispute User Submission Visa Card Dispute Merchant Pre-Arbitration Decline User Submission type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Visa Card Dispute Merchant Pre-Arbitration Decline User Submissions - type: 'null' status: description: The status of the Visa Card Dispute User Submission. enum: - abandoned - accepted - further_information_requested - pending_reviewing type: string x-documentation-priority: default x-enum-descriptions: - The User Submission was abandoned. - The User Submission was accepted. - Further information is requested, please resubmit with the requested information. - The User Submission is pending review. updated_at: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Visa Card Dispute User Submission was updated. format: date-time type: string x-documentation-priority: default user_prearbitration: anyOf: - additionalProperties: false description: A Visa Card Dispute User-Initiated Pre-Arbitration User Submission object. This field will be present in the JSON response if and only if `category` is equal to `user_prearbitration`. Contains the details specific to a user-initiated pre-arbitration Visa Card Dispute User Submission. example: category_change: category: fraud reason: Based on the response from the merchant. reason: I disagree with the explanation given by the merchant. properties: category_change: anyOf: - additionalProperties: false description: Category change details for the pre-arbitration request, if requested. properties: category: description: The category the dispute is being changed to. enum: - authorization - consumer_canceled_merchandise - consumer_canceled_recurring_transaction - consumer_canceled_services - consumer_counterfeit_merchandise - consumer_credit_not_processed - consumer_damaged_or_defective_merchandise - consumer_merchandise_misrepresentation - consumer_merchandise_not_as_described - consumer_merchandise_not_received - consumer_non_receipt_of_cash - consumer_original_credit_transaction_not_accepted - consumer_quality_merchandise - consumer_quality_services - consumer_services_misrepresentation - consumer_services_not_as_described - consumer_services_not_received - fraud - processing_error type: string x-documentation-priority: default x-enum-descriptions: - Authorization. - 'Consumer: canceled merchandise.' - 'Consumer: canceled recurring transaction.' - 'Consumer: canceled services.' - 'Consumer: counterfeit merchandise.' - 'Consumer: credit not processed.' - 'Consumer: damaged or defective merchandise.' - 'Consumer: merchandise misrepresentation.' - 'Consumer: merchandise not as described.' - 'Consumer: merchandise not received.' - 'Consumer: non-receipt of cash.' - 'Consumer: Original Credit Transaction (OCT) not accepted.' - 'Consumer: merchandise quality issue.' - 'Consumer: services quality issue.' - 'Consumer: services misrepresentation.' - 'Consumer: services not as described.' - 'Consumer: services not received.' - Fraud. - Processing error. reason: description: The reason for the pre-arbitration request. type: string x-documentation-priority: default required: - category - reason title: Visa Card Dispute User Submission Visa Card Dispute User-Initiated Pre-Arbitration User Submission Category Change type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Category Changes - type: 'null' reason: description: The reason for the pre-arbitration request. type: string x-documentation-priority: default required: - reason - category_change title: Visa Card Dispute User Submission Visa Card Dispute User-Initiated Pre-Arbitration User Submission type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Visa Card Dispute User-Initiated Pre-Arbitration User Submissions - type: 'null' required: - created_at - updated_at - amount - explanation - attachment_files - status - accepted_at - further_information_requested_at - further_information_requested_reason - category title: Visa Card Dispute User Submission type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: Visa Card Dispute User Submissions error: anyOf: - properties: detail: anyOf: - type: string - type: 'null' status: enum: - 404 type: integer title: type: string type: enum: - api_method_not_found_error type: string required: - type - title - detail - status type: object x-event-categories: [] - properties: detail: anyOf: - type: string - type: 'null' status: enum: - 403 type: integer title: type: string type: enum: - environment_mismatch_error type: string required: - type - title - detail - status type: object x-event-categories: [] - properties: detail: anyOf: - type: string - type: 'null' resource_id: description: '' type: string x-documentation-priority: default status: enum: - 409 type: integer title: type: string type: enum: - idempotency_key_already_used_error type: string required: - type - title - detail - status - resource_id type: object x-event-categories: [] - properties: detail: anyOf: - type: string - type: 'null' status: enum: - 403 type: integer title: type: string type: enum: - insufficient_permissions_error type: string required: - type - title - detail - status type: object x-event-categories: [] - properties: detail: anyOf: - type: string - type: 'null' status: enum: - 500 type: integer title: type: string type: enum: - internal_server_error type: string required: - type - title - detail - status type: object x-event-categories: [] - properties: detail: anyOf: - type: string - type: 'null' reason: description: '' enum: - deleted_credential - expired_credential - ip_not_allowed - no_credential - no_header - no_api_access - wrong_environment type: string x-documentation-priority: default x-enum-descriptions: - deleted_credential - expired_credential - ip_not_allowed - no_credential - no_header - no_api_access - wrong_environment status: enum: - 401 type: integer title: type: string type: enum: - invalid_api_key_error type: string required: - type - title - detail - status - reason type: object x-event-categories: [] - properties: detail: anyOf: - type: string - type: 'null' status: enum: - 409 type: integer title: type: string type: enum: - invalid_operation_error type: string required: - type - title - detail - status type: object x-event-categories: [] - properties: detail: anyOf: - type: string - type: 'null' errors: description: All errors related to parsing the request parameters. items: additionalProperties: true properties: {} title: ErrorsElement type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: ErrorsElements type: array x-documentation-priority: default status: enum: - 400 type: integer title: type: string type: enum: - invalid_parameters_error type: string required: - type - title - detail - status - errors type: object x-event-categories: [] - properties: detail: anyOf: - type: string - type: 'null' status: enum: - 400 type: integer title: type: string type: enum: - malformed_request_error type: string required: - type - title - detail - status type: object x-event-categories: [] - properties: detail: anyOf: - type: string - type: 'null' status: enum: - 404 type: integer title: type: string type: enum: - object_not_found_error type: string required: - type - title - detail - status type: object x-event-categories: [] - properties: detail: anyOf: - type: string - type: 'null' status: enum: - 403 type: integer title: type: string type: enum: - private_feature_error type: string required: - type - title - detail - status type: object x-event-categories: [] - properties: detail: anyOf: - type: string - type: 'null' retry_after: anyOf: - description: '' type: integer x-documentation-priority: default - type: 'null' status: enum: - 429 type: integer title: type: string type: enum: - rate_limited_error type: string required: - type - title - detail - status type: object x-event-categories: [] card_dispute_visa: additionalProperties: false properties: network_events: description: The network events for the Card Dispute. items: $ref: '#/components/schemas/card_dispute_visa_network_event' type: array x-documentation-priority: default required_user_submission_category: anyOf: - description: The category of the currently required user submission if the user wishes to proceed with the dispute. Present if and only if status is `user_submission_required`. Otherwise, this will be `nil`. enum: - chargeback - merchant_prearbitration_decline - user_prearbitration type: string x-documentation-priority: default x-enum-descriptions: - A Chargeback User Submission is required. - A Merchant Pre Arbitration Decline User Submission is required. - A User Initiated Pre Arbitration User Submission is required. - type: 'null' user_submissions: description: The user submissions for the Card Dispute. items: $ref: '#/components/schemas/card_dispute_visa_user_submission' type: array x-documentation-priority: default required: - network_events - required_user_submission_category - user_submissions title: Card Dispute Visa-specific details type: object x-event-categories: - card_dispute.created - card_dispute.updated x-stainless-empty-object: false x-title-plural: Card Dispute Visa-specific details withdraw_a_card_dispute_parameters: additionalProperties: false example: explanation: The explanation for withdrawing the Card Dispute. properties: explanation: description: The explanation for withdrawing the Card Dispute. maxLength: 2048 minLength: 1 type: string x-documentation-priority: default type: object x-event-categories: [] x-stainless-empty-object: false submit_a_user_submission_for_a_card_dispute_parameters: additionalProperties: true example: network: visa visa: category: merchant_prearbitration_decline merchant_prearbitration_decline: reason: The pre-arbitration received from the merchantdoes not explain how they obtained permission to charge the card. properties: amount: description: The adjusted monetary amount of the part of the transaction that is being disputed. This is optional and will default to the most recent amount provided. If provided, the amount must be less than or equal to the amount of the transaction. minimum: 1 type: integer x-documentation-priority: default attachment_files: description: The files to be attached to the user submission. items: additionalProperties: false properties: file_id: description: The ID of the file to be attached. The file must have a `purpose` of `card_dispute_attachment`. type: string x-documentation-priority: default x-id-reference-to: Files required: - file_id type: object x-event-categories: [] x-stainless-empty-object: false type: array x-documentation-priority: default explanation: description: The free-form explanation provided to Increase to provide more context for the user submission. This field is not sent directly to the card networks. maxLength: 200 minLength: 1 type: string x-documentation-priority: default network: description: The network of the Card Dispute. Details specific to the network are required under the sub-object with the same identifier as the network. enum: - visa type: string x-documentation-priority: default x-enum-descriptions: - Visa visa: additionalProperties: false description: The Visa-specific parameters for the dispute. Required if and only if `network` is `visa`. properties: category: description: The category of the user submission. Details specific to the category are required under the sub-object with the same identifier as the category. enum: - chargeback - merchant_prearbitration_decline - user_prearbitration type: string x-documentation-priority: default x-enum-descriptions: - Chargeback. - Merchant pre-arbitration decline. - User pre-arbitration. chargeback: additionalProperties: false description: The chargeback details for the user submission. Required if and only if `category` is `chargeback`. properties: authorization: additionalProperties: false description: Authorization. Required if and only if `category` is `authorization`. properties: account_status: description: Account status. enum: - account_closed - credit_problem - fraud type: string x-documentation-priority: default x-enum-descriptions: - Account closed. - Credit problem. - Fraud. required: - account_status type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false category: description: Category. enum: - authorization - consumer_canceled_merchandise - consumer_canceled_recurring_transaction - consumer_canceled_services - consumer_counterfeit_merchandise - consumer_credit_not_processed - consumer_damaged_or_defective_merchandise - consumer_merchandise_misrepresentation - consumer_merchandise_not_as_described - consumer_merchandise_not_received - consumer_non_receipt_of_cash - consumer_original_credit_transaction_not_accepted - consumer_quality_merchandise - consumer_quality_services - consumer_services_misrepresentation - consumer_services_not_as_described - consumer_services_not_received - fraud - processing_error type: string x-documentation-priority: default x-enum-descriptions: - Authorization. - 'Consumer: canceled merchandise.' - 'Consumer: canceled recurring transaction.' - 'Consumer: canceled services.' - 'Consumer: counterfeit merchandise.' - 'Consumer: credit not processed.' - 'Consumer: damaged or defective merchandise.' - 'Consumer: merchandise misrepresentation.' - 'Consumer: merchandise not as described.' - 'Consumer: merchandise not received.' - 'Consumer: non-receipt of cash.' - 'Consumer: Original Credit Transaction (OCT) not accepted.' - 'Consumer: merchandise quality issue.' - 'Consumer: services quality issue.' - 'Consumer: services misrepresentation.' - 'Consumer: services not as described.' - 'Consumer: services not received.' - Fraud. - Processing error. consumer_canceled_merchandise: additionalProperties: false description: Canceled merchandise. Required if and only if `category` is `consumer_canceled_merchandise`. properties: cardholder_cancellation: additionalProperties: false description: Cardholder cancellation. properties: canceled_at: description: Canceled at. format: date type: string x-documentation-priority: default canceled_prior_to_ship_date: description: Canceled prior to ship date. enum: - canceled_prior_to_ship_date - not_canceled_prior_to_ship_date type: string x-documentation-priority: default x-enum-descriptions: - Canceled prior to ship date. - Not canceled prior to ship date. cancellation_policy_provided: description: Cancellation policy provided. enum: - not_provided - provided type: string x-documentation-priority: default x-enum-descriptions: - Not provided. - Provided. reason: description: Reason. maxLength: 200 minLength: 1 type: string x-documentation-priority: default required: - canceled_at - canceled_prior_to_ship_date - cancellation_policy_provided - reason type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false merchant_resolution_attempted: description: Merchant resolution attempted. enum: - attempted - prohibited_by_local_law type: string x-documentation-priority: default x-enum-descriptions: - Attempted. - Prohibited by local law. not_returned: additionalProperties: false description: Not returned. Required if and only if `return_outcome` is `not_returned`. properties: {} type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true purchase_explanation: description: Purchase explanation. maxLength: 200 minLength: 1 type: string x-documentation-priority: default received_or_expected_at: description: Received or expected at. format: date type: string x-documentation-priority: default return_attempted: additionalProperties: false description: Return attempted. Required if and only if `return_outcome` is `return_attempted`. properties: attempt_explanation: description: Attempt explanation. maxLength: 200 minLength: 1 type: string x-documentation-priority: default attempt_reason: description: Attempt reason. enum: - merchant_not_responding - no_return_authorization_provided - no_return_instructions - requested_not_to_return - return_not_accepted type: string x-documentation-priority: default x-enum-descriptions: - Merchant not responding. - No return authorization provided. - No return instructions. - Requested not to return. - Return not accepted. attempted_at: description: Attempted at. format: date type: string x-documentation-priority: default merchandise_disposition: description: Merchandise disposition. maxLength: 200 minLength: 1 type: string x-documentation-priority: default required: - attempt_explanation - attempt_reason - attempted_at - merchandise_disposition type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false return_outcome: description: Return outcome. enum: - not_returned - returned - return_attempted type: string x-documentation-priority: default x-enum-descriptions: - Not returned. - Returned. - Return attempted. returned: additionalProperties: false description: Returned. Required if and only if `return_outcome` is `returned`. properties: merchant_received_return_at: description: Merchant received return at. format: date type: string x-documentation-priority: default other_explanation: description: Other explanation. Required if and only if the return method is `other`. maxLength: 200 minLength: 1 type: string x-documentation-priority: default return_method: description: Return method. enum: - dhl - face_to_face - fedex - other - postal_service - ups type: string x-documentation-priority: default x-enum-descriptions: - DHL. - Face-to-face. - FedEx. - Other. - Postal service. - UPS. returned_at: description: Returned at. format: date type: string x-documentation-priority: default tracking_number: description: Tracking number. maxLength: 200 minLength: 1 type: string x-documentation-priority: default required: - return_method - returned_at type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false required: - merchant_resolution_attempted - purchase_explanation - received_or_expected_at - return_outcome type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false consumer_canceled_recurring_transaction: additionalProperties: false description: Canceled recurring transaction. Required if and only if `category` is `consumer_canceled_recurring_transaction`. properties: cancellation_target: description: Cancellation target. enum: - account - transaction type: string x-documentation-priority: default x-enum-descriptions: - Account. - Transaction. merchant_contact_methods: additionalProperties: false description: Merchant contact methods. properties: application_name: description: Application name. maxLength: 200 minLength: 1 type: string x-documentation-priority: default call_center_phone_number: description: Call center phone number. maxLength: 200 minLength: 1 type: string x-documentation-priority: default email_address: description: Email address. maxLength: 200 minLength: 1 type: string x-documentation-priority: default in_person_address: description: In person address. maxLength: 200 minLength: 1 type: string x-documentation-priority: default mailing_address: description: Mailing address. maxLength: 200 minLength: 1 type: string x-documentation-priority: default text_phone_number: description: Text phone number. maxLength: 200 minLength: 1 type: string x-documentation-priority: default type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false other_form_of_payment_explanation: description: Other form of payment explanation. maxLength: 200 minLength: 1 type: string x-documentation-priority: default transaction_or_account_canceled_at: description: Transaction or account canceled at. format: date type: string x-documentation-priority: default required: - cancellation_target - merchant_contact_methods - transaction_or_account_canceled_at type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false consumer_canceled_services: additionalProperties: false description: Canceled services. Required if and only if `category` is `consumer_canceled_services`. properties: cardholder_cancellation: additionalProperties: false description: Cardholder cancellation. properties: canceled_at: description: Canceled at. format: date type: string x-documentation-priority: default cancellation_policy_provided: description: Cancellation policy provided. enum: - not_provided - provided type: string x-documentation-priority: default x-enum-descriptions: - Not provided. - Provided. reason: description: Reason. maxLength: 200 minLength: 1 type: string x-documentation-priority: default required: - canceled_at - cancellation_policy_provided - reason type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false contracted_at: description: Contracted at. format: date type: string x-documentation-priority: default guaranteed_reservation: additionalProperties: false description: Guaranteed reservation explanation. Required if and only if `service_type` is `guaranteed_reservation`. properties: explanation: description: Explanation. enum: - cardholder_canceled_prior_to_service - cardholder_cancellation_attempt_within_24_hours_of_confirmation - merchant_billed_no_show type: string x-documentation-priority: default x-enum-descriptions: - Cardholder canceled prior to service. - Cardholder cancellation attempt within 24 hours of confirmation. - Merchant billed for no-show. required: - explanation type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false merchant_resolution_attempted: description: Merchant resolution attempted. enum: - attempted - prohibited_by_local_law type: string x-documentation-priority: default x-enum-descriptions: - Attempted. - Prohibited by local law. other: additionalProperties: false description: Other service type explanation. Required if and only if `service_type` is `other`. properties: {} type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true purchase_explanation: description: Purchase explanation. maxLength: 200 minLength: 1 type: string x-documentation-priority: default service_type: description: Service type. enum: - guaranteed_reservation - other - timeshare type: string x-documentation-priority: default x-enum-descriptions: - Guaranteed reservation. - Other. - Timeshare. timeshare: additionalProperties: false description: Timeshare explanation. Required if and only if `service_type` is `timeshare`. properties: {} type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true required: - cardholder_cancellation - contracted_at - merchant_resolution_attempted - purchase_explanation - service_type type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false consumer_counterfeit_merchandise: additionalProperties: false description: Counterfeit merchandise. Required if and only if `category` is `consumer_counterfeit_merchandise`. properties: counterfeit_explanation: description: Counterfeit explanation. maxLength: 200 minLength: 1 type: string x-documentation-priority: default disposition_explanation: description: Disposition explanation. maxLength: 200 minLength: 1 type: string x-documentation-priority: default order_explanation: description: Order explanation. maxLength: 200 minLength: 1 type: string x-documentation-priority: default received_at: description: Received at. format: date type: string x-documentation-priority: default required: - counterfeit_explanation - disposition_explanation - order_explanation - received_at type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false consumer_credit_not_processed: additionalProperties: false description: Credit not processed. Required if and only if `category` is `consumer_credit_not_processed`. properties: canceled_or_returned_at: description: Canceled or returned at. format: date type: string x-documentation-priority: default credit_expected_at: description: Credit expected at. format: date type: string x-documentation-priority: default type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false consumer_damaged_or_defective_merchandise: additionalProperties: false description: Damaged or defective merchandise. Required if and only if `category` is `consumer_damaged_or_defective_merchandise`. properties: merchant_resolution_attempted: description: Merchant resolution attempted. enum: - attempted - prohibited_by_local_law type: string x-documentation-priority: default x-enum-descriptions: - Attempted. - Prohibited by local law. not_returned: additionalProperties: false description: Not returned. Required if and only if `return_outcome` is `not_returned`. properties: {} type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true order_and_issue_explanation: description: Order and issue explanation. maxLength: 200 minLength: 1 type: string x-documentation-priority: default received_at: description: Received at. format: date type: string x-documentation-priority: default return_attempted: additionalProperties: false description: Return attempted. Required if and only if `return_outcome` is `return_attempted`. properties: attempt_explanation: description: Attempt explanation. maxLength: 200 minLength: 1 type: string x-documentation-priority: default attempt_reason: description: Attempt reason. enum: - merchant_not_responding - no_return_authorization_provided - no_return_instructions - requested_not_to_return - return_not_accepted type: string x-documentation-priority: default x-enum-descriptions: - Merchant not responding. - No return authorization provided. - No return instructions. - Requested not to return. - Return not accepted. attempted_at: description: Attempted at. format: date type: string x-documentation-priority: default merchandise_disposition: description: Merchandise disposition. maxLength: 200 minLength: 1 type: string x-documentation-priority: default required: - attempt_explanation - attempt_reason - attempted_at - merchandise_disposition type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false return_outcome: description: Return outcome. enum: - not_returned - returned - return_attempted type: string x-documentation-priority: default x-enum-descriptions: - Not returned. - Returned. - Return attempted. returned: additionalProperties: false description: Returned. Required if and only if `return_outcome` is `returned`. properties: merchant_received_return_at: description: Merchant received return at. format: date type: string x-documentation-priority: default other_explanation: description: Other explanation. Required if and only if the return method is `other`. maxLength: 200 minLength: 1 type: string x-documentation-priority: default return_method: description: Return method. enum: - dhl - face_to_face - fedex - other - postal_service - ups type: string x-documentation-priority: default x-enum-descriptions: - DHL. - Face-to-face. - FedEx. - Other. - Postal service. - UPS. returned_at: description: Returned at. format: date type: string x-documentation-priority: default tracking_number: description: Tracking number. maxLength: 200 minLength: 1 type: string x-documentation-priority: default required: - return_method - returned_at type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false required: - merchant_resolution_attempted - order_and_issue_explanation - received_at - return_outcome type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false consumer_merchandise_misrepresentation: additionalProperties: false description: Merchandise misrepresentation. Required if and only if `category` is `consumer_merchandise_misrepresentation`. properties: merchant_resolution_attempted: description: Merchant resolution attempted. enum: - attempted - prohibited_by_local_law type: string x-documentation-priority: default x-enum-descriptions: - Attempted. - Prohibited by local law. misrepresentation_explanation: description: Misrepresentation explanation. maxLength: 200 minLength: 1 type: string x-documentation-priority: default not_returned: additionalProperties: false description: Not returned. Required if and only if `return_outcome` is `not_returned`. properties: {} type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true purchase_explanation: description: Purchase explanation. maxLength: 200 minLength: 1 type: string x-documentation-priority: default received_at: description: Received at. format: date type: string x-documentation-priority: default return_attempted: additionalProperties: false description: Return attempted. Required if and only if `return_outcome` is `return_attempted`. properties: attempt_explanation: description: Attempt explanation. maxLength: 200 minLength: 1 type: string x-documentation-priority: default attempt_reason: description: Attempt reason. enum: - merchant_not_responding - no_return_authorization_provided - no_return_instructions - requested_not_to_return - return_not_accepted type: string x-documentation-priority: default x-enum-descriptions: - Merchant not responding. - No return authorization provided. - No return instructions. - Requested not to return. - Return not accepted. attempted_at: description: Attempted at. format: date type: string x-documentation-priority: default merchandise_disposition: description: Merchandise disposition. maxLength: 200 minLength: 1 type: string x-documentation-priority: default required: - attempt_explanation - attempt_reason - attempted_at - merchandise_disposition type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false return_outcome: description: Return outcome. enum: - not_returned - returned - return_attempted type: string x-documentation-priority: default x-enum-descriptions: - Not returned. - Returned. - Return attempted. returned: additionalProperties: false description: Returned. Required if and only if `return_outcome` is `returned`. properties: merchant_received_return_at: description: Merchant received return at. format: date type: string x-documentation-priority: default other_explanation: description: Other explanation. Required if and only if the return method is `other`. maxLength: 200 minLength: 1 type: string x-documentation-priority: default return_method: description: Return method. enum: - dhl - face_to_face - fedex - other - postal_service - ups type: string x-documentation-priority: default x-enum-descriptions: - DHL. - Face-to-face. - FedEx. - Other. - Postal service. - UPS. returned_at: description: Returned at. format: date type: string x-documentation-priority: default tracking_number: description: Tracking number. maxLength: 200 minLength: 1 type: string x-documentation-priority: default required: - return_method - returned_at type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false required: - merchant_resolution_attempted - misrepresentation_explanation - purchase_explanation - received_at - return_outcome type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false consumer_merchandise_not_as_described: additionalProperties: false description: Merchandise not as described. Required if and only if `category` is `consumer_merchandise_not_as_described`. properties: merchant_resolution_attempted: description: Merchant resolution attempted. enum: - attempted - prohibited_by_local_law type: string x-documentation-priority: default x-enum-descriptions: - Attempted. - Prohibited by local law. received_at: description: Received at. format: date type: string x-documentation-priority: default return_attempted: additionalProperties: false description: Return attempted. Required if and only if `return_outcome` is `return_attempted`. properties: attempt_explanation: description: Attempt explanation. maxLength: 200 minLength: 1 type: string x-documentation-priority: default attempt_reason: description: Attempt reason. enum: - merchant_not_responding - no_return_authorization_provided - no_return_instructions - requested_not_to_return - return_not_accepted type: string x-documentation-priority: default x-enum-descriptions: - Merchant not responding. - No return authorization provided. - No return instructions. - Requested not to return. - Return not accepted. attempted_at: description: Attempted at. format: date type: string x-documentation-priority: default merchandise_disposition: description: Merchandise disposition. maxLength: 200 minLength: 1 type: string x-documentation-priority: default required: - attempt_explanation - attempt_reason - attempted_at - merchandise_disposition type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false return_outcome: description: Return outcome. enum: - returned - return_attempted type: string x-documentation-priority: default x-enum-descriptions: - Returned. - Return attempted. returned: additionalProperties: false description: Returned. Required if and only if `return_outcome` is `returned`. properties: merchant_received_return_at: description: Merchant received return at. format: date type: string x-documentation-priority: default other_explanation: description: Other explanation. Required if and only if the return method is `other`. maxLength: 200 minLength: 1 type: string x-documentation-priority: default return_method: description: Return method. enum: - dhl - face_to_face - fedex - other - postal_service - ups type: string x-documentation-priority: default x-enum-descriptions: - DHL. - Face-to-face. - FedEx. - Other. - Postal service. - UPS. returned_at: description: Returned at. format: date type: string x-documentation-priority: default tracking_number: description: Tracking number. maxLength: 200 minLength: 1 type: string x-documentation-priority: default required: - return_method - returned_at type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false required: - merchant_resolution_attempted - received_at - return_outcome type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false consumer_merchandise_not_received: additionalProperties: false description: Merchandise not received. Required if and only if `category` is `consumer_merchandise_not_received`. properties: cancellation_outcome: description: Cancellation outcome. enum: - cardholder_cancellation_prior_to_expected_receipt - merchant_cancellation - no_cancellation type: string x-documentation-priority: default x-enum-descriptions: - Cardholder cancellation prior to expected receipt. - Merchant cancellation. - No cancellation. cardholder_cancellation_prior_to_expected_receipt: additionalProperties: false description: Cardholder cancellation prior to expected receipt. Required if and only if `cancellation_outcome` is `cardholder_cancellation_prior_to_expected_receipt`. properties: canceled_at: description: Canceled at. format: date type: string x-documentation-priority: default reason: description: Reason. maxLength: 200 minLength: 1 type: string x-documentation-priority: default required: - canceled_at type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false delayed: additionalProperties: false description: Delayed. Required if and only if `delivery_issue` is `delayed`. properties: explanation: description: Explanation. maxLength: 200 minLength: 1 type: string x-documentation-priority: default not_returned: additionalProperties: false description: Not returned. Required if and only if `return_outcome` is `not_returned`. properties: {} type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true return_attempted: additionalProperties: false description: Return attempted. Required if and only if `return_outcome` is `return_attempted`. properties: attempted_at: description: Attempted at. format: date type: string x-documentation-priority: default required: - attempted_at type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false return_outcome: description: Return outcome. enum: - not_returned - returned - return_attempted type: string x-documentation-priority: default x-enum-descriptions: - Not returned. - Returned. - Return attempted. returned: additionalProperties: false description: Returned. Required if and only if `return_outcome` is `returned`. properties: merchant_received_return_at: description: Merchant received return at. format: date type: string x-documentation-priority: default returned_at: description: Returned at. format: date type: string x-documentation-priority: default required: - merchant_received_return_at - returned_at type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false required: - explanation - return_outcome type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false delivered_to_wrong_location: additionalProperties: false description: Delivered to wrong location. Required if and only if `delivery_issue` is `delivered_to_wrong_location`. properties: agreed_location: description: Agreed location. maxLength: 200 minLength: 1 type: string x-documentation-priority: default required: - agreed_location type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false delivery_issue: description: Delivery issue. enum: - delayed - delivered_to_wrong_location type: string x-documentation-priority: default x-enum-descriptions: - Delayed. - Delivered to wrong location. last_expected_receipt_at: description: Last expected receipt at. format: date type: string x-documentation-priority: default merchant_cancellation: additionalProperties: false description: Merchant cancellation. Required if and only if `cancellation_outcome` is `merchant_cancellation`. properties: canceled_at: description: Canceled at. format: date type: string x-documentation-priority: default required: - canceled_at type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false merchant_resolution_attempted: description: Merchant resolution attempted. enum: - attempted - prohibited_by_local_law type: string x-documentation-priority: default x-enum-descriptions: - Attempted. - Prohibited by local law. no_cancellation: additionalProperties: false description: No cancellation. Required if and only if `cancellation_outcome` is `no_cancellation`. properties: {} type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true purchase_info_and_explanation: description: Purchase information and explanation. maxLength: 200 minLength: 1 type: string x-documentation-priority: default required: - cancellation_outcome - delivery_issue - last_expected_receipt_at - merchant_resolution_attempted - purchase_info_and_explanation type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false consumer_non_receipt_of_cash: additionalProperties: false description: Non-receipt of cash. Required if and only if `category` is `consumer_non_receipt_of_cash`. properties: {} type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true consumer_original_credit_transaction_not_accepted: additionalProperties: false description: Original Credit Transaction (OCT) not accepted. Required if and only if `category` is `consumer_original_credit_transaction_not_accepted`. properties: explanation: description: Explanation. maxLength: 200 minLength: 1 type: string x-documentation-priority: default reason: description: Reason. enum: - prohibited_by_local_laws_or_regulation - recipient_refused type: string x-documentation-priority: default x-enum-descriptions: - Prohibited by local laws or regulation. - Recipient refused. required: - explanation - reason type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false consumer_quality_merchandise: additionalProperties: false description: Merchandise quality issue. Required if and only if `category` is `consumer_quality_merchandise`. properties: expected_at: description: Expected at. format: date type: string x-documentation-priority: default merchant_resolution_attempted: description: Merchant resolution attempted. enum: - attempted - prohibited_by_local_law type: string x-documentation-priority: default x-enum-descriptions: - Attempted. - Prohibited by local law. not_returned: additionalProperties: false description: Not returned. Required if and only if `return_outcome` is `not_returned`. properties: {} type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true ongoing_negotiations: additionalProperties: false description: Ongoing negotiations. Exclude if there is no evidence of ongoing negotiations. properties: explanation: description: Explanation of the previous ongoing negotiations between the cardholder and merchant. maxLength: 200 minLength: 1 type: string x-documentation-priority: default issuer_first_notified_at: description: Date the cardholder first notified the issuer of the dispute. format: date type: string x-documentation-priority: default started_at: description: Started at. format: date type: string x-documentation-priority: default required: - explanation - issuer_first_notified_at - started_at type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false purchase_info_and_quality_issue: description: Purchase information and quality issue. maxLength: 200 minLength: 1 type: string x-documentation-priority: default received_at: description: Received at. format: date type: string x-documentation-priority: default return_attempted: additionalProperties: false description: Return attempted. Required if and only if `return_outcome` is `return_attempted`. properties: attempt_explanation: description: Attempt explanation. maxLength: 200 minLength: 1 type: string x-documentation-priority: default attempt_reason: description: Attempt reason. enum: - merchant_not_responding - no_return_authorization_provided - no_return_instructions - requested_not_to_return - return_not_accepted type: string x-documentation-priority: default x-enum-descriptions: - Merchant not responding. - No return authorization provided. - No return instructions. - Requested not to return. - Return not accepted. attempted_at: description: Attempted at. format: date type: string x-documentation-priority: default merchandise_disposition: description: Merchandise disposition. maxLength: 200 minLength: 1 type: string x-documentation-priority: default required: - attempt_explanation - attempt_reason - attempted_at - merchandise_disposition type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false return_outcome: description: Return outcome. enum: - not_returned - returned - return_attempted type: string x-documentation-priority: default x-enum-descriptions: - Not returned. - Returned. - Return attempted. returned: additionalProperties: false description: Returned. Required if and only if `return_outcome` is `returned`. properties: merchant_received_return_at: description: Merchant received return at. format: date type: string x-documentation-priority: default other_explanation: description: Other explanation. Required if and only if the return method is `other`. maxLength: 200 minLength: 1 type: string x-documentation-priority: default return_method: description: Return method. enum: - dhl - face_to_face - fedex - other - postal_service - ups type: string x-documentation-priority: default x-enum-descriptions: - DHL. - Face-to-face. - FedEx. - Other. - Postal service. - UPS. returned_at: description: Returned at. format: date type: string x-documentation-priority: default tracking_number: description: Tracking number. maxLength: 200 minLength: 1 type: string x-documentation-priority: default required: - return_method - returned_at type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false required: - expected_at - merchant_resolution_attempted - purchase_info_and_quality_issue - received_at - return_outcome type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false consumer_quality_services: additionalProperties: false description: Services quality issue. Required if and only if `category` is `consumer_quality_services`. properties: cardholder_cancellation: additionalProperties: false description: Cardholder cancellation. properties: accepted_by_merchant: description: Accepted by merchant. enum: - accepted - not_accepted type: string x-documentation-priority: default x-enum-descriptions: - Accepted. - Not accepted. canceled_at: description: Canceled at. format: date type: string x-documentation-priority: default reason: description: Reason. maxLength: 200 minLength: 1 type: string x-documentation-priority: default required: - accepted_by_merchant - canceled_at - reason type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false cardholder_paid_to_have_work_redone: description: Cardholder paid to have work redone. enum: - did_not_pay_to_have_work_redone - paid_to_have_work_redone type: string x-documentation-priority: default x-enum-descriptions: - Cardholder did not pay to have work redone. - Cardholder paid to have work redone. non_fiat_currency_or_non_fungible_token_related_and_not_matching_description: description: Non-fiat currency or non-fungible token related and not matching description. enum: - not_related - related type: string x-documentation-priority: default x-enum-descriptions: - Not related. - Related. ongoing_negotiations: additionalProperties: false description: Ongoing negotiations. Exclude if there is no evidence of ongoing negotiations. properties: explanation: description: Explanation of the previous ongoing negotiations between the cardholder and merchant. maxLength: 200 minLength: 1 type: string x-documentation-priority: default issuer_first_notified_at: description: Date the cardholder first notified the issuer of the dispute. format: date type: string x-documentation-priority: default started_at: description: Started at. format: date type: string x-documentation-priority: default required: - explanation - issuer_first_notified_at - started_at type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false purchase_info_and_quality_issue: description: Purchase information and quality issue. maxLength: 200 minLength: 1 type: string x-documentation-priority: default restaurant_food_related: description: Whether the dispute is related to the quality of food from an eating place or restaurant. Must be provided when Merchant Category Code (MCC) is 5812, 5813 or 5814. enum: - not_related - related type: string x-documentation-priority: default x-enum-descriptions: - Not related. - Related. services_received_at: description: Services received at. format: date type: string x-documentation-priority: default required: - cardholder_cancellation - non_fiat_currency_or_non_fungible_token_related_and_not_matching_description - purchase_info_and_quality_issue - services_received_at type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false consumer_services_misrepresentation: additionalProperties: false description: Services misrepresentation. Required if and only if `category` is `consumer_services_misrepresentation`. properties: cardholder_cancellation: additionalProperties: false description: Cardholder cancellation. properties: accepted_by_merchant: description: Accepted by merchant. enum: - accepted - not_accepted type: string x-documentation-priority: default x-enum-descriptions: - Accepted. - Not accepted. canceled_at: description: Canceled at. format: date type: string x-documentation-priority: default reason: description: Reason. maxLength: 200 minLength: 1 type: string x-documentation-priority: default required: - accepted_by_merchant - canceled_at - reason type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false merchant_resolution_attempted: description: Merchant resolution attempted. enum: - attempted - prohibited_by_local_law type: string x-documentation-priority: default x-enum-descriptions: - Attempted. - Prohibited by local law. misrepresentation_explanation: description: Misrepresentation explanation. maxLength: 200 minLength: 1 type: string x-documentation-priority: default purchase_explanation: description: Purchase explanation. maxLength: 200 minLength: 1 type: string x-documentation-priority: default received_at: description: Received at. format: date type: string x-documentation-priority: default required: - cardholder_cancellation - merchant_resolution_attempted - misrepresentation_explanation - purchase_explanation - received_at type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false consumer_services_not_as_described: additionalProperties: false description: Services not as described. Required if and only if `category` is `consumer_services_not_as_described`. properties: cardholder_cancellation: additionalProperties: false description: Cardholder cancellation. properties: accepted_by_merchant: description: Accepted by merchant. enum: - accepted - not_accepted type: string x-documentation-priority: default x-enum-descriptions: - Accepted. - Not accepted. canceled_at: description: Canceled at. format: date type: string x-documentation-priority: default reason: description: Reason. maxLength: 200 minLength: 1 type: string x-documentation-priority: default required: - accepted_by_merchant - canceled_at - reason type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false explanation: description: Explanation of what was ordered and was not as described. maxLength: 200 minLength: 1 type: string x-documentation-priority: default merchant_resolution_attempted: description: Merchant resolution attempted. enum: - attempted - prohibited_by_local_law type: string x-documentation-priority: default x-enum-descriptions: - Attempted. - Prohibited by local law. received_at: description: Received at. format: date type: string x-documentation-priority: default required: - cardholder_cancellation - explanation - merchant_resolution_attempted - received_at type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false consumer_services_not_received: additionalProperties: false description: Services not received. Required if and only if `category` is `consumer_services_not_received`. properties: cancellation_outcome: description: Cancellation outcome. enum: - cardholder_cancellation_prior_to_expected_receipt - merchant_cancellation - no_cancellation type: string x-documentation-priority: default x-enum-descriptions: - Cardholder cancellation prior to expected receipt. - Merchant cancellation. - No cancellation. cardholder_cancellation_prior_to_expected_receipt: additionalProperties: false description: Cardholder cancellation prior to expected receipt. Required if and only if `cancellation_outcome` is `cardholder_cancellation_prior_to_expected_receipt`. properties: canceled_at: description: Canceled at. format: date type: string x-documentation-priority: default reason: description: Reason. maxLength: 200 minLength: 1 type: string x-documentation-priority: default required: - canceled_at type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false last_expected_receipt_at: description: Last expected receipt at. format: date type: string x-documentation-priority: default merchant_cancellation: additionalProperties: false description: Merchant cancellation. Required if and only if `cancellation_outcome` is `merchant_cancellation`. properties: canceled_at: description: Canceled at. format: date type: string x-documentation-priority: default required: - canceled_at type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false merchant_resolution_attempted: description: Merchant resolution attempted. enum: - attempted - prohibited_by_local_law type: string x-documentation-priority: default x-enum-descriptions: - Attempted. - Prohibited by local law. no_cancellation: additionalProperties: false description: No cancellation. Required if and only if `cancellation_outcome` is `no_cancellation`. properties: {} type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true purchase_info_and_explanation: description: Purchase information and explanation. maxLength: 200 minLength: 1 type: string x-documentation-priority: default required: - cancellation_outcome - last_expected_receipt_at - merchant_resolution_attempted - purchase_info_and_explanation type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false fraud: additionalProperties: false description: Fraud. Required if and only if `category` is `fraud`. properties: fraud_type: description: Fraud type. enum: - account_or_credentials_takeover - card_not_received_as_issued - fraudulent_application - fraudulent_use_of_account_number - incorrect_processing - issuer_reported_counterfeit - lost - manipulation_of_account_holder - merchant_misrepresentation - miscellaneous - stolen type: string x-documentation-priority: default x-enum-descriptions: - Account or credentials takeover. - Card not received as issued. - Fraudulent application. - Fraudulent use of account number. - Incorrect processing. - Issuer reported counterfeit. - Lost. - Manipulation of account holder. - Merchant misrepresentation. - Miscellaneous. - Stolen. required: - fraud_type type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false processing_error: additionalProperties: false description: Processing error. Required if and only if `category` is `processing_error`. properties: duplicate_transaction: additionalProperties: false description: Duplicate transaction. Required if and only if `error_reason` is `duplicate_transaction`. properties: other_transaction_id: description: Other transaction ID. maxLength: 200 minLength: 1 type: string x-documentation-priority: default required: - other_transaction_id type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false error_reason: description: Error reason. enum: - duplicate_transaction - incorrect_amount - paid_by_other_means type: string x-documentation-priority: default x-enum-descriptions: - Duplicate transaction. - Incorrect amount. - Paid by other means. incorrect_amount: additionalProperties: false description: Incorrect amount. Required if and only if `error_reason` is `incorrect_amount`. properties: expected_amount: description: Expected amount. minimum: 0 type: integer x-documentation-priority: default required: - expected_amount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false merchant_resolution_attempted: description: Merchant resolution attempted. enum: - attempted - prohibited_by_local_law type: string x-documentation-priority: default x-enum-descriptions: - Attempted. - Prohibited by local law. paid_by_other_means: additionalProperties: false description: Paid by other means. Required if and only if `error_reason` is `paid_by_other_means`. properties: other_form_of_payment_evidence: description: Other form of payment evidence. enum: - canceled_check - card_transaction - cash_receipt - other - statement - voucher type: string x-documentation-priority: default x-enum-descriptions: - Canceled check. - Card transaction. - Cash receipt. - Other. - Statement. - Voucher. other_transaction_id: description: Other transaction ID. maxLength: 200 minLength: 1 type: string x-documentation-priority: default required: - other_form_of_payment_evidence type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false required: - error_reason - merchant_resolution_attempted type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false required: - category type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false merchant_prearbitration_decline: additionalProperties: false description: The merchant pre-arbitration decline details for the user submission. Required if and only if `category` is `merchant_prearbitration_decline`. properties: reason: description: The reason for declining the merchant's pre-arbitration request. maxLength: 200 minLength: 1 type: string x-documentation-priority: default required: - reason type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false user_prearbitration: additionalProperties: false description: The user pre-arbitration details for the user submission. Required if and only if `category` is `user_prearbitration`. properties: category_change: additionalProperties: false description: Category change details for the pre-arbitration request. Should only be populated if the category of the dispute is being changed as part of the pre-arbitration request. properties: category: enum: - authorization - consumer_canceled_merchandise - consumer_canceled_recurring_transaction - consumer_canceled_services - consumer_counterfeit_merchandise - consumer_credit_not_processed - consumer_damaged_or_defective_merchandise - consumer_merchandise_misrepresentation - consumer_merchandise_not_as_described - consumer_merchandise_not_received - consumer_non_receipt_of_cash - consumer_original_credit_transaction_not_accepted - consumer_quality_merchandise - consumer_quality_services - consumer_services_misrepresentation - consumer_services_not_as_described - consumer_services_not_received - fraud - processing_error type: string x-documentation-priority: default x-enum-descriptions: - Authorization. - 'Consumer: canceled merchandise.' - 'Consumer: canceled recurring transaction.' - 'Consumer: canceled services.' - 'Consumer: counterfeit merchandise.' - 'Consumer: credit not processed.' - 'Consumer: damaged or defective merchandise.' - 'Consumer: merchandise misrepresentation.' - 'Consumer: merchandise not as described.' - 'Consumer: merchandise not received.' - 'Consumer: non-receipt of cash.' - 'Consumer: Original Credit Transaction (OCT) not accepted.' - 'Consumer: merchandise quality issue.' - 'Consumer: services quality issue.' - 'Consumer: services misrepresentation.' - 'Consumer: services not as described.' - 'Consumer: services not received.' - Fraud. - Processing error. reason: description: The reason for the category change. maxLength: 200 minLength: 1 type: string x-documentation-priority: default required: - category - reason type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false reason: description: The reason for the pre-arbitration request. maxLength: 200 minLength: 1 type: string x-documentation-priority: default required: - reason type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false required: - category type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false required: - network type: object x-event-categories: [] x-stainless-empty-object: false card_dispute: additionalProperties: false description: If unauthorized activity occurs on a card, you can create a Card Dispute and we'll work with the card networks to return the funds if appropriate. example: amount: 1000 card_id: card_oubs0hwk5rn6knuecxg2 created_at: '2020-01-31T23:59:59Z' disputed_transaction_id: transaction_uyrp7fld2ium70oa7oi id: card_dispute_h9sc95nbl1cgltpp7men idempotency_key: null loss: null network: visa status: pending_response type: card_dispute user_submission_required_by: null visa: network_events: [] required_user_submission_category: null user_submissions: - accepted_at: null amount: 1000 attachment_files: [] category: chargeback chargeback: authorization: null category: fraud consumer_canceled_merchandise: null consumer_canceled_recurring_transaction: null consumer_canceled_services: null consumer_counterfeit_merchandise: null consumer_credit_not_processed: null consumer_damaged_or_defective_merchandise: null consumer_merchandise_misrepresentation: null consumer_merchandise_not_as_described: null consumer_merchandise_not_received: null consumer_non_receipt_of_cash: null consumer_original_credit_transaction_not_accepted: null consumer_quality_merchandise: null consumer_quality_services: null consumer_services_misrepresentation: null consumer_services_not_as_described: null consumer_services_not_received: null fraud: fraud_type: lost processing_error: null created_at: '2020-01-31T23:59:59Z' explanation: null further_information_requested_at: null further_information_requested_reason: null status: pending_reviewing updated_at: '2020-01-31T23:59:59Z' win: null withdrawal: null properties: amount: description: The amount of the dispute. type: integer x-documentation-priority: default card_id: description: The Card that the Card Dispute is associated with. type: string x-documentation-priority: default x-id-reference-to: Cards created_at: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Card Dispute was created. format: date-time type: string x-documentation-priority: default disputed_transaction_id: description: The identifier of the Transaction that was disputed. type: string x-documentation-priority: default x-id-reference-to: Transactions id: description: The Card Dispute identifier. type: string x-documentation-priority: default x-id-reference-to: Card Disputes idempotency_key: anyOf: - description: The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys). type: string x-documentation-priority: default - type: 'null' loss: anyOf: - additionalProperties: false description: If the Card Dispute's status is `lost`, this will contain details of the lost dispute. example: lost_at: '2020-01-31T23:59:59Z' reason: user_withdrawn properties: lost_at: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Card Dispute was lost. format: date-time type: string x-documentation-priority: default reason: description: The reason the Card Dispute was lost. enum: - user_withdrawn - loss type: string x-documentation-priority: default x-enum-descriptions: - The user withdrew the Card Dispute. - The Card Dispute was lost according to network rules. required: - lost_at - reason title: Card Dispute Card Dispute Loss type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Card Dispute Losses - type: 'null' network: description: The network that the Card Dispute is associated with. enum: - visa - pulse type: string x-documentation-priority: default x-enum-descriptions: - 'Visa: details will be under the `visa` object.' - 'Pulse: details will be under the `pulse` object.' status: description: The status of the Card Dispute. enum: - user_submission_required - pending_user_submission_reviewing - pending_user_submission_submitting - pending_user_withdrawal_submitting - pending_response - lost - won type: string x-documentation-priority: default x-enum-descriptions: - A User Submission is required to continue with the Card Dispute. - The most recent User Submission is being reviewed. - The most recent User Submission is being submitted to the network. - The user's withdrawal of the Card Dispute is being submitted to the network. - The Card Dispute is pending a response from the network. - The Card Dispute has been lost and funds previously credited from the acceptance have been debited. - The Card Dispute has been won and no further action can be taken. type: description: A constant representing the object's type. For this resource it will always be `card_dispute`. enum: - card_dispute type: string x-documentation-priority: default user_submission_required_by: anyOf: - description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the user submission is required by. Present only if status is `user_submission_required` and a user submission is required by a certain time. Otherwise, this will be `nil`. format: date-time type: string x-documentation-priority: default - type: 'null' visa: anyOf: - $ref: '#/components/schemas/card_dispute_visa' description: Card Dispute information for card payments processed over Visa's network. This field will be present in the JSON response if and only if `network` is equal to `visa`. x-documentation-priority: default - type: 'null' win: anyOf: - additionalProperties: false description: If the Card Dispute's status is `won`, this will contain details of the won dispute. example: won_at: '2020-01-31T23:59:59Z' properties: won_at: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Card Dispute was won. format: date-time type: string x-documentation-priority: default required: - won_at title: Card Dispute Card Dispute Win type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Card Dispute Wins - type: 'null' withdrawal: anyOf: - additionalProperties: false description: If the Card Dispute has been withdrawn, this will contain details of the withdrawal. example: explanation: The cardholder requested a withdrawal of the dispute. properties: explanation: anyOf: - description: The explanation for the withdrawal of the Card Dispute. type: string x-documentation-priority: default - type: 'null' required: - explanation title: Card Dispute Card Dispute Withdrawal type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Card Dispute Withdrawals - type: 'null' required: - type - id - amount - user_submission_required_by - status - created_at - disputed_transaction_id - network - loss - win - withdrawal - card_id - visa - idempotency_key title: Card Dispute type: object x-event-categories: - card_dispute.created - card_dispute.updated x-stainless-empty-object: false x-tag: Card Disputes x-title-plural: Card Disputes card_dispute_visa_network_event: additionalProperties: false properties: attachment_files: description: The files attached to the Visa Card Dispute User Submission. items: $ref: '#/components/schemas/card_dispute_file_attachment' type: array x-documentation-priority: default category: description: The category of the user submission. We may add additional possible values for this enum over time; your application should be able to handle such additions gracefully. enum: - chargeback_accepted - chargeback_submitted - chargeback_timed_out - merchant_prearbitration_decline_submitted - merchant_prearbitration_received - merchant_prearbitration_timed_out - represented - representment_timed_out - user_prearbitration_accepted - user_prearbitration_declined - user_prearbitration_submitted - user_prearbitration_timed_out - user_withdrawal_submitted type: string x-documentation-priority: default x-enum-descriptions: - 'Card Dispute Chargeback Accepted Visa Network Event: details will be under the `chargeback_accepted` object.' - 'Card Dispute Chargeback Submitted Visa Network Event: details will be under the `chargeback_submitted` object.' - 'Card Dispute Chargeback Timed Out Visa Network Event: details will be under the `chargeback_timed_out` object.' - 'Card Dispute Merchant Pre-Arbitration Decline Submitted Visa Network Event: details will be under the `merchant_prearbitration_decline_submitted` object.' - 'Card Dispute Merchant Pre-Arbitration Received Visa Network Event: details will be under the `merchant_prearbitration_received` object.' - 'Card Dispute Merchant Pre-Arbitration Timed Out Visa Network Event: details will be under the `merchant_prearbitration_timed_out` object.' - 'Card Dispute Re-presented Visa Network Event: details will be under the `represented` object.' - 'Card Dispute Re-presentment Timed Out Visa Network Event: details will be under the `representment_timed_out` object.' - 'Card Dispute User Pre-Arbitration Accepted Visa Network Event: details will be under the `user_prearbitration_accepted` object.' - 'Card Dispute User Pre-Arbitration Declined Visa Network Event: details will be under the `user_prearbitration_declined` object.' - 'Card Dispute User Pre-Arbitration Submitted Visa Network Event: details will be under the `user_prearbitration_submitted` object.' - 'Card Dispute User Pre-Arbitration Timed Out Visa Network Event: details will be under the `user_prearbitration_timed_out` object.' - 'Card Dispute User Withdrawal Submitted Visa Network Event: details will be under the `user_withdrawal_submitted` object.' chargeback_accepted: anyOf: - additionalProperties: false description: A Card Dispute Chargeback Accepted Visa Network Event object. This field will be present in the JSON response if and only if `category` is equal to `chargeback_accepted`. Contains the details specific to a chargeback accepted Visa Card Dispute Network Event, which represents that a chargeback has been accepted by the merchant. example: {} properties: {} title: Visa Card Dispute Network Event Card Dispute Chargeback Accepted Visa Network Event type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true x-title-plural: Card Dispute Chargeback Accepted Visa Network Events - type: 'null' chargeback_submitted: anyOf: - additionalProperties: false description: A Card Dispute Chargeback Submitted Visa Network Event object. This field will be present in the JSON response if and only if `category` is equal to `chargeback_submitted`. Contains the details specific to a chargeback submitted Visa Card Dispute Network Event, which represents that a chargeback has been submitted to the network. example: {} properties: {} title: Visa Card Dispute Network Event Card Dispute Chargeback Submitted Visa Network Event type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true x-title-plural: Card Dispute Chargeback Submitted Visa Network Events - type: 'null' chargeback_timed_out: anyOf: - additionalProperties: false description: A Card Dispute Chargeback Timed Out Visa Network Event object. This field will be present in the JSON response if and only if `category` is equal to `chargeback_timed_out`. Contains the details specific to a chargeback timed out Visa Card Dispute Network Event, which represents that the chargeback has timed out in the user's favor. example: {} properties: {} title: Visa Card Dispute Network Event Card Dispute Chargeback Timed Out Visa Network Event type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true x-title-plural: Card Dispute Chargeback Timed Out Visa Network Events - type: 'null' created_at: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Visa Card Dispute Network Event was created. format: date-time type: string x-documentation-priority: default dispute_financial_transaction_id: anyOf: - description: The dispute financial transaction that resulted from the network event, if any. type: string x-documentation-priority: default x-id-reference-to: Transactions - type: 'null' merchant_prearbitration_decline_submitted: anyOf: - additionalProperties: false description: A Card Dispute Merchant Pre-Arbitration Decline Submitted Visa Network Event object. This field will be present in the JSON response if and only if `category` is equal to `merchant_prearbitration_decline_submitted`. Contains the details specific to a merchant prearbitration decline submitted Visa Card Dispute Network Event, which represents that the user has declined the merchant's request for a prearbitration request decision in their favor. example: {} properties: {} title: Visa Card Dispute Network Event Card Dispute Merchant Pre-Arbitration Decline Submitted Visa Network Event type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true x-title-plural: Card Dispute Merchant Pre-Arbitration Decline Submitted Visa Network Events - type: 'null' merchant_prearbitration_received: anyOf: - additionalProperties: false description: A Card Dispute Merchant Pre-Arbitration Received Visa Network Event object. This field will be present in the JSON response if and only if `category` is equal to `merchant_prearbitration_received`. Contains the details specific to a merchant prearbitration received Visa Card Dispute Network Event, which represents that the merchant has issued a prearbitration request in the user's favor. example: cardholder_no_longer_disputes: explanation: See the attached email where the cardholder confirmed that they no longer dispute the transaction. compelling_evidence: null credit_or_reversal_processed: null delayed_charge_transaction: null evidence_of_imprint: null invalid_dispute: null non_fiat_currency_or_non_fungible_token_received: null prior_undisputed_non_fraud_transactions: null reason: cardholder_no_longer_disputes properties: cardholder_no_longer_disputes: anyOf: - additionalProperties: false description: Cardholder no longer disputes details. Present if and only if `reason` is `cardholder_no_longer_disputes`. example: explanation: See the attached email where the cardholder confirmed that they no longer dispute the transaction. properties: explanation: anyOf: - description: Explanation for why the merchant believes the cardholder no longer disputes the transaction. type: string x-documentation-priority: default - type: 'null' required: - explanation title: Visa Card Dispute Network Event Card Dispute Merchant Pre-Arbitration Received Visa Network Event Cardholder No Longer Disputes type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Cardholder No Longer Disputes - type: 'null' compelling_evidence: anyOf: - additionalProperties: false description: Compelling evidence details. Present if and only if `reason` is `compelling_evidence`. example: category: merchandise_use explanation: null properties: category: description: The category of compelling evidence provided by the merchant. enum: - authorized_signer - delivery - delivery_at_place_of_employment - digital_goods_download - dynamic_currency_conversion_actively_chosen - flight_manifest_and_purchase_itinerary - household_member_signer - legitimate_spend_across_payment_types_for_same_merchandise - merchandise_use - passenger_transport_ticket_use - recurring_transaction_with_binding_contract_or_previous_undisputed_transaction - signed_delivery_or_pickup_form - signed_mail_order_phone_order_form - travel_and_expense_loyalty_transaction - travel_and_expense_subsequent_purchase type: string x-documentation-priority: default x-enum-descriptions: - Authorized signer known by the cardholder. - Proof of delivery. - Proof of delivery to cardholder at place of employment. - Proof of digital goods download. - Dynamic Currency Conversion actively chosen by cardholder. - Flight manifest with corresponding purchase itinerary record. - Signer is member of cardholder's household. - Legitimate spend across multiple payment types for same merchandise. - Documentation to prove the cardholder is in possession of and/or using the merchandise. - 'Passenger transport: proof ticket was received, scanned at gate or other transaction related to original (for example, frequent flyer miles.)' - Recurring transaction with binding contract or previous undisputed recurring transactions and proof the cardholder is using the merchandise or service. - Signed delivery form, or copy of/details of identification from cardholder as proof goods were picked up at merchant location. - Signed Mail Order/Phone Order form. - 'Travel & Expense: loyalty transactions related to purchase.' - 'Travel & Expense: subsequent purchases made throughout service period.' explanation: anyOf: - description: Explanation of the compelling evidence provided by the merchant. type: string x-documentation-priority: default - type: 'null' required: - category - explanation title: Visa Card Dispute Network Event Card Dispute Merchant Pre-Arbitration Received Visa Network Event Compelling Evidence type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Compelling Evidences - type: 'null' credit_or_reversal_processed: anyOf: - additionalProperties: false description: Credit or reversal processed details. Present if and only if `reason` is `credit_or_reversal_processed`. example: amount: 4900 currency: USD explanation: The user did not provide the required documentation. processed_at: '2020-01-31' properties: amount: description: The amount of the credit or reversal in the minor unit of its currency. For dollars, for example, this is cents. type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the credit or reversal's currency. type: string x-documentation-priority: default explanation: anyOf: - description: Explanation for why the merchant believes the credit or reversal was processed. type: string x-documentation-priority: default - type: 'null' processed_at: description: The date the credit or reversal was processed. format: date type: string x-documentation-priority: default required: - explanation - processed_at - amount - currency title: Visa Card Dispute Network Event Card Dispute Merchant Pre-Arbitration Received Visa Network Event Credit Or Reversal Processed type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Credit Or Reversal Processeds - type: 'null' delayed_charge_transaction: anyOf: - additionalProperties: false description: Delayed charge transaction details. Present if and only if `reason` is `delayed_charge_transaction`. example: explanation: null properties: explanation: anyOf: - description: Additional details about the delayed charge transaction. type: string x-documentation-priority: default - type: 'null' required: - explanation title: Visa Card Dispute Network Event Card Dispute Merchant Pre-Arbitration Received Visa Network Event Delayed Charge Transaction type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Delayed Charge Transactions - type: 'null' evidence_of_imprint: anyOf: - additionalProperties: false description: Evidence of imprint details. Present if and only if `reason` is `evidence_of_imprint`. example: explanation: null properties: explanation: anyOf: - description: Explanation of the evidence of imprint. type: string x-documentation-priority: default - type: 'null' required: - explanation title: Visa Card Dispute Network Event Card Dispute Merchant Pre-Arbitration Received Visa Network Event Evidence Of Imprint type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Evidence Of Imprints - type: 'null' invalid_dispute: anyOf: - additionalProperties: false description: Invalid dispute details. Present if and only if `reason` is `invalid_dispute`. example: explanation: The user did not provide the required documentation. reason: other properties: explanation: anyOf: - description: Explanation for why the dispute is considered invalid by the merchant. type: string x-documentation-priority: default - type: 'null' reason: description: The reason a merchant considers the dispute invalid. enum: - other - special_authorization_procedures_followed type: string x-documentation-priority: default x-enum-descriptions: - Other. - Special authorization procedures followed. required: - reason - explanation title: Visa Card Dispute Network Event Card Dispute Merchant Pre-Arbitration Received Visa Network Event Invalid Dispute type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Invalid Disputes - type: 'null' non_fiat_currency_or_non_fungible_token_received: anyOf: - additionalProperties: false description: Non-fiat currency or non-fungible token received details. Present if and only if `reason` is `non_fiat_currency_or_non_fungible_token_received`. example: blockchain_transaction_hash: '0x1234567890123456789012345678901234567890' destination_wallet_address: '0x1234567890123456789012345678901234567890' prior_approved_transactions: '0x1234567890123456789012345678901234567890' properties: blockchain_transaction_hash: description: Blockchain transaction hash. type: string x-documentation-priority: default destination_wallet_address: description: Destination wallet address. type: string x-documentation-priority: default prior_approved_transactions: anyOf: - description: Prior approved transactions. type: string x-documentation-priority: default - type: 'null' required: - destination_wallet_address - blockchain_transaction_hash - prior_approved_transactions title: Visa Card Dispute Network Event Card Dispute Merchant Pre-Arbitration Received Visa Network Event Non Fiat Currency Or Non Fungible Token Received type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Non Fiat Currency Or Non Fungible Token Receiveds - type: 'null' prior_undisputed_non_fraud_transactions: anyOf: - additionalProperties: false description: Prior undisputed non-fraud transactions details. Present if and only if `reason` is `prior_undisputed_non_fraud_transactions`. example: explanation: null properties: explanation: anyOf: - description: Explanation of the prior undisputed non-fraud transactions provided by the merchant. type: string x-documentation-priority: default - type: 'null' required: - explanation title: Visa Card Dispute Network Event Card Dispute Merchant Pre-Arbitration Received Visa Network Event Prior Undisputed Non Fraud Transactions type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Prior Undisputed Non Fraud Transactions - type: 'null' reason: description: The reason the merchant re-presented the dispute. enum: - cardholder_no_longer_disputes - compelling_evidence - credit_or_reversal_processed - delayed_charge_transaction - evidence_of_imprint - invalid_dispute - non_fiat_currency_or_non_fungible_token_received - prior_undisputed_non_fraud_transactions type: string x-documentation-priority: default x-enum-descriptions: - Cardholder no longer disputes the transaction. - Compelling evidence. - Credit or reversal was processed. - Delayed charge transaction. - Evidence of imprint. - Invalid dispute. - Non-fiat currency or non-fungible token was received by the cardholder. - Prior undisputed non-fraud transactions. required: - reason - cardholder_no_longer_disputes - compelling_evidence - credit_or_reversal_processed - delayed_charge_transaction - evidence_of_imprint - invalid_dispute - non_fiat_currency_or_non_fungible_token_received - prior_undisputed_non_fraud_transactions title: Visa Card Dispute Network Event Card Dispute Merchant Pre-Arbitration Received Visa Network Event type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Card Dispute Merchant Pre-Arbitration Received Visa Network Events - type: 'null' merchant_prearbitration_timed_out: anyOf: - additionalProperties: false description: A Card Dispute Merchant Pre-Arbitration Timed Out Visa Network Event object. This field will be present in the JSON response if and only if `category` is equal to `merchant_prearbitration_timed_out`. Contains the details specific to a merchant prearbitration timed out Visa Card Dispute Network Event, which represents that the user has timed out responding to the merchant's prearbitration request. example: {} properties: {} title: Visa Card Dispute Network Event Card Dispute Merchant Pre-Arbitration Timed Out Visa Network Event type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true x-title-plural: Card Dispute Merchant Pre-Arbitration Timed Out Visa Network Events - type: 'null' represented: anyOf: - additionalProperties: false description: A Card Dispute Re-presented Visa Network Event object. This field will be present in the JSON response if and only if `category` is equal to `represented`. Contains the details specific to a re-presented Visa Card Dispute Network Event, which represents that the merchant has declined the user's chargeback and has re-presented the payment. example: cardholder_no_longer_disputes: null credit_or_reversal_processed: null invalid_dispute: explanation: The user did not provide the required documentation. reason: other non_fiat_currency_or_non_fungible_token_as_described: null non_fiat_currency_or_non_fungible_token_received: null proof_of_cash_disbursement: null reason: invalid_dispute reversal_issued: null properties: cardholder_no_longer_disputes: anyOf: - additionalProperties: false description: Cardholder no longer disputes details. Present if and only if `reason` is `cardholder_no_longer_disputes`. example: explanation: See the attached email where the cardholder confirmed that they no longer dispute the transaction. properties: explanation: anyOf: - description: Explanation for why the merchant believes the cardholder no longer disputes the transaction. type: string x-documentation-priority: default - type: 'null' required: - explanation title: Visa Card Dispute Network Event Card Dispute Re-presented Visa Network Event Cardholder No Longer Disputes type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Cardholder No Longer Disputes - type: 'null' credit_or_reversal_processed: anyOf: - additionalProperties: false description: Credit or reversal processed details. Present if and only if `reason` is `credit_or_reversal_processed`. example: amount: 4900 currency: USD explanation: The user did not provide the required documentation. processed_at: '2020-01-31' properties: amount: description: The amount of the credit or reversal in the minor unit of its currency. For dollars, for example, this is cents. type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the credit or reversal's currency. type: string x-documentation-priority: default explanation: anyOf: - description: Explanation for why the merchant believes the credit or reversal was processed. type: string x-documentation-priority: default - type: 'null' processed_at: description: The date the credit or reversal was processed. format: date type: string x-documentation-priority: default required: - explanation - processed_at - amount - currency title: Visa Card Dispute Network Event Card Dispute Re-presented Visa Network Event Credit Or Reversal Processed type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Credit Or Reversal Processeds - type: 'null' invalid_dispute: anyOf: - additionalProperties: false description: Invalid dispute details. Present if and only if `reason` is `invalid_dispute`. example: explanation: The user did not provide the required documentation. reason: other properties: explanation: anyOf: - description: Explanation for why the dispute is considered invalid by the merchant. type: string x-documentation-priority: default - type: 'null' reason: description: The reason a merchant considers the dispute invalid. enum: - automatic_teller_machine_transaction_proof_provided - balance_of_partial_prepayment_not_paid - cardholder_canceled_before_expected_merchandise_receipt_date - cardholder_canceled_before_expected_services_receipt_date - cardholder_canceled_different_date - cardholder_did_not_cancel_according_to_policy - cardholder_received_merchandise - country_code_correct - credit_processed_correctly - currency_correct - dispute_is_for_quality - dispute_is_for_visa_cash_back_transaction_portion - disputed_amount_is_value_added_tax - disputed_amount_is_value_added_tax_no_credit_receipt_provided - limited_return_or_cancellation_policy_properly_disclosed - merchandise_held_at_cardholder_customs_agency - merchandise_matches_description - merchandise_not_counterfeit - merchandise_not_damaged - merchandise_not_defective - merchandise_provided_prior_to_cancellation_date - merchandise_quality_matches_description - merchandise_return_not_attempted - merchant_not_notified_of_closed_account - name_on_flight_manifest_matches_purchase - no_credit_receipt_provided - other - processing_error_incorrect - returned_mechandise_held_at_customs_agency_outside_merchant_country - services_match_description - services_provided_prior_to_cancellation_date - services_used_after_cancellation_date - terms_of_service_not_misrepresented - transaction_code_correct type: string x-documentation-priority: default x-enum-descriptions: - Automatic Teller Machine (ATM) transaction proof provided. - Balance of partial prepayment not paid. - Cardholder canceled before expected receipt date of the merchandise. - Cardholder canceled before expected receipt date of the services. - Cardholder canceled on a different date than claimed. - Cardholder received did not cancel according to policy. - Cardholder received the merchandise. - Country code is correct. - Credit was processed correctly. - Currency is correct. - Dispute is for quality. - Dispute is for Visa Cash Back transaction portion. - Disputed amount is Value Added Tax (VAT). - Disputed amount is Value Added Tax (VAT) but no credit receipt was provided by the cardholder. - Limited return or cancellation policy was properly disclosed. - Merchandise held at cardholder customs agency. - Merchandise matches the merchant's description. - Merchandise is not counterfeit. - Merchandise is not damaged. - Merchandise is not defective. - Merchandise was provided prior to the cancellation date. - Merchandise quality matches the merchant's description. - Merchandise was not attempted returned to the merchant. - Merchant was not notified of the closed account. - Name on manifest of departed flight matches name on purchased itinerary. - No credit receipt was provided by the cardholder. - Other. - The claimed processing error did not occur. - Returned merchandise held at customs agency outside the merchant's country. - Services match the merchant's description. - Services were provided prior to the cancellation date. - Services were used after the cancellation date and prior to the dispute submission date. - Terms of service were not misrepresented. - Transaction code is correct. required: - reason - explanation title: Visa Card Dispute Network Event Card Dispute Re-presented Visa Network Event Invalid Dispute type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Invalid Disputes - type: 'null' non_fiat_currency_or_non_fungible_token_as_described: anyOf: - additionalProperties: false description: Non-fiat currency or non-fungible token as described details. Present if and only if `reason` is `non_fiat_currency_or_non_fungible_token_as_described`. example: {} properties: {} title: Visa Card Dispute Network Event Card Dispute Re-presented Visa Network Event Non Fiat Currency Or Non Fungible Token As Described type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true x-title-plural: Non Fiat Currency Or Non Fungible Token As Describeds - type: 'null' non_fiat_currency_or_non_fungible_token_received: anyOf: - additionalProperties: false description: Non-fiat currency or non-fungible token received details. Present if and only if `reason` is `non_fiat_currency_or_non_fungible_token_received`. example: blockchain_transaction_hash: '0x1234567890123456789012345678901234567890' destination_wallet_address: '0x1234567890123456789012345678901234567890' prior_approved_transactions: '0x1234567890123456789012345678901234567890' properties: blockchain_transaction_hash: description: Blockchain transaction hash. type: string x-documentation-priority: default destination_wallet_address: description: Destination wallet address. type: string x-documentation-priority: default prior_approved_transactions: anyOf: - description: Prior approved transactions. type: string x-documentation-priority: default - type: 'null' required: - destination_wallet_address - blockchain_transaction_hash - prior_approved_transactions title: Visa Card Dispute Network Event Card Dispute Re-presented Visa Network Event Non Fiat Currency Or Non Fungible Token Received type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Non Fiat Currency Or Non Fungible Token Receiveds - type: 'null' proof_of_cash_disbursement: anyOf: - additionalProperties: false description: Proof of cash disbursement details. Present if and only if `reason` is `proof_of_cash_disbursement`. example: explanation: null properties: explanation: anyOf: - description: Explanation for why the merchant believes the evidence provides proof of cash disbursement. type: string x-documentation-priority: default - type: 'null' required: - explanation title: Visa Card Dispute Network Event Card Dispute Re-presented Visa Network Event Proof Of Cash Disbursement type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Proof Of Cash Disbursements - type: 'null' reason: description: The reason the merchant re-presented the dispute. enum: - cardholder_no_longer_disputes - credit_or_reversal_processed - invalid_dispute - non_fiat_currency_or_non_fungible_token_as_described - non_fiat_currency_or_non_fungible_token_received - proof_of_cash_disbursement - reversal_issued type: string x-documentation-priority: default x-enum-descriptions: - Cardholder no longer disputes the transaction. - Credit or reversal was processed. - Invalid dispute. - Non-fiat currency or non-fungible token is as described by the merchant. - Non-fiat currency or non-fungible token was received by the cardholder. - Proof of cash disbursement provided. - Reversal issued by merchant. reversal_issued: anyOf: - additionalProperties: false description: Reversal issued by merchant details. Present if and only if `reason` is `reversal_issued`. example: explanation: The merchant has issued a reversal for the transaction prior to the dispute being filed. properties: explanation: anyOf: - description: Explanation of the reversal issued by the merchant. type: string x-documentation-priority: default - type: 'null' required: - explanation title: Visa Card Dispute Network Event Card Dispute Re-presented Visa Network Event Reversal Issued By Merchant type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Reversal Issued By Merchants - type: 'null' required: - reason - cardholder_no_longer_disputes - credit_or_reversal_processed - invalid_dispute - non_fiat_currency_or_non_fungible_token_as_described - non_fiat_currency_or_non_fungible_token_received - proof_of_cash_disbursement - reversal_issued title: Visa Card Dispute Network Event Card Dispute Re-presented Visa Network Event type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Card Dispute Re-presented Visa Network Events - type: 'null' representment_timed_out: anyOf: - additionalProperties: false description: A Card Dispute Re-presentment Timed Out Visa Network Event object. This field will be present in the JSON response if and only if `category` is equal to `representment_timed_out`. Contains the details specific to a re-presentment time-out Visa Card Dispute Network Event, which represents that the user did not respond to the re-presentment by the merchant within the time limit. example: {} properties: {} title: Visa Card Dispute Network Event Card Dispute Re-presentment Timed Out Visa Network Event type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true x-title-plural: Card Dispute Re-presentment Timed Out Visa Network Events - type: 'null' user_prearbitration_accepted: anyOf: - additionalProperties: false description: A Card Dispute User Pre-Arbitration Accepted Visa Network Event object. This field will be present in the JSON response if and only if `category` is equal to `user_prearbitration_accepted`. Contains the details specific to a user prearbitration accepted Visa Card Dispute Network Event, which represents that the merchant has accepted the user's prearbitration request in the user's favor. example: {} properties: {} title: Visa Card Dispute Network Event Card Dispute User Pre-Arbitration Accepted Visa Network Event type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true x-title-plural: Card Dispute User Pre-Arbitration Accepted Visa Network Events - type: 'null' user_prearbitration_declined: anyOf: - additionalProperties: false description: A Card Dispute User Pre-Arbitration Declined Visa Network Event object. This field will be present in the JSON response if and only if `category` is equal to `user_prearbitration_declined`. Contains the details specific to a user prearbitration declined Visa Card Dispute Network Event, which represents that the merchant has declined the user's prearbitration request. example: {} properties: {} title: Visa Card Dispute Network Event Card Dispute User Pre-Arbitration Declined Visa Network Event type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true x-title-plural: Card Dispute User Pre-Arbitration Declined Visa Network Events - type: 'null' user_prearbitration_submitted: anyOf: - additionalProperties: false description: A Card Dispute User Pre-Arbitration Submitted Visa Network Event object. This field will be present in the JSON response if and only if `category` is equal to `user_prearbitration_submitted`. Contains the details specific to a user prearbitration submitted Visa Card Dispute Network Event, which represents that the user's request for prearbitration has been submitted to the network. example: {} properties: {} title: Visa Card Dispute Network Event Card Dispute User Pre-Arbitration Submitted Visa Network Event type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true x-title-plural: Card Dispute User Pre-Arbitration Submitted Visa Network Events - type: 'null' user_prearbitration_timed_out: anyOf: - additionalProperties: false description: A Card Dispute User Pre-Arbitration Timed Out Visa Network Event object. This field will be present in the JSON response if and only if `category` is equal to `user_prearbitration_timed_out`. Contains the details specific to a user prearbitration timed out Visa Card Dispute Network Event, which represents that the merchant has timed out responding to the user's prearbitration request. example: {} properties: {} title: Visa Card Dispute Network Event Card Dispute User Pre-Arbitration Timed Out Visa Network Event type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true x-title-plural: Card Dispute User Pre-Arbitration Timed Out Visa Network Events - type: 'null' user_withdrawal_submitted: anyOf: - additionalProperties: false description: A Card Dispute User Withdrawal Submitted Visa Network Event object. This field will be present in the JSON response if and only if `category` is equal to `user_withdrawal_submitted`. Contains the details specific to a user withdrawal submitted Visa Card Dispute Network Event, which represents that the user's request to withdraw the dispute has been submitted to the network. example: {} properties: {} title: Visa Card Dispute Network Event Card Dispute User Withdrawal Submitted Visa Network Event type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true x-title-plural: Card Dispute User Withdrawal Submitted Visa Network Events - type: 'null' required: - created_at - attachment_files - dispute_financial_transaction_id - category title: Visa Card Dispute Network Event type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: Visa Card Dispute Network Events card_dispute_file_attachment: additionalProperties: false properties: file_id: description: The ID of the file attached to the Card Dispute. type: string x-documentation-priority: default x-id-reference-to: Files required: - file_id title: Card Dispute File Attachment type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: Card Dispute File Attachments card_dispute_list: additionalProperties: true description: A list of Card Dispute objects. example: data: - amount: 1000 card_id: card_oubs0hwk5rn6knuecxg2 created_at: '2020-01-31T23:59:59Z' disputed_transaction_id: transaction_uyrp7fld2ium70oa7oi id: card_dispute_h9sc95nbl1cgltpp7men idempotency_key: null loss: null network: visa status: pending_response type: card_dispute user_submission_required_by: null visa: network_events: [] required_user_submission_category: null user_submissions: - accepted_at: null amount: 1000 attachment_files: [] category: chargeback chargeback: authorization: null category: fraud consumer_canceled_merchandise: null consumer_canceled_recurring_transaction: null consumer_canceled_services: null consumer_counterfeit_merchandise: null consumer_credit_not_processed: null consumer_damaged_or_defective_merchandise: null consumer_merchandise_misrepresentation: null consumer_merchandise_not_as_described: null consumer_merchandise_not_received: null consumer_non_receipt_of_cash: null consumer_original_credit_transaction_not_accepted: null consumer_quality_merchandise: null consumer_quality_services: null consumer_services_misrepresentation: null consumer_services_not_as_described: null consumer_services_not_received: null fraud: fraud_type: lost processing_error: null created_at: '2020-01-31T23:59:59Z' explanation: null further_information_requested_at: null further_information_requested_reason: null status: pending_reviewing updated_at: '2020-01-31T23:59:59Z' win: null withdrawal: null next_cursor: v57w5d properties: data: description: The contents of the list. items: $ref: '#/components/schemas/card_dispute' type: array x-documentation-priority: default next_cursor: anyOf: - description: A pointer to a place in the list. Pass this as the `cursor` parameter to retrieve the next page of results. If there are no more results, the value will be `null`. type: string x-documentation-priority: default - type: 'null' required: - data - next_cursor title: Card Dispute List type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: Card Dispute Lists create_a_card_dispute_parameters: additionalProperties: true example: amount: 100 disputed_transaction_id: transaction_uyrp7fld2ium70oa7oi network: visa visa: category: fraud fraud: fraud_type: account_or_credentials_takeover properties: amount: description: The monetary amount of the part of the transaction that is being disputed. This is optional and will default to the full amount of the transaction if not provided. If provided, the amount must be less than or equal to the amount of the transaction. minimum: 1 type: integer x-documentation-priority: default attachment_files: description: The files to be attached to the initial dispute submission. items: additionalProperties: false properties: file_id: description: The ID of the file to be attached. The file must have a `purpose` of `card_dispute_attachment`. type: string x-documentation-priority: default x-id-reference-to: Files required: - file_id type: object x-event-categories: [] x-stainless-empty-object: false type: array x-documentation-priority: default disputed_transaction_id: description: The Transaction you wish to dispute. This Transaction must have a `source_type` of `card_settlement`. type: string x-documentation-priority: default x-id-reference-to: Transactions explanation: description: The free-form explanation provided to Increase to provide more context for the user submission. This field is not sent directly to the card networks. maxLength: 200 minLength: 1 type: string x-documentation-priority: default network: description: The network of the disputed transaction. Details specific to the network are required under the sub-object with the same identifier as the network. enum: - visa type: string x-documentation-priority: default x-enum-descriptions: - Visa visa: additionalProperties: false description: The Visa-specific parameters for the dispute. Required if and only if `network` is `visa`. properties: authorization: additionalProperties: false description: Authorization. Required if and only if `category` is `authorization`. properties: account_status: description: Account status. enum: - account_closed - credit_problem - fraud type: string x-documentation-priority: default x-enum-descriptions: - Account closed. - Credit problem. - Fraud. required: - account_status type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false category: description: Category. enum: - authorization - consumer_canceled_merchandise - consumer_canceled_recurring_transaction - consumer_canceled_services - consumer_counterfeit_merchandise - consumer_credit_not_processed - consumer_damaged_or_defective_merchandise - consumer_merchandise_misrepresentation - consumer_merchandise_not_as_described - consumer_merchandise_not_received - consumer_non_receipt_of_cash - consumer_original_credit_transaction_not_accepted - consumer_quality_merchandise - consumer_quality_services - consumer_services_misrepresentation - consumer_services_not_as_described - consumer_services_not_received - fraud - processing_error type: string x-documentation-priority: default x-enum-descriptions: - Authorization. - 'Consumer: canceled merchandise.' - 'Consumer: canceled recurring transaction.' - 'Consumer: canceled services.' - 'Consumer: counterfeit merchandise.' - 'Consumer: credit not processed.' - 'Consumer: damaged or defective merchandise.' - 'Consumer: merchandise misrepresentation.' - 'Consumer: merchandise not as described.' - 'Consumer: merchandise not received.' - 'Consumer: non-receipt of cash.' - 'Consumer: Original Credit Transaction (OCT) not accepted.' - 'Consumer: merchandise quality issue.' - 'Consumer: services quality issue.' - 'Consumer: services misrepresentation.' - 'Consumer: services not as described.' - 'Consumer: services not received.' - Fraud. - Processing error. consumer_canceled_merchandise: additionalProperties: false description: Canceled merchandise. Required if and only if `category` is `consumer_canceled_merchandise`. properties: cardholder_cancellation: additionalProperties: false description: Cardholder cancellation. properties: canceled_at: description: Canceled at. format: date type: string x-documentation-priority: default canceled_prior_to_ship_date: description: Canceled prior to ship date. enum: - canceled_prior_to_ship_date - not_canceled_prior_to_ship_date type: string x-documentation-priority: default x-enum-descriptions: - Canceled prior to ship date. - Not canceled prior to ship date. cancellation_policy_provided: description: Cancellation policy provided. enum: - not_provided - provided type: string x-documentation-priority: default x-enum-descriptions: - Not provided. - Provided. reason: description: Reason. maxLength: 200 minLength: 1 type: string x-documentation-priority: default required: - canceled_at - canceled_prior_to_ship_date - cancellation_policy_provided - reason type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false merchant_resolution_attempted: description: Merchant resolution attempted. enum: - attempted - prohibited_by_local_law type: string x-documentation-priority: default x-enum-descriptions: - Attempted. - Prohibited by local law. not_returned: additionalProperties: false description: Not returned. Required if and only if `return_outcome` is `not_returned`. properties: {} type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true purchase_explanation: description: Purchase explanation. maxLength: 200 minLength: 1 type: string x-documentation-priority: default received_or_expected_at: description: Received or expected at. format: date type: string x-documentation-priority: default return_attempted: additionalProperties: false description: Return attempted. Required if and only if `return_outcome` is `return_attempted`. properties: attempt_explanation: description: Attempt explanation. maxLength: 200 minLength: 1 type: string x-documentation-priority: default attempt_reason: description: Attempt reason. enum: - merchant_not_responding - no_return_authorization_provided - no_return_instructions - requested_not_to_return - return_not_accepted type: string x-documentation-priority: default x-enum-descriptions: - Merchant not responding. - No return authorization provided. - No return instructions. - Requested not to return. - Return not accepted. attempted_at: description: Attempted at. format: date type: string x-documentation-priority: default merchandise_disposition: description: Merchandise disposition. maxLength: 200 minLength: 1 type: string x-documentation-priority: default required: - attempt_explanation - attempt_reason - attempted_at - merchandise_disposition type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false return_outcome: description: Return outcome. enum: - not_returned - returned - return_attempted type: string x-documentation-priority: default x-enum-descriptions: - Not returned. - Returned. - Return attempted. returned: additionalProperties: false description: Returned. Required if and only if `return_outcome` is `returned`. properties: merchant_received_return_at: description: Merchant received return at. format: date type: string x-documentation-priority: default other_explanation: description: Other explanation. Required if and only if the return method is `other`. maxLength: 200 minLength: 1 type: string x-documentation-priority: default return_method: description: Return method. enum: - dhl - face_to_face - fedex - other - postal_service - ups type: string x-documentation-priority: default x-enum-descriptions: - DHL. - Face-to-face. - FedEx. - Other. - Postal service. - UPS. returned_at: description: Returned at. format: date type: string x-documentation-priority: default tracking_number: description: Tracking number. maxLength: 200 minLength: 1 type: string x-documentation-priority: default required: - return_method - returned_at type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false required: - merchant_resolution_attempted - purchase_explanation - received_or_expected_at - return_outcome type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false consumer_canceled_recurring_transaction: additionalProperties: false description: Canceled recurring transaction. Required if and only if `category` is `consumer_canceled_recurring_transaction`. properties: cancellation_target: description: Cancellation target. enum: - account - transaction type: string x-documentation-priority: default x-enum-descriptions: - Account. - Transaction. merchant_contact_methods: additionalProperties: false description: Merchant contact methods. properties: application_name: description: Application name. maxLength: 200 minLength: 1 type: string x-documentation-priority: default call_center_phone_number: description: Call center phone number. maxLength: 200 minLength: 1 type: string x-documentation-priority: default email_address: description: Email address. maxLength: 200 minLength: 1 type: string x-documentation-priority: default in_person_address: description: In person address. maxLength: 200 minLength: 1 type: string x-documentation-priority: default mailing_address: description: Mailing address. maxLength: 200 minLength: 1 type: string x-documentation-priority: default text_phone_number: description: Text phone number. maxLength: 200 minLength: 1 type: string x-documentation-priority: default type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false other_form_of_payment_explanation: description: Other form of payment explanation. maxLength: 200 minLength: 1 type: string x-documentation-priority: default transaction_or_account_canceled_at: description: Transaction or account canceled at. format: date type: string x-documentation-priority: default required: - cancellation_target - merchant_contact_methods - transaction_or_account_canceled_at type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false consumer_canceled_services: additionalProperties: false description: Canceled services. Required if and only if `category` is `consumer_canceled_services`. properties: cardholder_cancellation: additionalProperties: false description: Cardholder cancellation. properties: canceled_at: description: Canceled at. format: date type: string x-documentation-priority: default cancellation_policy_provided: description: Cancellation policy provided. enum: - not_provided - provided type: string x-documentation-priority: default x-enum-descriptions: - Not provided. - Provided. reason: description: Reason. maxLength: 200 minLength: 1 type: string x-documentation-priority: default required: - canceled_at - cancellation_policy_provided - reason type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false contracted_at: description: Contracted at. format: date type: string x-documentation-priority: default guaranteed_reservation: additionalProperties: false description: Guaranteed reservation explanation. Required if and only if `service_type` is `guaranteed_reservation`. properties: explanation: description: Explanation. enum: - cardholder_canceled_prior_to_service - cardholder_cancellation_attempt_within_24_hours_of_confirmation - merchant_billed_no_show type: string x-documentation-priority: default x-enum-descriptions: - Cardholder canceled prior to service. - Cardholder cancellation attempt within 24 hours of confirmation. - Merchant billed for no-show. required: - explanation type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false merchant_resolution_attempted: description: Merchant resolution attempted. enum: - attempted - prohibited_by_local_law type: string x-documentation-priority: default x-enum-descriptions: - Attempted. - Prohibited by local law. other: additionalProperties: false description: Other service type explanation. Required if and only if `service_type` is `other`. properties: {} type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true purchase_explanation: description: Purchase explanation. maxLength: 200 minLength: 1 type: string x-documentation-priority: default service_type: description: Service type. enum: - guaranteed_reservation - other - timeshare type: string x-documentation-priority: default x-enum-descriptions: - Guaranteed reservation. - Other. - Timeshare. timeshare: additionalProperties: false description: Timeshare explanation. Required if and only if `service_type` is `timeshare`. properties: {} type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true required: - cardholder_cancellation - contracted_at - merchant_resolution_attempted - purchase_explanation - service_type type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false consumer_counterfeit_merchandise: additionalProperties: false description: Counterfeit merchandise. Required if and only if `category` is `consumer_counterfeit_merchandise`. properties: counterfeit_explanation: description: Counterfeit explanation. maxLength: 200 minLength: 1 type: string x-documentation-priority: default disposition_explanation: description: Disposition explanation. maxLength: 200 minLength: 1 type: string x-documentation-priority: default order_explanation: description: Order explanation. maxLength: 200 minLength: 1 type: string x-documentation-priority: default received_at: description: Received at. format: date type: string x-documentation-priority: default required: - counterfeit_explanation - disposition_explanation - order_explanation - received_at type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false consumer_credit_not_processed: additionalProperties: false description: Credit not processed. Required if and only if `category` is `consumer_credit_not_processed`. properties: canceled_or_returned_at: description: Canceled or returned at. format: date type: string x-documentation-priority: default credit_expected_at: description: Credit expected at. format: date type: string x-documentation-priority: default type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false consumer_damaged_or_defective_merchandise: additionalProperties: false description: Damaged or defective merchandise. Required if and only if `category` is `consumer_damaged_or_defective_merchandise`. properties: merchant_resolution_attempted: description: Merchant resolution attempted. enum: - attempted - prohibited_by_local_law type: string x-documentation-priority: default x-enum-descriptions: - Attempted. - Prohibited by local law. not_returned: additionalProperties: false description: Not returned. Required if and only if `return_outcome` is `not_returned`. properties: {} type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true order_and_issue_explanation: description: Order and issue explanation. maxLength: 200 minLength: 1 type: string x-documentation-priority: default received_at: description: Received at. format: date type: string x-documentation-priority: default return_attempted: additionalProperties: false description: Return attempted. Required if and only if `return_outcome` is `return_attempted`. properties: attempt_explanation: description: Attempt explanation. maxLength: 200 minLength: 1 type: string x-documentation-priority: default attempt_reason: description: Attempt reason. enum: - merchant_not_responding - no_return_authorization_provided - no_return_instructions - requested_not_to_return - return_not_accepted type: string x-documentation-priority: default x-enum-descriptions: - Merchant not responding. - No return authorization provided. - No return instructions. - Requested not to return. - Return not accepted. attempted_at: description: Attempted at. format: date type: string x-documentation-priority: default merchandise_disposition: description: Merchandise disposition. maxLength: 200 minLength: 1 type: string x-documentation-priority: default required: - attempt_explanation - attempt_reason - attempted_at - merchandise_disposition type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false return_outcome: description: Return outcome. enum: - not_returned - returned - return_attempted type: string x-documentation-priority: default x-enum-descriptions: - Not returned. - Returned. - Return attempted. returned: additionalProperties: false description: Returned. Required if and only if `return_outcome` is `returned`. properties: merchant_received_return_at: description: Merchant received return at. format: date type: string x-documentation-priority: default other_explanation: description: Other explanation. Required if and only if the return method is `other`. maxLength: 200 minLength: 1 type: string x-documentation-priority: default return_method: description: Return method. enum: - dhl - face_to_face - fedex - other - postal_service - ups type: string x-documentation-priority: default x-enum-descriptions: - DHL. - Face-to-face. - FedEx. - Other. - Postal service. - UPS. returned_at: description: Returned at. format: date type: string x-documentation-priority: default tracking_number: description: Tracking number. maxLength: 200 minLength: 1 type: string x-documentation-priority: default required: - return_method - returned_at type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false required: - merchant_resolution_attempted - order_and_issue_explanation - received_at - return_outcome type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false consumer_merchandise_misrepresentation: additionalProperties: false description: Merchandise misrepresentation. Required if and only if `category` is `consumer_merchandise_misrepresentation`. properties: merchant_resolution_attempted: description: Merchant resolution attempted. enum: - attempted - prohibited_by_local_law type: string x-documentation-priority: default x-enum-descriptions: - Attempted. - Prohibited by local law. misrepresentation_explanation: description: Misrepresentation explanation. maxLength: 200 minLength: 1 type: string x-documentation-priority: default not_returned: additionalProperties: false description: Not returned. Required if and only if `return_outcome` is `not_returned`. properties: {} type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true purchase_explanation: description: Purchase explanation. maxLength: 200 minLength: 1 type: string x-documentation-priority: default received_at: description: Received at. format: date type: string x-documentation-priority: default return_attempted: additionalProperties: false description: Return attempted. Required if and only if `return_outcome` is `return_attempted`. properties: attempt_explanation: description: Attempt explanation. maxLength: 200 minLength: 1 type: string x-documentation-priority: default attempt_reason: description: Attempt reason. enum: - merchant_not_responding - no_return_authorization_provided - no_return_instructions - requested_not_to_return - return_not_accepted type: string x-documentation-priority: default x-enum-descriptions: - Merchant not responding. - No return authorization provided. - No return instructions. - Requested not to return. - Return not accepted. attempted_at: description: Attempted at. format: date type: string x-documentation-priority: default merchandise_disposition: description: Merchandise disposition. maxLength: 200 minLength: 1 type: string x-documentation-priority: default required: - attempt_explanation - attempt_reason - attempted_at - merchandise_disposition type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false return_outcome: description: Return outcome. enum: - not_returned - returned - return_attempted type: string x-documentation-priority: default x-enum-descriptions: - Not returned. - Returned. - Return attempted. returned: additionalProperties: false description: Returned. Required if and only if `return_outcome` is `returned`. properties: merchant_received_return_at: description: Merchant received return at. format: date type: string x-documentation-priority: default other_explanation: description: Other explanation. Required if and only if the return method is `other`. maxLength: 200 minLength: 1 type: string x-documentation-priority: default return_method: description: Return method. enum: - dhl - face_to_face - fedex - other - postal_service - ups type: string x-documentation-priority: default x-enum-descriptions: - DHL. - Face-to-face. - FedEx. - Other. - Postal service. - UPS. returned_at: description: Returned at. format: date type: string x-documentation-priority: default tracking_number: description: Tracking number. maxLength: 200 minLength: 1 type: string x-documentation-priority: default required: - return_method - returned_at type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false required: - merchant_resolution_attempted - misrepresentation_explanation - purchase_explanation - received_at - return_outcome type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false consumer_merchandise_not_as_described: additionalProperties: false description: Merchandise not as described. Required if and only if `category` is `consumer_merchandise_not_as_described`. properties: merchant_resolution_attempted: description: Merchant resolution attempted. enum: - attempted - prohibited_by_local_law type: string x-documentation-priority: default x-enum-descriptions: - Attempted. - Prohibited by local law. received_at: description: Received at. format: date type: string x-documentation-priority: default return_attempted: additionalProperties: false description: Return attempted. Required if and only if `return_outcome` is `return_attempted`. properties: attempt_explanation: description: Attempt explanation. maxLength: 200 minLength: 1 type: string x-documentation-priority: default attempt_reason: description: Attempt reason. enum: - merchant_not_responding - no_return_authorization_provided - no_return_instructions - requested_not_to_return - return_not_accepted type: string x-documentation-priority: default x-enum-descriptions: - Merchant not responding. - No return authorization provided. - No return instructions. - Requested not to return. - Return not accepted. attempted_at: description: Attempted at. format: date type: string x-documentation-priority: default merchandise_disposition: description: Merchandise disposition. maxLength: 200 minLength: 1 type: string x-documentation-priority: default required: - attempt_explanation - attempt_reason - attempted_at - merchandise_disposition type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false return_outcome: description: Return outcome. enum: - returned - return_attempted type: string x-documentation-priority: default x-enum-descriptions: - Returned. - Return attempted. returned: additionalProperties: false description: Returned. Required if and only if `return_outcome` is `returned`. properties: merchant_received_return_at: description: Merchant received return at. format: date type: string x-documentation-priority: default other_explanation: description: Other explanation. Required if and only if the return method is `other`. maxLength: 200 minLength: 1 type: string x-documentation-priority: default return_method: description: Return method. enum: - dhl - face_to_face - fedex - other - postal_service - ups type: string x-documentation-priority: default x-enum-descriptions: - DHL. - Face-to-face. - FedEx. - Other. - Postal service. - UPS. returned_at: description: Returned at. format: date type: string x-documentation-priority: default tracking_number: description: Tracking number. maxLength: 200 minLength: 1 type: string x-documentation-priority: default required: - return_method - returned_at type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false required: - merchant_resolution_attempted - received_at - return_outcome type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false consumer_merchandise_not_received: additionalProperties: false description: Merchandise not received. Required if and only if `category` is `consumer_merchandise_not_received`. properties: cancellation_outcome: description: Cancellation outcome. enum: - cardholder_cancellation_prior_to_expected_receipt - merchant_cancellation - no_cancellation type: string x-documentation-priority: default x-enum-descriptions: - Cardholder cancellation prior to expected receipt. - Merchant cancellation. - No cancellation. cardholder_cancellation_prior_to_expected_receipt: additionalProperties: false description: Cardholder cancellation prior to expected receipt. Required if and only if `cancellation_outcome` is `cardholder_cancellation_prior_to_expected_receipt`. properties: canceled_at: description: Canceled at. format: date type: string x-documentation-priority: default reason: description: Reason. maxLength: 200 minLength: 1 type: string x-documentation-priority: default required: - canceled_at type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false delayed: additionalProperties: false description: Delayed. Required if and only if `delivery_issue` is `delayed`. properties: explanation: description: Explanation. maxLength: 200 minLength: 1 type: string x-documentation-priority: default not_returned: additionalProperties: false description: Not returned. Required if and only if `return_outcome` is `not_returned`. properties: {} type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true return_attempted: additionalProperties: false description: Return attempted. Required if and only if `return_outcome` is `return_attempted`. properties: attempted_at: description: Attempted at. format: date type: string x-documentation-priority: default required: - attempted_at type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false return_outcome: description: Return outcome. enum: - not_returned - returned - return_attempted type: string x-documentation-priority: default x-enum-descriptions: - Not returned. - Returned. - Return attempted. returned: additionalProperties: false description: Returned. Required if and only if `return_outcome` is `returned`. properties: merchant_received_return_at: description: Merchant received return at. format: date type: string x-documentation-priority: default returned_at: description: Returned at. format: date type: string x-documentation-priority: default required: - merchant_received_return_at - returned_at type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false required: - explanation - return_outcome type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false delivered_to_wrong_location: additionalProperties: false description: Delivered to wrong location. Required if and only if `delivery_issue` is `delivered_to_wrong_location`. properties: agreed_location: description: Agreed location. maxLength: 200 minLength: 1 type: string x-documentation-priority: default required: - agreed_location type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false delivery_issue: description: Delivery issue. enum: - delayed - delivered_to_wrong_location type: string x-documentation-priority: default x-enum-descriptions: - Delayed. - Delivered to wrong location. last_expected_receipt_at: description: Last expected receipt at. format: date type: string x-documentation-priority: default merchant_cancellation: additionalProperties: false description: Merchant cancellation. Required if and only if `cancellation_outcome` is `merchant_cancellation`. properties: canceled_at: description: Canceled at. format: date type: string x-documentation-priority: default required: - canceled_at type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false merchant_resolution_attempted: description: Merchant resolution attempted. enum: - attempted - prohibited_by_local_law type: string x-documentation-priority: default x-enum-descriptions: - Attempted. - Prohibited by local law. no_cancellation: additionalProperties: false description: No cancellation. Required if and only if `cancellation_outcome` is `no_cancellation`. properties: {} type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true purchase_info_and_explanation: description: Purchase information and explanation. maxLength: 200 minLength: 1 type: string x-documentation-priority: default required: - cancellation_outcome - delivery_issue - last_expected_receipt_at - merchant_resolution_attempted - purchase_info_and_explanation type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false consumer_non_receipt_of_cash: additionalProperties: false description: Non-receipt of cash. Required if and only if `category` is `consumer_non_receipt_of_cash`. properties: {} type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true consumer_original_credit_transaction_not_accepted: additionalProperties: false description: Original Credit Transaction (OCT) not accepted. Required if and only if `category` is `consumer_original_credit_transaction_not_accepted`. properties: explanation: description: Explanation. maxLength: 200 minLength: 1 type: string x-documentation-priority: default reason: description: Reason. enum: - prohibited_by_local_laws_or_regulation - recipient_refused type: string x-documentation-priority: default x-enum-descriptions: - Prohibited by local laws or regulation. - Recipient refused. required: - explanation - reason type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false consumer_quality_merchandise: additionalProperties: false description: Merchandise quality issue. Required if and only if `category` is `consumer_quality_merchandise`. properties: expected_at: description: Expected at. format: date type: string x-documentation-priority: default merchant_resolution_attempted: description: Merchant resolution attempted. enum: - attempted - prohibited_by_local_law type: string x-documentation-priority: default x-enum-descriptions: - Attempted. - Prohibited by local law. not_returned: additionalProperties: false description: Not returned. Required if and only if `return_outcome` is `not_returned`. properties: {} type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true ongoing_negotiations: additionalProperties: false description: Ongoing negotiations. Exclude if there is no evidence of ongoing negotiations. properties: explanation: description: Explanation of the previous ongoing negotiations between the cardholder and merchant. maxLength: 200 minLength: 1 type: string x-documentation-priority: default issuer_first_notified_at: description: Date the cardholder first notified the issuer of the dispute. format: date type: string x-documentation-priority: default started_at: description: Started at. format: date type: string x-documentation-priority: default required: - explanation - issuer_first_notified_at - started_at type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false purchase_info_and_quality_issue: description: Purchase information and quality issue. maxLength: 200 minLength: 1 type: string x-documentation-priority: default received_at: description: Received at. format: date type: string x-documentation-priority: default return_attempted: additionalProperties: false description: Return attempted. Required if and only if `return_outcome` is `return_attempted`. properties: attempt_explanation: description: Attempt explanation. maxLength: 200 minLength: 1 type: string x-documentation-priority: default attempt_reason: description: Attempt reason. enum: - merchant_not_responding - no_return_authorization_provided - no_return_instructions - requested_not_to_return - return_not_accepted type: string x-documentation-priority: default x-enum-descriptions: - Merchant not responding. - No return authorization provided. - No return instructions. - Requested not to return. - Return not accepted. attempted_at: description: Attempted at. format: date type: string x-documentation-priority: default merchandise_disposition: description: Merchandise disposition. maxLength: 200 minLength: 1 type: string x-documentation-priority: default required: - attempt_explanation - attempt_reason - attempted_at - merchandise_disposition type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false return_outcome: description: Return outcome. enum: - not_returned - returned - return_attempted type: string x-documentation-priority: default x-enum-descriptions: - Not returned. - Returned. - Return attempted. returned: additionalProperties: false description: Returned. Required if and only if `return_outcome` is `returned`. properties: merchant_received_return_at: description: Merchant received return at. format: date type: string x-documentation-priority: default other_explanation: description: Other explanation. Required if and only if the return method is `other`. maxLength: 200 minLength: 1 type: string x-documentation-priority: default return_method: description: Return method. enum: - dhl - face_to_face - fedex - other - postal_service - ups type: string x-documentation-priority: default x-enum-descriptions: - DHL. - Face-to-face. - FedEx. - Other. - Postal service. - UPS. returned_at: description: Returned at. format: date type: string x-documentation-priority: default tracking_number: description: Tracking number. maxLength: 200 minLength: 1 type: string x-documentation-priority: default required: - return_method - returned_at type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false required: - expected_at - merchant_resolution_attempted - purchase_info_and_quality_issue - received_at - return_outcome type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false consumer_quality_services: additionalProperties: false description: Services quality issue. Required if and only if `category` is `consumer_quality_services`. properties: cardholder_cancellation: additionalProperties: false description: Cardholder cancellation. properties: accepted_by_merchant: description: Accepted by merchant. enum: - accepted - not_accepted type: string x-documentation-priority: default x-enum-descriptions: - Accepted. - Not accepted. canceled_at: description: Canceled at. format: date type: string x-documentation-priority: default reason: description: Reason. maxLength: 200 minLength: 1 type: string x-documentation-priority: default required: - accepted_by_merchant - canceled_at - reason type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false cardholder_paid_to_have_work_redone: description: Cardholder paid to have work redone. enum: - did_not_pay_to_have_work_redone - paid_to_have_work_redone type: string x-documentation-priority: default x-enum-descriptions: - Cardholder did not pay to have work redone. - Cardholder paid to have work redone. non_fiat_currency_or_non_fungible_token_related_and_not_matching_description: description: Non-fiat currency or non-fungible token related and not matching description. enum: - not_related - related type: string x-documentation-priority: default x-enum-descriptions: - Not related. - Related. ongoing_negotiations: additionalProperties: false description: Ongoing negotiations. Exclude if there is no evidence of ongoing negotiations. properties: explanation: description: Explanation of the previous ongoing negotiations between the cardholder and merchant. maxLength: 200 minLength: 1 type: string x-documentation-priority: default issuer_first_notified_at: description: Date the cardholder first notified the issuer of the dispute. format: date type: string x-documentation-priority: default started_at: description: Started at. format: date type: string x-documentation-priority: default required: - explanation - issuer_first_notified_at - started_at type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false purchase_info_and_quality_issue: description: Purchase information and quality issue. maxLength: 200 minLength: 1 type: string x-documentation-priority: default restaurant_food_related: description: Whether the dispute is related to the quality of food from an eating place or restaurant. Must be provided when Merchant Category Code (MCC) is 5812, 5813 or 5814. enum: - not_related - related type: string x-documentation-priority: default x-enum-descriptions: - Not related. - Related. services_received_at: description: Services received at. format: date type: string x-documentation-priority: default required: - cardholder_cancellation - non_fiat_currency_or_non_fungible_token_related_and_not_matching_description - purchase_info_and_quality_issue - services_received_at type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false consumer_services_misrepresentation: additionalProperties: false description: Services misrepresentation. Required if and only if `category` is `consumer_services_misrepresentation`. properties: cardholder_cancellation: additionalProperties: false description: Cardholder cancellation. properties: accepted_by_merchant: description: Accepted by merchant. enum: - accepted - not_accepted type: string x-documentation-priority: default x-enum-descriptions: - Accepted. - Not accepted. canceled_at: description: Canceled at. format: date type: string x-documentation-priority: default reason: description: Reason. maxLength: 200 minLength: 1 type: string x-documentation-priority: default required: - accepted_by_merchant - canceled_at - reason type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false merchant_resolution_attempted: description: Merchant resolution attempted. enum: - attempted - prohibited_by_local_law type: string x-documentation-priority: default x-enum-descriptions: - Attempted. - Prohibited by local law. misrepresentation_explanation: description: Misrepresentation explanation. maxLength: 200 minLength: 1 type: string x-documentation-priority: default purchase_explanation: description: Purchase explanation. maxLength: 200 minLength: 1 type: string x-documentation-priority: default received_at: description: Received at. format: date type: string x-documentation-priority: default required: - cardholder_cancellation - merchant_resolution_attempted - misrepresentation_explanation - purchase_explanation - received_at type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false consumer_services_not_as_described: additionalProperties: false description: Services not as described. Required if and only if `category` is `consumer_services_not_as_described`. properties: cardholder_cancellation: additionalProperties: false description: Cardholder cancellation. properties: accepted_by_merchant: description: Accepted by merchant. enum: - accepted - not_accepted type: string x-documentation-priority: default x-enum-descriptions: - Accepted. - Not accepted. canceled_at: description: Canceled at. format: date type: string x-documentation-priority: default reason: description: Reason. maxLength: 200 minLength: 1 type: string x-documentation-priority: default required: - accepted_by_merchant - canceled_at - reason type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false explanation: description: Explanation of what was ordered and was not as described. maxLength: 200 minLength: 1 type: string x-documentation-priority: default merchant_resolution_attempted: description: Merchant resolution attempted. enum: - attempted - prohibited_by_local_law type: string x-documentation-priority: default x-enum-descriptions: - Attempted. - Prohibited by local law. received_at: description: Received at. format: date type: string x-documentation-priority: default required: - cardholder_cancellation - explanation - merchant_resolution_attempted - received_at type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false consumer_services_not_received: additionalProperties: false description: Services not received. Required if and only if `category` is `consumer_services_not_received`. properties: cancellation_outcome: description: Cancellation outcome. enum: - cardholder_cancellation_prior_to_expected_receipt - merchant_cancellation - no_cancellation type: string x-documentation-priority: default x-enum-descriptions: - Cardholder cancellation prior to expected receipt. - Merchant cancellation. - No cancellation. cardholder_cancellation_prior_to_expected_receipt: additionalProperties: false description: Cardholder cancellation prior to expected receipt. Required if and only if `cancellation_outcome` is `cardholder_cancellation_prior_to_expected_receipt`. properties: canceled_at: description: Canceled at. format: date type: string x-documentation-priority: default reason: description: Reason. maxLength: 200 minLength: 1 type: string x-documentation-priority: default required: - canceled_at type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false last_expected_receipt_at: description: Last expected receipt at. format: date type: string x-documentation-priority: default merchant_cancellation: additionalProperties: false description: Merchant cancellation. Required if and only if `cancellation_outcome` is `merchant_cancellation`. properties: canceled_at: description: Canceled at. format: date type: string x-documentation-priority: default required: - canceled_at type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false merchant_resolution_attempted: description: Merchant resolution attempted. enum: - attempted - prohibited_by_local_law type: string x-documentation-priority: default x-enum-descriptions: - Attempted. - Prohibited by local law. no_cancellation: additionalProperties: false description: No cancellation. Required if and only if `cancellation_outcome` is `no_cancellation`. properties: {} type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true purchase_info_and_explanation: description: Purchase information and explanation. maxLength: 200 minLength: 1 type: string x-documentation-priority: default required: - cancellation_outcome - last_expected_receipt_at - merchant_resolution_attempted - purchase_info_and_explanation type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false fraud: additionalProperties: false description: Fraud. Required if and only if `category` is `fraud`. properties: fraud_type: description: Fraud type. enum: - account_or_credentials_takeover - card_not_received_as_issued - fraudulent_application - fraudulent_use_of_account_number - incorrect_processing - issuer_reported_counterfeit - lost - manipulation_of_account_holder - merchant_misrepresentation - miscellaneous - stolen type: string x-documentation-priority: default x-enum-descriptions: - Account or credentials takeover. - Card not received as issued. - Fraudulent application. - Fraudulent use of account number. - Incorrect processing. - Issuer reported counterfeit. - Lost. - Manipulation of account holder. - Merchant misrepresentation. - Miscellaneous. - Stolen. required: - fraud_type type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false processing_error: additionalProperties: false description: Processing error. Required if and only if `category` is `processing_error`. properties: duplicate_transaction: additionalProperties: false description: Duplicate transaction. Required if and only if `error_reason` is `duplicate_transaction`. properties: other_transaction_id: description: Other transaction ID. maxLength: 200 minLength: 1 type: string x-documentation-priority: default required: - other_transaction_id type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false error_reason: description: Error reason. enum: - duplicate_transaction - incorrect_amount - paid_by_other_means type: string x-documentation-priority: default x-enum-descriptions: - Duplicate transaction. - Incorrect amount. - Paid by other means. incorrect_amount: additionalProperties: false description: Incorrect amount. Required if and only if `error_reason` is `incorrect_amount`. properties: expected_amount: description: Expected amount. minimum: 0 type: integer x-documentation-priority: default required: - expected_amount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false merchant_resolution_attempted: description: Merchant resolution attempted. enum: - attempted - prohibited_by_local_law type: string x-documentation-priority: default x-enum-descriptions: - Attempted. - Prohibited by local law. paid_by_other_means: additionalProperties: false description: Paid by other means. Required if and only if `error_reason` is `paid_by_other_means`. properties: other_form_of_payment_evidence: description: Other form of payment evidence. enum: - canceled_check - card_transaction - cash_receipt - other - statement - voucher type: string x-documentation-priority: default x-enum-descriptions: - Canceled check. - Card transaction. - Cash receipt. - Other. - Statement. - Voucher. other_transaction_id: description: Other transaction ID. maxLength: 200 minLength: 1 type: string x-documentation-priority: default required: - other_form_of_payment_evidence type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false required: - error_reason - merchant_resolution_attempted type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false required: - category type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false required: - disputed_transaction_id - network type: object x-event-categories: [] x-stainless-empty-object: false responses: errorResponse: content: application/json: schema: allOf: - $ref: '#/components/schemas/error' description: Error securitySchemes: bearerAuth: scheme: bearer type: http x-tagGroups: - name: Accounts tags: - Accounts - Account Numbers - Account Transfers - name: Transactions tags: - Transactions - Pending Transactions - Declined Transactions - name: Ach Transfers tags: - ACH Transfers - Inbound ACH Transfers - ACH Prenotifications - name: Check Transfers tags: - Check Transfers - Inbound Check Deposits - name: Real Time Payments Transfers tags: - Real-Time Payments Transfers - Inbound Real-Time Payments Transfers - name: Fednow Transfers tags: - FedNow Transfers - Inbound FedNow Transfers - name: Swift Transfers tags: - Swift Transfers - name: Wire Transfers tags: - Wire Transfers - Inbound Wire Transfers - Wire Drawdown Requests - Inbound Wire Drawdown Requests - name: Card Transfers tags: - Card Tokens - Card Push Transfers - Card Validations - name: Check Deposits tags: - Check Deposits - Lockbox Addresses - Lockbox Recipients - Inbound Mail Items - name: Cards tags: - Cards - Card Payments - Card Purchase Supplements - Card Disputes - Physical Cards - Digital Card Profiles - Physical Card Profiles - Digital Wallet Tokens - name: Compliance tags: - Entities - Beneficial Owners - Supplemental Documents - Entity Onboarding Sessions - Programs - name: Events and Webhooks tags: - Events - Event Subscriptions - Real-Time Decisions - name: External Accounts tags: - Routing Numbers - External Accounts - name: Files and Exports tags: - Account Statements - Files - File Links - Exports - name: OAuth tags: - Groups - OAuth Applications - OAuth Connections - OAuth Tokens - name: Intrafi tags: - IntraFi Account Enrollments - IntraFi Balances - IntraFi Exclusions