POST
/
accounts
Create an account
curl --request POST \
  --url https://api-sandbox.synctera.com/v0/accounts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "balance_ceiling": {
    "balance": 1,
    "linked_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "overflow_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "balance_floor": {
    "balance": 123,
    "linked_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "overdraft_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "fee_product_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "interest_product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "note": "<string>",
  "overdraft_limit": 1,
  "spend_control_ids": [
    "7d943c51-e4ff-4e57-9558-08cab6b963c7"
  ],
  "spending_limits": {
    "day": {
      "amount": 1,
      "transactions": 1
    },
    "description": "<string>",
    "lifetime": {
      "amount": 1,
      "transactions": 1
    },
    "month": {
      "amount": 1,
      "transactions": 1
    },
    "transaction": {
      "amount": 1
    },
    "week": {
      "amount": 1,
      "transactions": 1
    }
  },
  "is_ach_enabled": true,
  "is_card_enabled": true,
  "is_eft_ca_enabled": true,
  "is_external_card_enabled": true,
  "is_p2p_enabled": true,
  "is_synctera_pay_enabled": true,
  "is_wire_enabled": true,
  "access_status": "ACTIVE",
  "account_purpose": "This account for the account holder'\''s salary deposit.",
  "account_type": "CHARGE_SECURED",
  "application_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "currency": "USD",
  "exchange_rate_type": "M, INTERBANK, CUST",
  "iban": "<string>",
  "is_account_pool": true,
  "metadata": {},
  "nickname": "<string>",
  "status": "ACCOUNT_NEVER_ACTIVE",
  "swift_code": "<string>",
  "account_template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "manual_account_number": "<string>",
  "relationships": [
    {
      "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "person_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "relationship_type": "ACCOUNT_HOLDER"
    }
  ]
}'
{
  "access_status": "ACTIVE",
  "access_status_last_updated_time": "2023-11-07T05:31:56Z",
  "account_closure": {
    "cases": [
      {
        "case_id": "<string>",
        "case_reason": "<string>"
      }
    ],
    "destination_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "payment_method": "ACH",
    "reason": "BANK_REQUEST_REGULATORY_REASONS",
    "reason_details": "<string>",
    "validation_responses": [
      {
        "details": {},
        "message": "Cards decoupled from account",
        "name": "cards",
        "validated": true
      }
    ]
  },
  "account_number": "<string>",
  "account_number_masked": "123*****6789",
  "account_purpose": "This account for the account holder's salary deposit.",
  "account_type": "CHARGE_SECURED",
  "application_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "auto_payment_period": 20,
  "balance_ceiling": {
    "balance": 1,
    "linked_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "overflow_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "balance_floor": {
    "balance": 123,
    "linked_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "overdraft_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "balances": [
    {
      "balance": 2399,
      "type": "ACCOUNT_BALANCE"
    }
  ],
  "bank_account_id": "<string>",
  "bank_routing": "<string>",
  "billing_period": {
    "frequency": "ANNUALLY",
    "start_date": "2022-01-01T00:00:00Z"
  },
  "business_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "close_date": "2023-12-25",
  "creation_time": "2023-11-07T05:31:56Z",
  "credit_limit": 2500,
  "currency": "USD",
  "customer_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "customer_type": "BUSINESS",
  "days_past_due": 123,
  "exchange_rate_type": "M, INTERBANK, CUST",
  "fee_product_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "funds_ownership": "BANK",
  "general_ledger_category": "CORE",
  "general_ledger_type": "ACH_SETTLEMENT",
  "grace_period": 21,
  "iban": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "interest_product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "is_account_pool": true,
  "is_ach_enabled": true,
  "is_card_enabled": true,
  "is_eft_ca_enabled": true,
  "is_external_card_enabled": true,
  "is_p2p_enabled": true,
  "is_sar_enabled": true,
  "is_security": true,
  "is_synctera_pay_enabled": true,
  "is_system_auto_pay_enabled": true,
  "is_wire_enabled": true,
  "last_updated_time": "2023-11-07T05:31:56Z",
  "metadata": {},
  "minimum_payment": {
    "min_amount": 123,
    "rate": 123,
    "type": "FULL"
  },
  "nickname": "<string>",
  "open_date": "2023-12-25",
  "overdraft_limit": 1,
  "restrictions": {
    "is_account_out_of_area": true,
    "is_delinquent": true,
    "is_past_due": true,
    "is_revoked": true
  },
  "security": {
    "linked_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "spend_control_ids": [
    "7d943c51-e4ff-4e57-9558-08cab6b963c7"
  ],
  "spending_limits": {
    "day": {
      "amount": 1,
      "transactions": 1
    },
    "description": "<string>",
    "lifetime": {
      "amount": 1,
      "transactions": 1
    },
    "month": {
      "amount": 1,
      "transactions": 1
    },
    "transaction": {
      "amount": 1
    },
    "week": {
      "amount": 1,
      "transactions": 1
    }
  },
  "status": "ACCOUNT_NEVER_ACTIVE",
  "stop_payments": [
    {
      "dispute_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "expires_on": "2023-11-07T05:31:56Z",
      "originator_name": "<string>",
      "stop_payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "swift_code": "<string>",
  "tenant": "abcdef_ghijkl"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Idempotency-Key
string

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.

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

Body

application/json

Account to create

Account Account representing either a checking or saving account. Rails available to enable on depository accounts

Response

201
application/json

Created account

The response is of type object.