Business Transfers Administration v0.3.0

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

This API provides administrative applications access to business transfers for the financial institution.

This API provides the following operations:

• getBusinessTransfers to return details of business ACH debit/credit batches. In this release of the API, only ACH transfers are supported, not wires or NACHA pass through files.
• getWireTransferAccounts to look up the source and target accounts for wire transfers.

The operations in this API are authorized with the OAuth2 Client Credentials flow. Clients must be secure server-side applications, not web or mobile applications.

Download OpenAPI Definition (YAML)

Base URLs:

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

Terms of service

Email: Apiture Web: Apiture

License: Apiture API License

Authentication

• OAuth2 authentication (clientCredentials)
  • Client Credentials OAuth2 flow that allows a secure service application to access resources. (This access is not used with insecure clients such as web or mobile applications.) See details at Secure Access.
  • Flow: clientCredentials
  • Token URL = https://dev-oidc.apiture-comm-nonprod.com/oidc/token

Scope	Scope Description
bankingAdmin/read	Read a wide variety of banking and other financial institution and customer data.
bankingAdmin/write	Write a wide variety of banking and other financial institution and customer data.

Business Transfers Administration

Banking Business Transfers Administration

getBusinessTransfers

Code samples

# You can also use wget
curl -X GET https://api.apiture.com/bankingAdmin/businessTransfers?transfers=6f2625952ad00ef4f701,f73e992e4230a6e8ef64,d1aa5570846beb619dfa,ed202975b84b7acd5161,b39069bdbc65c83c58ed \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.apiture.com/bankingAdmin/businessTransfers?transfers=6f2625952ad00ef4f701,f73e992e4230a6e8ef64,d1aa5570846beb619dfa,ed202975b84b7acd5161,b39069bdbc65c83c58ed HTTP/1.1
Host: api.apiture.com
Accept: application/json

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

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

};

