➕Create with Customer

In order to complete a Business Affordability Assessment, you will first need to create a Business Bank Account ID. You may associate the Business Bank Account Record to a Customer Record.

You will need to first save the customerId from the POST Create New Customer response as a variable to use in the request body for Create with Customer.

Create with Customer

POST {{baseUrl}}/business/bank-accounts

In order to complete a business affordability assessment a unique Business Bank Account ID needs to be created. PDF Bank Statements collected from a Business are stored against the Business bank_account_id as well as the customer_id.

Headers

Name	Type	Description
Content-Type*	application/json

Request Body

Name	Type	Description
bank*	String	The commercial bank that the business has a bank account with. Please see this list of slugs for the available banks.
type*	String	This field determines the method that the end-user wants to make use of to collect transactions and bank statements. Currently we only support "statement" for business bank accounts.
customer_id*	String	The UUID for a specific customer that gets generated and returned in the POST Create New Customer response. It ensures that the Business is associated to a specific customer.
business_id*	String	The UUID for a specific business that gets generated and returned in POST Create a Business for a Customer.

201: Created Bank Account created

```postman_json
{
    "data": {
        "id": "{{bankAccountId}}",
        "customer_id": "{{customerId}}",
        "business_id": "{{businessId}}",
        "type": "statement",
        "bank": "standard-bank",
        "num_transactions": 0,
        "last_updated": "2023-05-24T14:19:21.000000Z",
        "first_transaction": null,
        "last_transaction": null
    }
}
```

422: Unprocessable Entity Invalid Customer ID

```postman_json
{
    "errors": {
        "customer_id": [
            "The selected customer id is invalid."
        ]
    }
}
```

422: Unprocessable Entity Invalid Business ID

```postman_json
{
    "errors": {
        "business_id": [
            "The selected business id is invalid."
        ]
    }
}
```

422: Unprocessable Entity Invalid Bank

```postman_json
{
    "errors": {
        "bank": [
            "Provided bank is not valid. Please check list of supported banks."
        ]
    }
}
```

Request body

Below is an example of the body. Open the expandable tabs below to see the a more detailed explanation of the expected values.

{
    "bank": "fnb",
    "type": "statement",
    "customer_id": "{{customerId}}",
    "business_id": "{{businessId}}"
}

Banks Supported for Business Bank Statements

• "absa"

• "capitec"

• "discovery"

• "fnb"

• "nedbank"

• "standard-bank"