Synctera website screenshot

Synctera

Synctera is a Banking-as-a-Service platform connecting fintechs to a network of sponsor banks. Provides REST APIs for personal/business customers, accounts, cards, internal transfers, payment schedules, ACH payments, mRDC, KYC/KYB verification, document verification, and disclosures.

2 APIs 0 Features
FinTechBaaSBankingPaymentsCard IssuingKYC

APIs

Synctera Platform API

REST API covering Customers (Personal & Business), Accounts, Cards, Internal Transfers, Payment Schedules, ACH Payments, mRDC, KYC/KYB Verification, Document Verification, and D...

Synctera Webhooks

Outbound HTTP webhook delivery for customer, account, card, transaction, and payment events.

Collections

Pricing Plans

Synctera Plans Pricing

2 plans

PLANS

Rate Limits

Synctera Rate Limits

1 limits

RATE LIMITS

FinOps

JSON Structure

Synctera Structure

0 properties

JSON STRUCTURE

Resources

👥
GitHubOrganization
GitHubOrganization
🔗
LinkedIn
LinkedIn
🔗
Website
Website
🔗
Plans
Plans
🔗
RateLimits
RateLimits
🔗
FinOps
FinOps
🔗
LlmsText
LlmsText

Sources

Raw ↑
opencollection: 1.0.0
info:
  name: Synctera API
  version: 0.20.0
request:
  auth:
    type: bearer
    token: '{{bearerToken}}'
