Apiture Xpress Customer Administration v0.1.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

Bank customer administrative operations including access to customer and access to account entitements.

Download OpenAPI Definition (YAML)

Base URLs:

• https://api.apiture.com/axbi-admin/customers

Terms of service

Email: Apiture Web: Apiture

Customer

Financial Institution customer that is enrolled for digital banking services

getCustomer

Code samples

# You can also use wget
curl -X GET https://api.apiture.com/axbi-admin/customers/{customerId} \
  -H 'Accept: application/json'

GET https://api.apiture.com/axbi-admin/customers/{customerId} HTTP/1.1
Host: api.apiture.com
Accept: application/json

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'

};

fetch('https://api.apiture.com/axbi-admin/customers/{customerId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

var headers = {
  'Accept':'application/json'

};

$.ajax({
  url: 'https://api.apiture.com/axbi-admin/customers/{customerId}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://api.apiture.com/axbi-admin/customers/{customerId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.apiture.com/axbi-admin/customers/{customerId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/axbi-admin/customers/{customerId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.apiture.com/axbi-admin/customers/{customerId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Returns a digital banking customer

GET https://api.apiture.com/axbi-admin/customers/{customerId}

Return a JSON representation of this customer resource.

Parameters

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
    }
  }
}

Responses

getCustomerAccountEntitlements

Code samples

# You can also use wget
curl -X GET https://api.apiture.com/axbi-admin/customers/{customerId}/entitlements/accounts \
  -H 'Accept: application/json'

GET https://api.apiture.com/axbi-admin/customers/{customerId}/entitlements/accounts HTTP/1.1
Host: api.apiture.com
Accept: application/json

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'

};

fetch('https://api.apiture.com/axbi-admin/customers/{customerId}/entitlements/accounts',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

var headers = {
  'Accept':'application/json'

};

$.ajax({
  url: 'https://api.apiture.com/axbi-admin/customers/{customerId}/entitlements/accounts',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://api.apiture.com/axbi-admin/customers/{customerId}/entitlements/accounts',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.apiture.com/axbi-admin/customers/{customerId}/entitlements/accounts', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/axbi-admin/customers/{customerId}/entitlements/accounts");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.apiture.com/axbi-admin/customers/{customerId}/entitlements/accounts", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Returns a digital banking customer's account entitlements

GET https://api.apiture.com/axbi-admin/customers/{customerId}/entitlements/accounts

Return a JSON representation of this customers account entitlements. # djb: Return a JSON representation of this customer's account entitlements.

Parameters

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
    }
  },
  "_embedded": {
    "items": [
      {
        "_id": "45454343",
        "accountNumbers": {
          "full": "2-12345678",
          "masked": "*5678"
        },
        "accountType": {
          "type": "DDA",
          "code": "checking"
        },
        "role": "fraud_notify_ach_debit"
      },
      {
        "_id": "45454344",
        "accountNumbers": {
          "full": "2-12345679",
          "masked": "*5679"
        },
        "accountType": {
          "type": "SAV",
          "code": "savings"
        },
        "accountTypeGeneric": "checking",
        "role": "fraud_notify_ach_credit"
      }
    ]
  }
}

Responses

getCustomerCompanyIds

Code samples

# You can also use wget
curl -X GET https://api.apiture.com/axbi-admin/customers/{customerId}/companyIds \
  -H 'Accept: application/json'

GET https://api.apiture.com/axbi-admin/customers/{customerId}/companyIds HTTP/1.1
Host: api.apiture.com
Accept: application/json

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'

};

fetch('https://api.apiture.com/axbi-admin/customers/{customerId}/companyIds',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

var headers = {
  'Accept':'application/json'

};

$.ajax({
  url: 'https://api.apiture.com/axbi-admin/customers/{customerId}/companyIds',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://api.apiture.com/axbi-admin/customers/{customerId}/companyIds',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.apiture.com/axbi-admin/customers/{customerId}/companyIds', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/axbi-admin/customers/{customerId}/companyIds");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.apiture.com/axbi-admin/customers/{customerId}/companyIds", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Returns a list of customer's company IDs

GET https://api.apiture.com/axbi-admin/customers/{customerId}/companyIds

Return a JSON representation of this customer's company IDs. A company ID is used to provide additional tracking information on ACH transactions. The ID may or may not exist. The customer's Tax ID is treated as a unique company ID, and they can add additional IDs (such as a DUNS number, user specified ID, or other ID). The resource contains a unique NACHA prefix number for ACH, as well as other identifying information such as the company's name and whether the ID is active for use.

Parameters

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
    }
  },
  "_embedded": {
    "items": [
      {
        "_id": 123456789,
        "name": "AAA Plumbing",
        "value": "1984719084",
        "type": {
          "nachaPrefix": 10,
          "description": "Other"
        }
      }
    ]
  },
  "types": [
    {
      "nachaPrefix": 1,
      "description": "taxId"
    },
    {
      "nachaPrefix": 3,
      "description": "dunsNumber"
    },
    {
      "nachaPrefix": 9,
      "description": "userSpecifiedId'"
    },
    {
      "nachaPrefix": 10,
      "description": "other"
    }
  ]
}

