Skip to main content
POST
/
accounts
Create a manual account
curl --request POST \
  --url https://api.finta.io/v2/accounts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "institutionName": "<string>",
  "type": "<string>",
  "subtype": "<string>",
  "mask": "<string>",
  "currency": "<string>",
  "currentBalance": 123,
  "availableBalance": 123,
  "liability": {
    "minimumPaymentAmount": 123,
    "nextPaymentDueDate": "2023-12-25",
    "lastPaymentAmount": 123,
    "lastPaymentDate": "2023-12-25",
    "interestRate": 123,
    "isOverdue": true,
    "lastStatementBalance": 123,
    "aprs": [
      {
        "aprType": "<string>",
        "aprPercentage": 123,
        "balanceSubjectToApr": 123,
        "interestChargeAmount": 123
      }
    ],
    "loanName": "<string>",
    "loanStatus": {
      "type": "<string>",
      "endDate": "2023-12-25"
    },
    "repaymentPlan": {
      "type": "<string>",
      "description": "<string>"
    },
    "pslfStatus": {
      "paymentsRemaining": 123,
      "paymentsMade": 123,
      "estimatedEligibilityDate": "2023-12-25"
    },
    "originationDate": "2023-12-25",
    "originationPrincipalAmount": 123,
    "expectedPayoffDate": "2023-12-25",
    "outstandingInterestAmount": 123,
    "ytdInterestPaid": 123,
    "ytdPrincipalPaid": 123,
    "nextMonthlyPayment": 123,
    "escrowBalance": 123,
    "hasPmi": true,
    "hasPrepaymentPenalty": true,
    "propertyAddress": {
      "street": "<string>",
      "city": "<string>",
      "region": "<string>",
      "postalCode": "<string>",
      "country": "<string>"
    },
    "loanTypeDescription": "<string>",
    "maturityDate": "2023-12-25",
    "pastDueAmount": 123
  }
}
'
{
  "account": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "providerAccountId": "<string>",
    "bankConnectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "provider": "plaid",
    "institutionName": "<string>",
    "name": "<string>",
    "mask": "<string>",
    "type": "<string>",
    "subtype": "<string>",
    "currency": "<string>",
    "currentBalance": 123,
    "availableBalance": 123,
    "balanceAsOf": "2023-11-07T05:31:56Z",
    "closedAt": "2023-11-07T05:31:56Z",
    "liability": {
      "minimumPaymentAmount": 123,
      "nextPaymentDueDate": "2023-12-25",
      "lastPaymentAmount": 123,
      "lastPaymentDate": "2023-12-25",
      "interestRate": 123,
      "isOverdue": true,
      "lastStatementBalance": 123,
      "aprs": [
        {
          "aprType": "<string>",
          "aprPercentage": 123,
          "balanceSubjectToApr": 123,
          "interestChargeAmount": 123
        }
      ],
      "loanName": "<string>",
      "loanStatus": {
        "type": "<string>",
        "endDate": "2023-12-25"
      },
      "repaymentPlan": {
        "type": "<string>",
        "description": "<string>"
      },
      "pslfStatus": {
        "paymentsRemaining": 123,
        "paymentsMade": 123,
        "estimatedEligibilityDate": "2023-12-25"
      },
      "originationDate": "2023-12-25",
      "originationPrincipalAmount": 123,
      "expectedPayoffDate": "2023-12-25",
      "outstandingInterestAmount": 123,
      "ytdInterestPaid": 123,
      "ytdPrincipalPaid": 123,
      "nextMonthlyPayment": 123,
      "escrowBalance": 123,
      "hasPmi": true,
      "hasPrepaymentPenalty": true,
      "propertyAddress": {
        "street": "<string>",
        "city": "<string>",
        "region": "<string>",
        "postalCode": "<string>",
        "country": "<string>"
      },
      "loanTypeDescription": "<string>",
      "maturityDate": "2023-12-25",
      "pastDueAmount": 123
    }
  }
}

Authorizations

​
Authorization
string
header
required

Finta API key from the dashboard (Bearer token).

Body

application/json
​
name
string
required
Required string length: 1 - 255
​
institutionName
string

Institution label. Defaults to 'Manual'.

Required string length: 1 - 255
​
type
string

e.g. depository, credit, loan, investment, other

Required string length: 1 - 100
​
subtype
string

e.g. checking, savings, credit card, mortgage, student

Required string length: 1 - 100
​
mask
string
Required string length: 1 - 100
​
currency
string

ISO currency code, e.g. USD

Required string length: 1 - 10
​
currentBalance
number

For liabilities, use a positive number for the amount owed.

​
availableBalance
number
​
liability
object

Liability detail for credit, student, or mortgage accounts; null for non-liability accounts. Fields not relevant to the liability type are null. The same shape is accepted when creating or updating a manual account.

Response

Created account

​
account
object
required