items:
- info:
    name: Accounts
    type: folder
  items:
  - info:
      name: List accounts
      type: http
    http:
      method: GET
      url: https://api.synctera.com/v0/accounts
      params:
      - name: id
        value: ''
        type: query
        description: 'Account ID(s). Multiple IDs can be provided as a comma-separated list.

          '
      - name: linked_account_id
        value: ''
        type: query
        description: 'Return only resources that are linked to the specified backing account in balance_floor or balance_ceiling.
          Multiple IDs can be provided as a comma-separated list.

          '
      - name: overdraft_account_id
        value: ''
        type: query
        description: 'Overdraft account ID(s). Multiple IDs can be provided as a comma-separated list.

          This parameter is deprecated and will be removed in a future API version. Use linked_account_id instead.

          '
      - name: overflow_account_id
        value: ''
        type: query
        description: 'Overflow account ID(s). Multiple IDs can be provided as a comma-separated list.

          This parameter is deprecated and will be removed in a future API version. Use linked_account_id instead.

          '
      - name: account_number
        value: ''
        type: query
        description: 'Account number(s). Multiple account numbers can be provided as a comma-separated list.

          When only a single account number is provided, any * characters in the string are wildcards, and match any characters.

          '
      - name: status
        value: ''
        type: query
      - name: interest_product_id
        value: ''
        type: query
        description: Interest product ID that accounts associate with. Multiple IDs can be provided as a comma-separated list.
      - name: customer_type
        value: ''
        type: query
        description: 'Customer type of the account, BUSINESS or PERSONAL

          '
      - name: customer_id
        value: ''
        type: query
        description: The customer's unique identifier
      - name: business_id
        value: ''
        type: query
        description: 'Unique identifier for the business. Multiple IDs can be provided as a comma-separated list.

          '
      - name: person_id
        value: ''
        type: query
        description: 'Unique identifier for the person. Multiple IDs can be provided as a comma-separated list.

          '
      - name: first_name
        value: ''
        type: query
      - name: last_name
        value: ''
        type: query
      - name: limit
        value: ''
        type: query
      - name: page_token
        value: ''
        type: query
      - name: sort_by
        value: ''
        type: query
        description: 'Specifies the sort order for the returned accounts.

          '
    docs: Get paginated list of Accounts associated
  - info:
      name: Create an account
      type: http
    http:
      method: POST
      url: https://api.synctera.com/v0/accounts
      headers:
      - name: Idempotency-Key
        value: ''
      body:
        type: json
        data: '{}'
    docs: "Create a shadow mode or lead mode account. You need to determine the mode according to integrator configuration,\
      \ and specify the required fields accordingly.\n\nShadow mode required fields:\n  - account_number\n  - status\n\nLead\
      \ mode required fields:\n  - account_template_id\n  - relationships\n"
  - info:
      name: Get account
      type: http
    http:
      method: GET
      url: https://api.synctera.com/v0/accounts/:account_id
      params:
      - name: account_id
        value: ''
        type: path
        description: Unique identifier for the account.
    docs: Get an account
  - info:
      name: Update account
      type: http
    http:
      method: PUT
      url: https://api.synctera.com/v0/accounts/:account_id
      params:
      - name: account_id
        value: ''
        type: path
        description: Unique identifier for the account.
      body:
        type: json
        data: '{}'
    docs: "Update account\n\nShadow mode required fields:\n  - account_number\n  - status\n\nLead mode required fields:\n\
      \  - All fields are required.\n\nPlease note:\n  - access_status needs to be in ACTIVE.\n  - PUT request cannot change\
      \ access_status.\n"
  - info:
      name: Patch account
      type: http
    http:
      method: PATCH
      url: https://api.synctera.com/v0/accounts/:account_id
      headers:
      - name: Idempotency-Key
        value: ''
      params:
      - name: account_id
        value: ''
        type: path
        description: Unique identifier for the account.
      body:
        type: json
        data: '{}'
    docs: "Patch account.\n\nImmutable fields:\n  - account_number\n  - account_type\n  - account_template_id\n  - customer_type\n\
      \nPlease note:\n  - Other fields cannot be modified when access_status is FROZEN.\n  - access_status has to be patched\
      \ individually without other fields.\n"
  - info:
      name: List account relationships
      type: http
    http:
      method: GET
      url: https://api.synctera.com/v0/accounts/:account_id/relationships
      params:
      - name: account_id
        value: ''
        type: path
        description: Unique identifier for the account.
      - name: limit
        value: ''
        type: query
      - name: page_token
        value: ''
        type: query
    docs: List all customers of an account
  - info:
      name: Create account relationship
      type: http
    http:
      method: POST
      url: https://api.synctera.com/v0/accounts/:account_id/relationships
      headers:
      - name: Idempotency-Key
        value: ''
      params:
      - name: account_id
        value: ''
        type: path
        description: Unique identifier for the account.
      body:
        type: json
        data: '{}'
    docs: Add a customer to an account
  - info:
      name: Get account relationship
      type: http
    http:
      method: GET
      url: https://api.synctera.com/v0/accounts/:account_id/relationships/:relationship_id
      params:
      - name: account_id
        value: ''
        type: path
        description: Unique identifier for the account.
      - name: relationship_id
        value: ''
        type: path
        description: Relationship ID of the account associate with the account entity
    docs: Get account relationship by ID
  - info:
      name: Update account relationship
      type: http
    http:
      method: PUT
      url: https://api.synctera.com/v0/accounts/:account_id/relationships/:relationship_id
      params:
      - name: account_id
        value: ''
        type: path
        description: Unique identifier for the account.
      - name: relationship_id
        value: ''
        type: path
        description: Relationship ID of the account associate with the account entity
      body:
        type: json
        data: '{}'
    docs: Update account relationship. Only relationship_type can be updated. customer_id should not be modified.
  - info:
      name: Delete account relationship
      type: http
    http:
      method: DELETE
      url: https://api.synctera.com/v0/accounts/:account_id/relationships/:relationship_id
      params:
      - name: account_id
        value: ''
        type: path
        description: Unique identifier for the account.
      - name: relationship_id
        value: ''
        type: path
        description: Relationship ID of the account associate with the account entity
    docs: Delete account relationship
  - info:
      name: List account products
      type: http
    http:
      method: GET
      url: https://api.synctera.com/v0/accounts/products
      params:
      - name: limit
        value: ''
        type: query
      - name: page_token
        value: ''
        type: query
      - name: start_date
        value: ''
        type: query
        description: Date range filtering for type INTEREST. All rates in interest resource have to have valid_from later
          or equal to start_date.
      - name: end_date
        value: ''
        type: query
        description: Date range filtering for type INTEREST. All rates in interest resource have to have valid_to earlier
          or equal to end_date.
      - name: product_type
        value: ''
        type: query
        description: Type of account product
    docs: 'List account Products

      '
  - info:
      name: Create an account product
      type: http
    http:
      method: POST
      url: https://api.synctera.com/v0/accounts/products
      headers:
      - name: Idempotency-Key
        value: ''
      body:
        type: json
        data: '{}'
    docs: 'Create an account product. Rates cannot be nil or empty.

      '
  - info:
      name: Patch account product
      type: http
    http:
      method: PATCH
      url: https://api.synctera.com/v0/accounts/products/:product_id
      headers:
      - name: Idempotency-Key
        value: ''
      params:
      - name: product_id
        value: ''
        type: path
        description: Account Product ID
      body:
        type: json
        data: '{}'
    docs: 'Patch account product. Rates requires at minimum 1 entry if specified.

      '
  - info:
      name: List account templates
      type: http
    http:
      method: GET
      url: https://api.synctera.com/v0/accounts/templates
      params:
      - name: limit
        value: ''
        type: query
      - name: page_token
        value: ''
        type: query
    docs: 'List account templates

      '
  - info:
      name: Create an account template
      type: http
    http:
      method: POST
      url: https://api.synctera.com/v0/accounts/templates
      headers:
      - name: Idempotency-Key
        value: ''
      body:
        type: json
        data: '{}'
    docs: 'Create an account template. An account template is need when create an account in a lead mode

      '
  - info:
      name: Get account template
      type: http
    http:
      method: GET
      url: https://api.synctera.com/v0/accounts/templates/:template_id
      params:
      - name: template_id
        value: ''
        type: path
        description: Account Template ID
    docs: Get an account template
  - info:
      name: Update account template
      type: http
    http:
      method: PUT
      url: https://api.synctera.com/v0/accounts/templates/:template_id
      params:
      - name: template_id
        value: ''
        type: path
        description: Account Template ID
      body:
        type: json
        data: '{}'
    docs: 'Update account template

      '
  - info:
      name: Delete account template
      type: http
    http:
      method: DELETE
      url: https://api.synctera.com/v0/accounts/templates/:template_id
      params:
      - name: template_id
        value: ''
        type: path
        description: Account Template ID
    docs: Delete account template