Responses

addCustomerCompanyId

Code samples

# You can also use wget
curl -X POST https://api.apiture.com/axbi-admin/customers/{customerId}/companyIds \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

POST https://api.apiture.com/axbi-admin/customers/{customerId}/companyIds HTTP/1.1
Host: api.apiture.com
Content-Type: application/json
Accept: application/json

const fetch = require('node-fetch');
const inputBody = '{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractRequest/v2.0.0/profile.json",
  "_links": {},
  "_id": {},
  "name": "AAA Plumbing",
  "value": "1984719084",
  "inactive": false,
  "type": {
    "nachaPrefix": 10
  },
  "account_ids": [
    "123456789",
    "987654321",
    "123412304"
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'

};

fetch('https://api.apiture.com/axbi-admin/customers/{customerId}/companyIds',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'

};

$.ajax({
  url: 'https://api.apiture.com/axbi-admin/customers/{customerId}/companyIds',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'https://api.apiture.com/axbi-admin/customers/{customerId}/companyIds',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://api.apiture.com/axbi-admin/customers/{customerId}/companyIds', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/axbi-admin/customers/{customerId}/companyIds");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.apiture.com/axbi-admin/customers/{customerId}/companyIds", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Add new company ID

POST https://api.apiture.com/axbi-admin/customers/{customerId}/companyIds

Add a Company ID for this customer. A Company ID is information about an ID this customer includes with payments sent or received via ACH. The ID may or may not exist. The user will not be allowed to reuse the customer's Tax ID to create a new company ID, and we don’t store a collection of DUNS Numbers or user specified IDs today. The resource contains a unique prefix number for ACH, as well as other identifying information such as the company's name and whether the ID is active for use.

Body parameter

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractRequest/v2.0.0/profile.json",
  "_links": {},
  "_id": {},
  "name": "AAA Plumbing",
  "value": "1984719084",
  "inactive": false,
  "type": {
    "nachaPrefix": 10
  },
  "account_ids": [
    "123456789",
    "987654321",
    "123412304"
  ]
}

Parameters

Example responses

201 Response

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
    }
  },
  "_id": "123456789",
  "name": "AAA Plumbing",
  "value": "1984719083",
  "inactive": true,
  "type": {
    "nachaPrefix": 10,
    "description": "other"
  }
}

422 Response

Responses

getCustomerCompanyId

Code samples

# You can also use wget
curl -X GET https://api.apiture.com/axbi-admin/customers/{customerId}/companyIds/{companyIdInstanceId} \
  -H 'Accept: application/json'

GET https://api.apiture.com/axbi-admin/customers/{customerId}/companyIds/{companyIdInstanceId} HTTP/1.1
Host: api.apiture.com
Accept: application/json

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'

};

fetch('https://api.apiture.com/axbi-admin/customers/{customerId}/companyIds/{companyIdInstanceId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

var headers = {
  'Accept':'application/json'

};

$.ajax({
  url: 'https://api.apiture.com/axbi-admin/customers/{customerId}/companyIds/{companyIdInstanceId}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://api.apiture.com/axbi-admin/customers/{customerId}/companyIds/{companyIdInstanceId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.apiture.com/axbi-admin/customers/{customerId}/companyIds/{companyIdInstanceId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/axbi-admin/customers/{customerId}/companyIds/{companyIdInstanceId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.apiture.com/axbi-admin/customers/{customerId}/companyIds/{companyIdInstanceId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Retrive a company ID

GET https://api.apiture.com/axbi-admin/customers/{customerId}/companyIds/{companyIdInstanceId}

Retrive a company ID for this customer.

Parameters

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
    }
  },
  "_id": "123456789",
  "name": "AAA Plumbing",
  "value": "1984719083",
  "inactive": true,
  "type": {
    "nachaPrefix": 10,
    "description": "other"
  }
}

