Check Deposits

API

getApi

Top-level resources and operations in this API

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


/

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///checkDeposits/"
import { APIApi } from "@apiture/check_deposits-client-sdk";

const aPIApi = new APIApi(configuration);

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
aPIApi.setApiKey(apiKey);


var api = new CheckDeposits.APIApi.getApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
aPIApi.getApi(callback);

Scopes

Parameters

Responses


getApiDoc

Return API definition document

Return the OpenAPI document that describes this API.


/apiDoc

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///checkDeposits/apiDoc"
import { APIApi } from "@apiture/check_deposits-client-sdk";

const aPIApi = new APIApi(configuration);

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
aPIApi.setApiKey(apiKey);


var api = new CheckDeposits.APIApi.getApiDoc()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
aPIApi.getApiDoc(callback);

Scopes

Parameters

Responses


Check

createCheck

Add a check to the check deposit batch

Create a new check in the check deposit. A check must reside inside a check deposit resource. Checks can only be added to check deposits that have state `pending`, `processing`, `valid`, or `invalid`. Device data may be provided to identify the client device. The device data for each check may be compared to the device data for other checks or the parent check deposit to aid verification. It is recommended to provide as much device data as possible. The check in the response body will include `apiture:uploadFrontImage` and `apiture:uploadBackImage` links which the client should use to upload check images. Images must be uploaded in JPEG format. After images have been successfully uploaded, `apiture:frontImageContent` and `apiture:backImageContent` links can be used to download image contents. A check must be processed by using the `apiture:process` link before it can be submitted. The check must have successfully uploaded front and back images in order to be processed.


/checkDeposits/{depositId}/checks

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///checkDeposits/checkDeposits/{depositId}/checks"
import { CheckApi } from "@apiture/check_deposits-client-sdk";

const checkApi = new CheckApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
checkApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
checkApi.setApiKey(apiKey);


var api = new CheckDeposits.CheckApi.createCheck()
var depositId = depositId_example; // {String} The unique identifier of this deposit. This is an opaque string.
var createCheck = ; // {CreateCheck} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
checkApi.createCheck(depositId, createCheck, callback);

Scopes

banking/read Read access to things
banking/write Write (update) access to things
banking/delete Delete access to things
banking/full Full access to things

Parameters

Path parameters
Name Description
depositId*
String
The unique identifier of this deposit. This is an opaque string.
Required
Body parameters
Name Description
createCheck *

The data necessary to create a new check.

Responses