- info:
    name: ACH
    type: folder
  items:
  - info:
      name: List sent ACH transactions
      type: http
    http:
      method: GET
      url: https://api.synctera.com/v0/ach
      params:
      - name: limit
        value: ''
        type: query
      - name: page_token
        value: ''
        type: query
    docs: List sent ACH transactions
  - info:
      name: Send an ACH
      type: http
    http:
      method: POST
      url: https://api.synctera.com/v0/ach
      body:
        type: json
        data: '{}'
    docs: 'Send an ACH

      '
  - info:
      name: Get a sent ACH transaction
      type: http
    http:
      method: GET
      url: https://api.synctera.com/v0/ach/:transaction_id
      params:
      - name: transaction_id
        value: ''
        type: path
        description: Transaction ID in the ledger
    docs: Get a single sent ACH transaction
  - info:
      name: Update a sent ACH transaction
      type: http
    http:
      method: PATCH
      url: https://api.synctera.com/v0/ach/:transaction_id
      params:
      - name: transaction_id
        value: ''
        type: path
        description: Transaction ID in the ledger
      body:
        type: json
        data: '{}'
    docs: Update a sent ACH transaction (either status or funds availability)
- info:
    name: Applications
    type: folder
  items:
  - info:
      name: List credit applications.
      type: http
    http:
      method: GET
      url: https://api.synctera.com/v0/applications
      params:
      - name: customer_id
        value: ''
        type: query
        description: A list of customer unique identifiers, with a comma separating any values.
      - name: status
        value: ''
        type: query
        description: 'Status of the credit application

          '
    docs: 'List credit applications.

      '
  - info:
      name: Create a credit application.
      type: http
    http:
      method: POST
      url: https://api.synctera.com/v0/applications
      headers:
      - name: Idempotency-Key
        value: ''
      body:
        type: json
        data: '{}'
    docs: 'Create a credit application.

      '
  - info:
      name: Get Application
      type: http
    http:
      method: GET
      url: https://api.synctera.com/v0/applications/:application_id
      params:
      - name: application_id
        value: ''
        type: path
        description: Unique identifier for the application.
    docs: 'Get application by ID.

      '
  - info:
      name: Patch Application
      type: http
    http:
      method: PATCH
      url: https://api.synctera.com/v0/applications/:application_id
      headers:
      - name: Idempotency-Key
        value: ''
      params:
      - name: application_id
        value: ''
        type: path
        description: Unique identifier for the application.
      body:
        type: json
        data: '{}'
    docs: 'Patch Application.

      '
