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: /payment_schedules/payments: summary: PaymentSchedules get: tags: - PaymentSchedules summary: List payments description: Get paginated list of payments operationId: listPayments parameters: - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/page_token' - $ref: '#/components/parameters/id_query' - $ref: '#/components/parameters/payment_schedule_id_query' - $ref: '#/components/parameters/account_id_query' - $ref: '#/components/parameters/customer_id_query' responses: '200': content: application/json: schema: $ref: '#/components/schemas/payment_list' description: List of payment schedules '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '500': $ref: '#/components/responses/internal_server_error' components: parameters: 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 id_query: description: IDs. Multiple IDs can be provided as a comma-separated list. explode: false in: query name: id schema: example: >- 64438afd-fa20-4010-a573-2bbdca77cdb6,84ef251c-ab8f-47a5-bbfd-a16648f95157 items: format: uuid type: string type: array style: form payment_schedule_id_query: description: >- Payment schedule IDs. Multiple IDs can be provided as a comma-separated list. explode: false in: query name: schedule_id schema: example: >- 64438afd-fa20-4010-a573-2bbdca77cdb6,84ef251c-ab8f-47a5-bbfd-a16648f95157 items: format: uuid type: string type: array style: form account_id_query: description: >- Originating account IDs. Multiple IDs can be provided as a comma-separated list. explode: false in: query name: account_id schema: example: >- 64438afd-fa20-4010-a573-2bbdca77cdb6,84ef251c-ab8f-47a5-bbfd-a16648f95157 items: format: uuid type: string type: array style: form customer_id_query: description: >- The IDs of customers who created the payment schedules. Multiple IDs can be provided as a comma-separated list. explode: false in: query name: customer_id schema: example: >- 64438afd-fa20-4010-a573-2bbdca77cdb6,84ef251c-ab8f-47a5-bbfd-a16648f95157 items: format: uuid type: string type: array style: form schemas: payment_list: allOf: - properties: payments: description: Array of payments items: $ref: '#/components/schemas/payment' type: array required: - payments type: object - $ref: '#/components/schemas/paginated_response' payment: description: Executed payment properties: description: description: User provided description for the payment schedule type: string error_details: $ref: '#/components/schemas/payment_error_details' id: description: Payment ID format: uuid type: string metadata: description: User provided JSON format data for the payment schedule type: object payment_date: $ref: '#/components/schemas/payment_date' payment_instruction: $ref: '#/components/schemas/payment_instruction' payment_schedule_id: description: ID of the payment schedule that executed this payment format: uuid type: string status: $ref: '#/components/schemas/payment_status' transaction_id: description: Transaction ID. It will be included only when status is COMPLETED format: uuid type: string 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 payment_error_details: description: Payment error details. It will be included only when status is ERROR properties: code: type: string details: type: string type: object payment_date: properties: execution_date: description: Execution date for the next payment format: date type: string scheduled_date: description: Scheduled date for the next payment format: date type: string readOnly: true required: - scheduled_date - execution_date type: object payment_instruction: discriminator: mapping: ACH: $ref: '#/components/schemas/ach_instruction' INTERNAL_TRANSFER: $ref: '#/components/schemas/internal_transfer_instruction' propertyName: type oneOf: - $ref: '#/components/schemas/ach_instruction' - $ref: '#/components/schemas/internal_transfer_instruction' payment_status: description: Payment request status enum: - COMPLETED - ERROR type: string ach_instruction: properties: request: $ref: '#/components/schemas/outgoing_ach_request' type: enum: - ACH type: string required: - type - request type: object internal_transfer_instruction: properties: request: $ref: '#/components/schemas/internal_transfer' type: enum: - INTERNAL_TRANSFER type: string required: - type - request type: object outgoing_ach_request: description: Send an ACH properties: amount: description: Amount to transfer in ISO 4217 minor currency units example: 607 maximum: 9999999999 minimum: 1 type: integer company_entry_description: description: >- Company Entry Description field in ACH batch header. Originator inserts this field's value to provide the Receiver with a description of the entry's purpose. NACHA Operating Rules dictate that Payroll or E-Commerce Purchase ACH transactions require setting this field to PAYROLL or PURCHASE respectively. Only ASCII-printable characters (0x20-0x7E) are accepted. Non-ASCII characters will be stripped; the request will be rejected if no ASCII characters remain. example: PAYROLL maxLength: 10 nullable: true type: string company_name: description: >- Overrides the 'Company Name' field in ACH batch header, which otherwise defaults to the configured partner name. The provided name will be prepended with the Bank's configured prefix and a *. It will then be truncated to 16 characters. Only ASCII-printable characters (0x20-0x7E) are accepted. Non-ASCII characters will be stripped; the request will be rejected if no ASCII characters remain. example: Asdf Finance maxLength: 16 type: string currency: description: ISO 4217 alphabetic currency code of the transfer amount example: USD type: string customer_id: description: The customer's unique identifier example: b01db9c7-78f2-4a99-8aca-1231d32f9b96 format: uuid type: string dc_sign: description: >- The type of transaction (debit or credit). A debit is a transfer in and a credit is a transfer out of the originating account enum: - debit - credit example: debit type: string effective_date: description: >- Effective date transaction proccesses (is_same_day needs to be false or not present at all) example: '2022-03-18' format: date nullable: true type: string external_data: description: Additional transfer metadata structured as key-value pairs nullable: true type: object final_customer_id: description: >- ID of the international customer that receives the final remittance transfer (required for OFAC enabled payments) format: uuid nullable: true type: string hold: $ref: '#/components/schemas/ach_request_hold_data' is_same_day: description: >- Send as same day ACH transaction (use only is_same_day without specific effective_date) nullable: true type: boolean memo: description: Memo for the payment nullable: true type: string originating_account_id: description: The unique identifier for an originating account example: b01db9c7-78f2-4a99-8aca-1231d32f9b96 format: uuid type: string receiving_account_id: description: The unique identifier for an receiving account example: b01db9c7-78f2-4a99-8aca-1231d32f9b96 format: uuid type: string reference_info: description: >- Will be sent to the ACH network and maps to Addenda record 05 - the recipient bank will receive this info. Only ASCII-printable characters (0x20-0x7E) are accepted. Non-ASCII characters will be stripped; the request will be rejected if no ASCII characters remain. example: Tempore atque et cum. nullable: true type: string risk: $ref: '#/components/schemas/risk_data' sec_code: default: WEB description: >- Standard Entry Class Code: * WEB: Internet initiated / Mobile Entry (default if empty) * CCD: Corporate Credit or Debit * PPD: Pre-arranged Payment or Deposit (only deposits currently supported) enum: - WEB - CCD - PPD type: string required: - customer_id - amount - currency - receiving_account_id - dc_sign - originating_account_id title: Send ACH requests type: object internal_transfer: example: amount: 1025 currency: USD originating_account_id: 7d943c51-e4ff-4e57-9558-08cab6b963c7 receiving_account_id: 7d943c51-e4ff-4e57-9558-08cab6b963c7 type: ACCOUNT_TO_ACCOUNT properties: amount: description: >- The amount (in cents) to transfer from originating account to receiving account. format: int64 minimum: 1 type: integer capture_mode: default: IMMEDIATE description: >- Controls when the transfer will take effect. A value of `IMMEDIATE` (the default) means that the transfer will be completed immediately. A value of `MANUAL` means that the transaction will remain in a "pending" state until explicitly completed or cancelled (or the auth expires). enum: - IMMEDIATE - MANUAL type: string currency: description: ISO 4217 alphabetic currency code of the transfer amount example: USD type: string expires_at: description: >- When `capture_mode` is `MANUAL`, this field describes when the pending transaction should expire. format: date-time type: string final_customer_id: description: >- The customer id of the international customer that receives the final remittance transfer (required for remittance payments). format: uuid type: string memo: description: A short note to the recipient type: string metadata: description: Arbitrary key-value metadata to associate with the transaction type: object originating_account_alias: description: >- An alias representing a GL account to debit. This is alternative to specifying by account id example: ach_suspense type: string originating_account_customer_id: description: The customer id of the owner of the originating account. format: uuid type: string originating_account_id: description: The UUID of the account being debited format: uuid type: string receiving_account_alias: description: >- An alias representing a GL account to credit. This is an alternative to specifying by account id example: ach_suspense type: string receiving_account_customer_id: description: The customer id of the owner of the receiving account. format: uuid type: string receiving_account_id: description: The UUID of the account being credited format: uuid type: string reference_id: description: Network reference id maxLength: 128 type: string tenant: $ref: '#/components/schemas/tenant_id' type: description: The desired transaction type to use for this transfer enum: - ACCOUNT_BALANCE_ADJUSTMENT - ACCOUNT_TO_ACCOUNT - ACCOUNT_TO_ACCOUNT_SWEEP - ACH_CREDIT_SWEEP - ACH_DEBIT_SWEEP - ACH_FLOAT_TRANSFER - ACH_INCOMING_CREDIT_SWEEP - ACH_INCOMING_DEBIT_SWEEP - ACH_INCOMING_RETURN_CREDIT_SWEEP - ACH_INCOMING_RETURN_DEBIT_SWEEP - ACH_OUTGOING_CREDIT_SWEEP - ACH_OUTGOING_DEBIT_SWEEP - ACH_OUTGOING_RETURN_CREDIT_SWEEP - ACH_OUTGOING_RETURN_DEBIT_SWEEP - ACH_SWEEP - BULK_DOMESTIC_WIRE_OUTGOING_SWEEP - BULK_EFT_CA_OUTGOING_DEBIT_SWEEP - BULK_EFT_CA_OUTGOING_CREDIT_SWEEP - CARD_CHARGEBACK - CARD_CHARGEBACK_WRITEOFF - CARD_PROVISIONAL_CREDIT - CASH_DEPOSIT_KIOSK - CASH_DEPOSIT_KIOSK_REVERSAL - CASHBACK - CASHBACK_SWEEP - CHECK_DEPOSIT_KIOSK - CHECK_DEPOSIT_KIOSK_GOV - CHECK_DEPOSIT_KIOSK_GOV_REVERSAL - CHECK_DEPOSIT_KIOSK_PAYROLL - CHECK_DEPOSIT_KIOSK_PAYROLL_REVERSAL - CHECK_DEPOSIT_KIOSK_REVERSAL - CHECK_DEPOSIT_MOBILE - CHECK_DEPOSIT_MOBILE_REVERSAL - CREDIT_MEMO - DOMESTIC_WIRE_INCOMING_SWEEP - DOMESTIC_WIRE_INCOMING_RETURN_SWEEP - DOMESTIC_WIRE_OUTGOING_SWEEP - DOMESTIC_WIRE_OUTGOING_RETURN_SWEEP - DOMESTIC_MONEY_TRANSFER_ATM_WITHDRAWAL - DOMESTIC_MONEY_TRANSFER_ATM_WITHDRAWAL_REVERSAL - DOMESTIC_MONEY_TRANSFER_BANK_DEPOSIT - DOMESTIC_MONEY_TRANSFER_BANK_DEPOSIT_REVERSAL - DOMESTIC_MONEY_TRANSFER_CASH_PICKUP - DOMESTIC_MONEY_TRANSFER_CASH_PICKUP_REVERSAL - DOMESTIC_MONEY_TRANSFER_HOME_DELIVERY - DOMESTIC_MONEY_TRANSFER_HOME_DELIVERY_REVERSAL - DOMESTIC_MONEY_TRANSFER_MOBILE_WALLET - DOMESTIC_MONEY_TRANSFER_MOBILE_WALLET_REVERSAL - EFT_CA_INCOMING_CREDIT_SWEEP - EFT_CA_INCOMING_CREDIT_RETURN_SWEEP - EFT_CA_INCOMING_DEBIT_SWEEP - EFT_CA_INCOMING_DEBIT_RETURN_SWEEP - EFT_CA_OUTGOING_CREDIT_SWEEP - EFT_CA_OUTGOING_CREDIT_RETURN_SWEEP - EFT_CA_OUTGOING_DEBIT_SWEEP - EFT_CA_OUTGOING_DEBIT_RETURN_SWEEP - ETRANSFER_SWEEP - FEE - FEE_REVERSAL - FEE_SWEEP - FORCE_PAYMENT - INCOMING_WIRE - INCOMING_WIRE_SWEEP - IN_STORE_CASH_DEPOSIT_SWEEP - IN_STORE_CASH_DEPOSIT_SWEEP_REVERSAL - INTEREST_CHARGED_SWEEP - INTEREST_CORRECTION - INTEREST_PAYOUT - INTEREST_PAYOUT_SWEEP - INTERNATIONAL_WIRE_OUTGOING_SWEEP - INTERNATIONAL_WIRE_OUTGOING_RETURN_SWEEP - INTERNATIONAL_WIRE_INCOMING_SWEEP - INVOICE - LOAN_DISBURSEMENT - LOAN_FUNDING - MANUAL_ADJUSTMENT - MANUAL_ADJUSTMENT_REVERSAL - MANUAL_ADJUSTMENT_SWEEP - MANUAL_AFT_SWEEP - MANUAL_CARD_SWEEP - MANUAL_CASH_DEPOSIT_SWEEP - MANUAL_CASH_ORDER_SWEEP - MANUAL_CHECK_SWEEP - MANUAL_CHECK_ISSUANCE - MANUAL_OCT_SWEEP - MANUAL_WIRE_SWEEP - MARKETPLACE_BILL_PAY - MARKETPLACE_BILL_PAY_REVERSAL - MARKETPLACE_EVENT_TICKETS - MARKETPLACE_EVENT_TICKETS_REVERSAL - MARKETPLACE_GIFT_CARD - MARKETPLACE_GIFT_CARD_REVERSAL - MARKETPLACE_MOBILE_TOP_UP - MARKETPLACE_MOBILE_TOP_UP_REVERSAL - MASTERCARD_GROSS_SWEEP - MASTERCARD_INTERCHANGE_SWEEP - MASTERCARD_NET_SWEEP - MISC_CREDIT - MOBILE_DEPOSIT_SWEEP - MOBILE_DEPOSIT_RETURN_SWEEP - NEGATIVE_BALANCE_RESERVE - NEGATIVE_BALANCE_WRITEOFF - NETWORK_ADJUSTMENT_SWEEP - NETWORK_CHARGEBACK_SWEEP - ONE_TIME_PAYMENT - ONE_TIME_PAYMENT_REVERSAL - OUTGOING_INTERNATIONAL_REMITTANCE - OUTGOING_INTERNATIONAL_REMITTANCE_REVERSAL - PEER_TO_PEER - PROMOTIONAL_CREDIT - PROMOTIONAL_CREDIT_REVERSAL - PROMOTIONAL_CREDIT_SWEEP - PULSE_GROSS_SWEEP - PULSE_INTERCHANGE_SWEEP - REVENUE_DISBURSEMENT - SIGN_UP_BONUS - SUBSCRIPTION_FEE - SECURITY_ACCOUNT_PAYMENT - SECURITY_OVERPAY_ADJUSTMENT - SECURITY_OVERPAY_ADJUSTMENT_REVERSAL - TRANSFER_FEE - TRANSFER_FEE_REVERSAL - VISA_GROSS_SWEEP - VISA_INTERCHANGE_SWEEP - VISA_NET_SWEEP - WIRE_SETTLEMENT_CREDIT - WIRE_SETTLEMENT_DEBIT - OVERDUE_CARD_WRITEOFF - CARD_PROVISIONAL_CREDIT_REVERSAL - GENERAL_INTERNAL_TRANSFER_SWEEP - GENERAL_INTERNAL_TRANSFER_SWEEP_REVERSAL - CARD_PROVISIONAL_CREDIT_SWEEP - CARD_PROVISIONAL_CREDIT_SWEEP_REVERSAL - CARD_CHARGEBACK_CASE_WON_SWEEP - CARD_CHARGEBACK_CASE_WON_SWEEP_REVERSAL - CARD_CHARGEBACK_WRITEOFF_SWEEP - CARD_CHARGEBACK_WRITEOFF_SWEEP_REVERSAL - GENERAL_FEE_SWEEP - GENERAL_FEE_SWEEP_REVERSAL - GENERAL_REWARD_SWEEP - GENERAL_REWARD_SWEEP_REVERSAL - AUTO_PAYMENT - AUTO_PAYMENT_REVERSAL type: string required: - amount - currency - type type: object ach_request_hold_data: nullable: true properties: amount: type: integer duration: example: 2 minimum: 0 type: integer required: - amount - duration type: object risk_data: nullable: true properties: client_ip: description: Client IP type: string type: object 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 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 ````