Customers v0.7.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.

Banking Customers. Customers can be either individuals or businesses who hold bank accounts.

Download OpenAPI Definition (YAML)

Base URLs:

• https://api.apiture.com/banking

Terms of service

Email: Apiture Web: Apiture

License: Apiture API License

Authentication

• API Key (apiKey)
  • header parameter: API-Key
  • API Key based client identification. See details at Secure Access.

• OpenID Connect authentication (accessToken)
  • OpenId Connect (OIDC) authentication/authorization. The client uses the authorization_endpoint and token_endpoint to obtain an access token to pass in the Authorization header. Those endpoints are available via the OIDC Configuration URL. The actual URL may vary with each financial institution. See details at Secure Access.
  • OIDC Configuration URL = https://oidc.apiture.com/oidc/.well-known/oidc-configuration

Customers

Banking Customers

getMyPreferences

Code samples

# You can also use wget
curl -X GET https://api.apiture.com/banking/customers/me/preferences \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.apiture.com/banking/customers/me/preferences HTTP/1.1
Host: api.apiture.com
Accept: application/json

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

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/banking/customers/me/preferences',
{
  method: 'GET',

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

var headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.apiture.com/banking/customers/me/preferences',
  method: 'get',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.apiture.com/banking/customers/me/preferences',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.apiture.com/banking/customers/me/preferences', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/banking/customers/me/preferences");
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"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

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

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

Return the customer's preferences

GET https://api.apiture.com/banking/customers/me/preferences

Return the customer's preferences, organized by preference groups.

Optionally, an agent can access a business customer's preferences when acting on behalf of that business customer.

Parameters

Example responses

200 Response

{
  "ach": {
    "settlement": {
      "ppdDebit": "summary",
      "ppdCredit": "detailed",
      "ctxDebit": "detailed",
      "ctxCredit": "summary",
      "ccdDebit": "summary",
      "ccdCredit": "summary",
      "achImport": "summary"
    }
  }
}

Responses

getMyAchPreferences

Code samples

# You can also use wget
curl -X GET https://api.apiture.com/banking/customers/me/preferences/ach \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.apiture.com/banking/customers/me/preferences/ach HTTP/1.1
Host: api.apiture.com
Accept: application/json

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

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/banking/customers/me/preferences/ach',
{
  method: 'GET',

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

var headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.apiture.com/banking/customers/me/preferences/ach',
  method: 'get',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.apiture.com/banking/customers/me/preferences/ach',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.apiture.com/banking/customers/me/preferences/ach', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/banking/customers/me/preferences/ach");
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"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.apiture.com/banking/customers/me/preferences/ach", data)
    req.Header = headers

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

Return the customer's ACH preferences

GET https://api.apiture.com/banking/customers/me/preferences/ach

Return the customer's preferences related to ACH batches.

Optionally, an agent can access a business customer's preferences when acting on behalf of that business customer.

Parameters

Example responses

200 Response

{
  "settlement": {
    "ppdDebit": "summary",
    "ppdCredit": "detailed",
    "ctxDebit": "detailed",
    "ctxCredit": "summary",
    "ccdDebit": "summary",
    "ccdCredit": "summary",
    "achImport": "summary"
  }
}

Responses

patchMyAchPreferences

Code samples

# You can also use wget
curl -X PATCH https://api.apiture.com/banking/customers/me/preferences/ach \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

PATCH https://api.apiture.com/banking/customers/me/preferences/ach HTTP/1.1
Host: api.apiture.com
Content-Type: application/json
Accept: application/json

const fetch = require('node-fetch');
const inputBody = '{
  "settlement": {
    "ppdDebit": "summary",
    "ppdCredit": "detailed",
    "ctxDebit": "detailed",
    "ctxCredit": "summary",
    "ccdDebit": "summary",
    "ccdCredit": "summary",
    "achImport": "summary"
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/banking/customers/me/preferences/ach',
{
  method: 'PATCH',
  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',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.apiture.com/banking/customers/me/preferences/ach',
  method: 'patch',

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

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch 'https://api.apiture.com/banking/customers/me/preferences/ach',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.patch('https://api.apiture.com/banking/customers/me/preferences/ach', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/banking/customers/me/preferences/ach");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
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"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "https://api.apiture.com/banking/customers/me/preferences/ach", data)
    req.Header = headers

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

Update the customer's ACH preferences

PATCH https://api.apiture.com/banking/customers/me/preferences/ach

Perform a partial update of the customer's ACH preferences as per JSON Merge Patch format and processing rules. Only fields in the request body are updated on the resource; fields which are omitted are not updated.

Optionally, an agent can access a business customer's preferences when acting on behalf of that business customer.

Body parameter

{
  "settlement": {
    "ppdDebit": "summary",
    "ppdCredit": "detailed",
    "ctxDebit": "detailed",
    "ctxCredit": "summary",
    "ccdDebit": "summary",
    "ccdCredit": "summary",
    "achImport": "summary"
  }
}

Parameters

Example responses

200 Response

{
  "settlement": {
    "ppdDebit": "summary",
    "ppdCredit": "detailed",
    "ctxDebit": "detailed",
    "ctxCredit": "summary",
    "ccdDebit": "summary",
    "ccdCredit": "summary",
    "achImport": "summary"
  }
}

Responses

Schemas

achPaymentSettlementType

"summary"

ACH Payment Settlement Type (v1.0.0)

Provides instruction for the system on how to process the payment batch.
The schema achPaymentSettlementType was added on version 0.2.0 of the API.

achPaymentSettlementType strings may have one of the following enumerated values:

type: string

enum values: summary, detailed

achSettlementPreference

{
  "ppdDebit": "summary",
  "ppdCredit": "detailed",
  "ctxDebit": "detailed",
  "ctxCredit": "summary",
  "ccdDebit": "summary",
  "ccdCredit": "summary",
  "achImport": "summary"
}

ACH Settlement Preference (v1.0.0)

Indicates the ACH settlement type for payment batch creation. Preferences are set for various individual SEC codes for specific payment directions, as well as for imports via NACHA ACH file.
The schema achSettlementPreference was added on version 0.2.0 of the API.

Properties

apiProblem

{
  "id": "3fbad566-be86-4b22-9ba6-3ca99fdc0799",
  "type": "https://production.api.apiture.com/errors/accountNotFound/v1.0.0",
  "title": "Account Not Found",
  "status": 422,
  "occurredAt": "2022-04-25T12:42:21.375Z",
  "detail": "No account exists at the given account_url",
  "instance": "https://production.api.apiture.com/banking/transfers/bb709151-575041fcd617"
}

API Problem (v1.1.0)

API problem or error, as per RFC 7807 application/problem+json.

Properties

challengeFactor

{
  "type": "sms",
  "labels": [
    "9876"
  ]
}

Challenge Factor (v1.0.0)

An challenge factor. See requiredIdentityChallenge for multiple examples.

Properties

challengeFactorType

"sms"

Challenge Factor Type (v1.0.0)

The name of challenge factor.

challengeFactorType strings may have one of the following enumerated values:

type: string

enum values: sms, email, voice, securityQuestions, authenticatorToken

challengePromptId

"string"

Challenge Prompt ID (v1.0.0)

The unique ID of a prompt (such as a security question) in a challenge factor.

type: string

minLength: 1
maxLength: 48
pattern: ^[-_:.~$a-zA-Z0-9]+$

challengeSecurityQuestion

{
  "id": "74699fa628911e762ea5",
  "prompt": "What is your mother's maiden name?"
}

Challenge Security Question (v1.0.0)

A single security question within the questions array of the challengeSecurityQuestions

Properties

challengeSecurityQuestions

{
  "questions": [
    {
      "id": "q1",
      "prompt": "What is your mother's maiden name?"
    },
    {
      "id": "q4",
      "prompt": "What is your high school's name?"
    },
    {
      "id": "q9",
      "prompt": "What is the name of your first pet?"
    }
  ]
}

Challenge Security Questions (v1.0.0)

Describes a securityQuestions challenge. This is omitted if the challenge type is not securityQuestions.

Properties

customerAchPreferences

{
  "settlement": {
    "ppdDebit": "summary",
    "ppdCredit": "detailed",
    "ctxDebit": "detailed",
    "ctxCredit": "summary",
    "ccdDebit": "summary",
    "ccdCredit": "summary",
    "achImport": "summary"
  }
}

Customer ACH Preferences (v1.0.0)

A digital banking customer's ACH Payment preferences.
The schema customerAchPreferences was added on version 0.2.0 of the API.

Properties

customerAchPreferencesPatch

{
  "settlement": {
    "ppdDebit": "summary",
    "ppdCredit": "detailed",
    "ctxDebit": "detailed",
    "ctxCredit": "summary",
    "ccdDebit": "summary",
    "ccdCredit": "summary",
    "achImport": "summary"
  }
}

Customer ACH Preferences Patch (v1.0.0)

Representation used to patch existing customer ACH preferences using the JSON Merge Patch format and processing rules.
The schema customerAchPreferencesPatch was added on version 0.2.0 of the API.

Properties

customerPreferences

{
  "ach": {
    "settlement": {
      "ppdDebit": "summary",
      "ppdCredit": "detailed",
      "ctxDebit": "detailed",
      "ctxCredit": "summary",
      "ccdDebit": "summary",
      "ccdCredit": "summary",
      "achImport": "summary"
    }
  }
}

Customer Preference (v1.0.1)

Enumerated customer preferences grouped by preference category.
The schema customerPreferences was added on version 0.2.0 of the API.

Properties

customerReference

{
  "id": "f48291b6-14ce",
  "name": "Amanda Cummins"
}

Customer Reference (v1.0.0)

A reference to a customer. The name property is the customer's name at the time this reference was created.

Properties

phoneNumberType

"primary"

Phone Number Type (v1.0.0)

Describes the type of a banking customer's phone number.

phoneNumberType strings may have one of the following enumerated values:

type: string

enum values: primary, secondary, mobile, fax, alternate

problemResponse

{
  "id": "3fbad566-be86-4b22-9ba6-3ca99fdc0799",
  "type": "https://production.api.apiture.com/errors/noSuchAccount/v1.0.0",
  "title": "Account Not Found",
  "status": 422,
  "occurredAt": "2022-04-25T12:42:21.375Z",
  "detail": "No account exists for the given account reference",
  "instance": "https://production.api.apiture.com/banking/transfers/bb709151-575041fcd617"
}

Problem Response (v0.3.0)

API problem or error response, as per RFC 7807 application/problem+json.

Properties

readOnlyResourceId

"string"

Read-only Resource Identifier (v1.0.0)

The unique, opaque system-assigned identifier for a resource. This case-sensitive ID is also used in URLs as path parameters or in other properties or parameters that reference a resource by ID rather than URL. Resource IDs are immutable.

type: string

read-only
minLength: 6
maxLength: 48
pattern: ^[-_:.~$a-zA-Z0-9]+$

readOnlyTimestamp

"2021-10-30T19:06:04.250Z"

Read-Only Timestamp (v1.0.0)

A readonly or derived timestamp (an instant in time) formatted in RFC 3339 date-time UTC format: YYYY-MM-DDThh:mm:ss.sssZ.
The schema readOnlyTimestamp was added on version 0.4.0 of the API.

type: string(date-time)

read-only
format: date-time
minLength: 20
maxLength: 30

requiredIdentityChallenge

{
  "operationId": "createTransfer",
  "challengeId": "0504076c566a3cf7009c",
  "factors": [
    {
      "type": "sms",
      "labels": [
        "9876"
      ]
    },
    {
      "type": "voice",
      "labels": [
        "9876"
      ]
    },
    {
      "type": "voice",
      "labels": [
        "6754"
      ]
    },
    {
      "type": "email",
      "labels": [
        "an****nk@example.com",
        "an****98@example.com"
      ]
    },
    {
      "type": "authenticatorToken",
      "labels": [
        "Acme fob"
      ]
    },
    {
      "type": "securityQuestions",
      "securityQuestions": {
        "questions": [
          {
            "id": "q1",
            "prompt": "What is your mother's maiden name?"
          },
          {
            "id": "q4",
            "prompt": "What is your high school's name?"
          },
          {
            "id": "q9",
            "prompt": "What is the name of your first pet?"
          }
        ]
      }
    }
  ]
}

Required Challenge (v1.0.0)

A request from the service for the user to verify their identity. This contains a challenge ID, the corresponding operation ID, and a list of challenge factors for identity verification. The user must complete one of these challenge factors to satisfy the challenge. This schema defines the attributes in the 401 Unauthorized problem response when the 401 problem type name is challengeRequired. See the "Challenge API" for details.

Properties

resourceId

"string"

Resource Identifier (v1.0.0)

The unique, opaque system identifier for a resource. This case-sensitive ID is also used as path parameters in URLs or in other properties or parameters that reference a resource by ID rather than URL.

type: string

minLength: 6
maxLength: 48
pattern: ^[-_:.~$a-zA-Z0-9]+$