- info:
    name: Businesses
    type: folder
  items:
  - info:
      name: List business
      type: http
    http:
      method: GET
      url: https://api.synctera.com/v0/businesses
      params:
      - name: id
        value: ''
        type: query
        description: 'Unique identifier for the business. Multiple IDs can be provided as a comma-separated list.

          '
      - name: entity_name
        value: ''
        type: query
      - name: phone_number
        value: ''
        type: query
      - name: status
        value: ''
        type: query
      - name: is_customer
        value: ''
        type: query
        description: If true, show only customers. If false, show non-customer parties.
      - name: sort_by
        value: ''
        type: query
        description: 'Specifies the sort order for the returned businesses.

          '
      - name: limit
        value: ''
        type: query
      - name: page_token
        value: ''
        type: query
    docs: Retrieves paginated list of businesses associated with the authorized requester.
  - info:
      name: Create a business
      type: http
    http:
      method: POST
      url: https://api.synctera.com/v0/businesses
      headers:
      - name: Idempotency-Key
        value: ''
      body:
        type: json
        data: '{}'
    docs: 'Create a business who may act as a customer or a related business. You can then verify the identity of this customer
      and associate them with other people and accounts.

      '
  - info:
      name: Get business
      type: http
    http:
      method: GET
      url: https://api.synctera.com/v0/businesses/:business_id
      params:
      - name: business_id
        value: ''
        type: path
        description: Business's unique identifier.
    docs: Get business by ID.
  - info:
      name: Patch business
      type: http
    http:
      method: PATCH
      url: https://api.synctera.com/v0/businesses/:business_id
      headers:
      - name: Idempotency-Key
        value: ''
      params:
      - name: business_id
        value: ''
        type: path
        description: Business's unique identifier.
      body:
        type: json
        data: '{}'
    docs: Update business by ID.
