Skip to main content

Getting Started

Personal Checking Account Creation​

1- Creates the Person resource with POST /persons endpoint and obtain the personId. Below is an example of a Person response:

{
  "firstName": "John",
  "lastName": "Simth",
  "personId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
}

2- Creates the Account resource using the POST /accounts endpoint, linking it to the Person resource (using parties.partyId). Below is an example of an Account request:

{
  "accountId": "7ym9d4d6-1a3c-11ed-861d-0242ac140009",
  "accountType": "Checking",
  "ownershipType": "SingleOwnerAccount",
  "productId": "personal_checking_01",
  "currency": "USD",
  "parties": [
    {
      "partyId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
      "partyType": "Person",
      "partyAccountRole": "AccountOwner"
    }
  ]
}

Small Business Checking Account Creation​

1- Creates the Organization resource with POST /organizations endpoint and obtain the organizationId. Below is an example of an Organization response:

{
  "name": "CoffeeShop",
  "organizationId": "5fb9d4d6-1a3c-11ed-861d-0242ac133333",
  "organizationType": "Business"
  "relatedParties": [
    {
      "partyId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
      "partyType": "Person",
      "partyName": "John Smith",
      "partyAccountRole": "Owner",
    }
  ]
}

2- Creates the Account resource using the POST /accounts endpoint, linking it to the Organization resource (using parties.partyId). Below is an example of an Account request:

{
  "accountType": "Checking",
  "ownershipType": "Business",
  "productId": "small_business_checking_01",
  "currency": "USD",
  "parties": [
    {
      "partyId": "5fb9d4d6-1a3c-11ed-861d-0242ac133333",
      "partyType": "Organization",
      "partyAccountRole": "AccountOwner"
    }
  ]
}

Business Debit Card Creation​

Creates a PaymentCard [Debit] resource for card holder named John Smith using POST /persons/{5fb9d4d6-1a3c-11ed-861d-0242ac120002}/cards endpoint. The funding source is the business checking created above. Below is an example of the request:

{

"fundingSourceType": "Debit",
"productId": "Visa_Debit_Bussines_003",
"cardHolderType": "Primary",
"nameOnCard": "John Smith",
"businessNameOnCard": "CoffeeShop",
"relatedAccounts": [
{
"accountRelationType": "FundingSource",
"accountType": "Checking",   
"accountId": "5fb9d4d6-1a3c-11ed-861d-0242ac1989898"
}
],

"orderedDate": "2022-04-17",

Business Credit Card Creation​

Creates a PaymentCard [Credit] resource for card holder named John Smith using POST /persons/{5fb9d4d6-1a3c-11ed-861d-0242ac120002}/cards endpoint. The funding source is CreditCard account, the referene account is the business account created above. Below is an example of a possible request:

{

"fundingSourceType": "Credit",
"productId": "Visa_Credit_Bussines_003",
"cardHolderType": "Primary",
"nameOnCard": "John Smith",
"businessNameOnCard": "CoffeeShop",
"referenceAccountId": "5fb9d4d6-1a3c-11ed-861d-0242ac1989898",
"relatedAccounts": [
{
"accountRelationType": "FundingSource",
"accountType": "CreditCard",   
"accountId": "5fb9d4d6-1a3c-11ed-861d-0242ac1777777"
}
],

"orderedDate": "2022-04-17",
}

Personal Loan Exposure​

Obtain the personal loan exposure with the GET /person/{personId}/loans endpoint. Below is an example of the response:

{
  "personId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  "personName": "John Smith",
  "personStatus": "GoodStanding",
  "creditRankingScales": [
    {
      "name": "StandardAndPoors",
      "score": "AAA"
    }
  ],
  "balances": [
    {
      "balanceName": "OutstandingBalance",
      "amount": "1.250.000",
      "currency": "USD",
    }
  ],
  "loans": [
    {
      "loanId": "0dd926fe-1ca2-11ed-861d-0242ac120002",
      "loanType": "Mortgage",
      "principalAmount": "1.000.000",
      "maturityDate": "2022-04-17",
      "status": "Withdrawn",
      "openDate": "2022-04-17",
      "ownershipType": "JointAccount",
      "productId": "personal_mortgage_loan_1",
      "parties": [
        {
          "partyId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
          "partyType": "Person",
          "partyAccountRole": "PrimaryOwner",
          "name": "John Smith",
        }
                                   {
          "partyId": "5fb9d4d6-1a3c-11ed-861d-0242ac120003",
          "partyType": "Person",
          "partyAccountRole": "SecondaryOwner",
          "name": "Jane Smith",
        }
      ],
      "restrictions": [],
      "limits": [],
      "interests": []
    },
    {
      "loanId": "0dd926fe-1ca2-11ed-861d-0242ac120033",
      "loanType": "StartupLoan",
      "principalAmount": "250.000",
      "maturityDate": "2025-04-17",
      "status": "Withdrawn",
      "openDate": "2022-04-17",
      "ownershipType": "Business",
      "productId": "small_business_startUp_1",
      "parties": [
        {
          "partyId": "5fb9d4d6-1a3c-11ed-861d-0242ac133333",
          "partyType": "Organization",
          "partyAccountRole": "LoanBorrower",
          "name": "SmallCaffe",
        }
                                   {
          "partyId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
          "partyType": "Person",
          "partyAccountRole": "BusinessOwner",
          "name": "John Smith",
        }
      ],
      "restrictions": [],
      "limits": [],
      "interests": []
    }
  ]
}

Payment Between Customer Accounts​

To make a payment between customer accounts, use the POST /credit-transfers endpoint. Below is an example of an ACH (Automated Clearing House) request:

{
"paymentMethod": "CreditTransfer",
"paymentType": "ACH",
"amount": "1000",
"paymentReasons": [
"CashManagementTransfer"
],
"debtorAccountId": "5fb9d4d6-1a3c-11ed-861d-0242ac1989898",
"creditor": {
"name": "Jane Birkin",
"account": {
"accountBranchId": "001",
"accountNumber": "012345678",
"accountType": "Checking",
"routingNumber": "001012345678",
}

To make a payment between customer accounts within the same bank, use the same endpoint. Below is an example of a request:

{
"paymentMethod": "CreditTransfer",
"paymentType": "OnUs",
"amount": "1000",
"paymentReasons": [
"CashManagementTransfer"
],
"debtorAccountId": "5fb9d4d6-1a3c-11ed-861d-0242ac1989898",
"creditorAccountId": "5fb9d4d6-1a3c-11ed-861d-0242ac1236789",
}