Welcome to the official reference documentation for Synctera APIs. Our APIs are the best way to automate your company's banking needs and are designed to be easy to understand and implement.
We're continuously growing this library and what you see here is just the start, but if you need something specific or have a question, contact us.
license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html title: Synctera API version: v2 servers: - description: Production url: https://api.synctera.com/v2 - description: Sandbox (no real world financial impact) url: https://api-sandbox.synctera.com/v2 security: - bearerAuth: [] tags: - description: FDX authentication and data transfer using Plaid Core Exchange name: Plaid Core Exchange (beta) - description: Create a credit application. name: Applications (beta) - description: Billing period summaries name: Billing Period Summaries - description: Customer Service Details for disputes and billing inquiries name: Customer Service Details - description: Billing rates name: Billing Rates - description: Rates name: Rates - description: Lending Config name: Lending Config - description: Manage credit disputes name: Credit Disputes - description: Payments related to lending accounts name: Payments - description: Tenant Config name: Tenant Config - description: Bank Delinquency Configuration name: Bank Delinquency Configuration - description: >- Per bank/partner account-type mapping to FFIEC collateral codes used for regulatory call report furnishment. name: Collateral Code Configuration - description: >- Rules that map a posted payment transaction (bank/partner + transaction attributes) to a regulatory payment code. NULL match columns act as wildcards. name: Payment Code Configuration - description: Autopay configuration management for lending accounts name: Autopay Configs - description: Autopay payment records for billing periods name: Autopays - description: Configuration for mapping LoanPro events to Payola transaction parameters name: LoanPro Transaction Event Config - description: >- Aggregated write-off amounts for lending accounts, computed from posted transactions. name: Write Off Amounts - description: Create and manage accounts name: Accounts - description: Create and manage holds name: Hold - description: Create and manage transactions name: Transactions - description: Create and manage transactions name: Transactions (internal) - description: Create and manage scheduled transactions name: Scheduled Transactions (internal) - description: Create and manage spending controls name: Spend Controls - description: Create and manage tenant configurations name: Tenant Configs - description: Lookup merchant information name: Merchants - description: See balance history name: BalanceHistory - description: API for effective balances name: effective_balances - description: API for point-in-time account balances name: account_balances - description: Transaction lines API name: transactions - description: Create and manage transactions name: Transactions (beta) - description: Create and manage spending controls name: Spend Controls (beta) - description: | Requests to create and manage fees name: Fees (beta) - description: | Requests to create and manage Rewards name: Rewards (beta) - description: Create and manage disputes name: Disputes - description: Create and manage tenant-level transaction limits name: Tenant Limits (beta) - description: | Requests to create and manage batch payments name: Batch Payments (alpha) - description: Manage negative balance processes name: Negative Balance - description: | Manage fee products and fee configs for automated fee collection name: Fee Products - description: | Manage reward products and reward configs for automated cashback rewards name: Reward Products - description: Configure vendor secrets for egress requests name: Egress Gateway Vendor Secret CRUD API - description: Configure webhook secrets for egress requests name: Egress Gateway Webhook Secret CRUD API - description: Requests for risk evaluation and decisioning name: Risk Evaluations - description: Requests for transaction risk detection name: Transaction risk - description: Configuration and management of transaction monitoring rules name: Transaction Monitoring - description: Request to create and manage deposits using remote deposit capture name: Remote Check Deposit - description: Request to create and manage rdc configurations name: RDC Config - description: Request to create and manage statements name: Statements - description: Account Template name: Account Templates - description: >- Account programs define configurations for payment rails and transaction capabilities across different account types. name: Account Programs - description: Requests to create and manage account products, including fees, interest. name: Account Products - description: | The internal account resource is used for managing links to internal accounts where the funds are managed by integrators. name: Internal Accounts - description: Requests to create and manage API keys name: API Keys - description: Requests to manage banks name: Banks - description: Requests to create and manage customers name: Customers - description: > A natural person (individual human) that is relevant to the Synctera platform in some way: e.g. a personal customer or a director/officer/owner of a business. name: Persons - description: > A legal entity (corporation, partnership, etc.) that is relevant to the Synctera platform in some way: a business customer or some other organization that has an ownership share in such a business customer. name: Businesses - description: > The fintech profile document resource is used to track the approval status of any documents which must be reviewed by a bank. This includes regulatory documents which will be presented to the fintech's end users, and also any documents that help the bank understand the fintech's fitness for duty. name: Fintech Profile - description: | The disclosures resource is used to track the status of disclosures and ensure that all parties have been shown the necessary disclosures to meet regulatory obligations. name: Disclosures - description: | The Disclosures resource is used to track the status of disclosures and ensure that customers have been shown the necessary disclosures to meet regulatory obligations. name: Disclosures (deprecated) - description: | The External Account resource is used for managing links to accounts that operate outside of the Synctera ecosystem. name: External Accounts - description: History name: History - description: Requests to initiate customer verification. name: KYC Verification (deprecated) - description: Requests to initiate customer verification. name: KYC/KYB Verifications - description: Requests to screen parties against sanctions watchlists name: Sanctions Screening - description: Requests to manage monitoring subscriptions and alerts for customers. name: Monitoring - description: Requests to manage partners name: Partners - description: Request to create and manage party groups and party group members name: Party Groups - description: Requests to create and manage roles name: Roles - description: > Represents the relationships between parties. A relationship can exist between personal customers, business customers, or non-customer persons/organizations. name: Relationships - description: Request to create and manage users name: Users - description: Request to enroll, renew, or cancel watchlist monitors name: Watchlist (deprecated) - description: Retrieve user identity information name: Identity - description: Endpoints for modifying or fetching posting dates name: Posting Dates - description: Admin API for Middesk configuration using the tenants API keys. name: Middesk - description: Requests to search and manage compliance searches name: Compliance Searches - description: Requests to configure vendors. name: Vendor Configurations - description: Requests to create and manage notes name: Notes - description: > Represents the compliance rules that are used to verify certain kinds of money movement. name: Compliance Rules - description: Requests to create licenses name: Licenses - description: >- Used to configure bank accounts for which synctera accounts are considered a "subledger" to name: Bank Account - description: Requests to search financial institutions name: Institutions (Beta) - description: Requests to manage addresses name: Addresses - description: Requests to Admins to grant permissions to user name: Request Permissions - description: Manage contacts for bank and fintech partners name: Contacts - description: Requests to create and manage personal ID configurations name: Personal ID Configuration - description: >- Migration mappings associate resources from an old tenant identity with a new tenant identity. name: Migration Mappings - description: Create and manage payments name: ACH - description: Simulate receiving ACH transactions and returns name: ACH Transaction Simulations - description: Create and manage Cash Order and Cash Deposit transfers name: Cash Orders and Deposits (alpha) - description: Create and manage sweep configurations name: Configs - description: Requests to generate simulated transactions name: Cash Transaction Simulations (alpha) - description: >- Testing endpoints to simulate in-store cash deposits. Available in sandbox environments only. name: In-Store Cash Deposit Simulations - description: Create and manage barcodes for in-store cash deposits name: In-Store Cash Deposits - description: Create and manage Synctera Pay templates name: SyncteraPay - description: Apple Pay APIs name: Apple Pay - description: Create and manage wire transfers name: Wires - description: Simulate receiving Wire transactions and returns name: Wire Transaction Simulations - description: >- Create and manage same currency and multi-currency international wire transfers name: International Wires (alpha) - description: Request to create and manage edd name: Trust - description: Requests to calculate and manage CRR name: CRR - description: Requests to issue and manage cards name: Cards - description: Push and pull from cards name: External Cards - description: Bulk card issuance name: Bulk Issuance - description: Requests to generate simulated transactions name: Card Transaction Simulations - description: Requests to generate simulated webhooks name: Card Webhook Simulations - description: Requests to create and manage card disputes name: Card Disputes - description: Requests to simulate card payments name: Card Simulations - description: Requests to create and manage webhooks name: Webhooks - description: Create and manage documents. name: Documents - description: Request to create and manage payment_schedules name: Cronut paths: /disputes: summary: Disputes description: | The dispute object represents a disputed transaction. get: tags: - Disputes summary: List disputes description: | Get paginated list of disputes operationId: listDisputes parameters: - $ref: '#/components/parameters/end_time_query' - $ref: '#/components/parameters/start_time_query' - $ref: '#/components/parameters/to_date_query' - $ref: '#/components/parameters/from_date_query' - $ref: '#/components/parameters/dispute_status_query' - $ref: '#/components/parameters/account_id' - $ref: '#/components/parameters/dispute_decision_query' - $ref: '#/components/parameters/transaction_id_query' - $ref: '#/components/parameters/related_transaction_id_query' - $ref: '#/components/parameters/payment_rail_query' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/page_token' responses: '200': content: application/json: schema: $ref: '#/components/schemas/dispute_list' description: List of disputes '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '500': $ref: '#/components/responses/internal_server_error' components: parameters: end_time_query: description: >- Only display disputes with a final decision time less than or equal to end_time in: query name: end_time schema: format: date-time type: string start_time_query: description: >- Only display disputes with a creation time greater than or equal to start_time in: query name: start_time schema: format: date-time type: string to_date_query: description: Only display disputes with a creation date less than or equal to to_date in: query name: to_date schema: format: date type: string from_date_query: description: >- Only display disputes with a creation date greater than or equal to from_date in: query name: from_date schema: format: date type: string dispute_status_query: in: query name: status schema: $ref: '#/components/schemas/dispute_status' account_id: description: uuid representing an account in: query name: account_id schema: example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 format: uuid type: string dispute_decision_query: in: query name: decision schema: $ref: '#/components/schemas/dispute_decision' transaction_id_query: in: query name: transaction_id schema: $ref: '#/components/schemas/transaction_id' related_transaction_id_query: in: query name: related_transaction_id schema: description: >- The unique identifier for a transaction related to the dispute, such as a provisional credit or chargeback. example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 format: uuid type: string payment_rail_query: description: | Specifies the payment rail type for the returned disputes. explode: false in: query name: payment_rail schema: $ref: '#/components/schemas/payment_rail' style: form limit: in: query name: limit schema: default: 100 description: > Maximum number of objects to return per page. If the limit is greater than 100, then it will be set to 100. example: 100 minimum: 1 type: integer page_token: in: query name: page_token schema: description: >- Optional pagination token to be provided to retrieve subsequent pages, returned from previous get example: a8937a0d type: string schemas: dispute_list: allOf: - properties: disputes: description: Array of disputes items: $ref: '#/components/schemas/dispute_response' type: array required: - disputes type: object - $ref: '#/components/schemas/paginated_response' title: List of Disputes dispute_status: description: The current status of the dispute. enum: - OPEN - CLOSED type: string dispute_decision: description: | Decision | Description ---------|-------------------------------------------------- LOST | Decision reached in favour of the network. NONE | No decision was reached. ONGOING | Dispute is ongoing and requires further action. RESOLVED | Resolved in favour of the account holder. WON | Decision reached in favour of the account holder. enum: - LOST - NONE - ONGOING - RESOLVED - WON type: string transaction_id: description: The unique identifier of a posted transaction example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 format: uuid type: string payment_rail: description: | A short string representing the payment rail of the dispute. enum: - CARD - EXTERNAL_CARD - ACH type: string dispute_response: discriminator: mapping: ACH: $ref: '#/components/schemas/ach_dispute_response' CARD: $ref: '#/components/schemas/card_dispute_response' EXTERNAL_CARD: $ref: '#/components/schemas/external_card_dispute_response' propertyName: payment_rail oneOf: - $ref: '#/components/schemas/card_dispute_response' - $ref: '#/components/schemas/external_card_dispute_response' - $ref: '#/components/schemas/ach_dispute_response' type: object paginated_response: properties: next_page_token: description: >- If returned, use the next_page_token to query for the next page of results. Not returned if there are no more rows. example: a8937a0d type: string title: Paginated List response type: object error: description: >- Synctera error responses in API v0 follow [RFC 7807](https://datatracker.ietf.org/doc/html/rfc7807). Following that standard, the field for a machine-readable "error code" in API v0 is `type`. In our future API v1, we are phasing out RFC 7807 and adopting a custom error format. That format will be documented in our API v1 spec. But you may see some v0 error responses with a machine-readable `code` field while we are making the transition from v0 to v1. properties: code: description: >- An optional “sneak preview” of our future API v1 error responses. This is provided to give integrators a chance to work with our future error codes. Error codes for the same error may change between v0 and v1. example: BAD_REQUEST_BODY type: string detail: description: | A human-readable string explaining this particular error. example: 'missing required fields: first_name, dob' type: string status: description: the HTTP status code for this response example: 400 type: integer title: description: > A human-readable string for this general category of error, which corresponds 1-to-1 with error types (`title` is the human-readable version of `type`). There can be multiple distinct titles for the same HTTP status code, and the same `title` can result in many different `detail` strings. This field will be removed in API v1. example: Bad Request Body type: string type: description: > A machine-readable string that identifies the error for programmatic use. This is a URI, i.e. a globally unique identifier. It is _not_ necessarily a URL, so do not expect it to resolve to a web page. You can use this whole string as an error code, or just everything after the last slash. This field will be removed in API v1. example: https://dev.synctera.com/errors/bad-request-body type: string title: Standard error response (RFC 7807 problem report) type: object ach_dispute_response: allOf: - $ref: '#/components/schemas/dispute_response_details' - properties: action_history: description: History of all the action filed for the dispute. items: $ref: '#/components/schemas/ach_dispute_action_response' type: array available_actions: description: List of actions that can be taken on the dispute. items: $ref: '#/components/schemas/available_ach_action' type: array credit_status: $ref: '#/components/schemas/dispute_credit_status' lifecycle_state: $ref: '#/components/schemas/ach_lifecycle_state' required: - action_history - available_actions - lifecycle_state - credit_status type: object description: Response for an ACH dispute. title: ACH Dispute card_dispute_response: allOf: - $ref: '#/components/schemas/dispute_response_details' - properties: acquirer_reference_number: description: >- The acquirer reference number of the original transaction associated with the dispute. type: string action_history: description: History of all the action filed for the dispute. items: $ref: '#/components/schemas/card_dispute_action_response' type: array available_actions: description: List of actions that can be taken on the dispute. items: $ref: '#/components/schemas/available_card_action' type: array credit_status: $ref: '#/components/schemas/dispute_credit_status' evidence: $ref: '#/components/schemas/card_dispute_evidence' lifecycle_state: $ref: '#/components/schemas/card_lifecycle_state' managed_by: $ref: '#/components/schemas/card_dispute_managed_by' network_eligibility: $ref: '#/components/schemas/card_network_eligibility' reason_code: $ref: '#/components/schemas/card_dispute_reason_codes' switch_serial_number: description: >- The switch serial number of the original transaction associated with the dispute. type: string required: - action_history - available_actions - lifecycle_state - network_eligibility - reason_code - managed_by - credit_status type: object description: Response for a card dispute. title: Card Dispute external_card_dispute_response: allOf: - $ref: '#/components/schemas/dispute_response_details' - properties: action_history: description: History of all actions taken on the dispute items: $ref: '#/components/schemas/external_card_dispute_action_response' type: array available_actions: description: List of actions that can be taken on the dispute items: $ref: '#/components/schemas/available_external_card_action' type: array debit_status: $ref: '#/components/schemas/dispute_debit_status' lifecycle_state: $ref: '#/components/schemas/external_card_lifecycle_state' managed_by: $ref: '#/components/schemas/card_dispute_managed_by' network_eligibility: $ref: '#/components/schemas/external_card_network_eligibility' reason_code: $ref: '#/components/schemas/external_card_dispute_reason_code' required: - action_history - available_actions - lifecycle_state - reason_code - debit_status - network_eligibility - managed_by type: object description: Response for an external card dispute. title: External Card dispute_response_details: properties: account_id: description: >- The customer account related to the dispute, to which dispute-related credits will be posted. example: ca4450a5-5d4c-4afc-9533-729e2948c477 format: uuid type: string applicable_regulation: $ref: '#/components/schemas/dispute_regulation' creation_time: description: The timestamp representing when the dispute was created example: '2010-05-06T12:23:34.321Z' format: date-time readOnly: true type: string currency: description: ISO 4217 Alpha-3 currency code example: USD maxLength: 3 minLength: 3 type: string customer_id: description: >- The customer related to the dispute, to which dispute-related credits will be posted. example: 52593ea7-4d66-40df-80e9-3b9bc54fa880 format: uuid type: string date_customer_reported: description: The timestamp representing when the customer reported the dispute. example: '2010-05-06T12:23:34.321Z' format: date-time type: string decision: $ref: '#/components/schemas/dispute_decision' dispute_documents: description: Documents associated with the dispute. items: $ref: '#/components/schemas/dispute_document_response' type: array disputed_amount: description: The amount to be disputed in cents. minimum: 1 type: integer external_reference_id: description: Reference ID associated with the dispute on the external network. type: string id: description: The unique identifier of the dispute example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 format: uuid readOnly: true type: string last_action_by: $ref: '#/components/schemas/dispute_action_by' last_updated_time: description: The timestamp representing when the dispute was last modified example: '2010-05-06T12:23:34.321Z' format: date-time readOnly: true type: string memo: description: >- Brief written message describing the reason for disputing the transaction. maxLength: 1000 type: string network: $ref: '#/components/schemas/dispute_network' payment_rail: $ref: '#/components/schemas/payment_rail' status: $ref: '#/components/schemas/dispute_status' tenant: $ref: '#/components/schemas/tenant_id' timestamp_final_decision: description: The time that a final decision was made on the dispute. format: date-time type: string timestamp_investigation_due: format: date-time type: string timestamp_provisional_credit_due: description: >- The time by which provisional credit should be posted to the customer account in response to the dispute. format: date-time type: string transaction_id: description: The ID of the posted transaction to be disputed. example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 format: uuid type: string required: - id - creation_time - last_updated_time - tenant - status - network - decision - transaction_id - disputed_amount - currency - date_customer_reported - dispute_documents - account_id - customer_id - payment_rail - memo type: object ach_dispute_action_response: description: Response for an ACH dispute action. properties: action: $ref: '#/components/schemas/ach_action' creation_time: description: The date and time the resource was created. example: '2010-05-06T12:23:34.321Z' format: date-time readOnly: true type: string id: description: The unique identifier of the dispute action example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 format: uuid readOnly: true type: string message: description: Message text related to card dispute action maxLength: 100 type: string payment_rail: $ref: '#/components/schemas/payment_rail' reason_code: $ref: '#/components/schemas/ach_dispute_reason_codes' return_code: $ref: '#/components/schemas/ach_dispute_return_codes' status: $ref: '#/components/schemas/ach_dispute_action_status' supporting_doc_id: description: The unique identifier of the supporting document example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 format: uuid readOnly: true type: string tenant: $ref: '#/components/schemas/tenant_id' required: - id - creation_time - tenant - payment_rail - action - status title: ACH Action type: object available_ach_action: properties: action: $ref: '#/components/schemas/ach_action' state: $ref: '#/components/schemas/ach_action_state' timestamp_valid_to: description: | The time by which the action must be taken against the dispute. * Only applicable for time constrained actions. example: '2010-05-06T12:23:34.321Z' format: date-time type: string required: - action - state type: object dispute_credit_status: description: > The status of customer account credit related to the dispute | Status | Description | |-------------|--------------------------------------------------------------------------------------------------------| | NONE | The customer account has not been credited or a provisional credit has been reversed and not replaced. | | PROVISIONAL | A provisional credit has been posted to the customer account. | | FINAL | A final credit has been posted to the customer account. | enum: - NONE - PROVISIONAL - FINAL type: string ach_lifecycle_state: description: Current lifecycle state of the dispute. enum: - PENDING_ACTION - ACH_AWAITING_APPROVAL - ACH_FILED_WITH_NETWORK - ACH_REJECTED - ACH_MORE_INFO_REQUIRED - DENIED type: string card_dispute_action_response: description: Response for a card dispute action. properties: action: $ref: '#/components/schemas/card_action' amount: description: The amount of the action in cents. format: int64 minimum: 0 type: integer creation_time: description: The timestamp representing when the object was created example: '2010-05-06T12:23:34.321Z' format: date-time readOnly: true type: string external_reference_id: description: Reference ID associated with the action on the external network. type: string id: description: The unique identifier of the dispute action example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 format: uuid readOnly: true type: string memo: description: | Memo text related to card dispute action type: string message: description: Message text related to card dispute action type: string payment_rail: $ref: '#/components/schemas/payment_rail' reason_code: $ref: '#/components/schemas/card_dispute_reason_codes' representment_reason_code: $ref: '#/components/schemas/card_dispute_representment_reason_code' status: $ref: '#/components/schemas/card_dispute_action_status' supporting_doc_id: description: The unique identifier of the supporting document example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 format: uuid readOnly: true type: string tenant: $ref: '#/components/schemas/tenant_id' updated_reason_code_memo: description: | Memo text describing the reason for updating a reason code. type: string required: - id - creation_time - tenant - payment_rail - action - status title: Card Action type: object available_card_action: properties: action: $ref: '#/components/schemas/card_action' state: $ref: '#/components/schemas/card_action_state' timestamp_valid_to: description: | The time by which the action must be taken against the dispute. * Only applicable for time constrained actions. example: '2010-05-06T12:23:34.321Z' format: date-time type: string required: - action - state type: object card_dispute_evidence: description: > > 🚧 Beta > This is a Beta object. It is not used in production at this time. Feedback from the community is welcome. Any breaking changes will be pre-announced. Issuer evidence for network dispute filing. Which nested fields are required depends on `reason_code` and the card network (Visa or Mastercard) of the disputed transaction. Some reason codes also require a dispute document with a specific category before filing — see `dispute_document_category`. **Mastercard** | Reason code | Required evidence | | --- | --- | | `GOODS_OR_SERVICES_NOT_PROVIDED` | `merchant_contact` | | `DEFECTIVE_GOODS_OR_SERVICES` | `merchant_contact` | | `DISPUTE_OF_RECURRING_TRANSACTION` | `merchant_contact` | | `CREDIT_NOT_RECEIVED` | `merchant_contact` | | `TRANSACTION_AMOUNT_DIFFERS` | `amount_correction.amount`, `amount_correction.currency` | | `COUNTERFEIT_GOODS` | `merchant_contact` | | `CANCELED_OR_RETURNED` | `merchant_contact` | **Visa** | Reason code | Required evidence | | --- | --- | | `GOODS_OR_SERVICES_NOT_PROVIDED` | `delivery.expected_date`, `merchant_contact` | | `DEFECTIVE_GOODS_OR_SERVICES` | `delivery.date`, `merchant_contact` | | `DISPUTE_OF_RECURRING_TRANSACTION` | `cancellation.date`, `merchant_contact` | | `CREDIT_NOT_RECEIVED` | `refund.promise_date`, `merchant_contact` | | `TRANSACTION_AMOUNT_DIFFERS` | `amount_correction.amount`, `amount_correction.currency` | | `COUNTERFEIT_GOODS` | `delivery.date`, `merchant_contact` | | `CANCELED_OR_RETURNED` | `delivery.date` or `delivery.expected_date`, `merchant_contact` | properties: amount_correction: $ref: '#/components/schemas/card_dispute_evidence_amount_correction' cancellation: $ref: '#/components/schemas/card_dispute_evidence_cancellation' delivery: $ref: '#/components/schemas/card_dispute_evidence_delivery' merchant_contact: $ref: '#/components/schemas/card_dispute_evidence_merchant_contact' refund: $ref: '#/components/schemas/card_dispute_evidence_refund' type: object card_lifecycle_state: description: > Lifecycle | Description -------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- PENDING_ACTION | The dispute has been created and is pending subsequent action. EVIDENCE_GATHERING | Evidence is being collected before submitting the dispute for evaluation. EVALUATION | The dispute has been submitted for evaluation. MANUAL_REVIEW | The dispute requires manual review. DENIED | The dispute has been denied. WITHDRAWN | The dispute has been withdrawn. REFUNDED | The cardholder has been refunded directly by the merchant through a separate channel. EXPIRED | The dispute has expired. REJECTED | The dispute has been rejected. WRITE_OFF | The dispute has been written off and will not be filed with the card network. CHARGEBACK | A chargeback has been created with the card network. The acquiring bank now has the opportunity to file for re-presentment. If no re-presentment is filed the acquirer assumes financial responsibility and the case is won. NETWORK_REJECTED_CHARGEBACK | The chargeback submission has been rejected by the card network. The chargeback can be optionally resubmitted once the rejection reason has been addressed. NETWORK_REJECTED_CHARGEBACK_REVERSAL | The chargeback reversal has been rejected by the card network. REPRESENTMENT | The acquiring bank has created a re-presentment with the card network. The issuing bank now has the opportunity to file for pre-arbitration. If no pre-arbitration is filed the issuer assumes financial responsibility and the case is lost. PRE_ARBITRATION | A pre-arbitration case has been created with the network. The acquiring bank now has the opportunity to rebut the case with subsequent evidence. If no rebuttal is filed the acquirer assumes financial responsibility and the case is won. PRE_ARBITRATION_RESPONSE | The acquiring bank has rebutted the pre-arbitration case. The issuing bank now has the opportunity to file for arbitration. If no arbitration case is filed the issuer assumes financial responsibility and the case is lost. ARBITRATION | An arbitration case has been created with the card network. The acquiring bank now has the opportunity to rebut the arbitration case with subsequent evidence. ARBITRATION_RESPONSE | The acquiring bank has rebutted the arbitration case. The issuing bank can either withdraw the case or do nothing and the card network will make a decision on who assumes the financial responsibility. enum: - EVIDENCE_GATHERING - EVALUATION - MANUAL_REVIEW - DENIED - WITHDRAWN - REFUNDED - EXPIRED - REJECTED - PENDING_ACTION - WRITE_OFF - CHARGEBACK - NETWORK_REJECTED_CHARGEBACK - NETWORK_REJECTED_CHARGEBACK_REVERSAL - REPRESENTMENT - PRE_ARBITRATION - PRE_ARBITRATION_RESPONSE - ARBITRATION - ARBITRATION_RESPONSE type: string card_dispute_managed_by: description: > Managed By | Description ----------------|------------------------------------------------------------ CUSTOMER | The dispute is managed by the customer. GROUND_CONTROL | The dispute is managed by Synctera Ground Control. AUTO_WRITE_OFF | The dispute is managed by the automatic write-off workflow. enum: - CUSTOMER - GROUND_CONTROL - AUTO_WRITE_OFF type: string card_network_eligibility: description: Network eligibility restrictions. properties: is_digital_wallet_token: description: Transaction was processed using a digital wallet token. type: boolean is_network_eligibility_overridden: description: Network eligibility restrictions have been overridden. type: boolean is_three_ds: description: Transaction was authenticated with 3DS. type: boolean required: - is_digital_wallet_token - is_three_ds - is_network_eligibility_overridden type: object card_dispute_reason_codes: description: > Deprecated reason codes are accepted for backwards compatibility and mapped to their active equivalent. Which codes are active depends on the dispute management version. See the [Version 2 rollout](https://docs.synctera.com/v2/docs/card-transaction-disputes#version-2-rollout) for dates, which flow to follow, and a link to the Version 1 guide. ### Version 2 | Reason Code | Status | Description | Mapped To | | -------------------------------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- | | AUTHORIZATION_RELATED_CHARGEBACK | Active | The merchant did not have a valid authorization for the transaction. Not used for fraud cases where the cardholder did not participate. | | | CARDHOLDER_DISPUTE | Active | The dispute reason does not fit any of the other categories. | | | ATM_CASH_DISPUTE | Active | Some or all of the funds debited from the cardholder's account were not dispensed by an ATM or point of sale terminal. | | | COUNTERFEIT_GOODS | Active | The cardholder claims that the goods were purported to be genuine, but were counterfeit. | | | CREDIT_NOT_RECEIVED | Active | The cardholder never received a refund. | | | DEFECTIVE_GOODS_OR_SERVICES | Active | Goods or services were not as described or unacceptable. | | | DISPUTE_OF_RECURRING_TRANSACTION | Active | The cardholder notified the merchant to cancel the recurring transaction and the merchant continued to bill the cardholder or the cardholder was not aware they were agreeing to a recurring transaction. | | | DUPLICATE_TRANSACTION | Active | The cardholder was charged more than once, or paid by another means and was also charged on their card. | | | GOODS_OR_SERVICES_NOT_PROVIDED | Active | The cardholder has been debited for goods or services that were to be shipped, delivered or otherwise provided and were not received by the expected delivery date. | | | TRANSACTION_AMOUNT_DIFFERS | Active | The amount of the transaction does not match the agreed-upon or expected amount. | | | UNAUTHORIZED_TRANSACTION | Active | A fraud claim: the cardholder does not recognize the transaction and asserts that they did not participate in it. | | | CANCELED_OR_RETURNED | Active | The cardholder canceled services or returned merchandise but was not credited. | | | NO_CARDHOLDER_AUTHORIZATION | Deprecated | A fraudulent transaction was made without the cardholder's consent. | AUTHORIZATION_RELATED_CHARGEBACK | | QUESTIONABLE_MERCHANT_ACTIVITY | Deprecated | The merchant is suspected of being involved in fraudulent activities or violating Mastercard rules. | UNAUTHORIZED_TRANSACTION | | CHIP_LIABILITY_SHIFT | Deprecated | A counterfeit card was used at a non-EMV-compliant terminal, and the merchant is held liable for the fraudulent transaction. | UNAUTHORIZED_TRANSACTION | | CHIP_PIN_LIABILITY_SHIFT | Deprecated | A lost or stolen chip card was used without PIN verification at a terminal that supports PIN, resulting in merchant liability for the fraudulent transaction. | UNAUTHORIZED_TRANSACTION | | POINT_OF_INTERACTION_ERROR | Deprecated | Processing errors such as ATM withdrawal discrepancies, duplicate transactions, late presentments, and amount discrepancies. | DUPLICATE_TRANSACTION | | CARD_LOST_STOLEN_NEVER_RECEIVED | Deprecated | The cardholder did not authorize the transaction and the card is no longer, or had never been, in the possession of the cardholder. | UNAUTHORIZED_TRANSACTION | | FRAUDULENT_PROCESSING | Deprecated | The cardholder is in possession and control of all valid cards, processed at least one legitimate face-to-face transaction, and denies making one or more additional face-to-face transactions at the same merchant location. | UNAUTHORIZED_TRANSACTION | | LATE_PRESENTMENT | Deprecated | The transaction was authorized offline by the chip and submitted for clearing more than 7 calendar days after the transaction date. | AUTHORIZATION_RELATED_CHARGEBACK | | PAID_BY_OTHER_MEANS | Deprecated | The cardholder used a different form of payment for this specific transaction. (Mastercard pre-compliance/compliance only) | DUPLICATE_TRANSACTION | | TRANSACTION_DID_NOT_COMPLETE | Deprecated | The cardholder engaged in the transaction and claims it did not complete. Goods or services were not provided. | GOODS_OR_SERVICES_NOT_PROVIDED | | TRANSACTION_NOT_RECOGNIZED | Deprecated | The account holder does not recognize the transaction, possibly due to mistake or fraud. | UNAUTHORIZED_TRANSACTION | ### Version 1 | Reason Code | Status | Description | Mapped To | | -------------------------------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- | | NO_CARDHOLDER_AUTHORIZATION | Active | A fraudulent transaction was made without the cardholder's consent. | | | QUESTIONABLE_MERCHANT_ACTIVITY | Active | The merchant is suspected of being involved in fraudulent activities or violating Mastercard rules. | | | CHIP_LIABILITY_SHIFT | Active | A counterfeit card was used at a non-EMV-compliant terminal, and the merchant is held liable for the fraudulent transaction. | | | CHIP_PIN_LIABILITY_SHIFT | Active | A lost or stolen chip card was used without PIN verification at a terminal that supports PIN, resulting in merchant liability for the fraudulent transaction. | | | AUTHORIZATION_RELATED_CHARGEBACK | Active | A transaction was processed without obtaining proper authorization. | | | POINT_OF_INTERACTION_ERROR | Active | Processing errors such as ATM withdrawal discrepancies, duplicate transactions, late presentments, and amount discrepancies. | | | CARDHOLDER_DISPUTE | Active | Claims for goods and services not received, counterfeit products, recurring transactions, incomplete transactions, hotel no-show charges, and more. | | | ATM_CASH_DISPUTE | Deprecated | Some or all funds debited from the cardholder's account as the result of an ATM withdrawal were not dispensed. | CARDHOLDER_DISPUTE | | CARD_LOST_STOLEN_NEVER_RECEIVED | Deprecated | The cardholder did not authorize the transaction and the card is no longer, or had never been, in the possession of the cardholder. | CHIP_PIN_LIABILITY_SHIFT | | COUNTERFEIT_GOODS | Deprecated | The cardholder claims that the goods were purported to be genuine, but were counterfeit. | CARDHOLDER_DISPUTE | | CREDIT_NOT_RECEIVED | Deprecated | The cardholder's account was not credited for a refund from a merchant or was inaccurately debited instead of credited. | CARDHOLDER_DISPUTE | | DEFECTIVE_GOODS_OR_SERVICES | Deprecated | Goods or services were either not as described or defective, including shipped merchandise was received damaged or not suitable for its intended purpose as well as the merchant didn't honour the terms and conditions of a contract. | CARDHOLDER_DISPUTE | | DISPUTE_OF_RECURRING_TRANSACTION | Deprecated | The cardholder notified the merchant to cancel the recurring transaction and the merchant continued to bill the cardholder or the cardholder was not aware they were agreeing to a recurring transaction. | CARDHOLDER_DISPUTE | | DUPLICATE_TRANSACTION | Deprecated | The same transaction has been processed more than once, resulting in duplicate charges. | POINT_OF_INTERACTION_ERROR | | FRAUDULENT_PROCESSING | Deprecated | The cardholder is in possession and control of all valid cards, processed at least one legitimate face-to-face transaction, and denies making one or more additional face-to-face transactions at the same merchant location. | NO_CARDHOLDER_AUTHORIZATION | | GOODS_OR_SERVICES_NOT_PROVIDED | Deprecated | The cardholder has been debited for goods or services that were to be shipped, delivered or otherwise provided and were not received by the expected delivery date. | CARDHOLDER_DISPUTE | | LATE_PRESENTMENT | Deprecated | The transaction was authorized offline by the chip and submitted for clearing more than 7 calendar days after the transaction date. | POINT_OF_INTERACTION_ERROR | | PAID_BY_OTHER_MEANS | Deprecated | The cardholder used a different form of payment for this specific transaction. (Mastercard pre-compliance/compliance only) | POINT_OF_INTERACTION_ERROR | | TRANSACTION_AMOUNT_DIFFERS | Deprecated | The amount of the transaction does not match the agreed-upon or expected amount. | POINT_OF_INTERACTION_ERROR | | TRANSACTION_DID_NOT_COMPLETE | Deprecated | The cardholder engaged in the transaction and claims it did not complete. Goods or services were not provided. | CARDHOLDER_DISPUTE | | TRANSACTION_NOT_RECOGNIZED | Deprecated | The account holder does not recognize the transaction, possibly due to mistake or fraud. | AUTHORIZATION_RELATED_CHARGEBACK | | UNAUTHORIZED_TRANSACTION | Deprecated | The transaction was not authorized by the account holder. | AUTHORIZATION_RELATED_CHARGEBACK | enum: - CARD_LOST_STOLEN_NEVER_RECEIVED - FRAUDULENT_PROCESSING - LATE_PRESENTMENT - PAID_BY_OTHER_MEANS - TRANSACTION_DID_NOT_COMPLETE - TRANSACTION_NOT_RECOGNIZED - NO_CARDHOLDER_AUTHORIZATION - QUESTIONABLE_MERCHANT_ACTIVITY - CHIP_LIABILITY_SHIFT - CHIP_PIN_LIABILITY_SHIFT - POINT_OF_INTERACTION_ERROR - UNAUTHORIZED_TRANSACTION - AUTHORIZATION_RELATED_CHARGEBACK - GOODS_OR_SERVICES_NOT_PROVIDED - DEFECTIVE_GOODS_OR_SERVICES - CREDIT_NOT_RECEIVED - DISPUTE_OF_RECURRING_TRANSACTION - DUPLICATE_TRANSACTION - TRANSACTION_AMOUNT_DIFFERS - ATM_CASH_DISPUTE - CANCELED_OR_RETURNED - COUNTERFEIT_GOODS - CARDHOLDER_DISPUTE type: string external_card_dispute_action_response: description: Response for an external card dispute action. properties: action: $ref: '#/components/schemas/external_card_action' creation_time: description: The timestamp representing when the object was created example: '2010-05-06T12:23:34.321Z' format: date-time readOnly: true type: string id: description: The unique identifier of the dispute action example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 format: uuid readOnly: true type: string payment_rail: $ref: '#/components/schemas/payment_rail' status: $ref: '#/components/schemas/external_card_dispute_action_status' supporting_doc_id: description: The unique identifier of the supporting document example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 format: uuid readOnly: true type: string tenant: $ref: '#/components/schemas/tenant_id' required: - id - creation_time - tenant - payment_rail - action - status title: External Card Action type: object available_external_card_action: properties: action: $ref: '#/components/schemas/external_card_action' state: $ref: '#/components/schemas/external_card_action_state' timestamp_valid_to: description: | The time by which the action must be taken against the dispute. * Only applicable for time constrained actions. example: '2010-05-06T12:23:34.321Z' format: date-time type: string required: - action - state type: object dispute_debit_status: description: > The status of customer account debit related to the dispute | Status | Description | |-------------|------------------------------------------------------------------------------------------------------| | NONE | The customer account has not been debited or a provisional debit has been reversed and not replaced. | | PROVISIONAL | A provisional debit has been posted to the customer account. | | FINAL | A final debit has been posted to the customer account. | enum: - NONE - PROVISIONAL - FINAL type: string external_card_lifecycle_state: description: > Lifecycle | Description --- | --- PENDING_ACTION | A dispute has been created and is pending subsequent action. CHARGEBACK | A chargeback has been created with the card network. The acquiring bank now has the opportunity to file for re-presentment. If no re-presentment is filed the acquirer assumes financial responsibility and the case is won. REPRESENTMENT | The acquiring bank has created a re-presentment with the card network. The issuing bank now has the opportunity to accept or deline the re-presentment. enum: - PENDING_ACTION - CHARGEBACK - REPRESENTMENT type: string external_card_network_eligibility: description: Network eligibility restrictions. properties: is_digital_wallet_token: description: Transaction was processed using a digital wallet token. type: boolean is_three_ds: description: Transaction was authenticated with 3DS. type: boolean required: - is_digital_wallet_token - is_three_ds type: object external_card_dispute_reason_code: description: > ### Mastercard Reason Code | Description --- | --- WARNING_BULLETIN | Transaction was processed using a card listed in a Mastercard warning bulletin file AUTHORIZATION_RELATED_CHARGEBACK | Transaction was processed without obtaining proper authorization ACCOUNT_NUMBER_NOT_ON_FILE | Account number used in transaction not regonized by cardholder’s bank TRANSACTION_AMOUNT_DIFFERS | Final transaction amount charged differs from expected or agreed upon amount POINT_OF_INTERACTION_ERROR | Processing errors such as ATM withdrawal discrepancies, duplicate transactions, late presentments, and amount discrepancies NO_CARDHOLDER_AUTHORIZATION | Fraudulent transaction made without the cardholder’s consent CANCELED_RECURRING_TRANSACTION | Cardholder billed for a recurring service afer cancellation or digital goods not authorized or received LATE_PRESENTMENT | Merchant submitted transaction for processing too late after original transaction date CORRECT_CURRENCY_CODE_NOT_PROVIDED | Currency conversion not properly presented or agreed upon QUESTIONABLE_MERCHANT_ACTIVITY | Merchant suspected of being involved in fraudulent activities or violating Mastercard rules CARDHOLDER_DISPUTE | Claims for goods and services not received, counterfeit products, recurring transactions, incomplete transactions, hotel no-show charges, and more CARDHOLDER_DISPUTE_NOT_ELSEWHERE_CLASSIFIED | Cardholder dissatisfied with transaction and has been unable to resolve it direclty with merchant (US region only) GOODS_OR_SERVICES_NOT_PROVIDED | Cardholder claims purchased goods or services were not delivered, delivered late, only partially delivered, or merchant failed to provide the agreed-upon service NO_SHOW_ADDENDUM_ATM_DISPUTE | Cardholder charged a penalty for failing to cancel a reservation (e.g. hotel booking), charged an addendum or modification to a service, or did not receive the correct amount of cash from an ATM CREDIT_NOT_PROCESSED | Expected credit or refund not received POTENTIAL_FRAUD | Cardholder does not recognize the transaction and suspects it might be fraudulent CHIP_LIABILITY_SHIFT | Counterfeit card used at a non-EMV-compliant terminal, and merchant is held liable for the fraudulent transaction CHIP_PIN_LIABILITY_SHIFT | Lost or stolen chip card used without PIN verification at a terminal that supports PIN, resulting in merchant liability for the fraudulent transaction DOMESTIC_CHARGEBACK_DISPUTE | Catch-all for transaction disputes within the Europe region ### Visa Reason Code | Description --- | --- EMV_LIABILITY_SHIFT_COUNTERFEIT_FRAUD | Transaction was processed with a counterfeit EMV card at a non-EMV-compliant terminal and the cardholder claims it was unauthorized EMV_LIABILITY_SHIFT_NON_COUNTERFEIT_FRAUD | Cardholder claims their lost or stolen card was used for an unauthorized transaction at a non-EMV-compliant terminal FRAUD_CARD_PRESENT | Cardholder disputes a card-present transaction as fraudulent, but does not involve a counterfeit or lost/stolen card FRAUD_CARD_ABSENT | Cardholder disputes a card-not-present (e.g., online or phone) transaction as unauthorized or fraudulent VISA_FRAUD_MONITORING_PROGRAM | Transaction flagged as part of the Visa Fraud Monitoring Program due to excessive fraud activity CARD_RECOVERY_BULLETIN | Transaction processed despite the card being listed in the Card Recovery Bulletin (a list of compromised cards) DECLINED_AUTHORIZATION | Transaction processed after receiving a declined authorization response from the issuer NO_AUTHORIZATION | Transaction processed without obtaining proper authorization from the issuer LATE_PRESENTMENT | Merchant submitted transaction for processing too late after original transaciton date INCORRECT_TRANSACTION_CODE | Transaction processed with the wrong transaction code (e.g., refund processed as a sale) INCORRECT_CURRENCY | Transaction processed in the incorrect currency INCORRECT_ACCOUNT_NUMBER | Transaction processed using an incorrect or invalid account number INCORRECT_AMOUNT | Transaction processed for an incorrect amount DUPLICATE_PROCESSING | Transaction processed more than once PAID_BY_OTHER_MEANS | Cardholder paid for the same transaction by other means (e.g., cash, check) INVALID_DATA | Transaction contained invalid or incomplete data required for processing SERVICES_NOT_RECEIVED | Cardholder claims the merchandise or services were not received as agreed CANCELED_RECURRING_TRANSACTION | Cardholder charged for a recurring transaction after canceling the service or subscription NOT_AS_DESCRIBED | Merchandise or services received were not as described or were defective COUNTERFEIT_MERCHANDISE | Cardholder claims merchandise received was counterfeit MISREPRESENTATION | Cardholder claims merchant misrepresented the terms or details of the transaction CREDIT_NOT_PROCESSED | Expected credit or refund not received CANCELED_SERVICE | Cardholder charged for merchandise or services that were canceled OCT_NOT_ACCEPTED | Original credit transaction not accepted or processed by the cardholder’s bank NON_RECEIPT_OF_CASH | Cardholder did not receive cash or the value from a load transaction at an ATM or similar device enum: - WARNING_BULLETIN - AUTHORIZATION_RELATED_CHARGEBACK - ACCOUNT_NUMBER_NOT_ON_FILE - TRANSACTION_AMOUNT_DIFFERS - POINT_OF_INTERACTION_ERROR - NO_CARDHOLDER_AUTHORIZATION - CANCELED_RECURRING_TRANSACTION - LATE_PRESENTMENT - CORRECT_CURRENCY_CODE_NOT_PROVIDED - QUESTIONABLE_MERCHANT_ACTIVITY - CARDHOLDER_DISPUTE - CARDHOLDER_DISPUTE_NOT_ELSEWHERE_CLASSIFIED - GOODS_OR_SERVICES_NOT_PROVIDED - NO_SHOW_ADDENDUM_ATM_DISPUTE - CREDIT_NOT_PROCESSED - POTENTIAL_FRAUD - CHIP_LIABILITY_SHIFT - CHIP_PIN_LIABILITY_SHIFT - DOMESTIC_CHARGEBACK_DISPUTE - EMV_LIABILITY_SHIFT_COUNTERFEIT_FRAUD - EMV_LIABILITY_SHIFT_NON_COUNTERFEIT_FRAUD - FRAUD_CARD_PRESENT - FRAUD_CARD_ABSENT - VISA_FRAUD_MONITORING_PROGRAM - CARD_RECOVERY_BULLETIN - DECLINED_AUTHORIZATION - NO_AUTHORIZATION - INCORRECT_TRANSACTION_CODE - INCORRECT_CURRENCY - INCORRECT_ACCOUNT_NUMBER - INCORRECT_AMOUNT - DUPLICATE_PROCESSING - PAID_BY_OTHER_MEANS - INVALID_DATA - SERVICES_NOT_RECEIVED - NOT_AS_DESCRIBED - COUNTERFEIT_MERCHANDISE - MISREPRESENTATION - CANCELED_SERVICE - OCT_NOT_ACCEPTED - NON_RECEIPT_OF_CASH type: string dispute_regulation: enum: - REGULATION_E - REGULATION_Z type: string dispute_document_response: properties: category: $ref: '#/components/schemas/dispute_document_category' creation_time: description: The timestamp representing when the object was created example: '2010-05-06T12:23:34.321Z' format: date-time readOnly: true type: string dispute_id: description: The unique identifier of the dispute example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 format: uuid readOnly: true type: string file_name: example: example.pdf type: string id: description: The unique identifier of a dispute document. format: uuid readOnly: true type: string tenant: $ref: '#/components/schemas/tenant_id' required: - id - creation_time - tenant - dispute_id - file_name type: object dispute_action_by: description: > | action_by | Description | |-----------|--------------------------------------------------------------------------------------------------------| | INITIATOR | The last action was taken by the initiator of the dispute. | | NETWORK | The last action was taken by the network. | enum: - NETWORK - INITIATOR type: string dispute_network: description: The network with which the transaction was disputed. enum: - NONE - ACH - DECISIONLY - MASTERCARD - MARQETA - TABAPAY type: string tenant_id: description: > The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces. example: abcdef_ghijkl type: string ach_action: enum: - STOP_PAYMENT - ACH_RETURN type: string ach_dispute_reason_codes: description: > | Reason Code | Description | |----------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | UNAUTHORIZED_TRANSACTION | A party claims that a transaction was not authorized by the account holder | | INCORRECT_TRANSACTION_AMOUNT | The amount of the ACH transaction does not match the agreed-upon or expected amount. | | DUPLICATE_TRANSACTION | The same transaction is processed more than once, leading to duplicate charges. | | MISTIMED_WITHDRAWAL | The timing of the transaction is not in accordance with the agreed-upon schedule, leading to a dispute. | | TRANSACTION_NOT_RECOGNIZED | The account holder does not recognize the transaction, possibly due to a mistake or fraudulent activity | enum: - UNAUTHORIZED_TRANSACTION - INCORRECT_TRANSACTION_AMOUNT - DUPLICATE_TRANSACTION - MISTIMED_WITHDRAWAL - TRANSACTION_NOT_RECOGNIZED type: string ach_dispute_return_codes: description: > This field is required for dispute action ACH_RETURN. Upon successful dispute resolution this return code will be used when sending the outgoing return. enum: - R05 - R07 - R10 - R29 - R34 - R51 type: string ach_dispute_action_status: description: > | Status | Description | |-----------|-------------------------------------------------------------------------------------------------------------| | SUBMITTED | The action has been submitted | | ACCEPTED | The action has been accepted | | REJECTED | The action has been rejected | | MORE_INFO_REQUIRED | The action contains a directive that more information is required | enum: - SUBMITTED - ACCEPTED - REJECTED - MORE_INFO_REQUIRED type: string ach_action_state: enum: - CREATE - ACCEPT - REJECT - MORE_INFO_REQUIRED type: string card_action: enum: - CHARGEBACK - REPRESENTMENT - PRE_ARBITRATION - ARBITRATION - PROVISIONAL_CREDIT - WRITE_OFF - EVIDENCE_GATHERING - DISPUTE type: string card_dispute_representment_reason_code: description: > Reason Code | Description -----------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------- INVALID_ACQUIRER_REFERENCE_DATA | The combination of primary account number and acquirer reference data on the chargeback does not match the information in the first presentment. NON_RECEIPT_OF_DOCUMENTATION | Required documentation was not received. DOCUMENTATION_INELIGIBLE | Documentation is ineligible to the point where it cannot be established that the chargeback is valid. DOCUMENTATION_SCANNING_ERROR | Documentation is a partial scan with missing information, or relates to another transaction. CORRECT_TRANSACTION_DATE | Chargeback can be remedied by providing the correct transaction date. CORRECT_MERCHANT_LOCATION | Chargeback can be remedied by providing new information in the form of a different merchant name or location. ISSUER_AUTHORIZED | Chargeback can be remedied by providing information that the transaction was properly authorized. CREDIT_PREVIOUSLY_ISSUED | Chargeback can be remedied by providing evidence that the merchant issued a credit to the cardholders account. CHARGEBACK_REMEDIED | Evidence to remedy the chargeback is included in the supporting documentation adn no other message code is applicable. DUPLICATE_CHARGEBACK | A first chargeback has already been processed for the transaction. PAST_CHARGEBACK_TIME_LIMIT | The chargeback was processed past the time limit allowed for chargeback. INVALID_DATA_RECORD_TEXT | Information that is required to appear in the Data Record and the required message text is missing or incomplete. CORRECT_MCC | Chargeback can be remedied by showing that the MCC assigned to the merchant is different from the MCC appearing on the first presentment. AUTHORIZATION_ADVISED_SUSPICIOUS | Transaction meets the requirements for a Suspicious Transaction. NO_AUTHORIZATION_REQUEST_REQUIRED_OR_ATTEMPTED | Transaction was below the applicable floor limit, and the merchant did not request an authorization. ACCOUNT_NOT_LISTED_ON_EWB | The account number was not included in the applicable Electronic Warning Bulletin as of the date the card was first presented to the merchant. INVALID_CHARGEBACK | The chargeback does not meet the prerequisites for the chargeback message reason code. CHIP_LIABILITY_SHIFT | Invoke chip liability shift in response and as final remedy to a first chargeback submitted under reason code 4837. CHIP_PIN_LIABILITY_SHIFT | Invoke chip/pin liability shift in response and as final remedy to a first chargeback submitted under reason code 4837. enum: - INVALID_ACQUIRER_REFERENCE_DATA - NON_RECEIPT_OF_DOCUMENTATION - DOCUMENTATION_INELIGIBLE - DOCUMENTATION_SCANNING_ERROR - CORRECT_TRANSACTION_DATE - CORRECT_MERCHANT_LOCATION - ISSUER_AUTHORIZED - CREDIT_PREVIOUSLY_ISSUED - CHARGEBACK_REMEDIED - DUPLICATE_CHARGEBACK - PAST_CHARGEBACK_TIME_LIMIT - INVALID_DATA_RECORD_TEXT - CORRECT_MCC - AUTHORIZATION_ADVISED_SUSPICIOUS - NO_AUTHORIZATION_REQUEST_REQUIRED_OR_ATTEMPTED - ACCOUNT_NOT_LISTED_ON_EWB - INVALID_CHARGEBACK - CHIP_LIABILITY_SHIFT - CHIP_PIN_LIABILITY_SHIFT type: string card_dispute_action_status: enum: - ACCEPTED - SUBMITTED - COMPLETED - LOST - NETWORK_REJECTED - NETWORK_REJECTED_REVERSAL - REBUTTED - REVERSED - REFUNDED - EXPIRED - REJECTED - WITHDRAWN - WON type: string card_action_state: enum: - ACCEPT - CREATE - COMPLETE - LOST - NETWORK_REJECT - NETWORK_REJECT_REVERSAL - REBUT - REVERSE - REFUND - EXPIRE - REJECT - WITHDRAW - WON type: string card_dispute_evidence_amount_correction: description: | Corrected transaction amount for an incorrect-amount dispute. Required for Visa and Mastercard when `reason_code` is `TRANSACTION_AMOUNT_DIFFERS`. properties: amount: description: Corrected amount in the smallest currency unit (e.g. cents). minimum: 1 type: integer currency: description: ISO 4217 Alpha-3 currency code of the corrected amount. example: USD maxLength: 3 minLength: 3 type: string required: - amount - currency type: object card_dispute_evidence_cancellation: description: Cancellation details for a disputed recurring or canceled transaction. properties: date: description: | Cancellation date. Required for Visa when `reason_code` is `DISPUTE_OF_RECURRING_TRANSACTION`. format: date type: string description: description: Description of the cancellation. maxLength: 2000 type: string id: description: Cancellation reference ID. maxLength: 200 type: string policy_provided: description: Whether a cancellation policy was provided to the cardholder. type: boolean type: object card_dispute_evidence_delivery: description: Delivery details for disputed goods or services. properties: date: description: | Actual delivery date. Required for Visa when `reason_code` is `DEFECTIVE_GOODS_OR_SERVICES` or `COUNTERFEIT_GOODS`. For Visa `CANCELED_OR_RETURNED`, either `date` or `expected_date` is required. format: date type: string expected_date: description: | Expected delivery date. Required for Visa when `reason_code` is `GOODS_OR_SERVICES_NOT_PROVIDED`. For Visa `CANCELED_OR_RETURNED`, either `date` or `expected_date` is required. format: date type: string type: object card_dispute_evidence_merchant_contact: description: > Details of a cardholder attempt to contact the merchant about the disputed transaction. Required when `reason_code` is one of: `GOODS_OR_SERVICES_NOT_PROVIDED`, `DEFECTIVE_GOODS_OR_SERVICES`, `CREDIT_NOT_RECEIVED`, `DISPUTE_OF_RECURRING_TRANSACTION`, `CANCELED_OR_RETURNED`, or `COUNTERFEIT_GOODS`. When required, `was_attempted` must be provided. If `was_attempted` is `true`, `date`, `was_successful`, and `description` must also be provided. properties: date: description: | When the contact attempt occurred. Required when `evidence.merchant_contact` is required and `was_attempted` is `true`. format: date type: string description: description: | Description of the contact attempt. Required when `evidence.merchant_contact` is required and `was_attempted` is `true`. type: string prohibited_reason: description: Reason contact was prohibited, if applicable. type: string was_attempted: description: | Whether contact with the merchant was attempted. Required whenever `evidence.merchant_contact` is required for the `reason_code`. type: boolean was_successful: description: | Whether the merchant was available and responsive. Required when `evidence.merchant_contact` is required and `was_attempted` is `true`. type: boolean type: object card_dispute_evidence_refund: description: Refund details for a disputed credit-not-processed transaction. properties: description: description: Description of the refund promise or outcome. maxLength: 2000 type: string policy_provided: description: Whether a refund policy was provided to the cardholder. type: boolean promise_date: description: | Date the merchant promised a refund. Required for Visa when `reason_code` is `CREDIT_NOT_RECEIVED`. format: date type: string was_promised: description: Whether the merchant promised a refund. type: boolean type: object external_card_action: enum: - CHARGEBACK - REPRESENTMENT - PROVISIONAL_DEBIT type: string external_card_dispute_action_status: enum: - SUBMITTED - ACCEPTED - DECLINED - REVERSED type: string external_card_action_state: enum: - ACCEPT - CREATE - DECLINE - REVERSE type: string dispute_document_category: description: > Category of the supporting document. | Category | Description | | --- | --- | | `TRANSACTION_RECEIPT` | Receipt for the disputed transaction showing the correct amount | | `PRIOR_TRANSACTION_RECEIPT` | Receipt from a prior related transaction (for example the original valid charge in a duplicate-charge dispute) | | `MERCHANT_CORRESPONDENCE` | Correspondence with the merchant about the dispute | | `COUNTERFEIT_EVIDENCE` | Evidence that goods were counterfeit (for example a photo of the item or third-party verification) | | `REFUND_PROMISE` | Proof of credit due (credit transaction receipt, voided transaction receipt, or other proof of a promised refund) | | `OTHER` | Other supporting documentation (for example a bank statement, cleared check, or cash receipt) | Some card reason codes require at least one dispute document with a specific category before the case can be filed with the network. Which category is required depends on `reason_code` and the card network (Visa or Mastercard) of the disputed transaction: **Mastercard** | Reason code | Required document category | | --- | --- | | `TRANSACTION_AMOUNT_DIFFERS` | `TRANSACTION_RECEIPT` | **Visa** | Reason code | Required document category | | --- | --- | | `CREDIT_NOT_RECEIVED` | `REFUND_PROMISE` | | `TRANSACTION_AMOUNT_DIFFERS` | `TRANSACTION_RECEIPT` | | `COUNTERFEIT_GOODS` | `COUNTERFEIT_EVIDENCE` | Reason codes not listed here do not require a specific document category. `category` remains optional on upload for those disputes. enum: - TRANSACTION_RECEIPT - PRIOR_TRANSACTION_RECEIPT - MERCHANT_CORRESPONDENCE - COUNTERFEIT_EVIDENCE - REFUND_PROMISE - OTHER type: string responses: unauthorized: content: application/problem+json: schema: $ref: '#/components/schemas/error' description: Unauthorized forbidden: content: application/problem+json: schema: $ref: '#/components/schemas/error' description: Forbidden error internal_server_error: content: application/problem+json: schema: $ref: '#/components/schemas/error' description: Internal server error securitySchemes: bearerAuth: bearerFormat: api_key scheme: bearer type: http ````