- info:
    name: Cards
    type: folder
  items:
  - info:
      name: List Cards
      type: http
    http:
      method: GET
      url: https://api.synctera.com/v0/cards
      params:
      - name: customer_id
        value: ''
        type: query
      - name: account_id
        value: ''
        type: query
        description: Account ID(s). Multiple IDs can be provided as a comma-separated list.
      - name: emboss_name
        value: ''
        type: query
        description: emboss name
      - name: last_four
        value: ''
        type: query
        description: The last 4 digits of the card PAN
      - name: expiration_date
        value: ''
        type: query
        description: The date representing when the card would expire at
      - name: card_type
        value: ''
        type: query
        description: Indicates the type of card
      - name: card_brand
        value: ''
        type: query
        description: The brand of a card product
      - name: form
        value: ''
        type: query
        description: The format of the card
      - name: card_product_id
        value: ''
        type: query
      - name: card_status
        value: ''
        type: query
        description: The status of a card
      - name: postal_code
        value: ''
        type: query
        description: The postal code of a card user
      - name: limit
        value: ''
        type: query
      - name: page_token
        value: ''
        type: query
      - name: sort_by
        value: ''
        type: query
        description: 'Specifies the sort order for the returned cards.

          '
    docs: 'List of cards matching query parameters

      '
  - info:
      name: Issue a Card
      type: http
    http:
      method: POST
      url: https://api.synctera.com/v0/cards
      body:
        type: json
        data: '{}'
    docs: 'Issue or reissue a new card for a customer

      '
  - info:
      name: Get Card
      type: http
    http:
      method: GET
      url: https://api.synctera.com/v0/cards/:card_id
      params:
      - name: card_id
        value: ''
        type: path
    docs: 'Get the details about a card that has been issued

      '
  - info:
      name: Update Card
      type: http
    http:
      method: PATCH
      url: https://api.synctera.com/v0/cards/:card_id
      params:
      - name: card_id
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: 'Integrators can update the card resource to change status, update shipping (if the card hasn''t been shipped) or
      edit metadata.

      '
  - info:
      name: Get Card Barcode
      type: http
    http:
      method: GET
      url: https://api.synctera.com/v0/cards/:card_id/barcodes
      params:
      - name: card_id
        value: ''
        type: path
    docs: 'This endpoint is for testing environment only to provide access to barcode of a test card

      '
  - info:
      name: List Card Changes
      type: http
    http:
      method: GET
      url: https://api.synctera.com/v0/cards/:card_id/changes
      params:
      - name: card_id
        value: ''
        type: path
    docs: 'List card change history

      '
  - info:
      name: Get a client token
      type: http
    http:
      method: POST
      url: https://api.synctera.com/v0/cards/:card_id/client_token
      params:
      - name: card_id
        value: ''
        type: path
    docs: 'Create a client access token for interacting with a card.  This token will be used on the client to identify the
      card for flows like viewing Full PAN or setting the PIN in a PCI compliant manner.

      '
  - info:
      name: Activate a card
      type: http
    http:
      method: POST
      url: https://api.synctera.com/v0/cards/activate
      body:
        type: json
        data: '{}'
    docs: 'Activate a card

      '
  - info:
      name: Get card widget URL
      type: http
    http:
      method: GET
      url: https://api.synctera.com/v0/cards/card_widget_url
      params:
      - name: widget_type
        value: ''
        type: query
        description: The type of widget for which to construct the URL
      - name: customer_id
        value: ''
        type: query
      - name: account_id
        value: ''
        type: query
      - name: card_id
        value: ''
        type: query
        description: The ID of the card (required for set PIN widget)
    docs: 'This endpoint returns a URL address of the specified widget for a given card

      '
  - info:
      name: List Gateways
      type: http
    http:
      method: GET
      url: https://api.synctera.com/v0/cards/gateways
      params:
      - name: limit
        value: ''
        type: query
      - name: page_token
        value: ''
        type: query
    docs: 'List of gateways matching query parameters

      '
  - info:
      name: Create Gateway
      type: http
    http:
      method: POST
      url: https://api.synctera.com/v0/cards/gateways
      body:
        type: json
        data: '{}'
    docs: 'Create a new Authorization Gateway Configuration

      '
  - info:
      name: Get Gateway
      type: http
    http:
      method: GET
      url: https://api.synctera.com/v0/cards/gateways/:gateway_id
      params:
      - name: gateway_id
        value: ''
        type: path
    docs: 'Get the details of an Authorization Gateway that has been configured

      '
  - info:
      name: Update Gateway
      type: http
    http:
      method: PATCH
      url: https://api.synctera.com/v0/cards/gateways/:gateway_id
      params:
      - name: gateway_id
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: 'Update Authorization Gateway configuration

      '
  - info:
      name: List Card Image Details
      type: http
    http:
      method: GET
      url: https://api.synctera.com/v0/cards/images
      params:
      - name: customer_id
        value: ''
        type: query
    docs: 'List all card image details

      '
  - info:
      name: Create Card Image
      type: http
    http:
      method: POST
      url: https://api.synctera.com/v0/cards/images
      body:
        type: json
        data: '{}'
    docs: 'Create a card image entity. Note that this does not include the image data itself. You can upload the image data
      via a subsequent uploadCardImageData request using the ID created here.

      '
  - info:
      name: Get Card Image Details
      type: http
    http:
      method: GET
      url: https://api.synctera.com/v0/cards/images/:card_image_id
      params:
      - name: card_image_id
        value: ''
        type: path
    docs: Get card image details
  - info:
      name: Update Card Image Details
      type: http
    http:
      method: PATCH
      url: https://api.synctera.com/v0/cards/images/:card_image_id
      params:
      - name: card_image_id
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Update card image details. The only detail that can be updated is the card status as APPROVED or REJECTED.
  - info:
      name: Get Card Image Data
      type: http
    http:
      method: GET
      url: https://api.synctera.com/v0/cards/images/:card_image_id/data
      params:
      - name: card_image_id
        value: ''
        type: path
    docs: Get card image data
  - info:
      name: Upload Card Image
      type: http
    http:
      method: POST
      url: https://api.synctera.com/v0/cards/images/:card_image_id/data
      params:
      - name: card_image_id
        value: ''
        type: path
    docs: Upload card image data
  - info:
      name: List Card Products
      type: http
    http:
      method: GET
      url: https://api.synctera.com/v0/cards/products
      params:
      - name: limit
        value: ''
        type: query
      - name: page_token
        value: ''
        type: query
    docs: List Card Products
  - info:
      name: Get single-use token
      type: http
    http:
      method: POST
      url: https://api.synctera.com/v0/cards/single_use_token
      body:
        type: json
        data: '{}'
    docs: 'This endpoint returns a single-use access token. This type of token authorizes a single request to access API endpoints
      and data associated with a particular user

      '