Name Type Format Description
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.
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`


createCheckImageUpload

Create a new upload uri for the check side image

Create a new upload uri for the check side image. This operation is used if the client needs to replace an uploaded image side, it is not needed for new checks. Upload uris may not be issued if the check has state `submitted`, `accepted`, or `rejected`. The response body will include a `apiture:uploadUri` link which can be used to POST the file content and upload an image. This will replace any existing image. The Content-Type header (or the Content-Type in the multipart form data) must match the contentType of the file resource. JPEG is the only supported image format. If a check has state `processing`, `valid`, or `invalid`, creating a new image upload uri will invalidate the image analysis, reset the check to `pending`, and the check must be processed again. Valid check side values: * `front` * `back`


/checkDeposits/{depositId}/checks/{checkId}/images/{side}

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///checkDeposits/checkDeposits/{depositId}/checks/{checkId}/images/{side}"
import { CheckApi } from "@apiture/check_deposits-client-sdk";

const checkApi = new CheckApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
checkApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
checkApi.setApiKey(apiKey);


var api = new CheckDeposits.CheckApi.createCheckImageUpload()
var depositId = depositId_example; // {String} The unique identifier of this deposit. This is an opaque string.
var checkId = checkId_example; // {String} The unique identifier of this check. This is an opaque string.
var side = side_example; // {String} The side of the check. Valid check `side` values:
  * `front`
  * `back`

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
checkApi.createCheckImageUpload(depositId, checkId, side, callback);

Scopes

banking/read Read access to things
banking/write Write (update) access to things
banking/delete Delete access to things
banking/full Full access to things

Parameters

Path parameters
Name Description
depositId*
String
The unique identifier of this deposit. This is an opaque string.
Required
checkId*
String
The unique identifier of this check. This is an opaque string.
Required
side*
String
The side of the check. Valid check `side` values: * `front` * `back`
Required

Responses


deleteCheck

Remove a check from the check deposit

Removes the check from the check deposit batch. Checks may not be deleted if they have state `submitted`, `accepted`, or `rejected`.


/checkDeposits/{depositId}/checks/{checkId}

Usage and SDK Samples

curl -X DELETE -H "API-Key: [[apiKey]]" "http:///checkDeposits/checkDeposits/{depositId}/checks/{checkId}"
import { CheckApi } from "@apiture/check_deposits-client-sdk";

const checkApi = new CheckApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
checkApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
checkApi.setApiKey(apiKey);


var api = new CheckDeposits.CheckApi.deleteCheck()
var depositId = depositId_example; // {String} The unique identifier of this deposit. This is an opaque string.
var checkId = checkId_example; // {String} The unique identifier of this check. This is an opaque string.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
checkApi.deleteCheck(depositId, checkId, callback);

Scopes

banking/read Read access to things
banking/write Write (update) access to things
banking/delete Delete access to things
banking/full Full access to things

Parameters

Path parameters
Name Description
depositId*
String
The unique identifier of this deposit. This is an opaque string.
Required
checkId*
String
The unique identifier of this check. This is an opaque string.
Required

Responses


getCheck

Fetch a check

Fetch a HAL representation of this check resource


/checkDeposits/{depositId}/checks/{checkId}

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///checkDeposits/checkDeposits/{depositId}/checks/{checkId}"
import { CheckApi } from "@apiture/check_deposits-client-sdk";

const checkApi = new CheckApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
checkApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
checkApi.setApiKey(apiKey);


var api = new CheckDeposits.CheckApi.getCheck()
var depositId = depositId_example; // {String} The unique identifier of this deposit. This is an opaque string.
var checkId = checkId_example; // {String} The unique identifier of this check. This is an opaque string.
var opts = {
  'ifNoneMatch': ifNoneMatch_example // {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.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
checkApi.getCheck(depositId, checkId, opts, callback);

Scopes

banking/read Read access to things
banking/write Write (update) access to things
banking/delete Delete access to things
banking/full Full access to things

Parameters

Path parameters
Name Description
depositId*
String
The unique identifier of this deposit. This is an opaque string.
Required
checkId*
String
The unique identifier of this check. This is an opaque string.
Required
Header parameters
Name Description
If-None-Match
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.

Responses

Name Type Format Description
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 check deposit resource.


getCheckImage

Return the check side image metadata

Return metadata of the image file. Valid check side values: * `front` * `back`


/checkDeposits/{depositId}/checks/{checkId}/images/{side}

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///checkDeposits/checkDeposits/{depositId}/checks/{checkId}/images/{side}"
import { CheckApi } from "@apiture/check_deposits-client-sdk";

const checkApi = new CheckApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
checkApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
checkApi.setApiKey(apiKey);


var api = new CheckDeposits.CheckApi.getCheckImage()
var depositId = depositId_example; // {String} The unique identifier of this deposit. This is an opaque string.
var checkId = checkId_example; // {String} The unique identifier of this check. This is an opaque string.
var side = side_example; // {String} The side of the check. Valid check `side` values:
  * `front`
  * `back`
var opts = {
  'ifNoneMatch': ifNoneMatch_example // {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.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
checkApi.getCheckImage(depositId, checkId, side, opts, callback);

Scopes

banking/read Read access to things
banking/write Write (update) access to things
banking/delete Delete access to things
banking/full Full access to things

Parameters

Path parameters
Name Description
depositId*
String
The unique identifier of this deposit. This is an opaque string.
Required
checkId*
String
The unique identifier of this check. This is an opaque string.
Required
side*
String
The side of the check. Valid check `side` values: * `front` * `back`
Required
Header parameters
Name Description
If-None-Match
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.

Responses

Name Type Format Description
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 check deposit resource.


getCheckImageContent

Return the raw content of the check image side

Return the raw content of the image file as a stream of bytes. This operation normally returns a 302 to redirect the caller to the actual URL where the file content is available. Valid check side values: * `front` * `back`


/checkDeposits/{depositId}/checks/{checkId}/images/{side}/content

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///checkDeposits/checkDeposits/{depositId}/checks/{checkId}/images/{side}/content"
import { CheckApi } from "@apiture/check_deposits-client-sdk";

const checkApi = new CheckApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
checkApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
checkApi.setApiKey(apiKey);


var api = new CheckDeposits.CheckApi.getCheckImageContent()
var depositId = depositId_example; // {String} The unique identifier of this deposit. This is an opaque string.
var checkId = checkId_example; // {String} The unique identifier of this check. This is an opaque string.
var side = side_example; // {String} The side of the check. Valid check `side` values:
  * `front`
  * `back`
var opts = {
  'ifNoneMatch': ifNoneMatch_example // {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.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
checkApi.getCheckImageContent(depositId, checkId, side, opts, callback);

Scopes

banking/read Read access to things
banking/write Write (update) access to things
banking/delete Delete access to things
banking/full Full access to things

Parameters

Path parameters
Name Description
depositId*
String
The unique identifier of this deposit. This is an opaque string.
Required
checkId*
String
The unique identifier of this check. This is an opaque string.
Required
side*
String
The side of the check. Valid check `side` values: * `front` * `back`
Required
Header parameters
Name Description
If-None-Match
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.

Responses

Name Type Format Description
ContentMinusType String The media type of the file content. This will be `image/jpeg` but may change if additional file types are supported in the future.

Name Type Format Description
Location String The URL where the file's content is located.


patchCheck

Modify a check in the deposit

Modify check data. `enteredAmount` and `description` are the only editable fields. Checks may not be modified if they have state `submitted`, `accepted`, or `rejected`. If a check has state `processing`, `valid`, or `invalid`, modifying the check `enteredAmount` will invalidate the image analysis, reset the check to `pending`, and must be processed again.


/checkDeposits/{depositId}/checks/{checkId}

Usage and SDK Samples

curl -X PATCH -H "API-Key: [[apiKey]]" "http:///checkDeposits/checkDeposits/{depositId}/checks/{checkId}"
import { CheckApi } from "@apiture/check_deposits-client-sdk";

const checkApi = new CheckApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
checkApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
checkApi.setApiKey(apiKey);


var api = new CheckDeposits.CheckApi.patchCheck()
var depositId = depositId_example; // {String} The unique identifier of this deposit. This is an opaque string.
var checkId = checkId_example; // {String} The unique identifier of this check. This is an opaque string.
var check = ; // {Check} 
var opts = {
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
checkApi.patchCheck(depositId, checkId, check, opts, callback);

Scopes

banking/read Read access to things
banking/write Write (update) access to things
banking/delete Delete access to things
banking/full Full access to things

Parameters

Path parameters
Name Description
depositId*
String
The unique identifier of this deposit. This is an opaque string.
Required
checkId*
String
The unique identifier of this check. This is an opaque string.
Required
Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
Body parameters
Name Description
check *

The data to modify a check

Responses

Name Type Format Description
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.


processCheck

Process a check

Process a Check to validate data, perform image analysis, and return risk factors. This operation is invoked from the `apiture:process` link on a check. Each check in a check deposit must be processed before the batch can be submitted. Checks may not be processed if they have state `submitted`, `accepted`, or `rejected`. If the check has not been processed, this returns 202 Accepted and no response body. The response will include a `Retry-After` response header with a recommended retry interval in seconds. If the check has finished processing, the operations returns 200 OK and the response body is the updated check resource. `riskRejections`, `riskErrors`, `riskWarnings`, and `riskInfo` may contain risk factors after a check has completed processing. Risk factors include diagnostic information about the check, check images, or end user, which indicate if the check is acceptable for deposit. - `riskWarnings` are not required to be resolved, but may be useful to resolve potential issues. - `riskErrors` must be resolved in order to submit the check deposit. Errors may be fixed by reuploading images or correcting check data. - `riskRejections` indicate the check is not suitable for deposit, and the check must be removed from the check deposit. - `riskInfo` includes additional diagnostic information about the check. If a check has finished processing and contains no risk factors, it indicates the check has a high chance of being accepted for deposit.


/checkDeposits/{depositId}/processedChecks

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///checkDeposits/checkDeposits/{depositId}/processedChecks?checkId="
import { CheckApi } from "@apiture/check_deposits-client-sdk";

const checkApi = new CheckApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
checkApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
checkApi.setApiKey(apiKey);


var api = new CheckDeposits.CheckApi.processCheck()
var depositId = depositId_example; // {String} The unique identifier of this deposit. This is an opaque string.
var checkId = checkId_example; // {String} The unique identifier of this check. This is an opaque string.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
checkApi.processCheck(depositId, checkId, callback);

Scopes

banking/read Read access to things
banking/write Write (update) access to things
banking/delete Delete access to things
banking/full Full access to things

Parameters

Path parameters
Name Description
depositId*
String
The unique identifier of this deposit. This is an opaque string.
Required
Query parameters
Name Description
checkId*
String
The unique identifier of this check. This is an opaque string.
Required

Responses

Name Type Format Description
RetryMinusAfter String Indicates a suggested delay in seconds after which the client should retry the operation. Example: `Retry-After: 5`


rejectCheck

Reject a check

Reject a check if it is eligible to be rejected. This operation is invoked from the `apiture:reject` link on a check. The link will only be returned for admins, and only admins can reject a check. There is no request body in this method. Rejecting a check will also reverse the core transaction.


/rejectedChecks

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///checkDeposits/rejectedChecks?check="
import { CheckApi } from "@apiture/check_deposits-client-sdk";

const checkApi = new CheckApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
checkApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
checkApi.setApiKey(apiKey);


var api = new CheckDeposits.CheckApi.rejectCheck()
var check = check_example; // {String} A server-generated key which identifies an existing check resource.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
checkApi.rejectCheck(check, callback);

Scopes

banking/read Read access to things
banking/write Write (update) access to things
banking/delete Delete access to things
banking/full Full access to things

Parameters

Query parameters
Name Description
check*
String
A server-generated key which identifies an existing check resource.
Required

Responses


CheckDeposit

createCheckDeposit

Create a new check deposit

Create a new check deposit to add checks and submit a deposit. A check deposit must be used to submit a deposit, individual check resources can't be submitted. The `apiture:target` link can be used to specify the account resource the check deposit will be deposited to. This value is not required when creating a check deposit, but is required to submit it. The user can provide an optional `enteredAmount` when creating a check deposit. This is the expected total batch amount of all checks, and can be used as verification against the check amounts later scanned by OCR (optical character recognition). Device data may be provided to identify the client device and aid the deposit verification process. It is recommended to provide as much device data as possible. After creating a check deposit, use the `createCheck` operation (the `apiture:createCheck` link) to add checks to it, then use the `processCheckDeposit` operation (the `apiture:process` link) to process the checks to verify the check contents. If all the checks are valid, follow that with the `submitCheckDeposit` (the `apiture:process` link) operation to submit the valid checks for deposit.


/checkDeposits

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///checkDeposits/checkDeposits"
import { CheckDepositApi } from "@apiture/check_deposits-client-sdk";

const checkDepositApi = new CheckDepositApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
checkDepositApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
checkDepositApi.setApiKey(apiKey);


var api = new CheckDeposits.CheckDepositApi.createCheckDeposit()
var createCheckDeposit = ; // {CreateCheckDeposit} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
checkDepositApi.createCheckDeposit(createCheckDeposit, callback);

Scopes

banking/read Read access to things
banking/write Write (update) access to things
banking/delete Delete access to things
banking/full Full access to things

Parameters

Body parameters
Name Description
createCheckDeposit *

The data necessary to create a new check deposit.

Responses

Name Type Format Description
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.
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`