Responses

modifyCustomerCompanyId

Code samples

# You can also use wget
curl -X PUT https://api.apiture.com/axbi-admin/customers/{customerId}/companyIds/{companyIdInstanceId} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

PUT https://api.apiture.com/axbi-admin/customers/{customerId}/companyIds/{companyIdInstanceId} HTTP/1.1
Host: api.apiture.com
Content-Type: application/json
Accept: application/json

const fetch = require('node-fetch');
const inputBody = '{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
    }
  },
  "_id": "123456789",
  "name": "AAA Plumbing",
  "value": "1984719083",
  "inactive": true,
  "type": {
    "nachaPrefix": 10,
    "description": "other"
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'

};

fetch('https://api.apiture.com/axbi-admin/customers/{customerId}/companyIds/{companyIdInstanceId}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'

};

$.ajax({
  url: 'https://api.apiture.com/axbi-admin/customers/{customerId}/companyIds/{companyIdInstanceId}',
  method: 'put',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.put 'https://api.apiture.com/axbi-admin/customers/{customerId}/companyIds/{companyIdInstanceId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('https://api.apiture.com/axbi-admin/customers/{customerId}/companyIds/{companyIdInstanceId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/axbi-admin/customers/{customerId}/companyIds/{companyIdInstanceId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.apiture.com/axbi-admin/customers/{customerId}/companyIds/{companyIdInstanceId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Modify an existing company ID

PUT https://api.apiture.com/axbi-admin/customers/{customerId}/companyIds/{companyIdInstanceId}

Modify an existing Company ID for this customer. A company ID cannot be deleted. It can only be marked inactive using the PUT method.

Body parameter

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
    }
  },
  "_id": "123456789",
  "name": "AAA Plumbing",
  "value": "1984719083",
  "inactive": true,
  "type": {
    "nachaPrefix": 10,
    "description": "other"
  }
}

Parameters

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
    }
  },
  "_id": "123456789",
  "name": "AAA Plumbing",
  "value": "1984719083",
  "inactive": true,
  "type": {
    "nachaPrefix": 10,
    "description": "other"
  }
}

412 Response

Responses

Schemas

abstractRequest

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractRequest/v2.0.0/profile.json",
  "_links": {}
}

Abstract Request (v2.0.0)

An abstract schema used to define other request-only schemas. This is a HAL resource representation, minus the _error defined in abstractResource.

This schema was resolved from common/abstractRequest.

Properties

abstractResource

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
    }
  }
}

Abstract Resource (v2.0.0)

An abstract schema used to define other schemas for request and response bodies. This is a HAL resource representation. This model contains hypermedia _links, and either optional domain object data with _profile and optional _embedded objects, or an _error object. In responses, if the operation was successful, this object will not include the _error, but if the operation was a 4xx or 5xx error, this object will not include _embedded or any data fields, only _error and optionally _links.

This schema was resolved from common/abstractResource.

Properties

attributeValue

{}

Attribute Value (v2.0.0)

The data associated with this attribute.

This schema was resolved from common/attributeValue.

Properties

attributes

{
  "property1": {},
  "property2": {}
}

Attributes (v2.0.0)

An optional map of name/value pairs which contains additional dynamic data about the resource.

This schema was resolved from common/attributes.

Properties

collection

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
    }
  }
}

Collection (v2.0.0)

A collection of resources. This is an abstract model schema which is extended to define specific resource collections.

This schema was resolved from common/collection.

Properties

companyId

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
    }
  },
  "_id": "123456789",
  "name": "AAA Plumbing",
  "value": "1984719083",
  "inactive": true,
  "type": {
    "nachaPrefix": 10,
    "description": "other"
  }
}

Company Id (v1.0.0)

Representation of a company ID resource for this customer. A Company ID is information about an ID this customer includes with payments sent or received via ACH. The resource contains a unique prefix number for ACH, as well as other identifying information such as the company's name.

Properties

companyIdType

{
  "nachaPrefix": 3,
  "description": "dunsNumber"
}

Company ID Type (v1.0.0)

Representation of a company ID type resource.

Properties