- info:
    name: Digital Wallet Tokens
    type: folder
  items:
  - info:
      name: Create digital wallet token provision request for Apple Pay
      type: http
    http:
      method: POST
      url: https://api.synctera.com/v0/cards/:card_id/digital_wallet_tokens/applepay
      params:
      - name: card_id
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Create digital wallet token provision request for Apple Pay
  - info:
      name: Create digital wallet token provision request for Google Pay
      type: http
    http:
      method: POST
      url: https://api.synctera.com/v0/cards/:card_id/digital_wallet_tokens/googlepay
      params:
      - name: card_id
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Create digital wallet token provision request for Google Pay
  - info:
      name: List Digital Wallet Tokens
      type: http
    http:
      method: GET
      url: https://api.synctera.com/v0/cards/digital_wallet_tokens
      params:
      - name: card_id
        value: ''
        type: query
      - name: token_state
        value: ''
        type: query
        description: The status of the Digital Wallet Token
      - name: limit
        value: ''
        type: query
      - name: page_token
        value: ''
        type: query
    docs: 'List Digital Wallet Tokens

      '
  - info:
      name: Get Digital Wallet Token
      type: http
    http:
      method: GET
      url: https://api.synctera.com/v0/cards/digital_wallet_tokens/:digital_wallet_token_id
      params:
      - name: digital_wallet_token_id
        value: ''
        type: path
    docs: 'Get the details about the digital wallet token of a card

      '
  - info:
      name: Update Digital Wallet Token's life cycle status
      type: http
    http:
      method: PATCH
      url: https://api.synctera.com/v0/cards/digital_wallet_tokens/:digital_wallet_token_id
      params:
      - name: digital_wallet_token_id
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: 'The status of a digital wallet token can be updated as, ACTIVE to SUSPENDED, SUSPENDED to ACTIVE, ACTIVE to TERMINATED
      or SUSPENDED to TERMINATED.

      '
- info:
    name: Card Webhook Simulations
    type: folder
  items:
  - info:
      name: Simulate Card Fulfillment Event
      type: http
    http:
      method: POST
      url: https://api.synctera.com/v0/cards/:card_id/webhook_simulations/fulfillment
      params:
      - name: card_id
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: 'This endpoint is for testing environment only to trigger a simulated change in card fulfillment status event

      '
