NAV Navigation
Shell HTTP JavaScript Node.JS Ruby Python Java Go

Transfers v0.5.6

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

With the Transfers API, clients can schedule transfer requests to move funds from one account to another. To schedule a new transfer, use the POST operation at /scheduledTransfers path. The GET operation there returns a paginated collection of scheduled transfers. Scheduled transfers which have been processed are automatically removed from /scheduledTransfers. The /pastTransfers collection contains processed (or canceled) transfers. This differs from the Payments API which allows scheduling bill or other payments to external payees.

Download OpenAPI Definition (YAML)

Base URLs:

Terms of service

Email: Apiture Web: Apiture

Authentication

Scope Scope Description
banking/read Read access to accounts and account-related resources such as transfers and transactions.
banking/write Write (update) access to accounts and account-related resources such as transfers and transactions.
banking/delete Delete access to deletable accounts and account-related resources such as transfers.
banking/readBalance Read access to account balances. This must be granted in addition to the banking/read scope in order to view balances, but is included in the banking/full scope.
banking/full Full access to accounts and account-related resources such as transfers and transactions.
admin/read Read access to system configuration.
admin/write Write (update) access to system configuration.
admin/full Full access to system configuration.

API

Endpoints which describe this API.

getApi

Code samples

# You can also use wget
curl -X GET /transfers/ \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY'

GET /transfers/ HTTP/1.1

Accept: application/hal+json

var headers = {
  'Accept':'application/hal+json',
  'API-Key':'API_KEY'

};