deleteCheckDeposit

Delete this check deposit resource

Delete this check deposit resource and any resources that are owned by it. This operation will also delete any checks included in the check deposit. The check deposit must have state `pending`, `processing`, `valid`, or `invalid`.


/checkDeposits/{depositId}

Usage and SDK Samples

curl -X DELETE -H "API-Key: [[apiKey]]" "http:///checkDeposits/checkDeposits/{depositId}"
import { CheckDepositApi } from "@apiture/check_deposits-client-sdk";

const checkDepositApi = new CheckDepositApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
checkDepositApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
checkDepositApi.setApiKey(apiKey);


var api = new CheckDeposits.CheckDepositApi.deleteCheckDeposit()
var depositId = depositId_example; // {String} The unique identifier of this deposit. This is an opaque string.
var opts = {
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
checkDepositApi.deleteCheckDeposit(depositId, opts, callback);

Scopes

banking/read Read access to things
banking/write Write (update) access to things
banking/delete Delete access to things
banking/full Full access to things

Parameters

Path parameters
Name Description
depositId*
String
The unique identifier of this deposit. This is an opaque string.
Required
Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.

Responses


getCheckDeposit

Fetch a check deposit

Return a HAL representation of this check deposit resource.


/checkDeposits/{depositId}

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///checkDeposits/checkDeposits/{depositId}"
import { CheckDepositApi } from "@apiture/check_deposits-client-sdk";

const checkDepositApi = new CheckDepositApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
checkDepositApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
checkDepositApi.setApiKey(apiKey);


var api = new CheckDeposits.CheckDepositApi.getCheckDeposit()
var depositId = depositId_example; // {String} The unique identifier of this deposit. This is an opaque string.
var opts = {
  'ifNoneMatch': ifNoneMatch_example // {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.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
checkDepositApi.getCheckDeposit(depositId, opts, callback);

Scopes

banking/read Read access to things
banking/write Write (update) access to things
banking/delete Delete access to things
banking/full Full access to things

Parameters

Path parameters
Name Description
depositId*
String
The unique identifier of this deposit. This is an opaque string.
Required
Header parameters
Name Description
If-None-Match
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.

Responses

Name Type Format Description
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 check deposit resource.


getCheckDeposits

Return a collection of check deposits

Return a [paginated](https://developer.apiture.com/docs/concepts/pagination) [sortable](https://developer.apiture.com/docs/concepts/sorting) [filterable](https://developer.apiture.com/docs/concepts/filtering) [searchable](https://developer.apiture.com/docs/concepts/searchable) collection of check deposits. The [links](https://developer.apiture.com/docs/concepts/links) in the response include pagination links.


/checkDeposits

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///checkDeposits/checkDeposits?start=&limit=&sortBy=&state=&filter=&q="
import { CheckDepositApi } from "@apiture/check_deposits-client-sdk";

const checkDepositApi = new CheckDepositApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
checkDepositApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
checkDepositApi.setApiKey(apiKey);


var api = new CheckDeposits.CheckDepositApi.getCheckDeposits()
var opts = {
  'start': 789, // {Long} The zero-based index of the first check deposit item to include in this page. The default 0 denotes the beginning of the collection.
  'limit': 56, // {Integer} The maximum number of check deposit representations to return in this page.
  'sortBy': sortBy_example, // {String} Optional sort criteria. See [sort criteria format](https://developer.apiture.com/docs/concepts/sorting), such as `?sortBy=field1,-field2`.
  'state': state_example, // {String} Subset of the check deposit collection to those whose `state` matches this value. Use `|` to separate multiple values. For example, `?state=pending` matches only items whose `state` is `pending`; `?state=pending|submitted` matches items whose `state` is `pending` or `submitted`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
  'filter': filter_example, // {String} Optional filter criteria. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
  'q': q_example // {String} Optional search string. See [searching](https://developer.apiture.com/docs/concepts/searching).
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
checkDepositApi.getCheckDeposits(opts, callback);

Scopes

banking/read Read access to things
banking/write Write (update) access to things
banking/delete Delete access to things
banking/full Full access to things

Parameters

Query parameters
Name Description
start
Long (int64)
The zero-based index of the first check deposit item to include in this page. The default 0 denotes the beginning of the collection.
limit
Integer (int32)
The maximum number of check deposit representations to return in this page.
sortBy
String
Optional sort criteria. See [sort criteria format](https://developer.apiture.com/docs/concepts/sorting), such as `?sortBy=field1,-field2`.
state
String
Subset of the check deposit collection to those whose `state` matches this value. Use `|` to separate multiple values. For example, `?state=pending` matches only items whose `state` is `pending`; `?state=pending|submitted` matches items whose `state` is `pending` or `submitted`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
filter
String
Optional filter criteria. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
q
String
Optional search string. See [searching](https://developer.apiture.com/docs/concepts/searching).

Responses


patchCheckDeposit

Modify this check deposit resource

Modify this check deposit. The `apiture:target` link, `description`, and `enteredAmount` are the only editable fields. The check deposit must have state `pending`, `processing`, `valid`, or `invalid`.


/checkDeposits/{depositId}

Usage and SDK Samples

curl -X PATCH -H "API-Key: [[apiKey]]" "http:///checkDeposits/checkDeposits/{depositId}"
import { CheckDepositApi } from "@apiture/check_deposits-client-sdk";

const checkDepositApi = new CheckDepositApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
checkDepositApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
checkDepositApi.setApiKey(apiKey);


var api = new CheckDeposits.CheckDepositApi.patchCheckDeposit()
var depositId = depositId_example; // {String} The unique identifier of this deposit. This is an opaque string.
var opts = {
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
checkDepositApi.patchCheckDeposit(depositId, opts, callback);

Scopes

banking/read Read access to things
banking/write Write (update) access to things
banking/delete Delete access to things
banking/full Full access to things

Parameters

Path parameters
Name Description
depositId*
String
The unique identifier of this deposit. This is an opaque string.
Required
Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.

Responses

Name Type Format Description
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.


processCheckDeposit

Process checks in a check deposit

Process all checks in a check deposit which have state `pending`. This operation is invoked from the `apiture:process` link on a check deposit. All checks with `pending` state on the check deposit will be processed asyncronously. Checks which are currently being processed or have finished processing with state `valid` or `invalid` will be ignored. If any checks have not been processed yet, this returns 202 Accepted and no response body. The response will include a `Retry-After` response header with a recommended retry interval in seconds. If all checks have finished processing, the operations returns 200 OK and the response body is the updated check deposit resource.


/processedCheckDeposits

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///checkDeposits/processedCheckDeposits?depositId="
import { CheckDepositApi } from "@apiture/check_deposits-client-sdk";

const checkDepositApi = new CheckDepositApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
checkDepositApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
checkDepositApi.setApiKey(apiKey);


var api = new CheckDeposits.CheckDepositApi.processCheckDeposit()
var opts = {
  'depositId': depositId_example // {String} The unique identifier of this deposit. This is an opaque string.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
checkDepositApi.processCheckDeposit(opts, callback);

Scopes

banking/read Read access to things
banking/write Write (update) access to things
banking/delete Delete access to things
banking/full Full access to things

Parameters

Query parameters
Name Description
depositId
String
The unique identifier of this deposit. This is an opaque string.

Responses

Name Type Format Description
RetryMinusAfter String Indicates a suggested delay in seconds after which the client should retry the operation. Example: `Retry-After: 5`


submitCheckDeposit

Submit a check deposit

Submit a check deposit that is eligible to be submitted. This operation is invoked from the `apiture:submit` link on a check deposit, which only exists if the action is allowed. If successful, this changes the state to `submitted`. The `apiture:target` link is required to be a valid account resource uri, which will be used to deposit the checks into. A check deposit can only be submitted to a single target account.


/submittedCheckDeposits

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///checkDeposits/submittedCheckDeposits?depositId="
import { CheckDepositApi } from "@apiture/check_deposits-client-sdk";

const checkDepositApi = new CheckDepositApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
checkDepositApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
checkDepositApi.setApiKey(apiKey);


var api = new CheckDeposits.CheckDepositApi.submitCheckDeposit()
var opts = {
  'depositId': depositId_example // {String} The unique identifier of this deposit. This is an opaque string.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
checkDepositApi.submitCheckDeposit(opts, callback);

Scopes

banking/read Read access to things
banking/write Write (update) access to things
banking/delete Delete access to things
banking/full Full access to things

Parameters

Query parameters
Name Description
depositId
String
The unique identifier of this deposit. This is an opaque string.

Responses


Limits

getLimits

Return the mobile check deposit limits

Return the mobile check deposit limits. The response shows the check deposit limits and amounts for the previous 30 days.


/limits

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///checkDeposits/limits?account="
import { LimitsApi } from "@apiture/check_deposits-client-sdk";

const limitsApi = new LimitsApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
limitsApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
limitsApi.setApiKey(apiKey);


var api = new CheckDeposits.LimitsApi.getLimits()
var opts = {
  'account': account_example // {String} Return check deposit limits for the named account. This is the `_id` of the account resource. If omitted, the response contains only user limits.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
limitsApi.getLimits(opts, callback);

Scopes

banking/read Read access to things
banking/write Write (update) access to things
banking/delete Delete access to things
banking/full Full access to things

Parameters

Query parameters
Name Description
account
String
Return check deposit limits for the named account. This is the `_id` of the account resource. If omitted, the response contains only user limits.

Responses