- info:
    name: Card Transaction Simulations
    type: folder
  items:
  - info:
      name: Simulate authorization
      type: http
    http:
      method: POST
      url: https://api.synctera.com/v0/cards/transaction_simulations/authorization
      body:
        type: json
        data: '{}'
    docs: 'Simulate an `authorization` type transaction by including the `card_token` and other authorization details in your
      request.

      '
  - info:
      name: Simulate authorization advice
      type: http
    http:
      method: POST
      url: https://api.synctera.com/v0/cards/transaction_simulations/authorization/advice
      body:
        type: json
        data: '{}'
    docs: 'An authorization advice allows an amount to be decreased after the authorization. This endpoint allows you to simulate
      post-swipe adjustments.


      Simulate an `authorization.advice` type transaction by including the `original_transaction_token` and other authorization
      details in your request.

      '
  - info:
      name: Simulate clearing or refund
      type: http
    http:
      method: POST
      url: https://api.synctera.com/v0/cards/transaction_simulations/clearing
      body:
        type: json
        data: '{}'
    docs: 'Simulate an `authorization.clearing` type transaction by including the `original_transaction_token` and `amount`
      in your request. To simulate a refund type transaction, set the `is_refund` field to true.

      '
  - info:
      name: Simulate financial
      type: http
    http:
      method: POST
      url: https://api.synctera.com/v0/cards/transaction_simulations/financial
      body:
        type: json
        data: '{}'
    docs: 'A "financial" is a transaction message class that includes ATM transactions, PIN-debit transactions, and balance
      inquiries.


      Simulate a `pindebit` type transaction by including the `card_token` and `amount` in your request.

      '
  - info:
      name: Simulate financial advice
      type: http
    http:
      method: POST
      url: https://api.synctera.com/v0/cards/transaction_simulations/financial/advice
      body:
        type: json
        data: '{}'
    docs: 'Simulate a financial advice by including the `original_transaction_token` and other authorization details in JSON
      format in the body of the request.

      '
  - info:
      name: Simulate balance inquiry
      type: http
    http:
      method: POST
      url: https://api.synctera.com/v0/cards/transaction_simulations/financial/balance_inquiry
      body:
        type: json
        data: '{}'
    docs: 'Simulate a `pindebit.balanceinquiry` type transaction by sending a POST request to the `/simulate/financial/balanceinquiry`
      endpoint.

      '
  - info:
      name: Simulate OCT
      type: http
    http:
      method: POST
      url: https://api.synctera.com/v0/cards/transaction_simulations/financial/original_credit
      body:
        type: json
        data: '{}'
    docs: 'This Original Credit Transaction (OCT) enables the cardholder to receive funds on the specified card from an external
      source via the card network. Use this endpoint to simulate a transaction that is similar to a wire transfer and not
      linked to any purchase.


      Simulate an OCT by including the `card_token`, `amount`, `mid`, and `type` in your request.

      '
  - info:
      name: Simulate ATM withdrawal
      type: http
    http:
      method: POST
      url: https://api.synctera.com/v0/cards/transaction_simulations/financial/withdrawal
      body:
        type: json
        data: '{}'
    docs: 'Simulate a `pindebit.atm.withdrawal` type transaction by including the `card_token` and `amount` in your request.

      '
  - info:
      name: Simulate reversal
      type: http
    http:
      method: POST
      url: https://api.synctera.com/v0/cards/transaction_simulations/reversal
      body:
        type: json
        data: '{}'
    docs: 'A reversal releases the hold that was placed on account funds by an authorization, thus returning the funds to
      the account.


      Simulate an `authorization.reversal` type transaction by including the `original_transaction_token` and `amount` in
      your request.

      '
- info:
    name: Customers
    type: folder
  items:
  - info:
      name: List Customers
      type: http
    http:
      method: GET
      url: https://api.synctera.com/v0/customers
      params:
      - name: id
        value: ''
        type: query
        description: Unique resource identifier
      - name: first_name
        value: ''
        type: query
      - name: last_name
        value: ''
        type: query
      - name: phone_number
        value: ''
        type: query
      - name: email
        value: ''
        type: query
      - name: ssn_last_4
        value: ''
        type: query
      - name: status
        value: ''
        type: query
      - name: limit
        value: ''
        type: query
      - name: page_token
        value: ''
        type: query
      - name: sort_by
        value: ''
        type: query
        description: 'Specifies the sort order for the returned customers.

          '
    docs: Retrieves paginated list of Customers associated with the auth

# --- truncated at 32 KB (86 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/synctera/refs/heads/main/apis.yml