companyIds

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
    }
  },
  "_embedded": {
    "items": [
      {
        "_id": 123456789,
        "name": "AAA Plumbing",
        "value": "1984719084",
        "type": {
          "nachaPrefix": 10,
          "description": "Other"
        }
      }
    ]
  },
  "types": [
    {
      "nachaPrefix": 1,
      "description": "taxId"
    },
    {
      "nachaPrefix": 3,
      "description": "dunsNumber"
    },
    {
      "nachaPrefix": 9,
      "description": "userSpecifiedId'"
    },
    {
      "nachaPrefix": 10,
      "description": "other"
    }
  ]
}

Company IDs (v1.0.0)

Returns a list of company IDs and allowed types.

Properties

customer

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
    }
  }
}

Customer (v1.0.0)

Representation of an customer resource. A digital banking user.

Properties

customerAccountEntitlement

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
    }
  },
  "_id": "45454343",
  "accountNumbers": {
    "full": "12345678-9",
    "masked": "*678-9"
  },
  "accountType": {
    "type": "DDA",
    "code": "checking"
  },
  "role": "fraud_notify_ach_debit"
}

Customer Account Entitlement (v1.0.0)

Representation of an entitlement between a customer and an account. This representation normally does not contain any _embedded objects.

Properties

customerAccountEntitlements

{
  "items": [
    {
      "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.0.0/profile.json",
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
        }
      },
      "_id": "45454343",
      "accountNumbers": {
        "full": "12345678-9",
        "masked": "*678-9"
      },
      "accountType": {
        "type": "DDA",
        "code": "checking"
      },
      "role": "fraud_notify_ach_debit"
    }
  ]
}

Customer Account Entitlements (v1.0.0)

A list of customer account entitlements.

Properties

error

{
  "_id": "2eae46e1575c0a7b0115a4b3",
  "message": "Descriptive error message...",
  "statusCode": 422,
  "type": "errorType1",
  "remediation": "Remediation string...",
  "occurredAt": "2018-01-25T05:50:52.375Z",
  "errors": [
    {
      "_id": "ccdbe2c5c938a230667b3827",
      "message": "An optional embedded error"
    },
    {
      "_id": "dbe9088dcfe2460f229338a3",
      "message": "Another optional embedded error"
    }
  ],
  "_links": {
    "describedby": {
      "href": "https://developer.apiture.com/errors/errorType1"
    }
  }
}

Error (v2.0.0)

Describes an error in an API request or in a service called via the API.

This schema was resolved from common/error.

Properties

errorResponse

{
  "_profile": "https://api.apiture.com/schemas/common/errorResponse/v2.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
    }
  },
  "_error": {
    "_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
    "message": "The value for deposit must be greater than 0.",
    "statusCode": 422,
    "type": "positiveNumberRequired",
    "attributes": {
      "value": -125.5
    },
    "remediation": "Provide a value which is greater than 0",
    "occurredAt": "2018-01-25T05:50:52.375Z",
    "_links": {
      "describedby": {
        "href": "https://api.apiture.com/errors/positiveNumberRequired"
      }
    },
    "_embedded": {
      "errors": []
    }
  }
}

Error Response (v2.0.0)

Describes an error response, typically returned on 4xx or 5xx errors from API operations. The _error object contains the error details.

This schema was resolved from common/errorResponse.

Properties

getCustomerAccountEntitlementsResponse

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
    }
  },
  "_embedded": {
    "items": [
      {
        "_id": "45454343",
        "accountNumbers": {
          "full": "2-12345678",
          "masked": "*5678"
        },
        "accountType": {
          "type": "DDA",
          "code": "checking"
        },
        "role": "fraud_notify_ach_debit"
      },
      {
        "_id": "45454344",
        "accountNumbers": {
          "full": "2-12345679",
          "masked": "*5679"
        },
        "accountType": {
          "type": "SAV",
          "code": "savings"
        },
        "accountTypeGeneric": "checking",
        "role": "fraud_notify_ach_credit"
      }
    ]
  }
}

Account Entitlements Collection (v1.0.0)

Collection of entitements between a customer and an account. The items in the collection are ordered in the _embedded object with name items.

Properties

link

{
  "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
  "title": "Application"
}

Link (v1.0.0)

Describes a hypermedia link within a _links object in HAL representations. In Apiture APIs, links are HAL links, but Apiture APIs do not use the name or hreflang properties of HAL. Apiture links may include a method property.

This schema was resolved from common/link.

Properties

links

{
  "property1": {
    "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
    "title": "Application"
  },
  "property2": {
    "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
    "title": "Application"
  }
}

Links (v1.0.0)

An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.

This schema was resolved from common/links.

Properties