Guide

1. Credit Products

After the first time you authenticate you will need to get a list of credit products.

As part of the initial set up Bloom will configure the Organization and Credit Product lines. The initial configuration will allow us to configure our furnishment schedules.

{
  "method": "get",
  "url": "/api/v1/credit-products"
}

This will provide you with a set of products, e.g.:

{
  "data": [
    {
      "id": "string",
      "type": "string",
      "attributes": {
        "name": "string",
        "portfolio_type": "C",
        "account_type": "string",
        "interest_type": "F",
        "terms_duration": 0,
        "terms_frequency": "D",
        "id": null,
        "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
        "created_at": "2019-08-24T14:15:22Z",
        "modified_at": "2019-08-24T14:15:22Z"
      }
    }
  ]
}

2. Consumers

Creating a consumer

{
  "method": "post",
  "url": "/api/v1/consumers",
  "body": "{\n    \"data\": {\n        \"type\": \"Consumer\",\n        \"attributes\": {\n            \"first_name\": \"first\",\n            \"middle_name\": \"middle\",\n            \"surname\": \"last\",\n            \"ssn\": \"523456786\",\n            \"date_of_birth\": \"1994-09-12\",\n            \"telephone_number\": \"2487209784\",\n            \"addresses\": [\n                {\n                    \"line1\": \"123 Boring Avenue\",\n                    \"city\": \"Boringville\",\n                    \"state\": \"NY\",\n                    \"zip_code\": \"12345\"\n                }\n            ]\n        }\n    }"
}

An example payload:

{
  "data": {
    "id": "string",
    "type": "string",
    "attributes": {
      "first_name": "string",
      "middle_name": "string",
      "surname": "string",
      "ssn": "string",
      "date_of_birth": "2019-08-24",
      "telephone_number": "string",
      "addresses": [
        {
          "line1": "string",
          "line2": "string",
          "city": "string",
          "state": "AL",
          "zip_code": "string",
          "country_code": "US",
          "address_type": "C",
          "residence_type": "O"
        }
      ]
    }
  }
}

An example response:

{
  "data": {
    "id": "string",
    "type": "string",
    "attributes": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "first_name": "string",
      "middle_name": "string",
      "surname": "string",
      "ssn": "string",
      "date_of_birth": "2019-08-24",
      "telephone_number": "string",
      "addresses": [
        {
          "line1": "string",
          "line2": "string",
          "city": "string",
          "state": "AL",
          "zip_code": "string",
          "country_code": "US",
          "address_type": "C",
          "residence_type": "O",
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
        }
      ]
    }
  }
}

3. Accounts

Here we will associate the consumer that we just created with your credit product that we got in Step 2

An example request:

{
  "data": {
    "type": "string",
    "attributes": {
      "credit_product_id": "1f9cc7e5-1b70-49bf-aacb-c89d627fc2e0",
      "primary_consumer_id": "8e419fc9-805a-4f90-8d6b-a2f448b24d76",
      "primary_address_id": "626e4845-6010-4ecc-848a-9cf85de2776d",
      "primary_designation": "individual",
      "secondary_consumers": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "address_id": "a32b0e3d-a5f5-48d8-a572-6ae561815055",
          "designation": "individual"
        }
      ],
      "external_account_identifier": "string",
      "account_opened_date": "2019-08-24"
    }
  }
}

An example response:

{
  "data": {
    "id": "string",
    "type": "string",
    "attributes": {
      "id": null,
      "primary_consumer_id": "8e419fc9-805a-4f90-8d6b-a2f448b24d76",
      "primary_address_id": "626e4845-6010-4ecc-848a-9cf85de2776d",
      "credit_product_id": "1f9cc7e5-1b70-49bf-aacb-c89d627fc2e0",
      "secondary_consumers": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "address_id": "a32b0e3d-a5f5-48d8-a572-6ae561815055",
          "designation": "individual"
        }
      ],
      "external_account_identifier": "ac12-122-12345697"
    }
  }
}

4. Statements

Statements are used to capture all activity of an Account that occurs during a billing period. These periods are typically one month long for all credit products but may differ by issuer.

{
  "method": "post",
  "url": "api/v1/account-snapshots/"
}

An example request:

{
  "data": {
    "type": "string",
    "attributes": {
      "account_id": "449e7a5c-69d3-4b8a-aaaf-5c9b713ebc65",
      "statement_date": "2019-08-24",
      "current_balance": 0,
      "days_delinquent": 0,
      "credit_limit": 0,
      "highest_credit": 0,
      "scheduled_monthly_payment": 0,
      "actual_monthly_payment": 0,
      "consumer_information_indicator": "A",
      "account_status": "05",
      "payment_rating": "0",
      "special_comment": "I",
      "compliance_condition_code": null,
      "amount_past_due": 0,
      "original_chargeoff_amount": 0,
      "revolving_apr_percentage": 0,
      "payment_due_date": "2019-08-24",
      "last_payment_date": "2019-08-24",
      "payments": [
        {
          "payment_date": "2019-08-24",
          "amount": 0
        }
      ],
      "statement_identifier": "string"
    }
  }
}

An example of payload here:

{
  "data": {
    "id": "string",
    "type": "string",
    "attributes": {
      "account_id": "449e7a5c-69d3-4b8a-aaaf-5c9b713ebc65",
      "statement_date": "2019-08-24",
      "current_balance": 0,
      "days_delinquent": 0,
      "credit_limit": 0,
      "highest_credit": 0,
      "scheduled_monthly_payment": 0,
      "actual_monthly_payment": 0,
      "consumer_information_indicator": "A",
      "account_status": "05",
      "payment_rating": "0",
      "special_comment": "I",
      "compliance_condition_code": null,
      "amount_past_due": 0,
      "original_chargeoff_amount": 0,
      "revolving_apr_percentage": 0,
      "payment_due_date": "2019-08-24",
      "last_payment_date": "2019-08-24",
      "payments": [
        {
          "payment_date": "2019-08-24",
          "amount": 0
        }
      ],
      "statement_identifier": "string",
      "id": null
    }
  }
}