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: Request to create and manage statements name: Statements - 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: 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: 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: 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: 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: Create and manage Synctera Pay templates name: SyncteraPay - description: Apple Pay APIs name: Apple Pay - 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 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: 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 payment_schedules name: Cronut - description: Create and manage EFT Canada transfers name: EFT Canada (Beta) - description: FDX authentication and data transfer using Plaid Core Exchange name: Plaid Core Exchange (beta) - 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: 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: Requests to create and manage webhooks name: Webhooks - description: Create and manage documents. name: Documents paths: /disputes/{dispute_id}/actions: post: tags: - Disputes summary: Create a dispute action description: | Create an action on a disputed transaction operationId: createAction parameters: - $ref: '#/components/parameters/idempotency_key' - $ref: '#/components/parameters/dispute_id' requestBody: content: application/json: schema: $ref: '#/components/schemas/dispute_action_request' description: Details of the dispute action required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/dispute_action_response' description: Successfully created dispute action '400': $ref: '#/components/responses/bad_request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/unprocessable_entity' '500': $ref: '#/components/responses/internal_server_error' components: parameters: idempotency_key: description: >- An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry. in: header name: Idempotency-Key schema: example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 type: string dispute_id: in: path name: dispute_id required: true schema: $ref: '#/components/schemas/dispute_id' schemas: dispute_action_request: discriminator: mapping: ACH: $ref: '#/components/schemas/ach_dispute_action' CARD: $ref: '#/components/schemas/card_dispute_action' EXTERNAL_CARD: $ref: '#/components/schemas/external_card_dispute_action' propertyName: payment_rail oneOf: - $ref: '#/components/schemas/card_dispute_action' - $ref: '#/components/schemas/ach_dispute_action' - $ref: '#/components/schemas/external_card_dispute_action' type: object dispute_action_response: discriminator: mapping: ACH: $ref: '#/components/schemas/ach_dispute_action_response' CARD: $ref: '#/components/schemas/card_dispute_action_response' EXTERNAL_CARD: $ref: '#/components/schemas/external_card_dispute_action_response' propertyName: payment_rail oneOf: - $ref: '#/components/schemas/card_dispute_action_response' - $ref: '#/components/schemas/ach_dispute_action_response' - $ref: '#/components/schemas/external_card_dispute_action_response' type: object dispute_id: description: The unique identifier of the dispute example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 format: uuid type: string ach_dispute_action: description: Create an action against a disputed ACH transaction properties: action: $ref: '#/components/schemas/ach_action' message: description: | Message text related to ACH dispute action * Max length for debit transactions is 38 characters 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' state: $ref: '#/components/schemas/ach_action_state' supporting_doc_id: description: The unique identifier of the supporting document example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 format: uuid type: string required: - payment_rail - action - state title: ACH Action type: object card_dispute_action: description: Create an action against a disputed card transaction properties: action: $ref: '#/components/schemas/card_action' amount: description: > Optional amount for the action in cents. If not provided, defaults to the dispute amount. Amount is only applicable when creating actions (state: `CREATE`) and is only supported for specific action types (see table below); amounts provided for other action types or states will be ignored. | Action Type | Maximum Allowed Amount | | -------------------- | --------------------------------------- | | `CHARGEBACK` | Eligible chargeback amount from network | | `PROVISIONAL_CREDIT` | Dispute amount | | `WRITE_OFF` | Dispute amount | format: int64 minimum: 0 type: integer memo: description: | Memo text related to card dispute action * Required for PRE_ARBITRATION, ARBITRATION maxLength: 1000 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/card_dispute_reason_codes' state: $ref: '#/components/schemas/card_action_state' supporting_doc_id: description: The unique identifier of the supporting document example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 format: uuid type: string updated_reason_code_memo: description: | Memo text describing the reason for updating a reason code. * Required for PRE_ARBITRATION and ARBITRATION if a reason code is provided in the request. If no reason code is present in the request, the original CHARGEBACK reason code will be used. maxLength: 1000 type: string required: - payment_rail - action - state title: Card Action type: object external_card_dispute_action: description: Create an action against a disputed external card transaction properties: action: $ref: '#/components/schemas/external_card_action' payment_rail: $ref: '#/components/schemas/payment_rail' state: $ref: '#/components/schemas/external_card_action_state' supporting_doc_id: description: | The unique identifier of the supporting document * Required for `REPRESENTMENT.CREATE` example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 format: uuid type: string required: - payment_rail - action - state title: External Card Action 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 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 maxLength: 1000 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/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. maxLength: 1000 type: string required: - id - creation_time - tenant - payment_rail - action - status title: Card Action type: object 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 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_action: enum: - STOP_PAYMENT - ACH_RETURN type: string payment_rail: description: | A short string representing the payment rail of the dispute. enum: - CARD - EXTERNAL_CARD - ACH 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_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_reason_codes: description: > * NOTE: deprecated reason codes are accepted for backwards compatibility but will be mapped to their active equivalent reason codes by the API. | Reason Code | Status | Category | Mastercard Code | Documentation Required | Description | | -------------------------------- | ---------- | -------------------------- | --------------- | ---------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | NO_CARDHOLDER_AUTHORIZATION | Active | Fraud | 4837 | No | A fraudulent transaction was made without the cardholder's consent. | | QUESTIONABLE_MERCHANT_ACTIVITY | Active | Fraud | 4849 | No | The merchant is suspected of being involved in fraudulent activities or violating Mastercard rules. | | CHIP_LIABILITY_SHIFT | Active | Fraud | 4870 | No | 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 | Fraud | 4871 | No | 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 | Authorization | 4808 | No | A transaction was processed without obtaining proper authorization. | | POINT_OF_INTERACTION_ERROR | Active | Point-of-Interaction Error | 4834 | Yes | Processing errors such as ATM withdrawal discrepancies, duplicate transactions, late presentments, and amount discrepancies. | | CARDHOLDER_DISPUTE | Active | Cardholder Dispute | 4853 | Yes | Claims for goods and services not received, counterfeit products, recurring transactions, incomplete transactions, hotel no-show charges, and more. | | ATM_CASH_DISPUTE | Deprecated | N/A | N/A | N/A | Some or all funds debited from the cardholder's account as the result of an ATM withdrawal were not dispensed. | | CARD_LOST_STOLEN_NEVER_RECEIVED | Deprecated | N/A | N/A | N/A | The cardholder did not authorize the transaction and the card is no longer, or had never been, in the possession of the cardholder. | | COUNTERFEIT_GOODS | Deprecated | N/A | N/A | N/A | The cardholder claims that the goods were purported to be genuine, but were counterfeit. | | CREDIT_NOT_RECEIVED | Deprecated | N/A | N/A | N/A | The cardholder's account was not credited for a refund from a merchant or was inaccurately debited instead of credited. | | DEFECTIVE_GOODS_OR_SERVICES | Deprecated | N/A | N/A | N/A | 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. | | DISPUTE_OF_RECURRING_TRANSACTION | Deprecated | N/A | N/A | N/A | 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 | Deprecated | N/A | N/A | N/A | The same transaction has been processed more than once, resulting in duplicate charges. | | FRAUDULENT_PROCESSING | Deprecated | N/A | N/A | N/A | 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. | | GOODS_OR_SERVICES_NOT_PROVIDED | Deprecated | N/A | N/A | N/A | 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. | | LATE_PRESENTMENT | Deprecated | N/A | N/A | N/A | The transaction was authorized offline by the chip and submitted for clearing more than 7 calendar days after the transaction date. | | PAID_BY_OTHER_MEANS | Deprecated | N/A | N/A | N/A | The cardholder used a different form of payment for this specific transaction. (Mastercard pre-compliance/compliance only) | | TRANSACTION_AMOUNT_DIFFERS | Deprecated | N/A | N/A | N/A | The amount of the transaction does not match the agreed-upon or expected amount. | | TRANSACTION_DID_NOT_COMPLETE | Deprecated | N/A | N/A | N/A | The cardholder engaged in the transaction and claims it did not complete. Goods or services were not provided. | | TRANSACTION_NOT_RECOGNIZED | Deprecated | N/A | N/A | N/A | The account holder does not recognize the transaction, possibly due to mistake or fraud. | | UNAUTHORIZED_TRANSACTION | Deprecated | N/A | N/A | N/A | The transaction was not authorized by the account holder. | 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 card_action_state: enum: - ACCEPT - CREATE - COMPLETE - LOST - NETWORK_REJECT - NETWORK_REJECT_REVERSAL - REBUT - REVERSE - REFUND - EXPIRE - REJECT - WITHDRAW - WON type: string external_card_action: enum: - CHARGEBACK - REPRESENTMENT - PROVISIONAL_DEBIT type: string external_card_action_state: enum: - ACCEPT - CREATE - DECLINE - REVERSE 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 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 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 external_card_dispute_action_status: enum: - SUBMITTED - ACCEPTED - DECLINED - REVERSED type: string responses: bad_request: content: application/problem+json: schema: $ref: '#/components/schemas/error' description: BadRequest 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 unprocessable_entity: content: application/problem+json: schema: $ref: '#/components/schemas/error' description: Unprocessable entity request response 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 ````