fetch('https://api.apiture.com/bankingAdmin/businessTransfers?transfers=6f2625952ad00ef4f701,f73e992e4230a6e8ef64,d1aa5570846beb619dfa,ed202975b84b7acd5161,b39069bdbc65c83c58ed',
{
  method: 'GET',

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

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

};

$.ajax({
  url: 'https://api.apiture.com/bankingAdmin/businessTransfers',
  method: 'get',
  data: '?transfers=6f2625952ad00ef4f701,f73e992e4230a6e8ef64,d1aa5570846beb619dfa,ed202975b84b7acd5161,b39069bdbc65c83c58ed',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

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

result = RestClient.get 'https://api.apiture.com/bankingAdmin/businessTransfers',
  params: {
  'transfers' => '[businessTransferIdSelection](#schema-businessTransferIdSelection)'
}, headers: headers

p JSON.parse(result)

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

r = requests.get('https://api.apiture.com/bankingAdmin/businessTransfers', params={
  'transfers': [
  "6f2625952ad00ef4f701",
  "f73e992e4230a6e8ef64",
  "d1aa5570846beb619dfa",
  "ed202975b84b7acd5161",
  "b39069bdbc65c83c58ed"
]
}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/bankingAdmin/businessTransfers?transfers=6f2625952ad00ef4f701,f73e992e4230a6e8ef64,d1aa5570846beb619dfa,ed202975b84b7acd5161,b39069bdbc65c83c58ed");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

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

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

Return a list of specific business transfer resources.

GET https://api.apiture.com/bankingAdmin/businessTransfers

Return the details of a list of business transfers resources for the IDs passed in the transfers request parameter.

Parameters

Parameter	Description
transfers in: query	businessTransferIdSelection (required) Fetch business transfer details for the business transfers identified in this comma-separated list of IDs. unique items minItems: 1 maxItems: 100 comma-delimited items: string » minLength: 6 » maxLength: 48 » pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"

Example responses

200 Response

{
  "items": [
    {
      "id": "0399abed-fd3d",
      "type": "ach",
      "state": "pendingApproval",
      "toSummary": "12 payees",
      "fromSummary": "Payroll Checking *7890",
      "direction": "credit",
      "customerId": "d1b95731fb029fec062c",
      "ach": {
        "secCode": "ppd",
        "companyName": "Well's Roofing",
        "imported": false,
        "sameDay": false,
        "confidentialCustomers": [
          {
            "id": "64446f8d-780f",
            "name": "Philip F. Duciary"
          },
          {
            "id": "58853981-24bb",
            "name": "Alice A. Tuary"
          }
        ],
        "approvalDueAt": "2022-06-09T20:30:00.000Z",
        "sameDayApprovalDue": [
          "2022-06-09T15:00:00.000Z",
          "2022-06-09T18:00:00.000Z",
          "2022-06-09T20:30:00.000Z"
        ]
      },
      "trackingNumber": "15474162",
      "remainingApprovalsCount": 2,
      "approvalCount": 1,
      "creditTotal": "2640.60",
      "debitTotal": "0.00",
      "creditCount": 12,
      "debitCount": 30,
      "reversalDebitTotal": "0.00",
      "reversalCreditTotal": "0.00",
      "settlementAccount": {
        "label": "Payroll Checking *7890",
        "maskedNumber": "*7890",
        "id": "bf23bc970-91e8",
        "risk": "normal"
      },
      "schedule": {
        "scheduledOn": "2023-05-01",
        "effectiveOn": "2023-04-30"
      },
      "createdAt": "2023-04-28T07:48:20.375Z",
      "updatedAt": "2023-04-28T07:48:49.375Z",
      "createdBy": {
        "id": "0399abed-fd3d",
        "name": "Benny Billings",
        "username": "bbillings"
      },
      "updatedBy": {
        "id": "0399abed-fd3d",
        "name": "Benny Billings",
        "username": "bbillings"
      }
    }
  ]
}

Responses

Response Schema

Status Code 400

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 401

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 404

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

listBusinessTransferAchBatchInstructions

Code samples

# You can also use wget
curl -X GET https://api.apiture.com/bankingAdmin/businessTransfers/{businessTransferId}/achBatchInstructions \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.apiture.com/bankingAdmin/businessTransfers/{businessTransferId}/achBatchInstructions HTTP/1.1
Host: api.apiture.com
Accept: application/json

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

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

};

fetch('https://api.apiture.com/bankingAdmin/businessTransfers/{businessTransferId}/achBatchInstructions',
{
  method: 'GET',

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

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

};

$.ajax({
  url: 'https://api.apiture.com/bankingAdmin/businessTransfers/{businessTransferId}/achBatchInstructions',
  method: 'get',

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

require 'rest-client'
require 'json'

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

result = RestClient.get 'https://api.apiture.com/bankingAdmin/businessTransfers/{businessTransferId}/achBatchInstructions',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.get('https://api.apiture.com/bankingAdmin/businessTransfers/{businessTransferId}/achBatchInstructions', params={

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.apiture.com/bankingAdmin/businessTransfers/{businessTransferId}/achBatchInstructions", data)
    req.Header = headers

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

Return a list of ACH business transfer batch instructions

GET https://api.apiture.com/bankingAdmin/businessTransfers/{businessTransferId}/achBatchInstructions

Return a collection of debit/credit instructions for an ACH batch business transfer.

Parameters

Parameter	Description
businessTransferId in: path	resourceId (required) The unique identifier of a business transfer. This is an opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"

Example responses

200 Response

{
  "items": [
    {
      "id": "0399abed-fd3d",
      "traceNumber": 8706658,
      "name": "Pauline Stonemason",
      "identifier": "C-00523",
      "amount": "1287.65",
      "hold": false,
      "direction": "credit",
      "type": "ach",
      "ach": {
        "routingNumber": "123123123",
        "accountNumber": "123456789",
        "accountType": "checking",
        "reversed": false,
        "canceled": false,
        "prenote": false
      },
      "methodId": "ach0001",
      "contactId": "3e8375b1-8c34"
    },
    {
      "id": "0399abed-fd3d",
      "traceNumber": 8764783,
      "name": "Pauline Stonemason",
      "identifier": "C-012295",
      "amount": "2090.35",
      "hold": false,
      "direction": "credit",
      "type": "ach",
      "ach": {
        "routingNumber": "123123123",
        "accountNumber": "234567890",
        "accountType": "checking",
        "reversed": false,
        "canceled": false,
        "prenote": false
      }
    }
  ]
}

Responses

Response Schema

Status Code 400

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 401

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 404

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

getWireTransferAccounts

Code samples

# You can also use wget
curl -X POST https://api.apiture.com/bankingAdmin/wireTransferAccounts \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Institution-Id: TIBURON' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.apiture.com/bankingAdmin/wireTransferAccounts HTTP/1.1
Host: api.apiture.com
Content-Type: application/json
Accept: application/json
Institution-Id: TIBURON

const fetch = require('node-fetch');
const inputBody = '{
  "items": [
    "9fe04b71360e2a1a1293",
    "dc617d4fd715bac02ee1",
    "678345003",
    "003678345"
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Institution-Id':'TIBURON',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/bankingAdmin/wireTransferAccounts',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Institution-Id':'TIBURON',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.apiture.com/bankingAdmin/wireTransferAccounts',
  method: 'post',

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

require 'rest-client'
require 'json'

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

result = RestClient.post 'https://api.apiture.com/bankingAdmin/wireTransferAccounts',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.post('https://api.apiture.com/bankingAdmin/wireTransferAccounts', params={

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Institution-Id": []string{"TIBURON"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.apiture.com/bankingAdmin/wireTransferAccounts", data)
    req.Header = headers

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

Get accounts for a list of wire transfers.

POST https://api.apiture.com/bankingAdmin/wireTransferAccounts

Return the source and target (beneficiary) account location and account numbers for one or more wire transfers. The operation allows looking up wire transfer either by the wire transfer resource ID or by tracking numbers.

This operation applies a "GET over POST" pattern: it is a safe, idempotent operation, but passes data via a request body rather than via query parameters.

Body parameter

{
  "items": [
    "9fe04b71360e2a1a1293",
    "dc617d4fd715bac02ee1",
    "678345003",
    "003678345"
  ]
}

Parameters

Parameter	Description
body	wireTransferReferences (required) A list of wire transfer IDs.
Institution-Id in: header	institutionId The unique identifier of the financial institution. minLength: 2 maxLength: 8 pattern: "^[A-Z0-9_]{2,8}$"

Example responses

200 Response

{
  "items": [
    {
      "id": "9fe04b71360e2a1a1293",
      "trackingNumber": "122966",
      "sourceAccount": {
        "id": "89b19e14f7b602d79240",
        "accountNumber": "123456789"
      },
      "targetAccount": {
        "locatorType": "abaRoutingNumber",
        "locator": "123123123",
        "accountNumber": "0123456789"
      }
    },
    {
      "notFound": "dc617d4fd715bac02ee1"
    },
    {
      "notFound": "678345003"
    },
    {
      "id": "bab5c032f56dfe535680",
      "trackingNumber": "003678345",
      "sourceAccount": {
        "id": "89b19e14f7b602d79240",
        "accountNumber": "123456789"
      },
      "targetAccount": {
        "locatorType": "ibanAccountNumber",
        "accountNumber": "GB29 APBK 6020 6552 8568 24"
      }
    }
  ]
}

Responses

Response Schema

Status Code 400

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 401

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Schemas

accountRoutingNumber

"123123123"

Account Routing Number (v1.0.0)

An account ABA routing and transit number.

type: string

minLength: 9
maxLength: 9
pattern: "^[0-9]{9}$"

achAccountRisk

"early"

ACH Account Risk (v1.0.0)

Describes the risk level of a payment batch's settlement account.

achAccountRisk strings may have one of the following enumerated values:

Value	Description
early	Early: The account is debited three business days before the ACH transfer's effective date. The account balance is also checked for sufficient funds before the account is debited. A risk limit may apply for commercial accounts with an early risk level.
normal	Normal: The account is debited two business days before the ACH transfer's effective date. The account balance is also checked for sufficient funds before the account is debited. A risk limit may apply for commercial accounts with a normal risk level.
float	Float: The account is debited on the ACH transfer's effective date. The account balance is not checked for sufficient funds before the account is debited. A risk limit applies for commercial accounts with a float risk level.
sameDay	Same Day: The account is credited on the ACH transfer's effective day. The account balance is not checked because sameDay is used for credit. A risk limit and per-transaction limit applies.

type: string

enum values: early, normal, float, sameDay

achApprovalDateTimeFields

{
  "approvalDueAt": "2021-10-30T19:06:04.250Z",
  "sameDayApprovalDue": [
    "2022-06-09T15:00:00.000Z",
    "2022-06-09T18:00:00.000Z",
    "2022-06-09T20:30:00.000Z"
  ]
}

ACH Approval DateTime Fields (v1.0.0)

Common approval date-time fields for ACH payments.

Properties

Name	Description
ACH Approval DateTime Fields (v1.0.0)	object Common approval date-time fields for ACH payments.
approvalDueAt	readOnlyTimestamp(date-time) The date and time when the payment must be fully approved so that it can be processed in time to complete by the scheduledOn date. The time component of this timestamp is the financial institution's cutoff time. This is expressed in RFC 3339 YYYY-MM-DDThh:mm:ss.sssZ date-time format in UTC time zone. read-only format: date-time minLength: 20 maxLength: 30
sameDayApprovalDue	array: [timestamp] A list of date-times when a same day payment must be fully approved so that it can be processed that day. The financial institution may process same-day ACH batches multiple times per day. The time component of each date-time is the financial institution's same-day cutoff time. This is expressed in RFC 3339 YYYY-MM-DDThh:mm:ss.sssZ date-time format in UTC time zone. Same day batches submitted on non-business days are processed the next business day. read-only minItems: 1 maxItems: 8 items: string(date-time) » format: date-time » minLength: 20 » maxLength: 30

achBusinessTransferInstruction

{
  "routingNumber": "123123123",
  "accountNumber": "123456789",
  "accountType": "checking",
  "reversed": false,
  "canceled": false,
  "prenote": false
}

ACH Batch Instruction (v1.0.0)

The payment bank account number and routing number for paying or drafting from a contact's account by ACH.

Properties

Name	Description
ACH Batch Instruction (v1.0.0)	object The payment bank account number and routing number for paying or drafting from a contact's account by ACH.
routingNumber	accountRoutingNumber (required) The financial institution routing number to be used for the payment. minLength: 9 maxLength: 9 pattern: "^[0-9]{9}$"
accountNumber	fullAchAccountNumber (required) The financial institution full account number to be used for the payment. minLength: 2 maxLength: 17 pattern: "^[- a-zA-Z0-9.]{2,17}$"
accountType	achPaymentMethodAccountType The type of banking account for the financial institution, if known. enum values: checking, savings, loan, generalLedger
addenda	array: [string] Addenda records. minItems: 0 maxItems: 9999 items: string(text) » format: text » maxLength: 80
prenote	boolean (required) If true, this item requires prenote validation to validate the routing number and account number. When submitting a prenote batch from a business transfer, all the ACH instructions tagged with prenote: true are submitted with amount: "0.00".
canceled	boolean (required) true if the payment instruction was canceled.
reversed	boolean (required) true if the payment instruction was reversed.
rePresentedCheck	rePresentedCheck A re-presented check (RCK) ACH payment instruction. This field is only used if the payment direction is debit and the payment secCode is rck. This object is omitted when in a paymentInstructionItem, even if the item is a RCK instance.

achPaymentBatch

{
  "secCode": "ppd",
  "sameDay": false,
  "imported": true,
  "companyName": "Well's Roofing",
  "confidentialCustomers": [
    {
      "id": "64446f8d-780f",
      "name": "Philip F. Duciary"
    },
    {
      "id": "58853981-24bb",
      "name": "Alice A. Tuary"
    }
  ],
  "approvalDueAt": "2022-06-09T20:30:00.000Z",
  "sameDayApprovalDue": [
    "2022-06-09T15:00:00.000Z",
    "2022-06-09T18:00:00.000Z",
    "2022-06-09T20:30:00.000Z"
  ]
}

ACH Payment Batch (v1.6.0)

Properties unique to ACH payment batches.

Properties

Name	Description
ACH Payment Batch (v1.6.0)	object Properties unique to ACH payment batches.
confidentialCustomers	array: [confidentialAchCustomer] | null A list of customers entitled to view and manage this confidential payment batch. If this property is omitted, the batch is not confidential. To remove confidential customers in a batch and make the batch non-confidential, set this property to null in a patchPaymentBatch operation. minItems: 1 maxItems: 1000 nullable items: object
companyName	string(text) The name of the company associated with this ACH batch. This short form of the business name is included in the corresponding NACHA file which imposes a maximum length of 16 characters. format: text maxLength: 16
discretionaryData	string(text) Discretionary text data which is carried over to the settlement entry. format: text maxLength: 20
sameDay	boolean (required) The ACH payment should be processed on the same day, if enabled by the financial institution. default: false
sendRemittanceOnly	boolean If true, send only the payment remittance information with this ACH payment. This property applies only if secCode is ccd or ctx and this batch is not an ACH (NACHA) import, and is otherwise ignored. default: false
approvalDueAt	readOnlyTimestamp(date-time) The date and time when the payment must be fully approved so that it can be processed in time to complete by the scheduledOn date. The time component of this timestamp is the financial institution's cutoff time. This is expressed in RFC 3339 YYYY-MM-DDThh:mm:ss.sssZ date-time format in UTC time zone. read-only format: date-time minLength: 20 maxLength: 30
sameDayApprovalDue	array: [timestamp] A list of date-times when a same day payment must be fully approved so that it can be processed that day. The financial institution may process same-day ACH batches multiple times per day. The time component of each date-time is the financial institution's same-day cutoff time. This is expressed in RFC 3339 YYYY-MM-DDThh:mm:ss.sssZ date-time format in UTC time zone. Same day batches submitted on non-business days are processed the next business day. read-only minItems: 1 maxItems: 8 items: string(date-time) » format: date-time » minLength: 20 » maxLength: 30
type	achPaymentBatchType Optionally defines a specific type of ACH payment batch. Used for Vendor Credit batches. read-only enum values: other, vendorCredit
secCode	paymentBatchAchSecCode (required) The SEC code for these ACH payments. This is derived from type. read-only enum values: arc, boc, ccd, cie, ctx, pop, ppd, rck, tel, web
imported	boolean (required) If true, this batch was imported from a NACHA file. Imported batches only allow changing the hold boolean property in payment instructions. default: false
reversedPaymentId	readOnlyResourceId If this payment is a reversal of another batch, this is the id of that reversed payment batch. read-only minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"

achPaymentBatchType

"other"

ACH Payment Batch Type (v1.0.0)

Defines the type of this ACH payment batch.

achPaymentBatchType strings may have one of the following enumerated values:

Value	Description
other	Other: An other ACH payment type
vendorCredit	Vendor Credit: Pay vendor via Corporate Trade Exchange (CTX)

type: string

enum values: other, vendorCredit

achPaymentMethodAccountType

"checking"

ACH Payment Method Account Type (v1.1.0)

The product type of the ACH payment method account.

achPaymentMethodAccountType strings may have one of the following enumerated values:

Value	Description
checking	Checking: The ACH payment method is sourced from a checking account
savings	Savings: The ACH payment method is sourced from a savings account
loan	Loan: The ACH payment method is sourced from a loan account
generalLedger	General Ledger: The ACH payment method is sourced from a general ledger account

type: string

enum values: checking, savings, loan, generalLedger

achSecCode

"arc"

ACH SEC Code (v1.0.0)

The ACH transfer type.

achSecCode strings may have one of the following enumerated values:

Value	Description
arc	Accounts Receivable
boc	Back Office Conversion
ccd	Credit or Debit
cie	Customer-Initiated
ctx	Corporate Trade Exchange
pop	Point of Purchase
ppd	Prearranged Payment and Deposit
rck	Re-Presented Check
tel	Telephone-initiated
web	Internet-initiated/Mobile

type: string

enum values: arc, boc, ccd, cie, ctx, pop, ppd, rck, tel, web

apiProblem

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

API Problem (v1.2.1)

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

Properties

Name	Description
API Problem (v1.2.1)	object API problem or error, as per RFC 7807 application/problem+json.
type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". format: uri-reference maxLength: 2048
title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. format: text maxLength: 120
status	integer(int32) The HTTP status code for this occurrence of the problem. format: int32 minimum: 100 maximum: 599
detail	string(text) A human-readable explanation specific to this occurrence of the problem. format: text maxLength: 256
instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment format: uri-reference maxLength: 2048
id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. read-only minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. read-only format: date-time minLength: 20 maxLength: 30
problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 items: object

businessTransferAchBatchInstructions

{
  "items": [
    {
      "id": "0399abed-fd3d",
      "traceNumber": 8706658,
      "name": "Pauline Stonemason",
      "identifier": "C-00523",
      "amount": "1287.65",
      "hold": false,
      "direction": "credit",
      "type": "ach",
      "ach": {
        "routingNumber": "123123123",
        "accountNumber": "123456789",
        "accountType": "checking",
        "reversed": false,
        "canceled": false,
        "prenote": false
      },
      "methodId": "ach0001",
      "contactId": "3e8375b1-8c34"
    },
    {
      "id": "0399abed-fd3d",
      "traceNumber": 8764783,
      "name": "Pauline Stonemason",
      "identifier": "C-012295",
      "amount": "2090.35",
      "hold": false,
      "direction": "credit",
      "type": "ach",
      "ach": {
        "routingNumber": "123123123",
        "accountNumber": "234567890",
        "accountType": "checking",
        "reversed": false,
        "canceled": false,
        "prenote": false
      }
    }
  ]
}

ACH Batch Instruction Collection (v1.0.0)

Collection of payment instructions for an ACH business transfer batch. The items in the collection are ordered in the items array.

Properties

Name	Description
ACH Batch Instruction Collection (v1.0.0)	object Collection of payment instructions for an ACH business transfer batch. The items in the collection are ordered in the items array.
items	array: [businessTransferInstructionItem] An array of ACH payment batch instructions. maxItems: 1000 items: object

businessTransferIdSelection

[
  "6f2625952ad00ef4f701",
  "f73e992e4230a6e8ef64",
  "d1aa5570846beb619dfa",
  "ed202975b84b7acd5161",
  "b39069bdbc65c83c58ed"
]

Business Transfer ID Selection (v1.0.0)

A comma-separated list of unique opaque business transfer IDs. Each value is the id of a resource in the Payments API. The list is limited to 100 business transfer IDs.

businessTransferIdSelection is an array schema.

Array Elements

type: array: [resourceId]

unique items
minItems: 1
maxItems: 100

businessTransferInstructionItem

{
  "id": "0399abed-fd3d",
  "traceNumber": 8706658,
  "name": "Pauline Stonemason",
  "identifier": "C-00523",
  "amount": "1287.65",
  "hold": false,
  "direction": "credit",
  "type": "ach",
  "ach": {
    "routingNumber": "123123123",
    "accountNumber": "123456789",
    "type": "checking",
    "prenote": false,
    "reversed": false,
    "canceled": false
  },
  "methodId": "ach0001",
  "contactId": "3e8375b1-8c34"
}

Business Transfer Instruction Item (v1.0.0)

Summary representation of a payment instruction resource in payment instructions collections.

Properties

Name	Description
Business Transfer Instruction Item (v1.0.0)	object Summary representation of a payment instruction resource in payment instructions collections.
name	string(text) (required) The name of the payment contact being paid or drafted. format: text minLength: 1 maxLength: 22
identifier	string(text) A optional string, such as an employee ID, which distinguishes this payment contact from others with the same name. format: text maxLength: 15
amount	monetaryValue (required) The amount of money to send or draft from this payment contact. maxLength: 16 pattern: "^(0|[1-9][0-9]*)\\.[0-9][0-9]$"
hold	boolean (required) If true, do not process this instruction.
contactId	resourceId If this payment instruction is derived from a contact in the list of payment contacts, this is the contact's id. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
methodId	resourceId If this payment instruction is derived from a contact in the list of payment contacts, this is the id of that contact's payment method. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
id	resourceId (required) The unique identifier for this payment instruction resource. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
traceNumber	integer(int32) (required) A unique non-negative integer for tracing this payment through the payment system. This is an immutable opaque string of digits, assigned by the system. read-only format: int32 minimum: 1 maximum: 999999999
direction	paymentInstructionDirection (required) Indicates if this item is a debit or credit, relative to this payment contact. This field is immutable. read-only enum values: credit, debit
ach	achBusinessTransferInstruction The payment instruction details for an ACH batch business payment. This field is used only if the business transfer type is ach.

businessTransferItem

{
  "id": "0399abed-fd3d",
  "type": "ach",
  "state": "pendingApproval",
  "toSummary": "12 payees",
  "fromSummary": "Payroll Checking *7890",
  "direction": "credit",
  "customerId": "d1b95731fb029fec062c",
  "ach": {
    "secCode": "ppd",
    "companyName": "Well's Roofing",
    "imported": false,
    "sameDay": false,
    "confidentialCustomers": [
      {
        "id": "64446f8d-780f",
        "name": "Philip F. Duciary"
      },
      {
        "id": "58853981-24bb",
        "name": "Alice A. Tuary"
      }
    ],
    "approvalDueAt": "2022-06-09T20:30:00.000Z",
    "sameDayApprovalDue": [
      "2022-06-09T15:00:00.000Z",
      "2022-06-09T18:00:00.000Z",
      "2022-06-09T20:30:00.000Z"
    ]
  },
  "trackingNumber": "15474162",
  "remainingApprovalsCount": 2,
  "approvalCount": 1,
  "creditTotal": "2640.60",
  "debitTotal": "0.00",
  "creditCount": 12,
  "debitCount": 30,
  "reversalDebitTotal": "0.00",
  "reversalCreditTotal": "0.00",
  "settlementAccount": {
    "label": "Payroll Checking *7890",
    "maskedNumber": "*7890",
    "id": "bf23bc970-91e8",
    "risk": "normal"
  },
  "schedule": {
    "scheduledOn": "2023-05-01",
    "effectiveOn": "2023-04-30"
  },
  "createdAt": "2023-04-28T07:48:20.375Z",
  "updatedAt": "2023-04-28T07:48:49.375Z",
  "createdBy": {
    "id": "0399abed-fd3d",
    "name": "Benny Billings",
    "username": "bbillings"
  },
  "updatedBy": {
    "id": "0399abed-fd3d",
    "name": "Benny Billings",
    "username": "bbillings"
  }
}

Business Transfer Item (v1.0.0)

Overview of a business transfer.

Properties

Name	Description
Business Transfer Item (v1.0.0)	object Overview of a business transfer.
id	readOnlyResourceId (required) The unique identifier for this payment batch resource. This is an immutable opaque string. read-only minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
trackingNumber	paymentBatchTrackingNumber (required) A unique tracking number for this batch. Unlike the id, this numeric value is visible to the customer, and can be used to lookup a batch by this ID. read-only minLength: 6 maxLength: 9 pattern: "^[0-9]+$"
fromSummary	string(text) A short summary string describing where the payment batch originates, such as a description of the settlement account for credit payments, or for debit payments, a description of the draft account (if only one) or the number of payees. read-only format: text maxLength: 80
toSummary	string(text) A short summary string describing where the funds are credited, such as a description of the settlement account for debit payments, or for credit payments, a description of the payee (if only one) or the number of payees. read-only format: text maxLength: 80
state	paymentBatchState (required) The state of this payment batch. read-only enum values: pending, pendingApproval, rejected, scheduled, processing, processed, reversalPending, partiallyReversed, reversed, canceled, failed
reasonCode	paymentBatchReasonCode The reason code associated with the payment batch state. read-only enum values: incomplete, notScheduled, pastCutoff, sameDayRequired, locked, none
stateReason	string(text) The reason given when someone rejected the batch, reversed the batch, or removed approvals. This string is only present if a reason was given and the state has not changed since the reason was given. read-only format: text maxLength: 80
customerId	readOnlyResourceId (required) The ID of the banking customer that this payment batch is for. This is typically a business customer ID. Note: This is not the login or access ID of the customer. read-only minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
information	string(text) A text string with additional information about the status of the batch. read-only format: text maxLength: 100
remainingApprovalsCount	integer(int32) (required) The number of the remaining approvals that are required before the batch can be scheduled. This property only applies if the state of the payment batch is pendingApproval. read-only format: int32 minimum: 0 maximum: 3
approvalCount	integer(int32) (required) The number of approvals given for the batch. read-only format: int32 minimum: 0 maximum: 3
derivedFrom	paymentBatchDerivation If this batch was copied from another, this object describes that source payment batch. This field is only present when the payment batch was created via the copy operation. read-only
createdBy	customerAccountReference (required) The customer who created this payment batch.
updatedBy	customerAccountReference (required) The customer who last updated this payment batch.
name	string(text) The user-assigned name of this payment batch. format: text maxLength: 10
description	string(text) The user-assigned detailed description of this payment batch. format: text maxLength: 100
company	paymentBatchCompany Identification of the company making this payment batch.
settlementAccount	paymentSettlementAccountReference The account where the payment funds are drawn or credited.
settlementType	paymentBatchSettlementType Whether the payments in the batch are applied to the settlement account as detailed transactions per payment instruction or as one summary transaction. This value is initially derived from the customer's ACH preferences. When payment batch processing begins, the preference is assigned to the payment. read-only enum values: summary, detailed
schedule	paymentBatchSchedule The date when the payment should be processed, and any recurrence.
direction	paymentBatchDirection (required) The direction in which funds flow for this payment batch. read-only enum values: none, credit, debit, both
creditTotal	creditOrDebitValue (required) The total of all the payment credit amounts in this batch's payment instructions, expressed as a decimal value. These amounts are credits to the remote accounts and a debit to the settlement account. The total omits instructions where hold is true. read-only maxLength: 16 pattern: "^(-|\\+)?(0|[1-9][0-9]*)\\.[0-9][0-9]$"
debitTotal	creditOrDebitValue (required) The total of all the payment debit amounts in this batch's payment instructions, expressed as a decimal value. These amounts are debits to the remote accounts and a credit to the settlement account. The total omits instructions where hold is true. read-only maxLength: 16 pattern: "^(-|\\+)?(0|[1-9][0-9]*)\\.[0-9][0-9]$"
creditCount	integer(int32) (required) The number of all the credit instructions in this payment batch. The count omits instructions where hold is true. read-only format: int32 minimum: 0 maximum: 10000
debitCount	integer(int32) (required) The number of all the debit instructions in this payment batch. The count omits instructions where hold is true. read-only format: int32 minimum: 0 maximum: 10000
createdAt	readOnlyTimestamp(date-time) (required) The date-time when this resource was created, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. This is derived and immutable. read-only format: date-time minLength: 20 maxLength: 30
updatedAt	readOnlyTimestamp(date-time) (required) The date-time when the resource was last updated, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. This is derived and immutable. read-only format: date-time minLength: 20 maxLength: 30
reversalCreditTotal	creditOrDebitValue (required) The total of all credit payment instructions that have been reversed. read-only maxLength: 16 pattern: "^(-|\\+)?(0|[1-9][0-9]*)\\.[0-9][0-9]$"
reversalDebitTotal	creditOrDebitValue (required) The total of all credit payment instructions that have been reversed. read-only maxLength: 16 pattern: "^(-|\\+)?(0|[1-9][0-9]*)\\.[0-9][0-9]$"
ach	achPaymentBatch ACH-specific details of the business transfer. This object is present if and only if the business transfer's type is ach. read-only

businessTransferList

{
  "items": [
    {
      "id": "0399abed-fd3d",
      "type": "ach",
      "state": "pendingApproval",
      "toSummary": "12 payees",
      "fromSummary": "Payroll Checking *7890",
      "direction": "credit",
      "customerId": "d1b95731fb029fec062c",
      "ach": {
        "secCode": "ppd",
        "companyName": "Well's Roofing",
        "imported": false,
        "sameDay": false,
        "confidentialCustomers": [
          {
            "id": "64446f8d-780f",
            "name": "Philip F. Duciary"
          },
          {
            "id": "58853981-24bb",
            "name": "Alice A. Tuary"
          }
        ],
        "approvalDueAt": "2022-06-09T20:30:00.000Z",
        "sameDayApprovalDue": [
          "2022-06-09T15:00:00.000Z",
          "2022-06-09T18:00:00.000Z",
          "2022-06-09T20:30:00.000Z"
        ]
      },
      "trackingNumber": "15474162",
      "remainingApprovalsCount": 2,
      "approvalCount": 1,
      "creditTotal": "2640.60",
      "debitTotal": "0.00",
      "creditCount": 12,
      "debitCount": 30,
      "reversalDebitTotal": "0.00",
      "reversalCreditTotal": "0.00",
      "settlementAccount": {
        "label": "Payroll Checking *7890",
        "maskedNumber": "*7890",
        "id": "bf23bc970-91e8",
        "risk": "normal"
      },
      "schedule": {
        "scheduledOn": "2023-05-01",
        "effectiveOn": "2023-04-30"
      },
      "createdAt": "2023-04-28T07:48:20.375Z",
      "updatedAt": "2023-04-28T07:48:49.375Z",
      "createdBy": {
        "id": "0399abed-fd3d",
        "name": "Benny Billings",
        "username": "bbillings"
      },
      "updatedBy": {
        "id": "0399abed-fd3d",
        "name": "Benny Billings",
        "username": "bbillings"
      }
    }
  ]
}

Business Transfer List (v1.0.0)

A list of business transfers.

Properties

Name	Description
Business Transfer List (v1.0.0)	object A list of business transfers.
items	array: [businessTransferItem] (required) An array of business transfers. minItems: 1 maxItems: 100 items: object

confidentialAchCustomer

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

Confidential ACH Customer (v1.0.0)

A reference to a customer that is entitled to view and manage a confidential ACH payment batch.

Properties

Name	Description
Confidential ACH Customer (v1.0.0)	object A reference to a customer that is entitled to view and manage a confidential ACH payment batch.
id	resourceId (required) The unique id of the customer. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
name	string(text) (required) The customer's full name. format: text minLength: 1 maxLength: 50

creditOrDebitValue

"3456.78"

Credit Or Debit Value (v1.1.0)

The monetary value representing a credit (positive amounts with no prefix or a + prefix) or debit (negative amounts with a - prefix). The numeric value is represented as a string so that it can be exact with no loss of precision.

type: string

maxLength: 16
pattern: "^(-|\+)?(0|[1-9][0-9]*)\.[0-9][0-9]$"

customerAccountReference

{
  "id": "0399abed-fd3d",
  "name": "Benny Billings",
  "username": "bbillings"
}

Customer Account Reference (v1.0.0)

The representation of a customer account.

Properties

Name	Description
Customer Account Reference (v1.0.0)	object The representation of a customer account.
id	resourceId (required) The immutable, unique, opaque identifier for the user. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
name	string(text) (required) The user's full name. format: text maxLength: 20
username	customerUsername(text) (required) The user's login name. format: text maxLength: 20

customerReference

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

Customer Reference (v1.1.1)

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

Properties

Name	Description
Customer Reference (v1.1.1)	object A reference to a customer. The name property is the customer's name at the time this reference was created.
id	resourceId (required) The unique id of the customer. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
name	string(text) (required) The customer's full name. format: text minLength: 1 maxLength: 50

customerUsername

"string"

Customer Username (v1.0.0)

A customer's login username.

type: string(text)

format: text
maxLength: 20

date

"2021-10-30"

Date (v1.0.0)

A date formatted in YYYY-MM-DD RFC 3339 date UTC format.

type: string(date)

format: date
minLength: 10
maxLength: 10

fullAccountNumber

"123456789"

Full Account Number (v1.0.0)

A full account number. This is the number that the customer uses to reference the account within the financial institution.

type: string

minLength: 1
maxLength: 32
pattern: "^[- a-zA-Z0-9.]{1,32}$"

fullAchAccountNumber

"123456789"

Full ACH Account Number (v1.0.0)

A full account number used in ACH account processing.

type: string

minLength: 2
maxLength: 17
pattern: "^[- a-zA-Z0-9.]{2,17}$"

institutionId

"TIBURON"

Institution ID (v1.1.0)

The unique immutable identifier of a financial institution.

type: string

minLength: 2
maxLength: 8
pattern: "^[A-Z0-9_]{2,8}$"

institutionLocatorType

"abaRoutingNumber"

Institution Locator Type (v1.0.0)

Indicates the type of the institution locator.

institutionLocatorType strings may have one of the following enumerated values:

Value	Description
abaRoutingNumber	ABA Routing Number: The American Bankers Association routing number of a financial institution
swiftBicCode	swiftBicCode: The SWIFT Business Identifier Code (BIC) code of a financial institution
ibanAccountNumber	IBAN: International Bank Account Number (IBAN)

type: string

enum values: abaRoutingNumber, swiftBicCode, ibanAccountNumber

maskedAccountNumber

"*1008"

Masked Account Number (v1.0.1)

A masked account number: an asterisk * followed by one to four characters of the fullAccountNumber.

type: string

minLength: 2
maxLength: 5
pattern: "^\*[- _a-zA-Z0-9.]{1,4}$"

monetaryValue

"3456.78"

Monetary Value (v1.1.0)

The monetary value, supporting only positive amounts. The numeric value is represented as a string so that it can be exact with no loss of precision.

type: string

maxLength: 16
pattern: "^(0|[1-9][0-9]*)\.[0-9][0-9]$"

nullableReadOnlyResourceId

"string"

Nullable Read-only Resource Identifier (v1.0.0)

The unique, opaque system-assigned identifier for a resource. This case-sensitive ID is used in properties that reference a resource by ID rather than URL. This can be used in patch operations to detach a resource. Resource IDs are immutable.

type: string | null

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

nullableResourceId

"string"

Nullable Resource Identifier (v1.0.0)

The unique, opaque system-assigned identifier for a resource. This case-sensitive ID is used in properties that reference a resource by ID rather than URL. This can be used in patch operations to detach a resource.

type: string | null

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

paymentBatchAchSecCode

"arc"

ACH Payment (v1.0.1)

The Standard Entry Class (SEC) code that denotes the ACH payment authorization type.

type: string

enum values: arc, boc, ccd, cie, ctx, pop, ppd, rck, tel, web

paymentBatchCompany

{
  "id": "string",
  "type": "taxId"
}

Payment Batch Company (v1.1.0)

Identification of the company associated with this payment batch.

Properties

Name	Description
Payment Batch Company (v1.1.0)	object Identification of the company associated with this payment batch.
id	string(text) (required) The company identifier. format: text maxLength: 32
type	paymentBatchCompanyIdType (required) The type of this company identification number enum values: taxId, dunsNumber, userDefined, companyId

paymentBatchCompanyIdType

"taxId"

Payment Batch Company Id Type (v1.0.0)

An enumeration of allowed company ID types.

paymentBatchCompanyIdType strings may have one of the following enumerated values:

Value	Description
taxId	Tax Id: Government issued TAX identification ID
dunsNumber	DUNS Number: Dunn & Bradstreet company identification number
userDefined	User Defined ID
companyId	Company ID

type: string

enum values: taxId, dunsNumber, userDefined, companyId

paymentBatchCopyType

"prenote"

Payment Batch Copy Type (v1.1.0)

The type of the payment batch copy.

paymentBatchCopyType strings may have one of the following enumerated values:

Value	Description
prenote	Prenote: A prenote payment batch to validate the ACH routing number and account number
copy	Copy: A copy of an existing payment batch
recurrence	Recurrence: A payment batch originating from a payment batch recurrence
reversal	Reversal: A reversed payment batch

type: string

enum values: prenote, copy, recurrence, reversal

paymentBatchDerivation

{
  "id": "string",
  "trackingNumber": "15474162",
  "type": "prenote"
}

Payment Batch Derivation (v1.0.1)

If this batch was copied from another, this object describes that source payment batch. This field is only be present when the payment batch was created via the copy operation.

Properties

Name	Description
Payment Batch Derivation (v1.0.1)	object If this batch was copied from another, this object describes that source payment batch. This field is only be present when the payment batch was created via the copy operation.
id	readOnlyResourceId (required) The unique identifier for the origin payment batch resource. This is an immutable opaque string. read-only minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
trackingNumber	string (required) The unique tracking number for the batch this was copied from. minLength: 6 maxLength: 9 pattern: "^[0-9]+$"
type	paymentBatchCopyType (required) The type of the payment batch copy. paymentBatchCopyType strings may have one of the following enumerated values: Value Description prenote Prenote: A prenote payment batch to validate the ACH routing number and account number copy Copy: A copy of an existing payment batch recurrence Recurrence: A payment batch originating from a payment batch recurrence reversal Reversal: A reversed payment batch enum values: prenote, copy, recurrence, reversal

paymentBatchDirection

"none"

Batch Payment Direction (v1.0.0)

Indicates the direction of money flow for a payment batch.

paymentBatchDirection strings may have one of the following enumerated values:

Value	Description
none	None: No payment instructions to determine direction
credit	credit: Payments are credit in the external accounts, debit to the settlement account
debit	debit: Payments are debits in the external accounts, credit to the settlement account
both	both: Payment instructions include both debits and credits

type: string

enum values: none, credit, debit, both

paymentBatchReasonCode

"incomplete"

Payment Batch Reason Code (v1.2.0)

The reason that a payment batch is in its current state. Normally, this explains why the state is still pending and not eligible to be submitted or approved.

Some reasonCode values may only be associated with specific state values.

• state: pending may have these reasonCode values:
  • incomplete
  • notScheduled
  • pastCutoff
  • sameDayRequired
  • none
• state: pendingApproval may have these reasonCodes values:
  • locked

paymentBatchReasonCode strings may have one of the following enumerated values:

Value	Description
incomplete	Incomplete: The payment batch is missing one or more field values required for submission
notScheduled	Not Scheduled: The payment batch was created but does not have an assigned schedule.scheduledOn
pastCutoff	Past Cutoff: The payment batch's scheduled date has exceeded the processing cutoff time and is no longer eligible for processing
sameDayRequired	Same Day Required: The payment batch requires Same Day ACH processing
locked	Locked: The payment batch has been submitted and is unable to be modified
none	None: The payment batch has no problems and is eligible for submission and approval

type: string

enum values: incomplete, notScheduled, pastCutoff, sameDayRequired, locked, none

paymentBatchSchedule

{
  "recurrenceType": "fixed",
  "scheduledOn": "2021-10-30",
  "frequency": "once",
  "endsOn": "2021-10-30",
  "effectiveOn": "2021-10-30"
}

Payment Batch Schedule (v1.3.2)

The scheduled date when the payment should be completed, the recurrence, if any, and other derived dates based on the scheduled date.

If the payment is a NACHA pass-through, the schedule is read-only and reflects the earliest scheduledOn and effectiveOn dates from the NACHA file with a recurrenceType of once.

Properties

Name	Description
Payment Batch Schedule (v1.3.2)	object The scheduled date when the payment should be completed, the recurrence, if any, and other derived dates based on the scheduled date. If the payment is a NACHA pass-through, the schedule is read-only and reflects the earliest scheduledOn and effectiveOn dates from the NACHA file with a recurrenceType of once.
recurrenceType	paymentRecurrenceType Describes whether the payment instruction amounts in the batch vary or are fixed when the payment recurs. This is ignored if the payment frequency is once. paymentRecurrenceType strings may have one of the following enumerated values: Value Description fixed Fixed: The payment amounts are the same each time a payment recurs variable Variable: The payment amounts vary and must be entered/verified each time a payment recurs automaticallyRecur Automatically Recur: The payment batch will automatically recur after processing (but with no scheduled date) enum values: fixed, variable, automaticallyRecur
scheduledOn	date(date) The payment's target completion date, in YYYY-MM-DD RFC 3339 date format. For recurring batches, this date get recalculated after each recurrence is processed. format: date minLength: 10 maxLength: 10
frequency	paymentFrequency For recurring payments and drafts, the interval at which the money movement recurs. enum values: once, occasional, daily, weekly, biweekly, semimonthly, monthly, monthlyFirstDay, monthlyLastDay, bimonthly, quarterly, semiyearly, yearly
endsOn	date(date) The optional date when the recurring batch schedule ends, in YYYY-MM-DD RFC 3339 date format. Subsequent recurring payments may be scheduled up to and including this date, but not after. This property is omitted if frequency is once. format: date minLength: 10 maxLength: 10
effectiveOn	date(date) The target date when the batch payment or draft should be processed, in YYYY-MM-DD RFC 3339 date format. This is derived from the scheduledOn date. For recurring batches, this date get recalculated after each recurrence is processed. format: date minLength: 10 maxLength: 10

paymentBatchSettlementType

"summary"

Settlement Type (v1.0.0)

How the payment processing is applied to the settlement account.

paymentBatchSettlementType strings may have one of the following enumerated values:

Value	Description
summary	Summary: All the payments in the batch are combined into one transaction against the account
detailed	Detailed: Each payments in the batch is recorded as individual transactions against the account

type: string

enum values: summary, detailed

paymentBatchState

"pending"

Payment Batch State (v1.0.0)

Defines the state of this payment batch.

paymentBatchState strings may have one of the following enumerated values:

Value	Description
pending	Pending: A batch that has incomplete or erroneous data or has not yet be submitted for approval
pendingApproval	Pending Approval: At least one approval is necessary before the payment batch may be scheduled
rejected	Rejected: An approver rejected a payment batch
scheduled	Scheduled: A payment batch that is scheduled to be processed
processing	Processing: A payment patch that has begun payment processes
processed	Processed: A payment batch that has completed its payment processing
reversalPending	Reversal Pending: A customer has requested reversal which has not yet started
partiallyReversed	Partially Reversed: Some of the payment instructions in a payment batch have been reversed
reversed	Reversed: The entire batch has been fully reversed
canceled	Canceled: A reversed batch has been canceled before an account has been debited
failed	Failed: A batch which has failed validation business rules

type: string

enum values: pending, pendingApproval, rejected, scheduled, processing, processed, reversalPending, partiallyReversed, reversed, canceled, failed

paymentBatchTrackingNumber

"15474162"

Payment Batch Tracking Number (v1.0.0)

A unique tracking number for this batch. Unlike the id, this numeric value is visible to the customer, and can be used to lookup a batch by this ID.

type: string

read-only
minLength: 6
maxLength: 9
pattern: "^[0-9]+$"

paymentFrequency

"once"

Payment Frequency (v1.1.1)

For recurring payments and drafts, the interval at which the money movement recurs.

type: string

enum values: once, occasional, daily, weekly, biweekly, semimonthly, monthly, monthlyFirstDay, monthlyLastDay, bimonthly, quarterly, semiyearly, yearly

paymentInstructionDirection

"credit"

Payment Instruction Direction (v1.0.0)

Indicates the direction of money flow for a payment instruction.

paymentInstructionDirection strings may have one of the following enumerated values:

Value	Description
credit	credit: Payment is a credit in the external account, debit to the settlement account
debit	debit: Payment is a debit in the external account, credit to the settlement account

type: string

enum values: credit, debit

paymentRecurrenceType

"fixed"

Payment Recurrence Type (v1.1.0)

Describes whether the payment instruction amounts in the batch vary or are fixed when the payment recurs. This is ignored if the payment frequency is once.

paymentRecurrenceType strings may have one of the following enumerated values:

Value	Description
fixed	Fixed: The payment amounts are the same each time a payment recurs
variable	Variable: The payment amounts vary and must be entered/verified each time a payment recurs
automaticallyRecur	Automatically Recur: The payment batch will automatically recur after processing (but with no scheduled date)

type: string

enum values: fixed, variable, automaticallyRecur

paymentSettlementAccountReference

{
  "label": "Payroll Checking *1008",
  "maskedNumber": "*1008",
  "id": "bf23bc970b78d27691e",
  "risk": "normal"
}

Payment Settlement Account Reference (v3.1.0)

Descriptive fields that identify a payment's internal settlement account.

Properties

Name	Description
Payment Settlement Account Reference (v3.1.0)	object Descriptive fields that identify a payment's internal settlement account.
id	nullableReadOnlyResourceId | null (required) The account's unique, opaque resource ID. read-only minLength: 6 maxLength: 48 nullable pattern: "^[-_:.~$a-zA-Z0-9]+$"
label	string(text) A text label which describes this account. This is derived from the account.label. read-only format: text maxLength: 80
risk	achAccountRisk The risk level determines how the batch processes: how many days it takes to process the batch ( 2, 3 or 4 days ), when the customer gets debited, and how early the batch has to look ahead of the effective date. This is normally determined from the risk associated with the settlement account. enum values: early, normal, float, sameDay
maskedNumber	maskedAccountNumber The account number, masked for partial display. read-only minLength: 2 maxLength: 5 pattern: "^\\*[- _a-zA-Z0-9.]{1,4}$"

problemResponse

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

Problem Response (v0.4.1)

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

Properties

Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". format: uri-reference maxLength: 2048
title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. format: text maxLength: 120
status	integer(int32) The HTTP status code for this occurrence of the problem. format: int32 minimum: 100 maximum: 599
detail	string(text) A human-readable explanation specific to this occurrence of the problem. format: text maxLength: 256
instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment format: uri-reference maxLength: 2048
id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. read-only minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. read-only format: date-time minLength: 20 maxLength: 30
problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 items: object
attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

rePresentedCheck

{
  "checkNumber": 43318
}

Re-Presented Check (v1.1.0)

A re-presented check (RCK) ACH payment instruction. An RCK instruction represents a check that was returned for non-sufficient or uncollected funds and is being presented again for payment.

Properties

Name	Description
Re-Presented Check (v1.1.0)	object A re-presented check (RCK) ACH payment instruction. An RCK instruction represents a check that was returned for non-sufficient or uncollected funds and is being presented again for payment.
checkNumber	integer(int32) (required) The check number that was presented again. format: int32 minimum: 1 maximum: 999999999999999

readOnlyResourceId

"string"

Read-only Resource Identifier (v1.0.1)

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

type: string

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

readOnlyTimestamp

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

Read-Only Timestamp (v1.0.0)

A readonly or derived timestamp (an instant in time) formatted in RFC 3339 date-time UTC format: YYYY-MM-DDThh:mm:ss.sssZ.

type: string(date-time)

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

resourceId

"string"

Resource Identifier (v1.0.1)

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

type: string

minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"

timestamp

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

Timestamp (v1.0.0)

A timestamp (an instant in time) formatted in YYYY-MM-DDThh:mm:ss.sssZ RFC 3339 date-time UTC format.

type: string(date-time)

format: date-time
minLength: 20
maxLength: 30

transferFrequency

"once"

Transfer Frequency (v1.0.0)

For recurring transfers, the interval at which the money movement recurs.

transferFrequency strings may have one of the following enumerated values:

Value	Description
once	Once: Transfer does not repeat
occasional	Occasional: Transfer recurs but without a new scheduled date
daily	Daily: Repeat daily on business days
weekly	Weekly: Repeat weekly
biweekly	biweekly: Repeat every two weeks (26 times a year)
semimonthly	Semimonthly: Repeat twice a month (24 times a year)
monthly	Monthly: Repeat monthly
monthlyFirstDay	Monthly First Day: Repeat on the first business day of the month
monthlyLastDay	Monthly Last Day: Repeat on the last business day of the month
bimonthly	Bimonthly: Repeat every other month
quarterly	Quarterly: Repeat quarterly (four times a year)
semiyearly	Semiyearly: Repeat every six months (twice a year)
yearly	Yearly: Repeat once every year

type: string

enum values: once, occasional, daily, weekly, biweekly, semimonthly, monthly, monthlyFirstDay, monthlyLastDay, bimonthly, quarterly, semiyearly, yearly

wireTransferAccounts

{
  "id": "9fe04b71360e2a1a1293",
  "trackingNumber": "122966",
  "sourceAccount": {
    "id": "89b19e14f7b602d79240",
    "accountNumber": "123456789"
  },
  "targetAccount": {
    "locatorType": "abaRoutingNumber",
    "locator": "123123123",
    "accountNumber": "0123456789"
  }
}

Wire Transfer Accounts (v1.0.2)

The source and target (beneficiary) banking accounts associated with a wire transfer. If no wire transfer exists for the wire transfer reference given in the request body, only the notFound property is present.

Properties

Name	Description
Wire Transfer Accounts (v1.0.2)	object The source and target (beneficiary) banking accounts associated with a wire transfer. If no wire transfer exists for the wire transfer reference given in the request body, only the notFound property is present.
id	readOnlyResourceId The ID of the requested wire transfer resource. read-only minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
trackingNumber	paymentBatchTrackingNumber An optional tracking number for wire transfer. Unlike the id, this numeric value is visible to the customer and is used to track the wire transfer in downstream processing. read-only minLength: 6 maxLength: 9 pattern: "^[0-9]+$"
sourceAccount	wireTransferSourceAccountReference The source account where funds are debited for the wire transfer.
targetAccount	wireTransferBeneficiaryAccountReference The target (beneficiary) account where the wire transfer funds are transferred.
notFound	wireTransferReference The reference (ID or tracking number) of a wire transfer that was not found for the financial institution. This property is only present if no wire transfer was found for the corresponding wire transfer reference in the request. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"

wireTransferAccountsList

{
  "items": [
    {
      "id": "9fe04b71360e2a1a1293",
      "trackingNumber": "122966",
      "sourceAccount": {
        "id": "89b19e14f7b602d79240",
        "accountNumber": "123456789"
      },
      "targetAccount": {
        "locatorType": "abaRoutingNumber",
        "locator": "123123123",
        "accountNumber": "0123456789"
      }
    },
    {
      "notFound": "dc617d4fd715bac02ee1"
    },
    {
      "notFound": "678345003"
    },
    {
      "id": "bab5c032f56dfe535680",
      "trackingNumber": "003678345",
      "sourceAccount": {
        "id": "89b19e14f7b602d79240",
        "accountNumber": "123456789"
      },
      "targetAccount": {
        "locatorType": "ibanAccountNumber",
        "accountNumber": "GB29 APBK 6020 6552 8568 24"
      }
    }
  ]
}

Wire Transfer Accounts List (v1.0.2)

The source and target (beneficiary) banking accounts associated with a list of wire transfers. The items in the response correspond 1-to-1 with the each query value in the request. If no wire transfer exists for the wire transfer reference in the request body, only the notFound property is present in the corresponding response item; the notFound value is the corresponding wire transfer reference from the request. (In the example, no wire transfer was found for the input values 'dc617d4fd715bac02ee1' and '678345003'.)

Properties

Name	Description
Wire Transfer Accounts List (v1.0.2)	object The source and target (beneficiary) banking accounts associated with a list of wire transfers. The items in the response correspond 1-to-1 with the each query value in the request. If no wire transfer exists for the wire transfer reference in the request body, only the notFound property is present in the corresponding response item; the notFound value is the corresponding wire transfer reference from the request. (In the example, no wire transfer was found for the input values 'dc617d4fd715bac02ee1' and '678345003'.)
items	array: [wireTransferAccounts] (required) The array of details about the requested wire transfers' source and target accounts. minItems: 1 maxItems: 1000 items: object

wireTransferBeneficiaryAccountReference

{
  "locatorType": "abaRoutingNumber",
  "locator": "123123123",
  "accountNumber": "123456789"
}

Wire Transfer Beneficiary Account Reference (v1.0.0)

The beneficiary's (target) account where the wire transfer is transferred (credited).

Properties

Name	Description
Wire Transfer Beneficiary Account Reference (v1.0.0)	object The beneficiary's (target) account where the wire transfer is transferred (credited).
locator	string(text) The American Bankers Association routing number, SWIFT Business Identifier Code (BIC) code, or IBAN account number of the financial institution hosting the wire transfer beneficiary's (target) account. format: text maxLength: 36
locatorType	institutionLocatorType (required) The type of the locator used to identify the financial institution hosting the wire transfer beneficiary's (target) account. enum values: abaRoutingNumber, swiftBicCode, ibanAccountNumber
accountNumber	string(text) (required) The account number for the beneficiary's (target) account. For domestic wire transfers, this is the US Bank Account number. For international wire transfers, this is the International Bank Account Number (IBAN). format: text maxLength: 50

wireTransferReference

"string"

Wire Transfer Reference (v1.0.0)

The resource ID or tracking number of a wire transfer.

type: string

minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"

wireTransferReferences

{
  "items": [
    "9fe04b71360e2a1a1293",
    "dc617d4fd715bac02ee1",
    "678345003",
    "003678345"
  ]
}

Wire Transfer References (v1.0.2)

A list of unique wire transfer references. Each value contains either the resource ID or tracking number of a wire transfer.

Properties

Name	Description
Wire Transfer References (v1.0.2)	object A list of unique wire transfer references. Each value contains either the resource ID or tracking number of a wire transfer.
items	array: [wireTransferReference] (required) The array of wire transfer IDs or tracking numbers. unique items minItems: 1 maxItems: 1000 items: string » minLength: 6 » maxLength: 48 » pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"

wireTransferSourceAccountReference

{
  "id": "89b19e14f7b602d79240",
  "accountNumber": "123456789"
}

Wire Transfer Source Account Reference (v1.0.1)

Identifying properties of a wire transfer source account.

Properties

Name	Description
Wire Transfer Source Account Reference (v1.0.1)	object Identifying properties of a wire transfer source account.
id	readOnlyResourceId (required) The unique identifier for the source (debit) account resource. If the source account is no longer available (for example, it has been closed and then removed from the system), the id value no-such-account is returned. read-only minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
accountNumber	fullAccountNumber (required) The full account number of the source (debit) account. minLength: 1 maxLength: 32 pattern: "^[- a-zA-Z0-9.]{1,32}$"

---