$.ajax({
  url: '/transfers/',
  method: 'get',

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

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

const headers = {
  'Accept':'application/hal+json',
  'API-Key':'API_KEY'

};

fetch('/transfers/',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'API-Key' => 'API_KEY'
}

result = RestClient.get '/transfers/',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'API-Key': 'API_KEY'
}

r = requests.get('/transfers/', params={

}, headers = headers)

print r.json()

URL obj = new URL("/transfers/");
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/hal+json"},
        "API-Key": []string{"API_KEY"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/transfers/", data)
    req.Header = headers

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

Top-level resources and operations in this API

GET /

Return links to the top-level resources and operations in this API.

Example responses

200 Response

{
  "id": "apiName",
  "name": "API name",
  "apiVersion": "0.0.1-SNAPSHOT",
  "_profile": "https://api.apiture.com/schemas/common/root/v1.0.0/profile.json",
  "_links": {}
}

Responses

StatusDescription
200 OK
OK
Schema: root

getApiDoc

Code samples

# You can also use wget
curl -X GET /transfers/apiDoc \
  -H 'Accept: application/json' \
  -H 'API-Key: API_KEY'

GET /transfers/apiDoc HTTP/1.1

Accept: application/json

var headers = {
  'Accept':'application/json',
  'API-Key':'API_KEY'

};

$.ajax({
  url: '/transfers/apiDoc',
  method: 'get',

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

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

const headers = {
  'Accept':'application/json',
  'API-Key':'API_KEY'

};

fetch('/transfers/apiDoc',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'API-Key' => 'API_KEY'
}

result = RestClient.get '/transfers/apiDoc',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'API-Key': 'API_KEY'
}

r = requests.get('/transfers/apiDoc', params={

}, headers = headers)

print r.json()

URL obj = new URL("/transfers/apiDoc");
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"},
        "API-Key": []string{"API_KEY"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/transfers/apiDoc", data)
    req.Header = headers

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

Return API definition document

GET /apiDoc

Return the OpenAPI document that describes this API.

Example responses

200 Response

{}

Responses

StatusDescription
200 OK
OK
Schema: Inline

Response Schema

Scheduled Transfer

Scheduled transfers from a source account to a target account

getScheduledTransfers

Code samples

# You can also use wget
curl -X GET /transfers/scheduledTransfers \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

GET /transfers/scheduledTransfers HTTP/1.1

Accept: application/hal+json

var headers = {
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/transfers/scheduledTransfers',
  method: 'get',

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

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

const headers = {
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('/transfers/scheduledTransfers',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/transfers/scheduledTransfers',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/transfers/scheduledTransfers', params={

}, headers = headers)

print r.json()

URL obj = new URL("/transfers/scheduledTransfers");
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/hal+json"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/transfers/scheduledTransfers", data)
    req.Header = headers

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

Return a collection of scheduled transfers

GET /scheduledTransfers

Return a paginated sortable filterable searchable collection of transfers. The links in the response include pagination links.

Parameters

Parameter Description
start
(query)
integer(int64)
The zero-based index of the first transfer item to include in this page. The default 0 denotes the beginning of the collection.
limit
(query)
integer(int32)
The maximum number of transfer representations to return in this page.
sortBy
(query)
string
Optional sort criteria. See sort criteria format, such as ?sortBy=field1,-field2.
filter
(query)
string
Optional filter criteria. See filtering.
q
(query)
string
Optional search string. See searching.
state
(query)
string
Subset the accounts or external accounts collection to those whose state matches this value. Use | to separate multiple values. For example, ?state=pending will match only items whose state is pending; ?state=removed|inactive will match items whose state is removed or inactive. This is combined with an implicit and with other filters if they are used. See filtering.
Enumerated values:
scheduled
recurring
processing
suspended
completed
canceled
failed
name
(query)
string
Subset the accounts or external accounts collection to those with this name value. Use

Example responses

200 Response

{
  "_profile": "https://api.apiture.com/schemas/transfers/transfers/v1.0.0/profile.json",
  "start": 10,
  "limit": 10,
  "count": 67,
  "name": "transfers",
  "_links": {
    "self": {
      "href": "/transfers/scheduledTransfers?start=10&limit=10"
    },
    "first": {
      "href": "/transfers/scheduledTransfers?start=0&limit=10"
    },
    "next": {
      "href": "/transfers/scheduledTransfers?start=20&limit=10"
    },
    "collection": {
      "href": "/transfers/scheduledTransfers"
    }
  },
  "_embedded": {
    "items": [
      {
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "_profile": "https://api.apiture.com/schemas/transfers/summaryScheduledTransfer/v1.0.0/profile.json",
        "amount": {
          "value": "345.50",
          "currency": "USD"
        },
        "description": "Car payment",
        "state": "recurring",
        "schedule": {
          "start": "2018-02-05",
          "count": 3,
          "every": "P1M",
          "end": "2021-04-05"
        },
        "_links": {
          "apiture:source": {
            "href": "/accounts/accounts/46a31698-7398-4538-a9c9-9496010da2c2"
          },
          "apiture:target": {
            "href": "/accounts/externalAccounts/599b8ab5-6925-4f58-90c5-f6aa5b05f9d9"
          },
          "apiture:transactions": {
            "href": "/transaction?transfer=/transfers/transfers/0399abed-fd3d-4830-a88b-30f38b8a365c"
          },
          "self": {
            "href": "/transfers/scheduledTransfers/0399abed-fd3d-4830-a88b-30f38b8a365c"
          }
        }
      },
      {
        "_id": "a3bbba3c-d26b-497d-87b7-09eb47b24d77",
        "_profile": "https://api.apiture.com/schemas/transfers/summaryScheduledTransfer/v1.0.0/profile.json",
        "amount": {
          "value": "120.0",
          "currency": "USD"
        },
        "description": "Monthly allowance for Suzy's college expenses and meals",
        "state": "recurring",
        "schedule": {
          "start": "2018-08-01",
          "count": 24,
          "every": "P1M",
          "end": "2020-05-15"
        },
        "_links": {
          "apiture:source": {
            "href": "/accounts/accounts/46a31698-7398-4538-a9c9-9496010da2c2"
          },
          "apiture:target": {
            "href": "/accounts/externalAccounts/4fda6275-0a3b-49ad-ad12-5ebcd7013362"
          },
          "apiture:transactions": {
            "href": "/transaction?transfer=/transfers/transfers/a3bbba3c-d26b-497d-87b7-09eb47b24d77"
          },
          "self": {
            "href": "/transfers/scheduledTransfers/a3bbba3c-d26b-497d-87b7-09eb47b24d77"
          }
        }
      }
    ]
  }
}

Responses

StatusDescription
200 OK
OK
Schema: scheduledTransfers
400 Bad Request
Bad Request. The request body or one or more of the query parameters was not well formed. The _error field in the response will contain details about the request error.
Schema: errorResponse
422 Unprocessable Entity
Unprocessable Entity. One or more of the query parameters was well formed but otherwise invalid. The _error field in the response will contain details about the request error.
Schema: errorResponse

createScheduledTransfer

Code samples

# You can also use wget
curl -X POST /transfers/scheduledTransfers \
  -H 'Content-Type: application/hal+json' \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

POST /transfers/scheduledTransfers HTTP/1.1

Content-Type: application/hal+json
Accept: application/hal+json

var headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/transfers/scheduledTransfers',
  method: 'post',

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

const fetch = require('node-fetch');
const inputBody = '{
  "_profile": "https://api.apiture.com/schemas/transfers/createScheduledTransfer/v1.0.0/profile.json",
  "amount": {
    "value": "345.50",
    "currency": "USD"
  },
  "description": "Car payment",
  "schedule": {
    "start": "2018-02-05",
    "maximumCount": 36,
    "every": "P1M",
    "end": "2021-04-05"
  },
  "_links": {
    "apiture:source": {
      "href": "/accounts/accounts/46a31698-7398-4538-a9c9-9496010da2c2"
    },
    "apiture:target": {
      "href": "/accounts/externalAccounts/599b8ab5-6925-4f58-90c5-f6aa5b05f9d9"
    }
  }
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('/transfers/scheduledTransfers',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/hal+json',
  'Accept' => 'application/hal+json',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/transfers/scheduledTransfers',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.post('/transfers/scheduledTransfers', params={

}, headers = headers)

print r.json()

URL obj = new URL("/transfers/scheduledTransfers");
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/hal+json"},
        "Accept": []string{"application/hal+json"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/transfers/scheduledTransfers", data)
    req.Header = headers

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

Create a new scheduled transfer request

POST /scheduledTransfers

This operation adds either a new one-time or a recurring transfer, depending on the content of the embedded schedule. The request includes the amount of the transfer in the body, and the source and target accounts in the request's _links via the link relations apiture:source and apiture:target. The accounts must be active and available for transfers and the amount must be in the allowed transfer range.

If the request's transfer date (schedule.start) is the current day, the financial institution is processing transfers on that day, and the time is before the financial institution's transfer processing cutoff time, internal transfers will be processed as soon as possible and the transfer state will change to processing and then completed. If the request's transfer date (schedule.start) is the current day and the time is past the cutoff time, the transfer will be processed on the next processing day. The cutoff time is available as cutoffTime via this service's basic configuration values GET /transfers/configuration/groups/basic/values; those values are defined by the JSON schema GET /transfers/configuration/groups/basic/schema.

If the transfer is scheduled for a future date that is not a valid transfer processing day, the request fails with a 400 error. The holidays and other non-processing days are available via this service's calendar configuration values GET /transfers/configuration/groups/calendar/values; those values are defined by the JSON schema GET /transfers/configuration/groups/calendar/schema.

The service will reject duplicate requests, defined by a request that exactly matches an existing transfer (same amount, schedule, description, source and target accounts), returning a 409 Conflict status. To schedule a duplicate transfer with the same amount, schedule, and accounts, change at least the description.

Scheduled transfers will be deleted automatically at some point after they have completed (typically 7 days), up until which they are available with a state of completed if successful or failed if not.

Body parameter

{
  "_profile": "https://api.apiture.com/schemas/transfers/createScheduledTransfer/v1.0.0/profile.json",
  "amount": {
    "value": "345.50",
    "currency": "USD"
  },
  "description": "Car payment",
  "schedule": {
    "start": "2018-02-05",
    "maximumCount": 36,
    "every": "P1M",
    "end": "2021-04-05"
  },
  "_links": {
    "apiture:source": {
      "href": "/accounts/accounts/46a31698-7398-4538-a9c9-9496010da2c2"
    },
    "apiture:target": {
      "href": "/accounts/externalAccounts/599b8ab5-6925-4f58-90c5-f6aa5b05f9d9"
    }
  }
}

Parameters

Parameter Description
body
(body)
createScheduledTransfer (required)
The data necessary to create a new transfer.

Example responses

201 Response

{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_profile": "https://api.apiture.com/schemas/transfers/scheduledTransfer/v1.0.0/profile.json",
  "createdBy": "lucille-4700",
  "createdAt": "2018-05-08T13:37:57.375Z",
  "modifiedBy": "lucille-4700",
  "modifiedAt": "2018-05-18T16:42:57.000Z",
  "_links": {
    "self": {
      "href": "/transfers/scheduledTransfers/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:source": {
      "href": "/accounts/accounts/46a31698-7398-4538-a9c9-9496010da2c2"
    },
    "apiture:target": {
      "href": "/accounts/externalAccounts/599b8ab5-6925-4f58-90c5-f6aa5b05f9d9"
    },
    "apiture:creator": {
      "href": "/users/users/d076e102-facf-46e2-8ecf-bcdb531cd9e6"
    },
    "apiture:transactions": {
      "href": "/transaction?transfer=/transfers/transfers/0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "_embedded": {
    "transactions": {
      "start": 0,
      "count": 3,
      "items": [
        {
          "_id": "da8682e3-cc0b-4a1a-b8d2-8ce4dc45bf36",
          "occurredAt": "2018-02-05T11:10:00.375Z",
          "amount": {
            "value": "345.50",
            "currency": "USD",
            "description": "Car payment"
          }
        },
        {
          "_id": "a847c5c7-4a34-4464-b514-5ca1680cc00d",
          "occurredAt": "2018-03-05T11:11:17.375Z",
          "amount": {
            "value": "345.50",
            "currency": "USD",
            "description": "Car payment"
          }
        },
        {
          "_id": "d9ab0002-2cbb-4a4c-a01f-c3ce3ad20782",
          "occurredAt": "2018-04-05T11:11:17.375Z",
          "amount": {
            "value": "345.50",
            "currency": "USD",
            "description": "Car payment"
          }
        }
      ]
    },
    "source": {
      "_id": "34f8bec8-3939-4b7e-9ad5-10ee059ab250",
      "_profile": "https://api.apiture.com/schemas/accounts/summaryAccount/v1.0.0/profile.json",
      "name": "Personal Savings",
      "productName": "Basic Personal Savings",
      "type": "Personal Savings",
      "subtype": "Basic Personal Savings",
      "state": "active",
      "balance": {
        "current": "3450.30",
        "available": "3450.30",
        "currency": "USD"
      },
      "_links": {
        "self": {
          "href": "https://api.apiture.com/accounts/34f8bec8-3939-4b7e-9ad5-10ee059ab250"
        }
      }
    },
    "target": {
      "_id": "c9839d60-73e5-47ba-9676-ca8138e9494d",
      "_profile": "https://api.apiture.com/schemas/accounts/summaryAccount/v1.0.0/profile.json",
      "name": "My Basic Checking",
      "productName": "Basic Personal Checking",
      "type": "Personal Checking",
      "subtype": "Basic Personal Checking",
      "state": "active",
      "balance": {
        "current": "450.12",
        "available": "450.12",
        "currency": "USD"
      },
      "_links": {
        "self": {
          "href": "https://api.apiture.com/accounts/c9839d60-73e5-47ba-9676-ca8138e9494d"
        }
      }
    },
    "_links": {
      "self": {
        "href": "/transaction?transfer=/transfers/transfers/0399abed-fd3d-4830-a88b-30f38b8a365c"
      }
    }
  },
  "amount": {
    "value": "345.50",
    "currency": "USD"
  },
  "description": "Car payment",
  "state": "recurring",
  "schedule": {
    "start": "2018-02-05",
    "count": 3,
    "every": "P1M",
    "end": "2021-04-05"
  }
}

Responses

StatusDescription
201 Created
Created
Schema: scheduledTransfer
400 Bad Request
Bad Request. The request body or one or more of the query parameters was not well formed. The _error field in the response will contain details about the request error.
Schema: errorResponse
404 Not Found
Not Found. There is no such resource at the specified {Id} The _error field in the response will contain details about the request error.
Schema: error
409 Conflict

Conflict. A conflict can occur for several reasons:

  • A transfer that matches the request already exists. The service does not allow duplicate transfer requests, which probably reflect accidental duplicate POST operations from the client.
  • The source or target accounts do not allow the transfer.
Schema: error

Response Headers

StatusDescription
201 Location string uri
The URI of the new resource. If the URI begins with / it is relative to the API root context. Else, it is a full URI starting with scheme://host
201 ETag string
The ETag response header specifies an entity tag which must be provided in an If-Match request header for PUT or PATCH operations which update the resource.

getScheduledTransfer

Code samples

# You can also use wget
curl -X GET /transfers/scheduledTransfers/{scheduledTransferId} \
  -H 'Accept: application/hal+json' \
  -H 'If-None-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

GET /transfers/scheduledTransfers/{scheduledTransferId} HTTP/1.1

Accept: application/hal+json
If-None-Match: string

var headers = {
  'Accept':'application/hal+json',
  'If-None-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/transfers/scheduledTransfers/{scheduledTransferId}',
  method: 'get',

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

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

const headers = {
  'Accept':'application/hal+json',
  'If-None-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('/transfers/scheduledTransfers/{scheduledTransferId}',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'If-None-Match' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/transfers/scheduledTransfers/{scheduledTransferId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'If-None-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/transfers/scheduledTransfers/{scheduledTransferId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("/transfers/scheduledTransfers/{scheduledTransferId}");
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/hal+json"},
        "If-None-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/transfers/scheduledTransfers/{scheduledTransferId}", data)
    req.Header = headers

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

Fetch a representation of this transfer

GET /scheduledTransfers/{scheduledTransferId}

Return a HAL representation of this transfer resource. To also receive the full account number when fetching an account, include the ?unmasked=true option. When linking an external account, the full account number should be in the accountNumbers.full property in the request.

Parameters

Parameter Description
scheduledTransferId
(path)
string (required)
The unique identifier of this scheduled transfer. This is an opaque string.
If-None-Match
(header)
string
The entity tag that was returned in the ETag response. If the resource's current entity tag matches, the GET will return 304 (Not Modified) and no response body, else the resource representation will be returned.
unmasked
(query)
boolean
When requesting a transfer, the full account number of the source and target accounts is not included in the response by default, for security reasons. Include this query parameter, with a value of true, to request that the response body includes the full account number. Such requests are auditable.

Example responses

200 Response

{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_profile": "https://api.apiture.com/schemas/transfers/scheduledTransfer/v1.0.0/profile.json",
  "createdBy": "lucille-4700",
  "createdAt": "2018-05-08T13:37:57.375Z",
  "modifiedBy": "lucille-4700",
  "modifiedAt": "2018-05-18T16:42:57.000Z",
  "_links": {
    "self": {
      "href": "/transfers/scheduledTransfers/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:source": {
      "href": "/accounts/accounts/46a31698-7398-4538-a9c9-9496010da2c2"
    },
    "apiture:target": {
      "href": "/accounts/externalAccounts/599b8ab5-6925-4f58-90c5-f6aa5b05f9d9"
    },
    "apiture:creator": {
      "href": "/users/users/d076e102-facf-46e2-8ecf-bcdb531cd9e6"
    },
    "apiture:transactions": {
      "href": "/transaction?transfer=/transfers/transfers/0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "_embedded": {
    "transactions": {
      "start": 0,
      "count": 3,
      "items": [
        {
          "_id": "da8682e3-cc0b-4a1a-b8d2-8ce4dc45bf36",
          "occurredAt": "2018-02-05T11:10:00.375Z",
          "amount": {
            "value": "345.50",
            "currency": "USD",
            "description": "Car payment"
          }
        },
        {
          "_id": "a847c5c7-4a34-4464-b514-5ca1680cc00d",
          "occurredAt": "2018-03-05T11:11:17.375Z",
          "amount": {
            "value": "345.50",
            "currency": "USD",
            "description": "Car payment"
          }
        },
        {
          "_id": "d9ab0002-2cbb-4a4c-a01f-c3ce3ad20782",
          "occurredAt": "2018-04-05T11:11:17.375Z",
          "amount": {
            "value": "345.50",
            "currency": "USD",
            "description": "Car payment"
          }
        }
      ]
    },
    "source": {
      "_id": "34f8bec8-3939-4b7e-9ad5-10ee059ab250",
      "_profile": "https://api.apiture.com/schemas/accounts/summaryAccount/v1.0.0/profile.json",
      "name": "Personal Savings",
      "productName": "Basic Personal Savings",
      "type": "Personal Savings",
      "subtype": "Basic Personal Savings",
      "state": "active",
      "balance": {
        "current": "3450.30",
        "available": "3450.30",
        "currency": "USD"
      },
      "_links": {
        "self": {
          "href": "https://api.apiture.com/accounts/34f8bec8-3939-4b7e-9ad5-10ee059ab250"
        }
      }
    },
    "target": {
      "_id": "c9839d60-73e5-47ba-9676-ca8138e9494d",
      "_profile": "https://api.apiture.com/schemas/accounts/summaryAccount/v1.0.0/profile.json",
      "name": "My Basic Checking",
      "productName": "Basic Personal Checking",
      "type": "Personal Checking",
      "subtype": "Basic Personal Checking",
      "state": "active",
      "balance": {
        "current": "450.12",
        "available": "450.12",
        "currency": "USD"
      },
      "_links": {
        "self": {
          "href": "https://api.apiture.com/accounts/c9839d60-73e5-47ba-9676-ca8138e9494d"
        }
      }
    },
    "_links": {
      "self": {
        "href": "/transaction?transfer=/transfers/transfers/0399abed-fd3d-4830-a88b-30f38b8a365c"
      }
    }
  },
  "amount": {
    "value": "345.50",
    "currency": "USD"
  },
  "description": "Car payment",
  "state": "recurring",
  "schedule": {
    "start": "2018-02-05",
    "count": 3,
    "every": "P1M",
    "end": "2021-04-05"
  }
}

Responses

StatusDescription
200 OK
OK
Schema: scheduledTransfer
304 Not Modified
Not Modified. The resource has not been modified since it was last fetched.
404 Not Found
Not Found. There is no such resource at the specified {Id} The _error field in the response will contain details about the request error.
Schema: error

Response Headers

StatusDescription
200 ETag string
The ETag response header specifies an entity tag which must be provided in an If-Match request header for PUT or PATCH operations which update this transfer resource.

deleteScheduledTransfer

Code samples

# You can also use wget
curl -X DELETE /transfers/scheduledTransfers/{scheduledTransferId} \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

DELETE /transfers/scheduledTransfers/{scheduledTransferId} HTTP/1.1

Accept: application/hal+json
If-Match: string

var headers = {
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/transfers/scheduledTransfers/{scheduledTransferId}',
  method: 'delete',

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

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

const headers = {
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('/transfers/scheduledTransfers/{scheduledTransferId}',
{
  method: 'DELETE',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'If-Match' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete '/transfers/scheduledTransfers/{scheduledTransferId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'If-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('/transfers/scheduledTransfers/{scheduledTransferId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("/transfers/scheduledTransfers/{scheduledTransferId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
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/hal+json"},
        "If-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "/transfers/scheduledTransfers/{scheduledTransferId}", data)
    req.Header = headers

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

Delete this scheduled transfer

DELETE /scheduledTransfers/{scheduledTransferId}

Delete this transfer. Any processing transfers may complete; future scheduled transfers, if this is a recurring transfer, will be canceled. After deleting a transfer, there is no direct access to the transactions or transaction errors.

Parameters

Parameter Description
If-Match
(header)
string
The entity tag that was returned in the ETag response. This must match the current entity tag of the resource.
scheduledTransferId
(path)
string (required)
The unique identifier of this scheduled transfer. This is an opaque string.

Example responses

404 Response

{
  "_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
  "_profile": "https://api.apiture.com/schemas/common/errorResponse/v1.0.0/profile.json",
  "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": "http://doc.apiture.com/errors/positiveNumberRequired"
    }
  },
  "_embedded": {
    "errors": []
  }
}

Responses

StatusDescription
204 No Content
No Content
404 Not Found
Not Found. There is no such resource at the specified {Id} The _error field in the response will contain details about the request error.
Schema: error
412 Precondition Failed
Precondition Failed. The supplied if-Match header value does not match the most recent ETag response header value. The resource has changed in the interim.
Schema: errorResponse

patchScheduledTransfer

Code samples

# You can also use wget
curl -X PATCH /transfers/scheduledTransfers/{scheduledTransferId} \
  -H 'Content-Type: application/hal+json' \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

PATCH /transfers/scheduledTransfers/{scheduledTransferId} HTTP/1.1

Content-Type: application/hal+json
Accept: application/hal+json
If-Match: string

var headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/transfers/scheduledTransfers/{scheduledTransferId}',
  method: 'patch',

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

const fetch = require('node-fetch');
const inputBody = '{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_profile": "https://api.apiture.com/schemas/transfers/scheduledTransfer/v1.0.0/profile.json",
  "state": "recurring",
  "amount": {
    "value": "356.40",
    "currency": "USD"
  },
  "description": "Car payment",
  "schedule": {
    "start": "2018-02-05",
    "maximumCount": 36,
    "count": 11,
    "every": "P1M",
    "end": "2021-04-05"
  },
  "_links": {
    "self": {
      "href": "/transfers/scheduledTransfers/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:source": {
      "href": "/accounts/accounts/46a31698-7398-4538-a9c9-9496010da2c2"
    },
    "apiture:target": {
      "href": "/accounts/externalAccounts/599b8ab5-6925-4f58-90c5-f6aa5b05f9d9"
    }
  }
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('/transfers/scheduledTransfers/{scheduledTransferId}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/hal+json',
  'Accept' => 'application/hal+json',
  'If-Match' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch '/transfers/scheduledTransfers/{scheduledTransferId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/hal+json',
  'Accept': 'application/hal+json',
  'If-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('/transfers/scheduledTransfers/{scheduledTransferId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("/transfers/scheduledTransfers/{scheduledTransferId}");
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/hal+json"},
        "Accept": []string{"application/hal+json"},
        "If-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "/transfers/scheduledTransfers/{scheduledTransferId}", data)
    req.Header = headers

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

Update this scheduled transfer

PATCH /scheduledTransfers/{scheduledTransferId}

Perform a partial update of this transfer. Fields which are omitted are not updated. Nested _embedded and _links are ignored if included. If the state of the transfer allows, this operation may change the description, amount, and schedule; the source and target accounts and _embedded objects may not be changed. In the schedule, the user may not changed the count. The user may not change the state.

This update operation is subject to the same constraints defined in the createTransfer (POST /transfers/transfers) operation.

Body parameter

{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_profile": "https://api.apiture.com/schemas/transfers/scheduledTransfer/v1.0.0/profile.json",
  "state": "recurring",
  "amount": {
    "value": "356.40",
    "currency": "USD"
  },
  "description": "Car payment",
  "schedule": {
    "start": "2018-02-05",
    "maximumCount": 36,
    "count": 11,
    "every": "P1M",
    "end": "2021-04-05"
  },
  "_links": {
    "self": {
      "href": "/transfers/scheduledTransfers/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:source": {
      "href": "/accounts/accounts/46a31698-7398-4538-a9c9-9496010da2c2"
    },
    "apiture:target": {
      "href": "/accounts/externalAccounts/599b8ab5-6925-4f58-90c5-f6aa5b05f9d9"
    }
  }
}

Parameters

Parameter Description
scheduledTransferId
(path)
string (required)
The unique identifier of this scheduled transfer. This is an opaque string.
If-Match
(header)
string
The entity tag that was returned in the ETag response. This must match the current entity tag of the resource.
body
(body)
updateScheduledTransfer (required)

Example responses

200 Response

{
  "_links": {
    "property1": {
      "href": "http://example.com",
      "type": "string",
      "templated": true,
      "title": "string",
      "deprecation": "http://example.com",
      "profile": "http://example.com"
    },
    "property2": {
      "href": "http://example.com",
      "type": "string",
      "templated": true,
      "title": "string",
      "deprecation": "http://example.com",
      "profile": "http://example.com"
    }
  },
  "_embedded": {},
  "_profile": "http://example.com",
  "_error": {
    "_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
    "_profile": "https://api.apiture.com/schemas/common/errorResponse/v1.0.0/profile.json",
    "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": "http://doc.apiture.com/errors/positiveNumberRequired"
      }
    },
    "_embedded": {
      "errors": []
    }
  },
  "amount": {
    "value": "345.50",
    "currency": "USD"
  },
  "description": "Car payment",
  "schedule": {
    "start": "2018-06-10",
    "every": "P14D",
    "count": 5,
    "maximumCount": 10,
    "end": "2018-08-01"
  },
  "type": "internal",
  "visibility": "visible",
  "confirmationId": "4OehPba97q7----0-8--bk--",
  "state": "scheduled",
  "_id": "string",
  "createdBy": "lucille-4700",
  "createdAt": "2018-05-08T13:37:57.375Z",
  "modifiedBy": "lucille-4700",
  "modifiedAt": "2018-05-18T16:42:57.000Z",
  "sourceAccount": {
    "accountTitle": "John Smith",
    "title": "John Smith",
    "institutionName": "3rd Party Bank",
    "routingNumber": "021000021",
    "accountNumbers": {
      "masked": "*************3210",
      "full": "9876543210"
    }
  },
  "targetAccount": {
    "accountTitle": "John Smith",
    "title": "John Smith",
    "institutionName": "3rd Party Bank",
    "routingNumber": "021000021",
    "accountNumbers": {
      "masked": "*************3210",
      "full": "9876543210"
    }
  }
}

Responses

StatusDescription
200 OK
OK
Schema: transfer
400 Bad Request
Bad Request. The request body or one or more of the query parameters was not well formed. The _error field in the response will contain details about the request error.
Schema: errorResponse
404 Not Found
Not Found. There is no such resource at the specified {Id} The _error field in the response will contain details about the request error.
Schema: error
409 Conflict
Conflict. A conflict can occur if another existing transfer matches the request exactly. If similar transfers are desired, ensure at least the description is unique.
412 Precondition Failed
Precondition Failed. The supplied if-Match header value does not match the most recent ETag response header value. The resource has changed in the interim.
Schema: errorResponse
422 Unprocessable Entity
Unprocessable Entity. One or more of the query parameters was well formed but otherwise invalid. The _error field in the response will contain details about the request error.
Schema: errorResponse

Response Headers

StatusDescription
200 ETag string
The ETag response header specifies an entity tag which must be provided in an If-Match request header for PUT or PATCH operations which update this transfer resource.

suspendScheduledTransfer

Code samples

# You can also use wget
curl -X POST /transfers/suspendedScheduledTransfers?scheduledTransfer=string \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

POST /transfers/suspendedScheduledTransfers?scheduledTransfer=string HTTP/1.1

Accept: application/hal+json
If-Match: string

var headers = {
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/transfers/suspendedScheduledTransfers',
  method: 'post',
  data: '?scheduledTransfer=string',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

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

const headers = {
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('/transfers/suspendedScheduledTransfers?scheduledTransfer=string',
{
  method: 'POST',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'If-Match' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/transfers/suspendedScheduledTransfers',
  params: {
  'scheduledTransfer' => 'string'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'If-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/transfers/suspendedScheduledTransfers', params={
  'scheduledTransfer': 'string'
}, headers = headers)

print r.json()

URL obj = new URL("/transfers/suspendedScheduledTransfers?scheduledTransfer=string");
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{
        "Accept": []string{"application/hal+json"},
        "If-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/transfers/suspendedScheduledTransfers", data)
    req.Header = headers

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

Suspend a scheduled transfer

POST /suspendedScheduledTransfers

POST the URI of a scheduled transfer to suspend it. This disables future recurring transfers until the scheduled transfer is either resumed or canceled. Any transfers that would have occurred on dates that passed while suspended will not be processed on those dates. Use the apiture:resume or apiture:cancel links on the instance to resume or cancel the remaining transfers. This operation is only valid on scheduled transfers which are in the scheduled or recurring states.

This operation is invoked by submitting a POST to the href in the scheduled transfer's apiture:suspend link, The link will be present if the transfer can be suspended.

Parameters

Parameter Description
scheduledTransfer
(query)
string (required)
A server-generated key which identifies a scheduled transfer resource.
scheduledTransferUri
(query)
string
The URI of a scheduled transfer resource. This parameter is deprecated and will be removed in the next version. Use ?scheduledTransfer= instead.
If-Match
(header)
string
The entity tag that was returned in the ETag response. This must match the current entity tag of the resource.

Example responses

200 Response

{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_profile": "https://api.apiture.com/schemas/transfers/scheduledTransfer/v1.0.0/profile.json",
  "createdBy": "lucille-4700",
  "createdAt": "2018-05-08T13:37:57.375Z",
  "modifiedBy": "lucille-4700",
  "modifiedAt": "2018-05-18T16:42:57.000Z",
  "_links": {
    "self": {
      "href": "/transfers/scheduledTransfers/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:source": {
      "href": "/accounts/accounts/46a31698-7398-4538-a9c9-9496010da2c2"
    },
    "apiture:target": {
      "href": "/accounts/externalAccounts/599b8ab5-6925-4f58-90c5-f6aa5b05f9d9"
    },
    "apiture:creator": {
      "href": "/users/users/d076e102-facf-46e2-8ecf-bcdb531cd9e6"
    },
    "apiture:transactions": {
      "href": "/transaction?transfer=/transfers/transfers/0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "_embedded": {
    "transactions": {
      "start": 0,
      "count": 3,
      "items": [
        {
          "_id": "da8682e3-cc0b-4a1a-b8d2-8ce4dc45bf36",
          "occurredAt": "2018-02-05T11:10:00.375Z",
          "amount": {
            "value": "345.50",
            "currency": "USD",
            "description": "Car payment"
          }
        },
        {
          "_id": "a847c5c7-4a34-4464-b514-5ca1680cc00d",
          "occurredAt": "2018-03-05T11:11:17.375Z",
          "amount": {
            "value": "345.50",
            "currency": "USD",
            "description": "Car payment"
          }
        },
        {
          "_id": "d9ab0002-2cbb-4a4c-a01f-c3ce3ad20782",
          "occurredAt": "2018-04-05T11:11:17.375Z",
          "amount": {
            "value": "345.50",
            "currency": "USD",
            "description": "Car payment"
          }
        }
      ]
    },
    "source": {
      "_id": "34f8bec8-3939-4b7e-9ad5-10ee059ab250",
      "_profile": "https://api.apiture.com/schemas/accounts/summaryAccount/v1.0.0/profile.json",
      "name": "Personal Savings",
      "productName": "Basic Personal Savings",
      "type": "Personal Savings",
      "subtype": "Basic Personal Savings",
      "state": "active",
      "balance": {
        "current": "3450.30",
        "available": "3450.30",
        "currency": "USD"
      },
      "_links": {
        "self": {
          "href": "https://api.apiture.com/accounts/34f8bec8-3939-4b7e-9ad5-10ee059ab250"
        }
      }
    },
    "target": {
      "_id": "c9839d60-73e5-47ba-9676-ca8138e9494d",
      "_profile": "https://api.apiture.com/schemas/accounts/summaryAccount/v1.0.0/profile.json",
      "name": "My Basic Checking",
      "productName": "Basic Personal Checking",
      "type": "Personal Checking",
      "subtype": "Basic Personal Checking",
      "state": "active",
      "balance": {
        "current": "450.12",
        "available": "450.12",
        "currency": "USD"
      },
      "_links": {
        "self": {
          "href": "https://api.apiture.com/accounts/c9839d60-73e5-47ba-9676-ca8138e9494d"
        }
      }
    },
    "_links": {
      "self": {
        "href": "/transaction?transfer=/transfers/transfers/0399abed-fd3d-4830-a88b-30f38b8a365c"
      }
    }
  },
  "amount": {
    "value": "345.50",
    "currency": "USD"
  },
  "description": "Car payment",
  "state": "recurring",
  "schedule": {
    "start": "2018-02-05",
    "count": 3,
    "every": "P1M",
    "end": "2021-04-05"
  }
}

Responses

StatusDescription
200 OK
OK
Schema: scheduledTransfer
400 Bad Request
Bad Request. The scheduledTransferUri was malformed or does not refer to a scheduled transfer.
409 Conflict
Conflict. The specified scheduled transfer is in a state that does not allow suspending.
412 Precondition Failed
Precondition Failed. The supplied if-Match header value does not match the most recent ETag response header value. The resource has changed in the interim.
Schema: errorResponse
422 Unprocessable Entity
Unprocessable Entity. One or more of the query parameters was well formed but otherwise invalid. The _error field in the response will contain details about the request error.
Schema: errorResponse
500 Internal Server Error
Server Error. The server encountered an unexpected condition that prevented it from fulfilling the request.
Schema: errorResponse

Response Headers

StatusDescription
200 ETag string
The ETag response header specifies an entity tag which must be provided in an If-Match request header for PUT or PATCH operations which update this transfer resource.

resumeScheduledTransfer

Code samples

# You can also use wget
curl -X POST /transfers/resumedScheduledTransfers?scheduledTransfer=string \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

POST /transfers/resumedScheduledTransfers?scheduledTransfer=string HTTP/1.1

Accept: application/hal+json
If-Match: string

var headers = {
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/transfers/resumedScheduledTransfers',
  method: 'post',
  data: '?scheduledTransfer=string',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

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

const headers = {
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('/transfers/resumedScheduledTransfers?scheduledTransfer=string',
{
  method: 'POST',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'If-Match' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/transfers/resumedScheduledTransfers',
  params: {
  'scheduledTransfer' => 'string'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'If-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/transfers/resumedScheduledTransfers', params={
  'scheduledTransfer': 'string'
}, headers = headers)

print r.json()

URL obj = new URL("/transfers/resumedScheduledTransfers?scheduledTransfer=string");
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{
        "Accept": []string{"application/hal+json"},
        "If-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/transfers/resumedScheduledTransfers", data)
    req.Header = headers

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

Resume a suspended scheduled transfer

POST /resumedScheduledTransfers

POST the URI of a suspended scheduled transfer to resume it. This enables future recurring transfers. Any transfers that would have occurred on dates that passed while suspended will not be processed on those dates. See also the extendSchedule query parameter on this operation. This operation is only valid on scheduled transfers which are in the suspended state.

This operation is invoked by submitting a POST to the href in the scheduled transfer's apiture:resume link, The link will be present if the transfer can be resumed.

Parameters

Parameter Description
scheduledTransfer
(query)
string (required)
A server-generated key which identifies a scheduled transfer resource.
scheduledTransferUri
(query)
string
The URI of a scheduled transfer resource. This parameter is deprecated and will be removed in the next version. Use ?scheduledTransfer= instead.
If-Match
(header)
string
The entity tag that was returned in the ETag response. This must match the current entity tag of the resource.
extendSchedule
(query)
boolean
If true, the schedule.end will be extended if necessary so that the maximumCount number of transfers will be made (based on the periods in every). The default value (false) prevents processing transfers that the user may not expect based on the original schedule. (The user may still update the schedule.end via PATCH to the scheduled transfer.)

Example responses

200 Response

{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_profile": "https://api.apiture.com/schemas/transfers/scheduledTransfer/v1.0.0/profile.json",
  "createdBy": "lucille-4700",
  "createdAt": "2018-05-08T13:37:57.375Z",
  "modifiedBy": "lucille-4700",
  "modifiedAt": "2018-05-18T16:42:57.000Z",
  "_links": {
    "self": {
      "href": "/transfers/scheduledTransfers/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:source": {
      "href": "/accounts/accounts/46a31698-7398-4538-a9c9-9496010da2c2"
    },
    "apiture:target": {
      "href": "/accounts/externalAccounts/599b8ab5-6925-4f58-90c5-f6aa5b05f9d9"
    },
    "apiture:creator": {
      "href": "/users/users/d076e102-facf-46e2-8ecf-bcdb531cd9e6"
    },
    "apiture:transactions": {
      "href": "/transaction?transfer=/transfers/transfers/0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "_embedded": {
    "transactions": {
      "start": 0,
      "count": 3,
      "items": [
        {
          "_id": "da8682e3-cc0b-4a1a-b8d2-8ce4dc45bf36",
          "occurredAt": "2018-02-05T11:10:00.375Z",
          "amount": {
            "value": "345.50",
            "currency": "USD",
            "description": "Car payment"
          }
        },
        {
          "_id": "a847c5c7-4a34-4464-b514-5ca1680cc00d",
          "occurredAt": "2018-03-05T11:11:17.375Z",
          "amount": {
            "value": "345.50",
            "currency": "USD",
            "description": "Car payment"
          }
        },
        {
          "_id": "d9ab0002-2cbb-4a4c-a01f-c3ce3ad20782",
          "occurredAt": "2018-04-05T11:11:17.375Z",
          "amount": {
            "value": "345.50",
            "currency": "USD",
            "description": "Car payment"
          }
        }
      ]
    },
    "source": {
      "_id": "34f8bec8-3939-4b7e-9ad5-10ee059ab250",
      "_profile": "https://api.apiture.com/schemas/accounts/summaryAccount/v1.0.0/profile.json",
      "name": "Personal Savings",
      "productName": "Basic Personal Savings",
      "type": "Personal Savings",
      "subtype": "Basic Personal Savings",
      "state": "active",
      "balance": {
        "current": "3450.30",
        "available": "3450.30",
        "currency": "USD"
      },
      "_links": {
        "self": {
          "href": "https://api.apiture.com/accounts/34f8bec8-3939-4b7e-9ad5-10ee059ab250"
        }
      }
    },
    "target": {
      "_id": "c9839d60-73e5-47ba-9676-ca8138e9494d",
      "_profile": "https://api.apiture.com/schemas/accounts/summaryAccount/v1.0.0/profile.json",
      "name": "My Basic Checking",
      "productName": "Basic Personal Checking",
      "type": "Personal Checking",
      "subtype": "Basic Personal Checking",
      "state": "active",
      "balance": {
        "current": "450.12",
        "available": "450.12",
        "currency": "USD"
      },
      "_links": {
        "self": {
          "href": "https://api.apiture.com/accounts/c9839d60-73e5-47ba-9676-ca8138e9494d"
        }
      }
    },
    "_links": {
      "self": {
        "href": "/transaction?transfer=/transfers/transfers/0399abed-fd3d-4830-a88b-30f38b8a365c"
      }
    }
  },
  "amount": {
    "value": "345.50",
    "currency": "USD"
  },
  "description": "Car payment",
  "state": "recurring",
  "schedule": {
    "start": "2018-02-05",
    "count": 3,
    "every": "P1M",
    "end": "2021-04-05"
  }
}

Responses

StatusDescription
200 OK
OK
Schema: scheduledTransfer
400 Bad Request
Bad Request. The scheduledTransferUri was malformed or does not refer to a scheduled transfer.
409 Conflict
Conflict. The specified scheduled transfer is in a state that does not allow resuming.
412 Precondition Failed
Precondition Failed. The supplied if-Match header value does not match the most recent ETag response header value. The resource has changed in the interim.
Schema: errorResponse
422 Unprocessable Entity
Unprocessable Entity. One or more of the query parameters was well formed but otherwise invalid. The _error field in the response will contain details about the request error.
Schema: errorResponse
500 Internal Server Error
Server Error. The server encountered an unexpected condition that prevented it from fulfilling the request.
Schema: errorResponse

Response Headers

StatusDescription
200 ETag string
The ETag response header specifies an entity tag which must be provided in an If-Match request header for PUT or PATCH operations which update this transfer resource.

cancelScheduledTransfer

Code samples

# You can also use wget
curl -X POST /transfers/canceledScheduledTransfers?scheduledTransfer=string \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

POST /transfers/canceledScheduledTransfers?scheduledTransfer=string HTTP/1.1

Accept: application/hal+json
If-Match: string

var headers = {
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/transfers/canceledScheduledTransfers',
  method: 'post',
  data: '?scheduledTransfer=string',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

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

const headers = {
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('/transfers/canceledScheduledTransfers?scheduledTransfer=string',
{
  method: 'POST',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'If-Match' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/transfers/canceledScheduledTransfers',
  params: {
  'scheduledTransfer' => 'string'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'If-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/transfers/canceledScheduledTransfers', params={
  'scheduledTransfer': 'string'
}, headers = headers)

print r.json()

URL obj = new URL("/transfers/canceledScheduledTransfers?scheduledTransfer=string");
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{
        "Accept": []string{"application/hal+json"},
        "If-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/transfers/canceledScheduledTransfers", data)
    req.Header = headers

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

Cancel a scheduled transfer

POST /canceledScheduledTransfers

POST the URI of a scheduled transfer to cancel it. This cancels all future recurring transfers. Any transfers that would have occurred on future dates will be canceled. This operation is only valid on scheduled transfers which are in the scheduled, recurring, or suspended state. It may also be allowed if the transfer state is processing and the optional cutoff time has not passed.

This operation is invoked by submitting a POST to the href in the scheduled transfer's apiture:cancel link, The link will be present if the transfer can be canceled.

Parameters

Parameter Description
scheduledTransfer
(query)
string (required)
A server-generated key which identifies a scheduled transfer resource.
scheduledTransferUri
(query)
string
The URI of a scheduled transfer resource. This parameter is deprecated and will be removed in the next version. Use ?scheduledTransfer= instead.
If-Match
(header)
string
The entity tag that was returned in the ETag response. This must match the current entity tag of the resource.

Example responses

200 Response

{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_profile": "https://api.apiture.com/schemas/transfers/scheduledTransfer/v1.0.0/profile.json",
  "createdBy": "lucille-4700",
  "createdAt": "2018-05-08T13:37:57.375Z",
  "modifiedBy": "lucille-4700",
  "modifiedAt": "2018-05-18T16:42:57.000Z",
  "_links": {
    "self": {
      "href": "/transfers/scheduledTransfers/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:source": {
      "href": "/accounts/accounts/46a31698-7398-4538-a9c9-9496010da2c2"
    },
    "apiture:target": {
      "href": "/accounts/externalAccounts/599b8ab5-6925-4f58-90c5-f6aa5b05f9d9"
    },
    "apiture:creator": {
      "href": "/users/users/d076e102-facf-46e2-8ecf-bcdb531cd9e6"
    },
    "apiture:transactions": {
      "href": "/transaction?transfer=/transfers/transfers/0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "_embedded": {
    "transactions": {
      "start": 0,
      "count": 3,
      "items": [
        {
          "_id": "da8682e3-cc0b-4a1a-b8d2-8ce4dc45bf36",
          "occurredAt": "2018-02-05T11:10:00.375Z",
          "amount": {
            "value": "345.50",
            "currency": "USD",
            "description": "Car payment"
          }
        },
        {
          "_id": "a847c5c7-4a34-4464-b514-5ca1680cc00d",
          "occurredAt": "2018-03-05T11:11:17.375Z",
          "amount": {
            "value": "345.50",
            "currency": "USD",
            "description": "Car payment"
          }
        },
        {
          "_id": "d9ab0002-2cbb-4a4c-a01f-c3ce3ad20782",
          "occurredAt": "2018-04-05T11:11:17.375Z",
          "amount": {
            "value": "345.50",
            "currency": "USD",
            "description": "Car payment"
          }
        }
      ]
    },
    "source": {
      "_id": "34f8bec8-3939-4b7e-9ad5-10ee059ab250",
      "_profile": "https://api.apiture.com/schemas/accounts/summaryAccount/v1.0.0/profile.json",
      "name": "Personal Savings",
      "productName": "Basic Personal Savings",
      "type": "Personal Savings",
      "subtype": "Basic Personal Savings",
      "state": "active",
      "balance": {
        "current": "3450.30",
        "available": "3450.30",
        "currency": "USD"
      },
      "_links": {
        "self": {
          "href": "https://api.apiture.com/accounts/34f8bec8-3939-4b7e-9ad5-10ee059ab250"
        }
      }
    },
    "target": {
      "_id": "c9839d60-73e5-47ba-9676-ca8138e9494d",
      "_profile": "https://api.apiture.com/schemas/accounts/summaryAccount/v1.0.0/profile.json",
      "name": "My Basic Checking",
      "productName": "Basic Personal Checking",
      "type": "Personal Checking",
      "subtype": "Basic Personal Checking",
      "state": "active",
      "balance": {
        "current": "450.12",
        "available": "450.12",
        "currency": "USD"
      },
      "_links": {
        "self": {
          "href": "https://api.apiture.com/accounts/c9839d60-73e5-47ba-9676-ca8138e9494d"
        }
      }
    },
    "_links": {
      "self": {
        "href": "/transaction?transfer=/transfers/transfers/0399abed-fd3d-4830-a88b-30f38b8a365c"
      }
    }
  },
  "amount": {
    "value": "345.50",
    "currency": "USD"
  },
  "description": "Car payment",
  "state": "recurring",
  "schedule": {
    "start": "2018-02-05",
    "count": 3,
    "every": "P1M",
    "end": "2021-04-05"
  }
}

Responses

StatusDescription
200 OK
OK
Schema: scheduledTransfer
400 Bad Request
Bad Request. The scheduledTransferUri was malformed or does not refer to a scheduled transfer.
409 Conflict
Conflict. The specified scheduled transfer is in a state that does not allow cancelation.
412 Precondition Failed
Precondition Failed. The supplied if-Match header value does not match the most recent ETag response header value. The resource has changed in the interim.
Schema: errorResponse
422 Unprocessable Entity
Unprocessable Entity. One or more of the query parameters was well formed but otherwise invalid. The _error field in the response will contain details about the request error.
Schema: errorResponse
500 Internal Server Error
Server Error. The server encountered an unexpected condition that prevented it from fulfilling the request.
Schema: errorResponse

Response Headers

StatusDescription
200 ETag string
The ETag response header specifies an entity tag which must be provided in an If-Match request header for PUT or PATCH operations which update this transfer resource.

Past Transfer

Processed transfers

getPastTransfers

Code samples

# You can also use wget
curl -X GET /transfers/pastTransfers \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

GET /transfers/pastTransfers HTTP/1.1

Accept: application/hal+json

var headers = {
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/transfers/pastTransfers',
  method: 'get',

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

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

const headers = {
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('/transfers/pastTransfers',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/transfers/pastTransfers',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/transfers/pastTransfers', params={

}, headers = headers)

print r.json()

URL obj = new URL("/transfers/pastTransfers");
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/hal+json"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/transfers/pastTransfers", data)
    req.Header = headers

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

Return a collection of past transfers

GET /pastTransfers

Return a paginated sortable filterable searchable collection of past transfers. The links in the response include pagination links.

Past transfers are transfers which have been processed or canceled.

Parameters

Parameter Description
start
(query)
integer(int64)
The zero-based index of the first transfer item to include in this page. The default 0 denotes the beginning of the collection.
limit
(query)
integer(int32)
The maximum number of transfer representations to return in this page.
sortBy
(query)
string
Optional sort criteria. See sort criteria format, such as ?sortBy=field1,-field2.
filter
(query)
string
Optional filter criteria. See filtering.
q
(query)
string
Optional search string. See searching.
state
(query)
string
Subset the accounts or external accounts collection to those whose state matches this value. Use | to separate multiple values. For example, ?state=pending will match only items whose state is pending; ?state=removed|inactive will match items whose state is removed or inactive. This is combined with an implicit and with other filters if they are used. See filtering.
Enumerated values:
scheduled
recurring
processing
suspended
completed
canceled
failed
name
(query)
string
Subset the accounts or external accounts collection to those with this name value. Use

Example responses

200 Response

{
  "_profile": "https://api.apiture.com/schemas/transfers/pastTransfers/v1.0.0/profile.json",
  "start": 10,
  "limit": 10,
  "count": 67,
  "name": "transfers",
  "_links": {
    "self": {
      "href": "/transfers/pastTransfers?start=10&limit=10"
    },
    "first": {
      "href": "/transfers/pastTransfers?start=0&limit=10"
    },
    "next": {
      "href": "/transfers/pastTransfers?start=20&limit=10"
    },
    "collection": {
      "href": "/transfers/pastTransfers"
    }
  },
  "_embedded": {
    "items": [
      {
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "_profile": "https://api.apiture.com/schemas/transfers/summaryPastTransfer/v1.0.0/profile.json",
        "amount": {
          "value": "345.50",
          "currency": "USD"
        },
        "description": "Car payment",
        "state": "recurring",
        "schedule": {
          "start": "2018-02-05",
          "count": 3,
          "every": "P1M",
          "end": "2021-04-05"
        },
        "_links": {
          "apiture:source": {
            "href": "/accounts/accounts/46a31698-7398-4538-a9c9-9496010da2c2"
          },
          "apiture:target": {
            "href": "/accounts/externalAccounts/599b8ab5-6925-4f58-90c5-f6aa5b05f9d9"
          },
          "apiture:transactions": {
            "href": "/transaction?transfer=/transfers/transfers/0399abed-fd3d-4830-a88b-30f38b8a365c"
          },
          "self": {
            "href": "/transfers/pastTransfers/0399abed-fd3d-4830-a88b-30f38b8a365c"
          }
        }
      },
      {
        "_id": "a3bbba3c-d26b-497d-87b7-09eb47b24d77",
        "_profile": "https://api.apiture.com/schemas/transfers/summaryPastTransfer/v1.0.0/profile.json",
        "amount": {
          "value": "120.0",
          "currency": "USD"
        },
        "description": "Monthly allowance for Suzy's college expenses and meals",
        "state": "recurring",
        "schedule": {
          "start": "2018-08-01",
          "count": 24,
          "every": "P1M",
          "end": "2020-05-15"
        },
        "_links": {
          "apiture:source": {
            "href": "/accounts/accounts/46a31698-7398-4538-a9c9-9496010da2c2"
          },
          "apiture:target": {
            "href": "/accounts/externalAccounts/4fda6275-0a3b-49ad-ad12-5ebcd7013362"
          },
          "apiture:transactions": {
            "href": "/transaction?transfer=/transfers/transfers/a3bbba3c-d26b-497d-87b7-09eb47b24d77"
          },
          "self": {
            "href": "/transfers/pastTransfers/a3bbba3c-d26b-497d-87b7-09eb47b24d77"
          }
        }
      }
    ]
  }
}

Responses

StatusDescription
200 OK
OK
Schema: pastTransfers
400 Bad Request
Bad Request. The request body or one or more of the query parameters was not well formed. The _error field in the response will contain details about the request error.
Schema: errorResponse
422 Unprocessable Entity
Unprocessable Entity. One or more of the query parameters was well formed but otherwise invalid. The _error field in the response will contain details about the request error.
Schema: errorResponse

getPastTransfer

Code samples

# You can also use wget
curl -X GET /transfers/pastTransfers/{pastTransferId} \
  -H 'Accept: application/hal+json' \
  -H 'If-None-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

GET /transfers/pastTransfers/{pastTransferId} HTTP/1.1

Accept: application/hal+json
If-None-Match: string

var headers = {
  'Accept':'application/hal+json',
  'If-None-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/transfers/pastTransfers/{pastTransferId}',
  method: 'get',

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

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

const headers = {
  'Accept':'application/hal+json',
  'If-None-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('/transfers/pastTransfers/{pastTransferId}',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'If-None-Match' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/transfers/pastTransfers/{pastTransferId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'If-None-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/transfers/pastTransfers/{pastTransferId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("/transfers/pastTransfers/{pastTransferId}");
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/hal+json"},
        "If-None-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/transfers/pastTransfers/{pastTransferId}", data)
    req.Header = headers

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

Fetch a representation of this past transfer

GET /pastTransfers/{pastTransferId}

Return a HAL representation of this transfer resource.

Parameters

Parameter Description
pastTransferId
(path)
string (required)
The unique identifier of this scheduled transfer. This is an opaque string.
If-None-Match
(header)
string
The entity tag that was returned in the ETag response. If the resource's current entity tag matches, the GET will return 304 (Not Modified) and no response body, else the resource representation will be returned.
unmasked
(query)
boolean
When requesting a transfer, the full account number of the source and target accounts is not included in the response by default, for security reasons. Include this query parameter, with a value of true, to request that the response body includes the full account number. Such requests are auditable.

Example responses

200 Response

{
  "_links": {
    "property1": {
      "href": "http://example.com",
      "type": "string",
      "templated": true,
      "title": "string",
      "deprecation": "http://example.com",
      "profile": "http://example.com"
    },
    "property2": {
      "href": "http://example.com",
      "type": "string",
      "templated": true,
      "title": "string",
      "deprecation": "http://example.com",
      "profile": "http://example.com"
    }
  },
  "_embedded": {},
  "_profile": "http://example.com",
  "_error": {
    "_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
    "_profile": "https://api.apiture.com/schemas/common/errorResponse/v1.0.0/profile.json",
    "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": "http://doc.apiture.com/errors/positiveNumberRequired"
      }
    },
    "_embedded": {
      "errors": []
    }
  },
  "amount": {
    "value": "345.50",
    "currency": "USD"
  },
  "description": "Car payment",
  "schedule": {
    "start": "2018-06-10",
    "every": "P14D",
    "count": 5,
    "maximumCount": 10,
    "end": "2018-08-01"
  },
  "type": "internal",
  "visibility": "visible",
  "confirmationId": "6e5413df-9574-4568-b0c4-dfd96bbb454b",
  "state": "scheduled",
  "_id": "string",
  "createdBy": "lucille-4700",
  "createdAt": "2018-05-08T13:37:57.375Z",
  "modifiedBy": "lucille-4700",
  "modifiedAt": "2018-05-18T16:42:57.000Z",
  "sourceAccount": {
    "accountTitle": "John Smith",
    "title": "John Smith",
    "institutionName": "3rd Party Bank",
    "routingNumber": "021000021",
    "accountNumbers": {
      "masked": "*************3210",
      "full": "9876543210"
    }
  },
  "targetAccount": {
    "accountTitle": "John Smith",
    "title": "John Smith",
    "institutionName": "3rd Party Bank",
    "routingNumber": "021000021",
    "accountNumbers": {
      "masked": "*************3210",
      "full": "9876543210"
    }
  },
  "completedAt": "2018-05-08T14:08:50.375Z"
}

Responses

StatusDescription
200 OK
OK
Schema: pastTransfer
304 Not Modified
Not Modified. The resource has not been modified since it was last fetched.
404 Not Found
Not Found. There is no such past transfer resource at the specified {transferId} The _error field in the response will contain details about the request error.
Schema: error

Response Headers

StatusDescription
200 ETag string
The ETag response header specifies an entity tag which must be provided in an If-Match request header for PUT or PATCH operations which update this transfer resource.

Configuration

A set of endpoints that allows for the creation and retrieval of configuration options specific to this service

getConfiguration

Code samples

# You can also use wget
curl -X GET /transfers/configuration \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

GET /transfers/configuration HTTP/1.1

Accept: application/hal+json

var headers = {
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/transfers/configuration',
  method: 'get',

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

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

const headers = {
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('/transfers/configuration',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/transfers/configuration',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/transfers/configuration', params={

}, headers = headers)

print r.json()

URL obj = new URL("/transfers/configuration");
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/hal+json"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/transfers/configuration", data)
    req.Header = headers

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

Configuration definition for this API

GET /configuration

Returns the configuration for this API

Example responses

200 Response

{
  "_links": {
    "self": {
      "href": "/transfers/configuration/"
    },
    "apiture:groups": {
      "href": "/transfers/configuration/groups"
    }
  }
}

Responses

StatusDescription
200 OK
OK
Schema: configuration

getConfigurationGroups

Code samples

# You can also use wget
curl -X GET /transfers/configuration/groups \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

GET /transfers/configuration/groups HTTP/1.1

Accept: application/hal+json

var headers = {
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/transfers/configuration/groups',
  method: 'get',

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

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

const headers = {
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('/transfers/configuration/groups',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/transfers/configuration/groups',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/transfers/configuration/groups', params={

}, headers = headers)

print r.json()

URL obj = new URL("/transfers/configuration/groups");
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/hal+json"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/transfers/configuration/groups", data)
    req.Header = headers

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

Return a collection of configuration groups

GET /configuration/groups

Return a paginated sortable filterable searchable collection of configuration groups. The links in the response include pagination links.

Parameters

Parameter Description
start
(query)
integer(int64)
The zero-based index of the first configuration group item to include in this page. The default 0 denotes the beginning of the collection.
limit
(query)
integer(int32)
The maximum number of configuration group representations to return in this page.
sortBy
(query)
string
Optional sort criteria. See sort criteria format, such as ?sortBy=field1,-field2.
filter
(query)
string
Optional filter criteria. See filtering.
q
(query)
string
Optional search string. See searching.

Example responses

200 Response

{
  "_profile": "https://api.apiture.com/schemas/transfers/configurationGroups/v1.0.0/profile.json",
  "start": 10,
  "limit": 10,
  "count": 67,
  "name": "configurationGroups",
  "_links": {
    "self": {
      "href": "/transfers/configuration/groups?start=10&limit=10"
    },
    "first": {
      "href": "/transfers/configuration/groups?start=0&limit=10"
    },
    "next": {
      "href": "/transfers/configuration/groups?start=20&limit=10"
    },
    "collection": {
      "href": "/transfers/configuration/groups"
    }
  },
  "_embedded": {
    "items": [
      {
        "_profile": "https://api.apiture.com/schemas/transfers/configurationGroup/v1.0.0/profile.json",
        "_links": {
          "self": {
            "href": "/configuration/groups/basic"
          },
          "apiture:configuration": {
            "href": "/configuration"
          }
        },
        "name": "basic",
        "label": "Basic Settings",
        "description": "The basic settings for the Transfers API"
      },
      {
        "_profile": "https://api.apiture.com/schemas/transfers/configurationGroup/v1.0.0/profile.json",
        "_links": {
          "self": {
            "href": "/configuration/groups/calendar"
          },
          "apiture:configuration": {
            "href": "/configuration"
          }
        },
        "name": "calendar",
        "label": "Calendar",
        "description": "A calendar that specifies which dates are valid for performing transfers (e.g., weekdays excluding federal holidays)"
      }
    ]
  }
}

Responses

StatusDescription
200 OK
OK
Schema: configurationGroups
400 Bad Request
Bad Request. The request body or one or more of the query parameters was not well formed. The _error field in the response will contain details about the request error.
Schema: errorResponse
422 Unprocessable Entity
Unprocessable Entity. One or more of the query parameters was well formed but otherwise invalid. The _error field in the response will contain details about the request error.
Schema: errorResponse

getConfigurationGroup

Code samples

# You can also use wget
curl -X GET /transfers/configuration/groups/{groupName} \
  -H 'Accept: application/hal+json' \
  -H 'If-None-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

GET /transfers/configuration/groups/{groupName} HTTP/1.1

Accept: application/hal+json
If-None-Match: string

var headers = {
  'Accept':'application/hal+json',
  'If-None-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/transfers/configuration/groups/{groupName}',
  method: 'get',

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

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

const headers = {
  'Accept':'application/hal+json',
  'If-None-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('/transfers/configuration/groups/{groupName}',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'If-None-Match' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/transfers/configuration/groups/{groupName}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'If-None-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/transfers/configuration/groups/{groupName}', params={

}, headers = headers)

print r.json()

URL obj = new URL("/transfers/configuration/groups/{groupName}");
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/hal+json"},
        "If-None-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/transfers/configuration/groups/{groupName}", data)
    req.Header = headers

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

Fetch a representation of this configuration group

GET /configuration/groups/{groupName}

Return a HAL representation of this configuration group resource.

Parameters

Parameter Description
groupName
(path)
string (required)
The unique name of this configuration group.
If-None-Match
(header)
string
The entity tag that was returned in the ETag response. If the resource's current entity tag matches, the GET will return 304 (Not Modified) and no response body, else the resource representation will be returned.

Example responses

200 Response

{
  "_profile": "https://api.apiture.com/schemas/transfers/configurationGroup/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "/configuration/groups/basic"
    },
    "apiture:configuration": {
      "href": "/configuration"
    }
  },
  "name": "basic",
  "label": "Basic Settings",
  "description": "The basic settings for the Transfers API",
  "schema": {
    "type": "object",
    "properties": {
      "dailyLimit": {
        "type": "number",
        "description": "The daily limit for the number of transfers"
      },
      "cutoffTime": {
        "type": "string",
        "format": "time",
        "description": "The cutoff time for scheduling transfers for the current day"
      }
    }
  },
  "values": {
    "dailyLimit": 5,
    "cutoffTime": "17:30:00"
  }
}

Responses

StatusDescription
200 OK
OK
Schema: configurationGroup
304 Not Modified
Not Modified. The resource has not been modified since it was last fetched.
404 Not Found
Not Found. There is no such configuration group resource at the specified {groupName} The _error field in the response will contain details about the request error.
Schema: error

Response Headers

StatusDescription
200 ETag string
The ETag response header specifies an entity tag which may be provided in an If-None-Match request header for GET operations for this configuration group resource.

getConfigurationGroupSchema

Code samples

# You can also use wget
curl -X GET /transfers/configuration/groups/{groupName}/schema \
  -H 'Accept: application/hal+json' \
  -H 'If-None-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

GET /transfers/configuration/groups/{groupName}/schema HTTP/1.1

Accept: application/hal+json
If-None-Match: string

var headers = {
  'Accept':'application/hal+json',
  'If-None-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/transfers/configuration/groups/{groupName}/schema',
  method: 'get',

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

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

const headers = {
  'Accept':'application/hal+json',
  'If-None-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('/transfers/configuration/groups/{groupName}/schema',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'If-None-Match' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/transfers/configuration/groups/{groupName}/schema',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'If-None-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/transfers/configuration/groups/{groupName}/schema', params={

}, headers = headers)

print r.json()

URL obj = new URL("/transfers/configuration/groups/{groupName}/schema");
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/hal+json"},
        "If-None-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/transfers/configuration/groups/{groupName}/schema", data)
    req.Header = headers

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

Fetch the schema for this configuration group

GET /configuration/groups/{groupName}/schema

Return a HAL representation of this configuration group schema resource.

Parameters

Parameter Description
groupName
(path)
string (required)
The unique name of this configuration group.
If-None-Match
(header)
string
The entity tag that was returned in the ETag response. If the resource's current entity tag matches, the GET will return 304 (Not Modified) and no response body, else the resource representation will be returned.

Example responses

200 Response

{
  "type": "object",
  "properties": {
    "dailyLimit": {
      "type": "number",
      "description": "The daily limit for the number of transfers"
    },
    "cutoffTime": {
      "type": "string",
      "format": "time",
      "description": "The cutoff time for scheduling transfers for the current day"
    }
  }
}

Responses

StatusDescription
200 OK
OK
Schema: configurationSchema
304 Not Modified
Not Modified. The resource has not been modified since it was last fetched.
404 Not Found
Not Found. There is no such configuration group resource at the specified {groupName} The _error field in the response will contain details about the request error.
Schema: error

Response Headers

StatusDescription
200 ETag string
The ETag response header specifies an entity tag which must be provided in an If-Match request header for PUT

getConfigurationGroupValues

Code samples

# You can also use wget
curl -X GET /transfers/configuration/groups/{groupName}/values \
  -H 'Accept: application/hal+json' \
  -H 'If-None-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

GET /transfers/configuration/groups/{groupName}/values HTTP/1.1

Accept: application/hal+json
If-None-Match: string

var headers = {
  'Accept':'application/hal+json',
  'If-None-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/transfers/configuration/groups/{groupName}/values',
  method: 'get',

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

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

const headers = {
  'Accept':'application/hal+json',
  'If-None-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('/transfers/configuration/groups/{groupName}/values',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'If-None-Match' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/transfers/configuration/groups/{groupName}/values',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'If-None-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/transfers/configuration/groups/{groupName}/values', params={

}, headers = headers)

print r.json()

URL obj = new URL("/transfers/configuration/groups/{groupName}/values");
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/hal+json"},
        "If-None-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/transfers/configuration/groups/{groupName}/values", data)
    req.Header = headers

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

Fetch the values for the specified configuration group

GET /configuration/groups/{groupName}/values

Return a representation of this configuration group values resource.

Parameters

Parameter Description
groupName
(path)
string (required)
The unique name of this configuration group.
If-None-Match
(header)
string
The entity tag that was returned in the ETag response. If the resource's current entity tag matches, the GET will return 304 (Not Modified) and no response body, else the resource representation will be returned.

Example responses

200 Response

{
  "dailyLimit": 5,
  "cutoffTime": "17:30:00"
}

Responses

StatusDescription
200 OK
OK
Schema: configurationValues
304 Not Modified
Not Modified. The resource has not been modified since it was last fetched.
404 Not Found
Not Found. There is no such configuration group resource at the specified {groupName} The _error field in the response will contain details about the request error.
Schema: error

Response Headers

StatusDescription
200 ETag string
The ETag response header specifies an entity tag which must be provided in an If-Match request header for PUT

updateConfigurationGroupValues

Code samples

# You can also use wget
curl -X PUT /transfers/configuration/groups/{groupName}/values \
  -H 'Content-Type: application/hal+json' \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

PUT /transfers/configuration/groups/{groupName}/values HTTP/1.1

Content-Type: application/hal+json
Accept: application/hal+json
If-Match: string

var headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/transfers/configuration/groups/{groupName}/values',
  method: 'put',

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

const fetch = require('node-fetch');
const inputBody = '{
  "dailyLimit": 5,
  "cutoffTime": "17:30:00"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('/transfers/configuration/groups/{groupName}/values',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/hal+json',
  'Accept' => 'application/hal+json',
  'If-Match' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put '/transfers/configuration/groups/{groupName}/values',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/hal+json',
  'Accept': 'application/hal+json',
  'If-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('/transfers/configuration/groups/{groupName}/values', params={

}, headers = headers)

print r.json()

URL obj = new URL("/transfers/configuration/groups/{groupName}/values");
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/hal+json"},
        "Accept": []string{"application/hal+json"},
        "If-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/transfers/configuration/groups/{groupName}/values", data)
    req.Header = headers

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

Update the values for the specified configuration group

PUT /configuration/groups/{groupName}/values

Perform a complete replacement of this set of values

Body parameter

{
  "dailyLimit": 5,
  "cutoffTime": "17:30:00"
}

Parameters

Parameter Description
groupName
(path)
string (required)
The unique name of this configuration group.
If-Match
(header)
string
The entity tag that was returned in the ETag response. This must match the current entity tag of the resource.
body
(body)
configurationValues (required)

Example responses

200 Response

{
  "type": "object",
  "properties": {
    "dailyLimit": {
      "type": "number",
      "description": "The daily limit for the number of transfers"
    },
    "cutoffTime": {
      "type": "string",
      "format": "time",
      "description": "The cutoff time for scheduling transfers for the current day"
    }
  }
}

Responses

StatusDescription
200 OK
OK
Schema: configurationSchema
400 Bad Request
Bad Request. The request body or one or more of the query parameters was not well formed. The _error field in the response will contain details about the request error.
Schema: errorResponse
404 Not Found
Not Found. There is no such configuration group resource at the specified {groupName} The _error field in the response will contain details about the request error.
Schema: error
412 Precondition Failed
Precondition Failed. The supplied if-Match header value does not match the most recent ETag response header value. The resource has changed in the interim.
Schema: errorResponse

Response Headers

StatusDescription
200 ETag string
The ETag response header specifies an entity tag which must be provided in an If-Match request header for PUT

getConfigurationGroupValue

Code samples

# You can also use wget
curl -X GET /transfers/configuration/groups/{groupName}/values/{valueName} \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

GET /transfers/configuration/groups/{groupName}/values/{valueName} HTTP/1.1

Accept: application/hal+json

var headers = {
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/transfers/configuration/groups/{groupName}/values/{valueName}',
  method: 'get',

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

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

const headers = {
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('/transfers/configuration/groups/{groupName}/values/{valueName}',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/transfers/configuration/groups/{groupName}/values/{valueName}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/transfers/configuration/groups/{groupName}/values/{valueName}', params={

}, headers = headers)

print r.json()

URL obj = new URL("/transfers/configuration/groups/{groupName}/values/{valueName}");
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/hal+json"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/transfers/configuration/groups/{groupName}/values/{valueName}", data)
    req.Header = headers

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

Fetch a single value associated with the specified configuration group

GET /configuration/groups/{groupName}/values/{valueName}

Fetch a single value associated with this configuration group. This provides convenient access to the map of values of the configuration group. To update a specific value, use PUT /transfers/configuration/groups/{groupName}/values/{valueName} (operation updateConfigurationGroupValue).

Parameters

Parameter Description
groupName
(path)
string (required)
The unique name of this configuration group.
valueName
(path)
string (required)
The unique name of a value in a configuration group. This is the name of the value in the schema. A {valueName} must be a simple identifier following the pattern letter [letter | digit | '-' | '_']*

Example responses

200 Response

{}

Responses

StatusDescription
200 OK
OK
Schema: Inline
404 Not Found
Not Found. There is either no such configuration group resource at the specified {groupName} or no such value at the specified {valueName}. The _error field in the response will contain details about the request error.
Schema: error

Response Schema

Response Headers

StatusDescription
200 ETag string
The ETag response header specifies an entity tag which must be provided in an If-Match request header for PUT or PATCH operations which update this configuration group resource.

updateConfigurationGroupValue

Code samples

# You can also use wget
curl -X PUT /transfers/configuration/groups/{groupName}/values/{valueName} \
  -H 'Content-Type: application/hal+json' \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

PUT /transfers/configuration/groups/{groupName}/values/{valueName} HTTP/1.1

Content-Type: application/hal+json
Accept: application/hal+json

var headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/transfers/configuration/groups/{groupName}/values/{valueName}',
  method: 'put',

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

const fetch = require('node-fetch');
const inputBody = '{}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('/transfers/configuration/groups/{groupName}/values/{valueName}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/hal+json',
  'Accept' => 'application/hal+json',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put '/transfers/configuration/groups/{groupName}/values/{valueName}',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.put('/transfers/configuration/groups/{groupName}/values/{valueName}', params={

}, headers = headers)

print r.json()

URL obj = new URL("/transfers/configuration/groups/{groupName}/values/{valueName}");
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/hal+json"},
        "Accept": []string{"application/hal+json"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/transfers/configuration/groups/{groupName}/values/{valueName}", data)
    req.Header = headers

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

Update a single value associated with the specified configuration group

PUT /configuration/groups/{groupName}/values/{valueName}

Update a single value associated with this configuration group. This provides convenient access to individual values of the configuration group as defined in the configuration group's schema. The request body must conform to the configuration group's schema for the named {valueName}. This operation is idempotent.

To update a specific value, use PUT /transfers/configuration/groups/{groupName}/values/{valueName} (operation updateConfigurationGroupValue).

Body parameter

{}

Parameters

Parameter Description
groupName
(path)
string (required)
The unique name of this configuration group.
valueName
(path)
string (required)
The unique name of a value in a configuration group. This is the name of the value in the schema. A {valueName} must be a simple identifier following the pattern letter [letter | digit | '-' | '_']*
body
(body)
attributes (required)

Example responses

200 Response

{}

Responses

StatusDescription
200 OK
OK
Schema: Inline

Response Schema

Response Headers

StatusDescription
200 ETag string
The ETag response header specifies an entity tag which must be provided in an If-Match request header for PUT or PATCH operations which update this configuration group resource.

Schemas

transferFields

{
  "amount": {
    "value": "345.50",
    "currency": "USD"
  },
  "description": "Car payment",
  "schedule": {
    "start": "2018-06-10",
    "every": "P14D",
    "count": 5,
    "maximumCount": 10,
    "end": "2018-08-01"
  },
  "type": "internal",
  "visibility": "visible",
  "confirmationId": "4OehPba97q7----0-8--bk--"
}

Common Transfer Fields

Fields of the transfer resource, used to build other model schema.

Properties

NameDescription
amount money
The amount of the transfer. For a transfer, the amount must be positive. The funding account must have sufficient available funds. Financial institutions may impose an upper limit on the amount in a transfer which may be lower than the available balance.
description string
A description of this transfer.
maxLength: 4096
schedule schedule
Describes when the transfer is scheduled to occur.
type string
The type of transfer.

An internal transfer is one where both the source and target account reside within the current financial institution. ach (Automated Clearinghouse) is for standard cross-institution, U.S. only transfers. ach transfers are typically processed in batches. wire transfers (not implemented in this release), can be processed faster (they may not depend on batch processing) and can also involve financial institution outside the U.S. However, wire transfers have higher fees.

This field is optional, but immutable after being set. The default is ach if either the source or target account is external, and internal if both accounts are internal. It is an error to set the type to ach or wire for transfers between internal accounts, or to set type to internal if either the source or target account is external.


Enumerated values:
internal
ach
wire

visibility string
The transfer may be visible or hidden. Some transfers are micro-deposit ACH transfers into a local account from an external account as part of external account verification. These transfers are hidden from the user: the user may only see the transfer amounts by viewing their external account (via that external financial institution). Hidden transfers are by default omitted from the /scheduledTransfers and /pastTransfers collections. Financial institution administrators, however, can view hidden transfers.


Enumerated values:
visible
hidden

confirmationId string
The confirmation id that the transfer request was received for processing.
read-only
maxLength: 32

createScheduledTransfer

{
  "_profile": "https://api.apiture.com/schemas/transfers/createScheduledTransfer/v1.0.0/profile.json",
  "amount": {
    "value": "345.50",
    "currency": "USD"
  },
  "description": "Car payment",
  "schedule": {
    "start": "2018-02-05",
    "maximumCount": 36,
    "every": "P1M",
    "end": "2021-04-05"
  },
  "_links": {
    "apiture:source": {
      "href": "/accounts/accounts/46a31698-7398-4538-a9c9-9496010da2c2"
    },
    "apiture:target": {
      "href": "/accounts/externalAccounts/599b8ab5-6925-4f58-90c5-f6aa5b05f9d9"
    }
  }
}

Create Scheduled Transfer

Representation used to schedule a new transfer. The request includes the amount of the transfer and the schedule in the body, and the source and target accounts in the request's _links via the link relations apiture:source and apiture:target.

Properties

NameDescription
_links links (required)
An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
_embedded object
An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile string(uri)
The URI of a resource profile which describes the representation.
_error error
An object which describes an error. This value is omitted if the operation succeeded without error.
amount money (required)
The amount of the transfer. For a transfer, the amount must be positive. The funding account must have sufficient available funds. Financial institutions may impose an upper limit on the amount in a transfer which may be lower than the available balance.
description string
A description of this transfer.
maxLength: 4096
schedule schedule (required)
Describes when the transfer is scheduled to occur.
type string
The type of transfer.

An internal transfer is one where both the source and target account reside within the current financial institution. ach (Automated Clearinghouse) is for standard cross-institution, U.S. only transfers. ach transfers are typically processed in batches. wire transfers (not implemented in this release), can be processed faster (they may not depend on batch processing) and can also involve financial institution outside the U.S. However, wire transfers have higher fees.

This field is optional, but immutable after being set. The default is ach if either the source or target account is external, and internal if both accounts are internal. It is an error to set the type to ach or wire for transfers between internal accounts, or to set type to internal if either the source or target account is external.


Enumerated values:
internal
ach
wire

visibility string
The transfer may be visible or hidden. Some transfers are micro-deposit ACH transfers into a local account from an external account as part of external account verification. These transfers are hidden from the user: the user may only see the transfer amounts by viewing their external account (via that external financial institution). Hidden transfers are by default omitted from the /scheduledTransfers and /pastTransfers collections. Financial institution administrators, however, can view hidden transfers.


Enumerated values:
visible
hidden

confirmationId string
The confirmation id that the transfer request was received for processing.
read-only
maxLength: 32

summaryScheduledTransfer

{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_profile": "https://api.apiture.com/schemas/transfers/summaryScheduledTransfer/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "/transfers/scheduledTransfers/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:source": {
      "href": "/accounts/accounts/46a31698-7398-4538-a9c9-9496010da2c2"
    },
    "apiture:target": {
      "href": "/accounts/externalAccounts/599b8ab5-6925-4f58-90c5-f6aa5b05f9d9"
    }
  },
  "state": "recurring",
  "amount": {
    "value": "345.50",
    "currency": "USD"
  },
  "description": "Car payment",
  "schedule": {
    "start": "2018-02-05",
    "maximumCount": 36,
    "count": 11,
    "every": "P1M",
    "end": "2021-04-05"
  }
}

Scheduled Transfer Summary

Summary representation of a scheduled transfer resource. The summary includes the transfer ID, description, amount, state, and schedule, and the _links indicate the source and target accounts. This representation normally does not contain any _embedded objects. If needed, call the GET operation on the item's self link to get _embedded objects. For transfers which have failed, the _error object will describe the error circumstances.

Properties

NameDescription
_links links
An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
_embedded object
An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile string(uri)
The URI of a resource profile which describes the representation.
_error error
An object which describes an error. This value is omitted if the operation succeeded without error.
amount money
The amount of the transfer. For a transfer, the amount must be positive. The funding account must have sufficient available funds. Financial institutions may impose an upper limit on the amount in a transfer which may be lower than the available balance.
description string
A description of this transfer.
maxLength: 4096
schedule schedule
Describes when the transfer is scheduled to occur.
type string
The type of transfer.

An internal transfer is one where both the source and target account reside within the current financial institution. ach (Automated Clearinghouse) is for standard cross-institution, U.S. only transfers. ach transfers are typically processed in batches. wire transfers (not implemented in this release), can be processed faster (they may not depend on batch processing) and can also involve financial institution outside the U.S. However, wire transfers have higher fees.

This field is optional, but immutable after being set. The default is ach if either the source or target account is external, and internal if both accounts are internal. It is an error to set the type to ach or wire for transfers between internal accounts, or to set type to internal if either the source or target account is external.


Enumerated values:
internal
ach
wire

visibility string
The transfer may be visible or hidden. Some transfers are micro-deposit ACH transfers into a local account from an external account as part of external account verification. These transfers are hidden from the user: the user may only see the transfer amounts by viewing their external account (via that external financial institution). Hidden transfers are by default omitted from the /scheduledTransfers and /pastTransfers collections. Financial institution administrators, however, can view hidden transfers.


Enumerated values:
visible
hidden

confirmationId string
The confirmation id that the transfer request was received for processing.
read-only
maxLength: 32
state string
The state of the transfer. This is a derived and immutable value. The Transfers service processing updates the state. The state can be one of the following:

  • scheduled - A transfer is scheduled after a new one-time transfer is approved; it is scheduled to occur in the future.
  • recurring - A transfer is recurring after a new recurring transfer is approved; it is scheduled to start in the future.
  • pendingApproval - The source or target account is an external account which has not been verified. The financial institution may review the transfer and approve or deny it (the state will change to scheduled or failed).
  • processing - A transfer which has been begun and is currently being processed. A processing transfer can be modified as long as the transfer cutoff time has not passed. Once the cutoff time passes, the transfer cannot be modified (the amount or schedule may not be changed). To change a recurring transfer after the cutoff time, wait for the state to change back to recurring.
  • suspended - A scheduled recurring transfer which is temporarily suspended or paused. No further transfer of funds will occur until it is resumed. If it is resumed, any missed transfers will not be performed.
  • canceled - A transfer which has been canceled. No further transfer of funds will occur. Canceled transfers cannot be restarted; create a new one instead, or suspend/resume them instead of canceling. A canceled transfer cannot be modified. Note: There is no way to cancel specific transfers within a recurring transfer; instead, suspend the transfer and resume it after the desired date has passed.
  • failed - A transfer which failed. The _error will indicate the cause. A completed transfer cannot be modified.
  • completed - A transfer which has completed successfully. A completed transfer cannot be modified.

The client may change state in a limited number of ways: suspending a scheduled or recurring transaction via POST to the /suspendedScheduledTransfers; resuming a suspended recurring transaction via POST to the /resumedScheduledTransfers; canceling a scheduled transaction via POST to the /canceledScheduledTransfers. These operations are available with the apiture:suspend, apiture:resume, apiture:cancel links, respectively, on an instance. canceled by POSTing to /canceledTransfers. No request body is used on these operations.
read-only


Enumerated values:
scheduled
recurring
processing
suspended
completed
canceled
failed

_id string
The unique identifier for this transfer resource. This is an immutable opaque string.

summaryPastTransfer

{
  "_links": {
    "property1": {
      "href": "http://example.com",
      "type": "string",
      "templated": true,
      "title": "string",
      "deprecation": "http://example.com",
      "profile": "http://example.com"
    },
    "property2": {
      "href": "http://example.com",
      "type": "string",
      "templated": true,
      "title": "string",
      "deprecation": "http://example.com",
      "profile": "http://example.com"
    }
  },
  "_embedded": {},
  "_profile": "http://example.com",
  "_error": {
    "_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
    "_profile": "https://api.apiture.com/schemas/common/errorResponse/v1.0.0/profile.json",
    "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": "http://doc.apiture.com/errors/positiveNumberRequired"
      }
    },
    "_embedded": {
      "errors": []
    }
  },
  "amount": {
    "value": "345.50",
    "currency": "USD"
  },
  "description": "Car payment",
  "schedule": {
    "start": "2018-06-10",
    "every": "P14D",
    "count": 5,
    "maximumCount": 10,
    "end": "2018-08-01"
  },
  "type": "internal",
  "visibility": "visible",
  "confirmationId": "4OehPba97q7----0-8--bk--",
  "state": "scheduled",
  "_id": "string"
}

Past Transfer Summary

Summary representation of a past transfer resource. The summary includes the transfer ID, description, amount, state, and schedule, and the _links indicate the source and target accounts. This representation normally does not contain any _embedded objects. If needed, call the GET operation on the item's self link to get _embedded objects. For transfers which have failed, the _error object will describe the error circumstances.

Properties

NameDescription
_links links
An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
_embedded object
An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile string(uri)
The URI of a resource profile which describes the representation.
_error error
An object which describes an error. This value is omitted if the operation succeeded without error.
amount money
The amount of the transfer. For a transfer, the amount must be positive. The funding account must have sufficient available funds. Financial institutions may impose an upper limit on the amount in a transfer which may be lower than the available balance.
description string
A description of this transfer.
maxLength: 4096
schedule schedule
Describes when the transfer is scheduled to occur.
type string
The type of transfer.

An internal transfer is one where both the source and target account reside within the current financial institution. ach (Automated Clearinghouse) is for standard cross-institution, U.S. only transfers. ach transfers are typically processed in batches. wire transfers (not implemented in this release), can be processed faster (they may not depend on batch processing) and can also involve financial institution outside the U.S. However, wire transfers have higher fees.

This field is optional, but immutable after being set. The default is ach if either the source or target account is external, and internal if both accounts are internal. It is an error to set the type to ach or wire for transfers between internal accounts, or to set type to internal if either the source or target account is external.


Enumerated values:
internal
ach
wire

visibility string
The transfer may be visible or hidden. Some transfers are micro-deposit ACH transfers into a local account from an external account as part of external account verification. These transfers are hidden from the user: the user may only see the transfer amounts by viewing their external account (via that external financial institution). Hidden transfers are by default omitted from the /scheduledTransfers and /pastTransfers collections. Financial institution administrators, however, can view hidden transfers.


Enumerated values:
visible
hidden

confirmationId string
The confirmation id that the transfer request was received for processing.
read-only
maxLength: 32
state string
The state of the transfer. This is a derived and immutable value. The Transfers service processing updates the state. The state can be one of the following:

  • scheduled - A transfer is scheduled after a new one-time transfer is approved; it is scheduled to occur in the future.
  • recurring - A transfer is recurring after a new recurring transfer is approved; it is scheduled to start in the future.
  • pendingApproval - The source or target account is an external account which has not been verified. The financial institution may review the transfer and approve or deny it (the state will change to scheduled or failed).
  • processing - A transfer which has been begun and is currently being processed. A processing transfer can be modified as long as the transfer cutoff time has not passed. Once the cutoff time passes, the transfer cannot be modified (the amount or schedule may not be changed). To change a recurring transfer after the cutoff time, wait for the state to change back to recurring.
  • suspended - A scheduled recurring transfer which is temporarily suspended or paused. No further transfer of funds will occur until it is resumed. If it is resumed, any missed transfers will not be performed.
  • canceled - A transfer which has been canceled. No further transfer of funds will occur. Canceled transfers cannot be restarted; create a new one instead, or suspend/resume them instead of canceling. A canceled transfer cannot be modified. Note: There is no way to cancel specific transfers within a recurring transfer; instead, suspend the transfer and resume it after the desired date has passed.
  • failed - A transfer which failed. The _error will indicate the cause. A completed transfer cannot be modified.
  • completed - A transfer which has completed successfully. A completed transfer cannot be modified.

The client may change state in a limited number of ways: suspending a scheduled or recurring transaction via POST to the /suspendedScheduledTransfers; resuming a suspended recurring transaction via POST to the /resumedScheduledTransfers; canceling a scheduled transaction via POST to the /canceledScheduledTransfers. These operations are available with the apiture:suspend, apiture:resume, apiture:cancel links, respectively, on an instance. canceled by POSTing to /canceledTransfers. No request body is used on these operations.
read-only


Enumerated values:
scheduled
recurring
processing
suspended
completed
canceled
failed

_id string
The unique identifier for this transfer resource. This is an immutable opaque string.

updateScheduledTransfer

{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_profile": "https://api.apiture.com/schemas/transfers/scheduledTransfer/v1.0.0/profile.json",
  "state": "recurring",
  "amount": {
    "value": "356.40",
    "currency": "USD"
  },
  "description": "Car payment",
  "schedule": {
    "start": "2018-02-05",
    "maximumCount": 36,
    "count": 11,
    "every": "P1M",
    "end": "2021-04-05"
  },
  "_links": {
    "self": {
      "href": "/transfers/scheduledTransfers/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:source": {
      "href": "/accounts/accounts/46a31698-7398-4538-a9c9-9496010da2c2"
    },
    "apiture:target": {
      "href": "/accounts/externalAccounts/599b8ab5-6925-4f58-90c5-f6aa5b05f9d9"
    }
  }
}

Update Scheduled Transfer

Representation used to update or patch an existing scheduled transfer. The representation includes the transfer ID, description, amount, state, and schedule, and the _links indicate the source and target accounts. An update to a transfer ignores the _embedded object.

Properties

NameDescription
_links links
An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
_embedded object
An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile string(uri)
The URI of a resource profile which describes the representation.
_error error
An object which describes an error. This value is omitted if the operation succeeded without error.
amount money
The amount of the transfer. For a transfer, the amount must be positive. The funding account must have sufficient available funds. Financial institutions may impose an upper limit on the amount in a transfer which may be lower than the available balance.
description string
A description of this transfer.
maxLength: 4096
schedule schedule
Describes when the transfer is scheduled to occur.
type string
The type of transfer.

An internal transfer is one where both the source and target account reside within the current financial institution. ach (Automated Clearinghouse) is for standard cross-institution, U.S. only transfers. ach transfers are typically processed in batches. wire transfers (not implemented in this release), can be processed faster (they may not depend on batch processing) and can also involve financial institution outside the U.S. However, wire transfers have higher fees.

This field is optional, but immutable after being set. The default is ach if either the source or target account is external, and internal if both accounts are internal. It is an error to set the type to ach or wire for transfers between internal accounts, or to set type to internal if either the source or target account is external.


Enumerated values:
internal
ach
wire

visibility string
The transfer may be visible or hidden. Some transfers are micro-deposit ACH transfers into a local account from an external account as part of external account verification. These transfers are hidden from the user: the user may only see the transfer amounts by viewing their external account (via that external financial institution). Hidden transfers are by default omitted from the /scheduledTransfers and /pastTransfers collections. Financial institution administrators, however, can view hidden transfers.


Enumerated values:
visible
hidden

confirmationId string
The confirmation id that the transfer request was received for processing.
read-only
maxLength: 32
state string
The state of the transfer. This is a derived and immutable value. The Transfers service processing updates the state. The state can be one of the following:

  • scheduled - A transfer is scheduled after a new one-time transfer is approved; it is scheduled to occur in the future.
  • recurring - A transfer is recurring after a new recurring transfer is approved; it is scheduled to start in the future.
  • pendingApproval - The source or target account is an external account which has not been verified. The financial institution may review the transfer and approve or deny it (the state will change to scheduled or failed).
  • processing - A transfer which has been begun and is currently being processed. A processing transfer can be modified as long as the transfer cutoff time has not passed. Once the cutoff time passes, the transfer cannot be modified (the amount or schedule may not be changed). To change a recurring transfer after the cutoff time, wait for the state to change back to recurring.
  • suspended - A scheduled recurring transfer which is temporarily suspended or paused. No further transfer of funds will occur until it is resumed. If it is resumed, any missed transfers will not be performed.
  • canceled - A transfer which has been canceled. No further transfer of funds will occur. Canceled transfers cannot be restarted; create a new one instead, or suspend/resume them instead of canceling. A canceled transfer cannot be modified. Note: There is no way to cancel specific transfers within a recurring transfer; instead, suspend the transfer and resume it after the desired date has passed.
  • failed - A transfer which failed. The _error will indicate the cause. A completed transfer cannot be modified.
  • completed - A transfer which has completed successfully. A completed transfer cannot be modified.

The client may change state in a limited number of ways: suspending a scheduled or recurring transaction via POST to the /suspendedScheduledTransfers; resuming a suspended recurring transaction via POST to the /resumedScheduledTransfers; canceling a scheduled transaction via POST to the /canceledScheduledTransfers. These operations are available with the apiture:suspend, apiture:resume, apiture:cancel links, respectively, on an instance. canceled by POSTing to /canceledTransfers. No request body is used on these operations.
read-only


Enumerated values:
scheduled
recurring
processing
suspended
completed
canceled
failed

_id string
The unique identifier for this transfer resource. This is an immutable opaque string.

transferAccount

{
  "accountTitle": "John Smith",
  "title": "John Smith",
  "institutionName": "3rd Party Bank",
  "routingNumber": "021000021",
  "accountNumbers": {
    "masked": "*************3210",
    "full": "9876543210"
  }
}

Transfer Account

Summary properties of the source and target account for a transfer.

Properties

NameDescription
accountTitle string
The title of the account. Traditionally, this is the name of the account holder. This field is deprecated and will be removed in a future release; use title instead.
maxLength: 512
title string
The title of the account. Traditionally, this is the name of the account holder.
maxLength: 512
institutionName string
The name of the financial institution.
read-only
minLength: 2
maxLength: 128
routingNumber string
The account routing number which identifies the financial institution. The full routing number and full account number are required to fully identify the account.
read-only
minLength: 9
maxLength: 32
accountNumbers accountNumbers
The account numbers for this account
read-only

accountNumbers

{
  "masked": "*************3210",
  "full": "9876543210"
}

Account Numbers

Different representations of an account number.

Properties

NameDescription
masked string
A partial account number that does not contain all the digits of the full account number. This masked number appears in statements or in user experience presentation. It is sufficient for a user to differentiate this account from other accounts they hold, but is not sufficient for initiating transfers, etc. The first character is the mask character and is repeated; this does not indicate that the full account number is the same as the mask length. This value is derived and immutable.
read-only
minLength: 9
maxLength: 32
full string
The full account number. This value only appears when ?unmasked=true is passed on the GET request. Not included in the summary representation of the account that is included in account collection responses.
minLength: 9
maxLength: 32

transferAttribution

{
  "createdBy": "lucille-4700",
  "createdAt": "2018-05-08T13:37:57.375Z",
  "modifiedBy": "lucille-4700",
  "modifiedAt": "2018-05-18T16:42:57.000Z",
  "sourceAccount": {
    "accountTitle": "John Smith",
    "title": "John Smith",
    "institutionName": "3rd Party Bank",
    "routingNumber": "021000021",
    "accountNumbers": {
      "masked": "*************3210",
      "full": "9876543210"
    }
  },
  "targetAccount": {
    "accountTitle": "John Smith",
    "title": "John Smith",
    "institutionName": "3rd Party Bank",
    "routingNumber": "021000021",
    "accountNumbers": {
      "masked": "*************3210",
      "full": "9876543210"
    }
  }
}

Transfer Derived Fields

Fields of transfers which are derived, used to build other schemas.

Properties

NameDescription
createdBy string
The user who created/scheduled the transfer.
createdAt string(date-time)
The RFC 3339 UTC date-time when the transfer was scheduled/created.
modifiedBy string
The user who last modified the scheduled transfer.
modifiedAt string(date-time)
The RFC 3339 UTC date-time when the transfer was last modified.
sourceAccount transferAccount
Summary properties of the source account for a transfer
targetAccount transferAccount
Summary properties of the target account for a transfer

scheduledTransfer

{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_profile": "https://api.apiture.com/schemas/transfers/scheduledTransfer/v1.0.0/profile.json",
  "createdBy": "lucille-4700",
  "createdAt": "2018-05-08T13:37:57.375Z",
  "modifiedBy": "lucille-4700",
  "modifiedAt": "2018-05-18T16:42:57.000Z",
  "_links": {
    "self": {
      "href": "/transfers/scheduledTransfers/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:source": {
      "href": "/accounts/accounts/46a31698-7398-4538-a9c9-9496010da2c2"
    },
    "apiture:target": {
      "href": "/accounts/externalAccounts/599b8ab5-6925-4f58-90c5-f6aa5b05f9d9"
    },
    "apiture:creator": {
      "href": "/users/users/d076e102-facf-46e2-8ecf-bcdb531cd9e6"
    },
    "apiture:transactions": {
      "href": "/transaction?transfer=/transfers/transfers/0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "_embedded": {
    "transactions": {
      "start": 0,
      "count": 3,
      "items": [
        {
          "_id": "da8682e3-cc0b-4a1a-b8d2-8ce4dc45bf36",
          "occurredAt": "2018-02-05T11:10:00.375Z",
          "amount": {
            "value": "345.50",
            "currency": "USD",
            "description": "Car payment"
          }
        },
        {
          "_id": "a847c5c7-4a34-4464-b514-5ca1680cc00d",
          "occurredAt": "2018-03-05T11:11:17.375Z",
          "amount": {
            "value": "345.50",
            "currency": "USD",
            "description": "Car payment"
          }
        },
        {
          "_id": "d9ab0002-2cbb-4a4c-a01f-c3ce3ad20782",
          "occurredAt": "2018-04-05T11:11:17.375Z",
          "amount": {
            "value": "345.50",
            "currency": "USD",
            "description": "Car payment"
          }
        }
      ]
    },
    "source": {
      "_id": "34f8bec8-3939-4b7e-9ad5-10ee059ab250",
      "_profile": "https://api.apiture.com/schemas/accounts/summaryAccount/v1.0.0/profile.json",
      "name": "Personal Savings",
      "productName": "Basic Personal Savings",
      "type": "Personal Savings",
      "subtype": "Basic Personal Savings",
      "state": "active",
      "balance": {
        "current": "3450.30",
        "available": "3450.30",
        "currency": "USD"
      },
      "_links": {
        "self": {
          "href": "https://api.apiture.com/accounts/34f8bec8-3939-4b7e-9ad5-10ee059ab250"
        }
      }
    },
    "target": {
      "_id": "c9839d60-73e5-47ba-9676-ca8138e9494d",
      "_profile": "https://api.apiture.com/schemas/accounts/summaryAccount/v1.0.0/profile.json",
      "name": "My Basic Checking",
      "productName": "Basic Personal Checking",
      "type": "Personal Checking",
      "subtype": "Basic Personal Checking",
      "state": "active",
      "balance": {
        "current": "450.12",
        "available": "450.12",
        "currency": "USD"
      },
      "_links": {
        "self": {
          "href": "https://api.apiture.com/accounts/c9839d60-73e5-47ba-9676-ca8138e9494d"
        }
      }
    },
    "_links": {
      "self": {
        "href": "/transaction?transfer=/transfers/transfers/0399abed-fd3d-4830-a88b-30f38b8a365c"
      }
    }
  },
  "amount": {
    "value": "345.50",
    "currency": "USD"
  },
  "description": "Car payment",
  "state": "recurring",
  "schedule": {
    "start": "2018-02-05",
    "count": 3,
    "every": "P1M",
    "end": "2021-04-05"
  }
}

Scheduled Transfer

Representation of a transfer resource: a transfer of funds from one account to another. A transfer consists of an amount, a source account, a target account, and a schedule which specifies a one-time transfer or a recurring transfer. In addition to the normal self link, The links for a transfer include:

The _embedded object contains transactions, which contains the first page of transactions matching this transfer, and the summary representations of the source and target accounts.

Properties

NameDescription
_links links
An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
_embedded object
An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile string(uri)
The URI of a resource profile which describes the representation.
_error error
An object which describes an error. This value is omitted if the operation succeeded without error.
amount money
The amount of the transfer. For a transfer, the amount must be positive. The funding account must have sufficient available funds. Financial institutions may impose an upper limit on the amount in a transfer which may be lower than the available balance.
description string
A description of this transfer.
maxLength: 4096
schedule schedule
Describes when the transfer is scheduled to occur.
type string
The type of transfer.

An internal transfer is one where both the source and target account reside within the current financial institution. ach (Automated Clearinghouse) is for standard cross-institution, U.S. only transfers. ach transfers are typically processed in batches. wire transfers (not implemented in this release), can be processed faster (they may not depend on batch processing) and can also involve financial institution outside the U.S. However, wire transfers have higher fees.

This field is optional, but immutable after being set. The default is ach if either the source or target account is external, and internal if both accounts are internal. It is an error to set the type to ach or wire for transfers between internal accounts, or to set type to internal if either the source or target account is external.


Enumerated values:
internal
ach
wire

visibility string
The transfer may be visible or hidden. Some transfers are micro-deposit ACH transfers into a local account from an external account as part of external account verification. These transfers are hidden from the user: the user may only see the transfer amounts by viewing their external account (via that external financial institution). Hidden transfers are by default omitted from the /scheduledTransfers and /pastTransfers collections. Financial institution administrators, however, can view hidden transfers.


Enumerated values:
visible
hidden

confirmationId string
The confirmation id that the transfer request was received for processing.
read-only
maxLength: 32
state string
The state of the transfer. This is a derived and immutable value. The Transfers service processing updates the state. The state can be one of the following:

  • scheduled - A transfer is scheduled after a new one-time transfer is approved; it is scheduled to occur in the future.
  • recurring - A transfer is recurring after a new recurring transfer is approved; it is scheduled to start in the future.
  • pendingApproval - The source or target account is an external account which has not been verified. The financial institution may review the transfer and approve or deny it (the state will change to scheduled or failed).
  • processing - A transfer which has been begun and is currently being processed. A processing transfer can be modified as long as the transfer cutoff time has not passed. Once the cutoff time passes, the transfer cannot be modified (the amount or schedule may not be changed). To change a recurring transfer after the cutoff time, wait for the state to change back to recurring.
  • suspended - A scheduled recurring transfer which is temporarily suspended or paused. No further transfer of funds will occur until it is resumed. If it is resumed, any missed transfers will not be performed.
  • canceled - A transfer which has been canceled. No further transfer of funds will occur. Canceled transfers cannot be restarted; create a new one instead, or suspend/resume them instead of canceling. A canceled transfer cannot be modified. Note: There is no way to cancel specific transfers within a recurring transfer; instead, suspend the transfer and resume it after the desired date has passed.
  • failed - A transfer which failed. The _error will indicate the cause. A completed transfer cannot be modified.
  • completed - A transfer which has completed successfully. A completed transfer cannot be modified.

The client may change state in a limited number of ways: suspending a scheduled or recurring transaction via POST to the /suspendedScheduledTransfers; resuming a suspended recurring transaction via POST to the /resumedScheduledTransfers; canceling a scheduled transaction via POST to the /canceledScheduledTransfers. These operations are available with the apiture:suspend, apiture:resume, apiture:cancel links, respectively, on an instance. canceled by POSTing to /canceledTransfers. No request body is used on these operations.
read-only


Enumerated values:
scheduled
recurring
processing
suspended
completed
canceled
failed

_id string
The unique identifier for this transfer resource. This is an immutable opaque string.
createdBy string
The user who created/scheduled the transfer.
createdAt string(date-time)
The RFC 3339 UTC date-time when the transfer was scheduled/created.
modifiedBy string
The user who last modified the scheduled transfer.
modifiedAt string(date-time)
The RFC 3339 UTC date-time when the transfer was last modified.
sourceAccount transferAccount
Summary properties of the source account for a transfer
targetAccount transferAccount
Summary properties of the target account for a transfer

configuration

{
  "_links": {
    "self": {
      "href": "/transfers/configuration/"
    },
    "apiture:groups": {
      "href": "/transfers/configuration/groups"
    }
  }
}

Configuration

Represents the configuration for the Transfers API.

Properties

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

configurationGroups

{
  "_profile": "https://api.apiture.com/schemas/transfers/configurationGroups/v1.0.0/profile.json",
  "start": 10,
  "limit": 10,
  "count": 67,
  "name": "configurationGroups",
  "_links": {
    "self": {
      "href": "/transfers/configuration/groups?start=10&limit=10"
    },
    "first": {
      "href": "/transfers/configuration/groups?start=0&limit=10"
    },
    "next": {
      "href": "/transfers/configuration/groups?start=20&limit=10"
    },
    "collection": {
      "href": "/transfers/configuration/groups"
    }
  },
  "_embedded": {
    "items": [
      {
        "_profile": "https://api.apiture.com/schemas/transfers/configurationGroup/v1.0.0/profile.json",
        "_links": {
          "self": {
            "href": "/configuration/groups/basic"
          },
          "apiture:configuration": {
            "href": "/configuration"
          }
        },
        "name": "basic",
        "label": "Basic Settings",
        "description": "The basic settings for the Transfers API"
      },
      {
        "_profile": "https://api.apiture.com/schemas/transfers/configurationGroup/v1.0.0/profile.json",
        "_links": {
          "self": {
            "href": "/configuration/groups/calendar"
          },
          "apiture:configuration": {
            "href": "/configuration"
          }
        },
        "name": "calendar",
        "label": "Calendar",
        "description": "A calendar that specifies which dates are valid for performing transfers (e.g., weekdays excluding federal holidays)"
      }
    ]
  }
}

Configuration Group Collection

Collection of configuration groups. The items in the collection are ordered in the _embedded object with name items. The top-level _links object may contain pagination links: self, next, prev, first, last, collection.

Properties

NameDescription
_links links
An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
_embedded object
» items [configurationGroupSummary]
An array containing a page of configuration group items.
_profile string(uri)
The URI of a resource profile which describes the representation.
_error error
An object which describes an error. This value is omitted if the operation succeeded without error.
count integer
The number of items in the full collection.
start integer
The start index of this page of items.
limit integer
The maximum number of items per page.
name string
The name of the collection.

configurationGroupSummary

{
  "_links": {
    "property1": {
      "href": "http://example.com",
      "type": "string",
      "templated": true,
      "title": "string",
      "deprecation": "http://example.com",
      "profile": "http://example.com"
    },
    "property2": {
      "href": "http://example.com",
      "type": "string",
      "templated": true,
      "title": "string",
      "deprecation": "http://example.com",
      "profile": "http://example.com"
    }
  },
  "_embedded": {},
  "_profile": "http://example.com",
  "_error": {
    "_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
    "_profile": "https://api.apiture.com/schemas/common/errorResponse/v1.0.0/profile.json",
    "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": "http://doc.apiture.com/errors/positiveNumberRequired"
      }
    },
    "_embedded": {
      "errors": []
    }
  },
  "name": "transfers",
  "label": "Transfers Configuration",
  "description": "The configuration for the Transfers API."
}

Configuration Group Summary

A summary of the data contained within a configuration group resource.

Properties

NameDescription
_links links
An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
_embedded object
An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile string(uri)
The URI of a resource profile which describes the representation.
_error error
An object which describes an error. This value is omitted if the operation succeeded without error.
name string
The name of this configuration group, must be unique within the set of all resources of this type.
minLength: 1
maxLength: 48
pattern: [a-zA-Z][-\w_]*
label string
The text label for this resource, suitable for presentation to the client.
minLength: 1
maxLength: 128
description string
The full description for this resource, suitable for presentation to the client.
minLength: 1
maxLength: 4096

configurationGroup

{
  "_profile": "https://api.apiture.com/schemas/transfers/configurationGroup/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "/configuration/groups/basic"
    },
    "apiture:configuration": {
      "href": "/configuration"
    }
  },
  "name": "basic",
  "label": "Basic Settings",
  "description": "The basic settings for the Transfers API",
  "schema": {
    "type": "object",
    "properties": {
      "dailyLimit": {
        "type": "number",
        "description": "The daily limit for the number of transfers"
      },
      "cutoffTime": {
        "type": "string",
        "format": "time",
        "description": "The cutoff time for scheduling transfers for the current day"
      }
    }
  },
  "values": {
    "dailyLimit": 5,
    "cutoffTime": "17:30:00"
  }
}

Configuration Group

Represents a configuration group.

Properties

NameDescription
_links links
An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
_embedded object
An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile string(uri)
The URI of a resource profile which describes the representation.
_error error
An object which describes an error. This value is omitted if the operation succeeded without error.
name string
The name of this configuration group, must be unique within the set of all resources of this type.
minLength: 1
maxLength: 48
pattern: [a-zA-Z][-\w_]*
label string
The text label for this resource, suitable for presentation to the client.
minLength: 1
maxLength: 128
description string
The full description for this resource, suitable for presentation to the client.
minLength: 1
maxLength: 4096
schema configurationSchema
The schema which defines the name and types of the variables that are part of this configuration definition. Property names must be simple identifiers consisting of alphanumeric characters, -, _ following the pattern letter [letter | digit | '-' | '_']* This is implicitly a schema for type: object and contains the properties.

The values in a configuration conform to the schema. The names and types are described with a subset of JSON Schema Core and JSON Schema Validation similar to that used to define schemas in OpenAPI Specification 2.0.

values configurationValues
The data associated with this configuration: the resource's variable names and values. These values must conform to this item's schema.

Note: the schema may also contain default values which, if present, are used if a value is not set in the definition's values. For example, multiple configurations may use the same schema that defines values a, b, and c, but each configuration may have their own unique values for a, b, and c which is separate from the schema.

configurationSchema

{
  "type": "object",
  "properties": {
    "dailyLimit": {
      "type": "number",
      "description": "The daily limit for the number of transfers"
    },
    "cutoffTime": {
      "type": "string",
      "format": "time",
      "description": "The cutoff time for scheduling transfers for the current day"
    }
  }
}

Configuration Schema

The schema which defines the name and types of the variables that are part of this configuration definition. Property names must be simple identifiers consisting of alphanumeric characters, -, following the pattern letter [letter | digit | '-' | '']* This is implicitly a schema for type: object and contains the properties.

The values in a configuration conform to the schema. The names and types are described with a subset of JSON Schema Core and JSON Schema Validation similar to that used to define schemas in OpenAPI Specification 2.0.

Properties

No properties

configurationValues

{
  "dailyLimit": 5,
  "cutoffTime": "17:30:00"
}

Configuration Values

The data associated with this configuration: the resource's variable names and values. These values must conform to this item's schema.

Note: the schema may also contain default values which, if present, are used if a value is not set in the definition's values. For example, multiple configurations may use the same schema that defines values a, b, and c, but each configuration may have their own unique values for a, b, and c which is separate from the schema.

Properties

No properties

pastTransfer

{
  "_links": {
    "property1": {
      "href": "http://example.com",
      "type": "string",
      "templated": true,
      "title": "string",
      "deprecation": "http://example.com",
      "profile": "http://example.com"
    },
    "property2": {
      "href": "http://example.com",
      "type": "string",
      "templated": true,
      "title": "string",
      "deprecation": "http://example.com",
      "profile": "http://example.com"
    }
  },
  "_embedded": {},
  "_profile": "http://example.com",
  "_error": {
    "_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
    "_profile": "https://api.apiture.com/schemas/common/errorResponse/v1.0.0/profile.json",
    "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": "http://doc.apiture.com/errors/positiveNumberRequired"
      }
    },
    "_embedded": {
      "errors": []
    }
  },
  "amount": {
    "value": "345.50",
    "currency": "USD"
  },
  "description": "Car payment",
  "schedule": {
    "start": "2018-06-10",
    "every": "P14D",
    "count": 5,
    "maximumCount": 10,
    "end": "2018-08-01"
  },
  "type": "internal",
  "visibility": "visible",
  "confirmationId": "6e5413df-9574-4568-b0c4-dfd96bbb454b",
  "state": "scheduled",
  "_id": "string",
  "createdBy": "lucille-4700",
  "createdAt": "2018-05-08T13:37:57.375Z",
  "modifiedBy": "lucille-4700",
  "modifiedAt": "2018-05-18T16:42:57.000Z",
  "sourceAccount": {
    "accountTitle": "John Smith",
    "title": "John Smith",
    "institutionName": "3rd Party Bank",
    "routingNumber": "021000021",
    "accountNumbers": {
      "masked": "*************3210",
      "full": "9876543210"
    }
  },
  "targetAccount": {
    "accountTitle": "John Smith",
    "title": "John Smith",
    "institutionName": "3rd Party Bank",
    "routingNumber": "021000021",
    "accountNumbers": {
      "masked": "*************3210",
      "full": "9876543210"
    }
  },
  "completedAt": "2018-05-08T14:08:50.375Z"
}

Past Transfer

Represents a transfer that has been processed or canceled (one that is no longer scheduled).

If the state of the processed transfer is failed, the _error object will contain details of the failure, including a message. The _error.type field will be an identifier string, one of:

Properties

NameDescription
_links links
An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
_embedded object
An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile string(uri)
The URI of a resource profile which describes the representation.
_error error
An object which describes an error. This value is omitted if the operation succeeded without error.
amount money
The amount of the transfer. For a transfer, the amount must be positive. The funding account must have sufficient available funds. Financial institutions may impose an upper limit on the amount in a transfer which may be lower than the available balance.
description string
A description of this transfer.
maxLength: 4096
schedule schedule
Describes when the transfer is scheduled to occur.
type string
The type of transfer.

An internal transfer is one where both the source and target account reside within the current financial institution. ach (Automated Clearinghouse) is for standard cross-institution, U.S. only transfers. ach transfers are typically processed in batches. wire transfers (not implemented in this release), can be processed faster (they may not depend on batch processing) and can also involve financial institution outside the U.S. However, wire transfers have higher fees.

This field is optional, but immutable after being set. The default is ach if either the source or target account is external, and internal if both accounts are internal. It is an error to set the type to ach or wire for transfers between internal accounts, or to set type to internal if either the source or target account is external.


Enumerated values:
internal
ach
wire

visibility string
The transfer may be visible or hidden. Some transfers are micro-deposit ACH transfers into a local account from an external account as part of external account verification. These transfers are hidden from the user: the user may only see the transfer amounts by viewing their external account (via that external financial institution). Hidden transfers are by default omitted from the /scheduledTransfers and /pastTransfers collections. Financial institution administrators, however, can view hidden transfers.


Enumerated values:
visible
hidden

confirmationId string
A unique transaction confirmation ID.
state string
The state of the transfer. This is a derived and immutable value. The Transfers service processing updates the state. The state can be one of the following:

  • scheduled - A transfer is scheduled after a new one-time transfer is approved; it is scheduled to occur in the future.
  • recurring - A transfer is recurring after a new recurring transfer is approved; it is scheduled to start in the future.
  • pendingApproval - The source or target account is an external account which has not been verified. The financial institution may review the transfer and approve or deny it (the state will change to scheduled or failed).
  • processing - A transfer which has been begun and is currently being processed. A processing transfer can be modified as long as the transfer cutoff time has not passed. Once the cutoff time passes, the transfer cannot be modified (the amount or schedule may not be changed). To change a recurring transfer after the cutoff time, wait for the state to change back to recurring.
  • suspended - A scheduled recurring transfer which is temporarily suspended or paused. No further transfer of funds will occur until it is resumed. If it is resumed, any missed transfers will not be performed.
  • canceled - A transfer which has been canceled. No further transfer of funds will occur. Canceled transfers cannot be restarted; create a new one instead, or suspend/resume them instead of canceling. A canceled transfer cannot be modified. Note: There is no way to cancel specific transfers within a recurring transfer; instead, suspend the transfer and resume it after the desired date has passed.
  • failed - A transfer which failed. The _error will indicate the cause. A completed transfer cannot be modified.
  • completed - A transfer which has completed successfully. A completed transfer cannot be modified.

The client may change state in a limited number of ways: suspending a scheduled or recurring transaction via POST to the /suspendedScheduledTransfers; resuming a suspended recurring transaction via POST to the /resumedScheduledTransfers; canceling a scheduled transaction via POST to the /canceledScheduledTransfers. These operations are available with the apiture:suspend, apiture:resume, apiture:cancel links, respectively, on an instance. canceled by POSTing to /canceledTransfers. No request body is used on these operations.
read-only


Enumerated values:
scheduled
recurring
processing
suspended
completed
canceled
failed

_id string
The unique identifier for this transfer resource. This is an immutable opaque string.
createdBy string
The user who created/scheduled the transfer.
createdAt string(date-time)
The RFC 3339 UTC date-time when the transfer was scheduled/created.
modifiedBy string
The user who last modified the scheduled transfer.
modifiedAt string(date-time)
The RFC 3339 UTC date-time when the transfer was last modified.
sourceAccount transferAccount
Summary properties of the source account for a transfer
targetAccount transferAccount
Summary properties of the target account for a transfer
completedAt string(date-time)
The date/time when the transfer was completed.

transfer

{
  "_links": {
    "property1": {
      "href": "http://example.com",
      "type": "string",
      "templated": true,
      "title": "string",
      "deprecation": "http://example.com",
      "profile": "http://example.com"
    },
    "property2": {
      "href": "http://example.com",
      "type": "string",
      "templated": true,
      "title": "string",
      "deprecation": "http://example.com",
      "profile": "http://example.com"
    }
  },
  "_embedded": {},
  "_profile": "http://example.com",
  "_error": {
    "_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
    "_profile": "https://api.apiture.com/schemas/common/errorResponse/v1.0.0/profile.json",
    "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": "http://doc.apiture.com/errors/positiveNumberRequired"
      }
    },
    "_embedded": {
      "errors": []
    }
  },
  "amount": {
    "value": "345.50",
    "currency": "USD"
  },
  "description": "Car payment",
  "schedule": {
    "start": "2018-06-10",
    "every": "P14D",
    "count": 5,
    "maximumCount": 10,
    "end": "2018-08-01"
  },
  "type": "internal",
  "visibility": "visible",
  "confirmationId": "4OehPba97q7----0-8--bk--",
  "state": "scheduled",
  "_id": "string",
  "createdBy": "lucille-4700",
  "createdAt": "2018-05-08T13:37:57.375Z",
  "modifiedBy": "lucille-4700",
  "modifiedAt": "2018-05-18T16:42:57.000Z",
  "sourceAccount": {
    "accountTitle": "John Smith",
    "title": "John Smith",
    "institutionName": "3rd Party Bank",
    "routingNumber": "021000021",
    "accountNumbers": {
      "masked": "*************3210",
      "full": "9876543210"
    }
  },
  "targetAccount": {
    "accountTitle": "John Smith",
    "title": "John Smith",
    "institutionName": "3rd Party Bank",
    "routingNumber": "021000021",
    "accountNumbers": {
      "masked": "*************3210",
      "full": "9876543210"
    }
  }
}

Transfer

Note: This model schema is deprecated and only used by deprecated operations. See scheduledTransfer instead.

Representation of a transfer resource: a transfer of funds from one account to another.

Properties

NameDescription
_links links
An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
_embedded object
An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile string(uri)
The URI of a resource profile which describes the representation.
_error error
An object which describes an error. This value is omitted if the operation succeeded without error.
amount money
The amount of the transfer. For a transfer, the amount must be positive. The funding account must have sufficient available funds. Financial institutions may impose an upper limit on the amount in a transfer which may be lower than the available balance.
description string
A description of this transfer.
maxLength: 4096
schedule schedule
Describes when the transfer is scheduled to occur.
type string
The type of transfer.

An internal transfer is one where both the source and target account reside within the current financial institution. ach (Automated Clearinghouse) is for standard cross-institution, U.S. only transfers. ach transfers are typically processed in batches. wire transfers (not implemented in this release), can be processed faster (they may not depend on batch processing) and can also involve financial institution outside the U.S. However, wire transfers have higher fees.

This field is optional, but immutable after being set. The default is ach if either the source or target account is external, and internal if both accounts are internal. It is an error to set the type to ach or wire for transfers between internal accounts, or to set type to internal if either the source or target account is external.


Enumerated values:
internal
ach
wire

visibility string
The transfer may be visible or hidden. Some transfers are micro-deposit ACH transfers into a local account from an external account as part of external account verification. These transfers are hidden from the user: the user may only see the transfer amounts by viewing their external account (via that external financial institution). Hidden transfers are by default omitted from the /scheduledTransfers and /pastTransfers collections. Financial institution administrators, however, can view hidden transfers.


Enumerated values:
visible
hidden

confirmationId string
The confirmation id that the transfer request was received for processing.
read-only
maxLength: 32
state string
The state of the transfer. This is a derived and immutable value. The Transfers service processing updates the state. The state can be one of the following:

  • scheduled - A transfer is scheduled after a new one-time transfer is approved; it is scheduled to occur in the future.
  • recurring - A transfer is recurring after a new recurring transfer is approved; it is scheduled to start in the future.
  • pendingApproval - The source or target account is an external account which has not been verified. The financial institution may review the transfer and approve or deny it (the state will change to scheduled or failed).
  • processing - A transfer which has been begun and is currently being processed. A processing transfer can be modified as long as the transfer cutoff time has not passed. Once the cutoff time passes, the transfer cannot be modified (the amount or schedule may not be changed). To change a recurring transfer after the cutoff time, wait for the state to change back to recurring.
  • suspended - A scheduled recurring transfer which is temporarily suspended or paused. No further transfer of funds will occur until it is resumed. If it is resumed, any missed transfers will not be performed.
  • canceled - A transfer which has been canceled. No further transfer of funds will occur. Canceled transfers cannot be restarted; create a new one instead, or suspend/resume them instead of canceling. A canceled transfer cannot be modified. Note: There is no way to cancel specific transfers within a recurring transfer; instead, suspend the transfer and resume it after the desired date has passed.
  • failed - A transfer which failed. The _error will indicate the cause. A completed transfer cannot be modified.
  • completed - A transfer which has completed successfully. A completed transfer cannot be modified.

The client may change state in a limited number of ways: suspending a scheduled or recurring transaction via POST to the /suspendedScheduledTransfers; resuming a suspended recurring transaction via POST to the /resumedScheduledTransfers; canceling a scheduled transaction via POST to the /canceledScheduledTransfers. These operations are available with the apiture:suspend, apiture:resume, apiture:cancel links, respectively, on an instance. canceled by POSTing to /canceledTransfers. No request body is used on these operations.
read-only


Enumerated values:
scheduled
recurring
processing
suspended
completed
canceled
failed

_id string
The unique identifier for this transfer resource. This is an immutable opaque string.
createdBy string
The user who created/scheduled the transfer.
createdAt string(date-time)
The RFC 3339 UTC date-time when the transfer was scheduled/created.
modifiedBy string
The user who last modified the scheduled transfer.
modifiedAt string(date-time)
The RFC 3339 UTC date-time when the transfer was last modified.
sourceAccount transferAccount
Summary properties of the source account for a transfer
targetAccount transferAccount
Summary properties of the target account for a transfer

scheduledTransfers

{
  "_profile": "https://api.apiture.com/schemas/transfers/transfers/v1.0.0/profile.json",
  "start": 10,
  "limit": 10,
  "count": 67,
  "name": "transfers",
  "_links": {
    "self": {
      "href": "/transfers/scheduledTransfers?start=10&limit=10"
    },
    "first": {
      "href": "/transfers/scheduledTransfers?start=0&limit=10"
    },
    "next": {
      "href": "/transfers/scheduledTransfers?start=20&limit=10"
    },
    "collection": {
      "href": "/transfers/scheduledTransfers"
    }
  },
  "_embedded": {
    "items": [
      {
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "_profile": "https://api.apiture.com/schemas/transfers/summaryScheduledTransfer/v1.0.0/profile.json",
        "amount": {
          "value": "345.50",
          "currency": "USD"
        },
        "description": "Car payment",
        "state": "recurring",
        "schedule": {
          "start": "2018-02-05",
          "count": 3,
          "every": "P1M",
          "end": "2021-04-05"
        },
        "_links": {
          "apiture:source": {
            "href": "/accounts/accounts/46a31698-7398-4538-a9c9-9496010da2c2"
          },
          "apiture:target": {
            "href": "/accounts/externalAccounts/599b8ab5-6925-4f58-90c5-f6aa5b05f9d9"
          },
          "apiture:transactions": {
            "href": "/transaction?transfer=/transfers/transfers/0399abed-fd3d-4830-a88b-30f38b8a365c"
          },
          "self": {
            "href": "/transfers/scheduledTransfers/0399abed-fd3d-4830-a88b-30f38b8a365c"
          }
        }
      },
      {
        "_id": "a3bbba3c-d26b-497d-87b7-09eb47b24d77",
        "_profile": "https://api.apiture.com/schemas/transfers/summaryScheduledTransfer/v1.0.0/profile.json",
        "amount": {
          "value": "120.0",
          "currency": "USD"
        },
        "description": "Monthly allowance for Suzy's college expenses and meals",
        "state": "recurring",
        "schedule": {
          "start": "2018-08-01",
          "count": 24,
          "every": "P1M",
          "end": "2020-05-15"
        },
        "_links": {
          "apiture:source": {
            "href": "/accounts/accounts/46a31698-7398-4538-a9c9-9496010da2c2"
          },
          "apiture:target": {
            "href": "/accounts/externalAccounts/4fda6275-0a3b-49ad-ad12-5ebcd7013362"
          },
          "apiture:transactions": {
            "href": "/transaction?transfer=/transfers/transfers/a3bbba3c-d26b-497d-87b7-09eb47b24d77"
          },
          "self": {
            "href": "/transfers/scheduledTransfers/a3bbba3c-d26b-497d-87b7-09eb47b24d77"
          }
        }
      }
    ]
  }
}

Scheduled Transfer Collection

Collection of scheduled transfers. The items in the collection are ordered in the _embedded object with name items. The top-level _links object may contain pagination links (self, next, prev, first, last, collection).

Properties

NameDescription
_links links
An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
_embedded object
» items [summaryScheduledTransfer]
An array containing a page of transfer items.
_profile string(uri)
The URI of a resource profile which describes the representation.
_error error
An object which describes an error. This value is omitted if the operation succeeded without error.
count integer
The number of items in the full collection.
start integer
The start index of this page of items.
limit integer
The maximum number of items per page.
name string
The name of the collection.

pastTransfers

{
  "_profile": "https://api.apiture.com/schemas/transfers/pastTransfers/v1.0.0/profile.json",
  "start": 10,
  "limit": 10,
  "count": 67,
  "name": "transfers",
  "_links": {
    "self": {
      "href": "/transfers/pastTransfers?start=10&limit=10"
    },
    "first": {
      "href": "/transfers/pastTransfers?start=0&limit=10"
    },
    "next": {
      "href": "/transfers/pastTransfers?start=20&limit=10"
    },
    "collection": {
      "href": "/transfers/pastTransfers"
    }
  },
  "_embedded": {
    "items": [
      {
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "_profile": "https://api.apiture.com/schemas/transfers/summaryPastTransfer/v1.0.0/profile.json",
        "amount": {
          "value": "345.50",
          "currency": "USD"
        },
        "description": "Car payment",
        "state": "recurring",
        "schedule": {
          "start": "2018-02-05",
          "count": 3,
          "every": "P1M",
          "end": "2021-04-05"
        },
        "_links": {
          "apiture:source": {
            "href": "/accounts/accounts/46a31698-7398-4538-a9c9-9496010da2c2"
          },
          "apiture:target": {
            "href": "/accounts/externalAccounts/599b8ab5-6925-4f58-90c5-f6aa5b05f9d9"
          },
          "apiture:transactions": {
            "href": "/transaction?transfer=/transfers/transfers/0399abed-fd3d-4830-a88b-30f38b8a365c"
          },
          "self": {
            "href": "/transfers/pastTransfers/0399abed-fd3d-4830-a88b-30f38b8a365c"
          }
        }
      },
      {
        "_id": "a3bbba3c-d26b-497d-87b7-09eb47b24d77",
        "_profile": "https://api.apiture.com/schemas/transfers/summaryPastTransfer/v1.0.0/profile.json",
        "amount": {
          "value": "120.0",
          "currency": "USD"
        },
        "description": "Monthly allowance for Suzy's college expenses and meals",
        "state": "recurring",
        "schedule": {
          "start": "2018-08-01",
          "count": 24,
          "every": "P1M",
          "end": "2020-05-15"
        },
        "_links": {
          "apiture:source": {
            "href": "/accounts/accounts/46a31698-7398-4538-a9c9-9496010da2c2"
          },
          "apiture:target": {
            "href": "/accounts/externalAccounts/4fda6275-0a3b-49ad-ad12-5ebcd7013362"
          },
          "apiture:transactions": {
            "href": "/transaction?transfer=/transfers/transfers/a3bbba3c-d26b-497d-87b7-09eb47b24d77"
          },
          "self": {
            "href": "/transfers/pastTransfers/a3bbba3c-d26b-497d-87b7-09eb47b24d77"
          }
        }
      }
    ]
  }
}

Past Transfers Collection

Collection of past transfers. The items in the collection are ordered in the _embedded object with name items. The top-level _links object may contain pagination links (self, next, prev, first, last, collection).

Properties

NameDescription
_links links
An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
_embedded object
» items [summaryPastTransfer]
An array containing a page of transfer items.
_profile string(uri)
The URI of a resource profile which describes the representation.
_error error
An object which describes an error. This value is omitted if the operation succeeded without error.
count integer
The number of items in the full collection.
start integer
The start index of this page of items.
limit integer
The maximum number of items per page.
name string
The name of the collection.

collection

{
  "_links": {
    "property1": {
      "href": "http://example.com",
      "type": "string",
      "templated": true,
      "title": "string",
      "deprecation": "http://example.com",
      "profile": "http://example.com"
    },
    "property2": {
      "href": "http://example.com",
      "type": "string",
      "templated": true,
      "title": "string",
      "deprecation": "http://example.com",
      "profile": "http://example.com"
    }
  },
  "_embedded": {},
  "_profile": "http://example.com",
  "_error": {
    "_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
    "_profile": "https://api.apiture.com/schemas/common/errorResponse/v1.0.0/profile.json",
    "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": "http://doc.apiture.com/errors/positiveNumberRequired"
      }
    },
    "_embedded": {
      "errors": []
    }
  },
  "count": 0,
  "start": 0,
  "limit": 0,
  "name": "string"
}

Collection

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

Properties

NameDescription
_links links
An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
_embedded object
An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile string(uri)
The URI of a resource profile which describes the representation.
_error error
An object which describes an error. This value is omitted if the operation succeeded without error.
count integer
The number of items in the full collection.
start integer
The start index of this page of items.
limit integer
The maximum number of items per page.
name string
The name of the collection.

abstractResource

{
  "_profile": "https://api.apiture.com/schema/example/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "{uri of current resource}"
    }
  }
}

Abstract Resource

An augmented 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.

Properties

NameDescription
_links links
An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
_embedded object
An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile string(uri)
The URI of a resource profile which describes the representation.
_error error
An object which describes an error. This value is omitted if the operation succeeded without error.

root

{
  "id": "apiName",
  "name": "API name",
  "apiVersion": "0.0.1-SNAPSHOT",
  "_profile": "https://api.apiture.com/schemas/common/root/v1.0.0/profile.json",
  "_links": {}
}

API Root

A HAL response, with hypermedia _links for the top-level resources and operations in API.

Properties

NameDescription
_links links
An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
_embedded object
An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile string(uri)
The URI of a resource profile which describes the representation.
_error error
An object which describes an error. This value is omitted if the operation succeeded without error.
_id string
This API's unique ID.
name string
This API's name.
apiVersion string
This API's version.

errorResponse

{
  "_profile": "https://api.apiture.com/schemas/common/errorResponse/v1.0.0/profile.json",
  "_error": {
    "_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
    "_profile": "https://api.apiture.com/schemas/common/errorResponse/v1.0.0/profile.json",
    "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": {},
    "_links": {
      "describedby": {
        "href": "http://doc.apiture.com/errors/positiveNumberRequired"
      }
    },
    "_embedded": {
      "errors": []
    }
  }
}

Error Response

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

Properties

NameDescription
_links links
An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
_embedded object
An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile string(uri)
The URI of a resource profile which describes the representation.
_error error
An object which describes an error. This value is omitted if the operation succeeded without error.

error

{
  "_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
  "_profile": "https://api.apiture.com/schemas/common/errorResponse/v1.0.0/profile.json",
  "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": "http://doc.apiture.com/errors/positiveNumberRequired"
    }
  },
  "_embedded": {
    "errors": []
  }
}

Error

An error description. Nested source errors are contained in the _embedded object with the key "errors"; this is an array of nested error objects. For example, an API which validates its request body may find multiple errors in the request, which may be detailed here. The _links may contain a describedby link which refers to a web page with details about the error.

The attributes field is an optional map of name/value pairs which provide structured data about the error. For example, if the error is a value out of range, the attributes may specify the range values min and max. This allows clients to present error messages as they see fit (the API does not assume the client/presentation tier).

Properties

NameDescription
message string (required)
A localized message string describing the error condition.
_id string
A unique identifier for this error instance. This may be used as a correlation ID with the root cause error (i.e. this ID may be logged at the source of the error). This is is an opaque string.
statusCode integer
The HTTP status code associate with this error.
minimum: 100
maximum: 599
type string
An error identifier which indicates the category of error and associate it with API support documentation or which the UI tier can use to render an appropriate message or hint. This provides a finer level of granularity than the statusCode. For example, instead of just 400 Bad Request, the type may be much more specific. such as integerValueNotInAllowedRange or numericValueExceedsMaximum or stringValueNotInAllowedSet.
occurredAt string(date-time)
An RFC 3339 UTC time stamp indicating when the error occurred.
attributes attributes
Data attribute associated with the error, such as values or constraints.
remediation string
An optional localized string which provides hints for how the user or client can resolve the error.
_embedded object
Optional embedded array of errors. This field may not exist if the error does not have nested errors.
» items [errorResponse]
An array of error objects.

attributes

{}

Attributes

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

Properties

No properties

{
  "property1": {
    "href": "http://example.com",
    "type": "string",
    "templated": true,
    "title": "string",
    "deprecation": "http://example.com",
    "profile": "http://example.com"
  },
  "property2": {
    "href": "http://example.com",
    "type": "string",
    "templated": true,
    "title": "string",
    "deprecation": "http://example.com",
    "profile": "http://example.com"
  }
}

Links

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

Properties

NameDescription
additionalProperties link
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.

{
  "href": "http://example.com",
  "type": "string",
  "templated": true,
  "title": "string",
  "deprecation": "http://example.com",
  "profile": "http://example.com"
}

Link

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.

Properties

NameDescription
href string(uri) (required)
The URI or URI template for the resource/operation this link refers to.
type string
The media type for the resource.
templated boolean
If true, the link's href is a URI template.
title string
An optional human-readable localized title for the link.
deprecation string(uri)
If present, the containing link is deprecated and the value is a URI which provides human-readable text information about the deprecation.
profile string(uri)
The URI of a profile document, a JSON document which describes the target resource/operation.

schedule

{
  "start": "2018-06-10",
  "every": "P14D",
  "count": 5,
  "maximumCount": 10,
  "end": "2018-08-01"
}

Schedule

A definition for a one-time or recurring scheduled transfer. Some financial institutions may limit scheduled transfers such that the transfer must be within 365 days.

Properties

NameDescription
start string
When the transaction occurs, or when a recurring transfer begins. This may be either a date in RFC 3339 yyyy-mm-dd format, or a date-time in RFC 3339 yyyy-mm-ddTHH:MM:SSZ UTC format. If present, the time portion is a _hint_; the FI may not be able to schedule transfers at specific times. If start is omitted, the transfer will be scheduled for the next processing day. If start is the current day, the transfer may be scheduled for the next processing day if transfer processing has stopped for the day.
every string
The every period indicates the interval at which the transfer recurs, such as every week, every month, every 3 months. If omitted or empty, this transfer is a one-time transfer. every is required if either maximumCount is greater than 1 or if end is greater than start.

This value is an ISO 8601 duration string of the form P[n]Y[n]M[n]D to specify the number of years/months/days between transfers. For example, use P7D to transfer every week, P2M to transfer every other month, P4Y to transfer every four years on the anniversary set by start. Time values in every are ignored but may be honored in the future. (That is, it is not possible to schedule a transfer every 8 hours; the minimum is P1D.) To specify semi-monthly or semi-annually, use P0.5M or P0.5Y. Fractional values are only allowed for month and year, and 0.5 is the only allowed fractional value.

Some financial institutions may limit recurring transfers such that the period must be a year (P1Y, 'P12M, 'P365D) or less.

Scheduling may adjust transfer dates if start occurs near boundary dates which do occur not every year/month, such as start: "2018-01-31", every: "P1M". For example, the next transfer may occur on the 30th for months which have only 30 days (Apr, Jun, Sep, Nov), or 29th or 28th for February. Actual transfer dates may also be adjusted to account for holidays or other days when processing does not occur.

count integer
For a recurring transfer, this is the number of transfers which have been processed. It is a derived value and ignored on updates.
read-only
maximumCount integer
The maximum number of transfers to perform for a recurring transfer. (Transfers in the recurrence will stop if the current date is beyond that set by end, even if fewer thanmaximumCounttransfers have occurred). Theeveryperiod is required ifmaximumCountorendis set. It is an error (422) ifmaximumCountis anything other than 0 or 1 andeveryis not set. If a schedule contains bothendandmaximumCount`, the earliest will determine when the recurrence ends. Otherwise, the Transfers service will compute the other field.
end string
The date when the recurring transfer end (inclusive). Transfers will occur until the maximumCount of transfers have occurred or the next scheduled transaction will be after the date or date-time specified in end. (Earliest of maximumCount or end wins.) If specified, end must be no earlier than start.

This has the same format as start (may be a RFC 3339 date or a date-time) (yyyy-mm-dd or YYYY-MM-DDThh:mm:ss.sssZ UTC format).

When scheduling a transfer, the request should contain either maximumCount or end, but not both. The Transfers service will compute the other field.

money

{
  "value": "3456.78",
  "currency": "str"
}

Money

An amount of money in a specific currency.

Properties

NameDescription
value string
The net monetary value. A negative amount denotes a debit; a positive amount a credit. The numeric value is represented as a string so that it can be exact with no loss of precision.
currency string
The ISO 4217 currency code for this monetary value. This is always upper case ASCII. TODO: ISO 4217 defines three-character codes. However, ISO 4217 does not account for cryptocurrencies. Of note, DASH uses 4 characters.
minLength: 3
maxLength: 3