Real-Time Payments v0.21.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.

Real-Time Payments (RTP), also called instant or faster payment, is a payment method that allows banking customers (members) and businesses to send and receive immediate payments, 24/7/365, directly from their banking accounts.

A debit real-time payment represents a payment that is withdrawn (debited) from the sender's account and deposited to an internal account at the current financial institution, also known as an incoming real-time payment.

A credit real-time payment represents a payment that is withdrawn from an internal account at the current financial institution and deposited (credited) into the recipient's account, also known as an outgoing real-time payment.

Download OpenAPI Definition (YAML)

Base URLs:

https://api.apiture.com/banking

Email: Apiture Web: Apiture

License: Apiture API License

Authentication

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

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

Debit Real-Time Payments

Real-time payments debited from the sender's account and credited to an internal account

listDebitRealTimePayments

Code samples

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

GET https://api.apiture.com/banking/debitRealTimePayments HTTP/1.1
Host: api.apiture.com
Accept: application/json

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

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

};

fetch('https://api.apiture.com/banking/debitRealTimePayments',
{
  method: 'GET',

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

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

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

Return a collection of debit real-time payments

GET https://api.apiture.com/banking/debitRealTimePayments

Return a paginated collection of debit real-time payments. The result is ordered by default in reverse chronological order based on the created date (createdAt) of the debit real-time payments.

Parameters

Parameter	Description
`senderName` `in: query`	`string(text)` Return only debit real-time payments whose `sender.name` contains this substring of at least two characters, ignoring case. `format: text` `minLength: 2` `maxLength: 140`
`availableAt` `in: query`	`dateRange` Return only debit real-time payments whose `availableAt` date matches with the value or date range. Can search up to 2 years in the past. Date ranges use range notation. Examples: `[2023-05-01,2023-05-31]` between May 1 and 31, 2023, inclusive `[2023-05-01,2023-06-01)` on or after May 1, but before June 1 (in May, 2023) `[2023-05-19,]` on or after May 19, 2023 `[,2023-05-19]` on or before May 19, 2023 `2023-05-19` uploaded on May 19, 2023. `maxLength: 24` `pattern: "^\\d{4}-\\d{2}-\\d{2}\|([[(](\\d{4}-\\d{2}-\\d{2},(\\d{4}-\\d{2}-\\d{2})?\|,\\d{4}-\\d{2}-\\d{2})[)\\]])$"`
`accounts` `in: query`	`bankingAccountIdSelection` Return only debit real-time payments which were deposited into one of these accounts. `unique items` `minItems: 1` `maxItems: 32` `comma-delimited` items: `string` » `minLength: 6` » `maxLength: 48` » `pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"`
`amount` `in: query`	`amountRange` Return only debit real-time payments whose `amount` is in this range. Amount ranges use range notation. The value may have the following forms: `1200.50` match the dollar amount 1,200.50 exactly `[1000.00,1200.00)` matches items where `1000.00 <= amount < 1200.00` `[1000.00,1199.99]` matches items where `1000.00 <= amount <= 1199.99` `(999.99,1200.00)` matches items where `999.99 < amount < 1200.00` `[1200.50,]` matches items where `amount >= 1200.50` `(1200.50,)` matches items where `amount > 1200.50` `[,1200.50]` matches items where `amount <= 1200.50` `(,1200.50)` matches items where `amount < 1200.50` `minLength: 1` `maxLength: 30` `pattern: "^((\\d+(\\.\\d{0,2})?)\|([\\[\$](((\\d+(\\.\\d{0,2})?),((\\d+(\\.\\d{0,2})?))?)\|(,(\\d+(\\.\\d{0,2})?)))[\\]\$]))$"`
`sortBy` `in: query`	`array[string]` The sort order for the items in the response. Use `?sortBy=createdAt` or `?sortBy=-createdAt` to sort by ascending or descending order of the payment's `createdAt` date-time. The default is `-createdAt`. `unique items` `minItems: 1` `maxItems: 1` `comma-delimited` items: `string` » `minLength: 9` » `maxLength: 10` » `pattern: "^-?(createdAt)"`
`start` `in: query`	`string` The location of the next item in the collection. This is an opaque cursor supplied by the API service. Omit this to start at the beginning of the collection. The client does not define this value; the API services automatically pass the `?start=` parameter on the `nextPage_url`. `maxLength: 256` `default: ""` `pattern: "^[-a-zA-Z0-9.,-=_+:;@$]{0,256}$"`
`limit` `in: query`	`integer(int32)` The maximum number of items to return in this paged response. `format: int32` `minimum: 0` `maximum: 1000` `default: 100`

Example responses

200 Response

{
  "nextPage_url": "https://production.api.apiture.com/banking/debitRealTimePayments?start=641f62296ecbf1882c84?limit=100",
  "start": "df8sk3hk4hf8sf",
  "limit": 100,
  "count": 5000,
  "pageNumber": 1,
  "items": [
    {
      "id": "0399abed-fd3d",
      "messageId": "M2015111202120020101BCPF00000000001",
      "createdAt": "2022-05-23T08:01:28.375Z",
      "availableAt": "2022-05-23T08:01:28.375Z",
      "state": "received",
      "targetAccount": {
        "id": "bf23bc970b78d27691e8",
        "nickname": "Premiere Checking",
        "label": "Premiere Checking *1008",
        "maskedNumber": "*1008",
        "type": "checking"
      },
      "amount": {
        "value": "100.00",
        "currency": "USD"
      },
      "sender": {
        "name": "Exquisite Creations Interior Design & Renovation Services"
      }
    },
    {
      "id": "d62c0701-0d74-4836-83f9-ebf3709442ea",
      "messageId": "M2015111202120020101BCPF00000000002",
      "createdAt": "2022-05-26T10:05:44.102Z",
      "availableAt": "2022-05-26T10:05:44.102Z",
      "state": "received",
      "targetAccount": {
        "id": "bf23bc970b78d27691e8",
        "nickname": "Premiere Checking",
        "label": "Premiere Checking *1008",
        "maskedNumber": "*1008",
        "type": "checking"
      },
      "amount": {
        "value": "15.00",
        "currency": "USD"
      },
      "sender": {
        "name": "Billy Bob Jordan"
      }
    }
  ]
}

Responses

Status	Description
200	OK
	OK. A page from the full list of the customer's debit real-time payments. While the `nextPage_url` property is present in the response, the client can fetch the next page of debit real-time payments by performing a `GET` on that URL.
	Schema: `debitRealTimePayments`

Status Description

400 Bad Request

Status	Description
400	Bad Request
	Bad Request. The request body, request headers, and/or query parameters are not well-formed. This problem responsemay have one of the following `type` values: `https://production.api.apiture.com/errors/badRequest/v1.0.0` The request body and/or parameters was not well-formed. Remediation: Correct any syntax or schema errors in the request body or parameters.
	Schema: `Inline`

Bad Request. The request body, request headers, and/or query parameters are not well-formed.

This problem responsemay have one of the following type values:

https://production.api.apiture.com/errors/badRequest/v1.0.0
The request body and/or parameters was not well-formed. Remediation: Correct any syntax or schema errors in the request body or parameters.

Schema: Inline

Status Description

401 Unauthorized

Status	Description
401	Unauthorized
	Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given. This problem responsemay have one of the following `type` values: `https://production.api.apiture.com/errors/unauthorized/v1.0.0` The request lacks valid authentication credentials for the target resource or operation. Remediation: Authenticate the user and pass the required authorization with the request.
	Schema: `Inline`

Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given.

This problem responsemay have one of the following type values:

https://production.api.apiture.com/errors/unauthorized/v1.0.0
The request lacks valid authentication credentials for the target resource or operation. Remediation: Authenticate the user and pass the required authorization with the request.

Schema: Inline

Status Description

403 Forbidden

Status	Description
403	Forbidden
	Forbidden. The authenticated caller is not authorized to perform the requested operation. This problem responsemay have one of the following `type` values: `https://production.api.apiture.com/errors/forbidden/v1.0.0` The user or agent is not allowed to perform this operation; authentication credentials were provided in the request, but the server considers them insufficient to grant access. Remediation: Check the user's permissions and entitlements before attempting the operation. `https://production.api.apiture.com/errors/customerDisabled/v1.0.0` The customer is disabled. Remediation: Have the customer contact the financial institution for support. `https://production.api.apiture.com/errors/antiMalwareRequired/v1.0.0` The financial institution requires the customer to have anti-malware software installed. Remediation: Direct the user to the software requirements guide to install the correct anti-malware software. `https://production.api.apiture.com/errors/modificationForbidden/v1.0.0` The customer is properly authenticated but not authorized to create, modify, or delete resources. Remediation: Avoid modification operation for customers with read-only authorization. `https://production.api.apiture.com/errors/challengeRequired/v1.0.0` The operation requires the customer to complete an identity challenge. Remediation: Complete the challenge as per the problem response, and add an additional `Challenge` header to the call. The `attributes` object in the error may have the properties defined by the `requiredIdentityChallenge` schema. `https://production.api.apiture.com/errors/challengeBlocked/v1.0.0` The user has failed challenges too many times and is blocked from attempting more or performing operations which require additional authentication. Remediation: Have the user end their login session and login again. `https://production.api.apiture.com/errors/noIdentityChallengeFactors/v1.0.0` This operation requires an identity challenge, but the user does not have the necessary registered authentication factors. Remediation: Have the user register one or more challenge security code delivery factors. `https://production.api.apiture.com/errors/invalidIdentityChallengeHeader/v1.0.0` The additional on-time `Challenge` header in this request is expired, already used, or otherwise invalid. Remediation: Supply a valid, unexpired, unclaimed `Challenge` header in the request.
	Schema: `Inline`

Forbidden. The authenticated caller is not authorized to perform the requested operation.

This problem responsemay have one of the following type values:

https://production.api.apiture.com/errors/forbidden/v1.0.0
The user or agent is not allowed to perform this operation; authentication credentials were provided in the request, but the server considers them insufficient to grant access. Remediation: Check the user's permissions and entitlements before attempting the operation.
https://production.api.apiture.com/errors/customerDisabled/v1.0.0
The customer is disabled. Remediation: Have the customer contact the financial institution for support.
https://production.api.apiture.com/errors/antiMalwareRequired/v1.0.0
The financial institution requires the customer to have anti-malware software installed. Remediation: Direct the user to the software requirements guide to install the correct anti-malware software.
https://production.api.apiture.com/errors/modificationForbidden/v1.0.0
The customer is properly authenticated but not authorized to create, modify, or delete resources. Remediation: Avoid modification operation for customers with read-only authorization.
https://production.api.apiture.com/errors/challengeRequired/v1.0.0
The operation requires the customer to complete an identity challenge. Remediation: Complete the challenge as per the problem response, and add an additional Challenge header to the call. The attributes object in the error may have the properties defined by the requiredIdentityChallenge schema.
https://production.api.apiture.com/errors/challengeBlocked/v1.0.0
The user has failed challenges too many times and is blocked from attempting more or performing operations which require additional authentication. Remediation: Have the user end their login session and login again.
https://production.api.apiture.com/errors/noIdentityChallengeFactors/v1.0.0
This operation requires an identity challenge, but the user does not have the necessary registered authentication factors. Remediation: Have the user register one or more challenge security code delivery factors.
https://production.api.apiture.com/errors/invalidIdentityChallengeHeader/v1.0.0
The additional on-time Challenge header in this request is expired, already used, or otherwise invalid. Remediation: Supply a valid, unexpired, unclaimed Challenge header in the request.

Schema: Inline

Status Description

422 Unprocessable Entity

Unprocessable Entity. The request body and/or query parameters were well-formed but otherwise invalid.

This problem responsemay have one of the following type values:

https://production.api.apiture.com/errors/invalidAccountIds/v1.0.0
One or more account IDs are invalid and do not correspond to accounts. Remediation: Remove the invalid account IDs from the request and try again. The attributes object in the error may have the properties defined for invalidAccountIds.

Schema: problemResponse

Status Description

429 Too Many Requests

Status	Description
429	Too Many Requests
	Too Many Requests. The client has sent too many requests in a given amount of time. This problem responsemay have one of the following `type` values: `https://production.api.apiture.com/errors/tooManyRequests/v1.0.0` The client has sent too many requests in a given amount of time, exceeding rate limiting. Remediation: Slow down the rate of API calls.
	Schema: `Inline`

Too Many Requests. The client has sent too many requests in a given amount of time.

This problem responsemay have one of the following type values:

https://production.api.apiture.com/errors/tooManyRequests/v1.0.0
The client has sent too many requests in a given amount of time, exceeding rate limiting. Remediation: Slow down the rate of API calls.

Schema: Inline

Status	Description
4XX	Unknown
	Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Status	Description
5XX	Unknown
	Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

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.

getDebitRealTimePayment

Code samples

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

GET https://api.apiture.com/banking/debitRealTimePayments/{debitRealTimePaymentId} HTTP/1.1
Host: api.apiture.com
Accept: application/json

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

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

};

fetch('https://api.apiture.com/banking/debitRealTimePayments/{debitRealTimePaymentId}',
{
  method: 'GET',

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

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

};

$.ajax({
  url: 'https://api.apiture.com/banking/debitRealTimePayments/{debitRealTimePaymentId}',
  method: 'get',

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

require 'rest-client'
require 'json'

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

result = RestClient.get 'https://api.apiture.com/banking/debitRealTimePayments/{debitRealTimePaymentId}',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.get('https://api.apiture.com/banking/debitRealTimePayments/{debitRealTimePaymentId}', params={

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

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

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

Fetch a representation of this debit real-time payment

GET https://api.apiture.com/banking/debitRealTimePayments/{debitRealTimePaymentId}

Return the JSON representation of this debit real-time payment resource.

Parameters

Parameter	Description
`debitRealTimePaymentId` `in: path`	`externalResourceId` (required) The unique identifier of this debit real-time payment. This is an opaque string. This value corresponds to the `id` of a debit real-time payment resource. `read-only` `format: text` `minLength: 1` `maxLength: 256`

Example responses

200 Response

{
  "id": "0399abed-fd3d",
  "messageId": "M2015111202120020101BCPF00000000001",
  "createdAt": "2022-05-23T08:01:28.375Z",
  "availableAt": "2022-05-23T08:01:28.375Z",
  "state": "received",
  "targetAccount": {
    "id": "bf23bc970b78d27691e8",
    "nickname": "Premiere Checking",
    "label": "Premiere Checking *1008",
    "maskedNumber": "*1008",
    "type": "checking"
  },
  "amount": {
    "value": "100.00",
    "currency": "USD"
  },
  "sender": {
    "name": "Exquisite Creations Interior Design & Renovation Services",
    "address": {
      "address1": "1805 Tiburon Dr.",
      "address2": "Building 14, Suite 1500",
      "locality": "Wilmington",
      "regionCode": "NC",
      "countryCode": "US",
      "postalCode": "28403"
    },
    "contact": {
      "name": "Janine Doe",
      "emailAddress": "janine.doe@creations.com",
      "phoneNumber": "+19105550155"
    }
  },
  "confirmationId": "12345",
  "endToEndId": "E2E-Ref001",
  "remittanceAdvice": {
    "method": "email",
    "address": "info@example.com",
    "message": "Payment for invoice INV-123"
  }
}

Responses

Status	Description
200	OK
	OK.
	Schema: `debitRealTimePayment`

Status Description

401 Unauthorized

Status	Description
401	Unauthorized
	Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given. This problem responsemay have one of the following `type` values: `https://production.api.apiture.com/errors/unauthorized/v1.0.0` The request lacks valid authentication credentials for the target resource or operation. Remediation: Authenticate the user and pass the required authorization with the request.
	Schema: `Inline`

Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given.

This problem responsemay have one of the following type values:

https://production.api.apiture.com/errors/unauthorized/v1.0.0
The request lacks valid authentication credentials for the target resource or operation. Remediation: Authenticate the user and pass the required authorization with the request.

Schema: Inline

Status Description

403 Forbidden

Status	Description
403	Forbidden
	Forbidden. The authenticated caller is not authorized to perform the requested operation. This problem responsemay have one of the following `type` values: `https://production.api.apiture.com/errors/forbidden/v1.0.0` The user or agent is not allowed to perform this operation; authentication credentials were provided in the request, but the server considers them insufficient to grant access. Remediation: Check the user's permissions and entitlements before attempting the operation. `https://production.api.apiture.com/errors/customerDisabled/v1.0.0` The customer is disabled. Remediation: Have the customer contact the financial institution for support. `https://production.api.apiture.com/errors/antiMalwareRequired/v1.0.0` The financial institution requires the customer to have anti-malware software installed. Remediation: Direct the user to the software requirements guide to install the correct anti-malware software. `https://production.api.apiture.com/errors/modificationForbidden/v1.0.0` The customer is properly authenticated but not authorized to create, modify, or delete resources. Remediation: Avoid modification operation for customers with read-only authorization. `https://production.api.apiture.com/errors/challengeRequired/v1.0.0` The operation requires the customer to complete an identity challenge. Remediation: Complete the challenge as per the problem response, and add an additional `Challenge` header to the call. The `attributes` object in the error may have the properties defined by the `requiredIdentityChallenge` schema. `https://production.api.apiture.com/errors/challengeBlocked/v1.0.0` The user has failed challenges too many times and is blocked from attempting more or performing operations which require additional authentication. Remediation: Have the user end their login session and login again. `https://production.api.apiture.com/errors/noIdentityChallengeFactors/v1.0.0` This operation requires an identity challenge, but the user does not have the necessary registered authentication factors. Remediation: Have the user register one or more challenge security code delivery factors. `https://production.api.apiture.com/errors/invalidIdentityChallengeHeader/v1.0.0` The additional on-time `Challenge` header in this request is expired, already used, or otherwise invalid. Remediation: Supply a valid, unexpired, unclaimed `Challenge` header in the request.
	Schema: `Inline`

Forbidden. The authenticated caller is not authorized to perform the requested operation.

This problem responsemay have one of the following type values:

https://production.api.apiture.com/errors/forbidden/v1.0.0
The user or agent is not allowed to perform this operation; authentication credentials were provided in the request, but the server considers them insufficient to grant access. Remediation: Check the user's permissions and entitlements before attempting the operation.
https://production.api.apiture.com/errors/customerDisabled/v1.0.0
The customer is disabled. Remediation: Have the customer contact the financial institution for support.
https://production.api.apiture.com/errors/antiMalwareRequired/v1.0.0
The financial institution requires the customer to have anti-malware software installed. Remediation: Direct the user to the software requirements guide to install the correct anti-malware software.
https://production.api.apiture.com/errors/modificationForbidden/v1.0.0
The customer is properly authenticated but not authorized to create, modify, or delete resources. Remediation: Avoid modification operation for customers with read-only authorization.
https://production.api.apiture.com/errors/challengeRequired/v1.0.0
The operation requires the customer to complete an identity challenge. Remediation: Complete the challenge as per the problem response, and add an additional Challenge header to the call. The attributes object in the error may have the properties defined by the requiredIdentityChallenge schema.
https://production.api.apiture.com/errors/challengeBlocked/v1.0.0
The user has failed challenges too many times and is blocked from attempting more or performing operations which require additional authentication. Remediation: Have the user end their login session and login again.
https://production.api.apiture.com/errors/noIdentityChallengeFactors/v1.0.0
This operation requires an identity challenge, but the user does not have the necessary registered authentication factors. Remediation: Have the user register one or more challenge security code delivery factors.
https://production.api.apiture.com/errors/invalidIdentityChallengeHeader/v1.0.0
The additional on-time Challenge header in this request is expired, already used, or otherwise invalid. Remediation: Supply a valid, unexpired, unclaimed Challenge header in the request.

Schema: Inline

Status	Description
404	Not Found
	Not Found. There is no such debit real-time payment resource at the specified `{debitRealTimePaymentId}`.
	Schema: `problemResponse`

Status Description

429 Too Many Requests

Status	Description
429	Too Many Requests
	Too Many Requests. The client has sent too many requests in a given amount of time. This problem responsemay have one of the following `type` values: `https://production.api.apiture.com/errors/tooManyRequests/v1.0.0` The client has sent too many requests in a given amount of time, exceeding rate limiting. Remediation: Slow down the rate of API calls.
	Schema: `Inline`

Too Many Requests. The client has sent too many requests in a given amount of time.

This problem responsemay have one of the following type values:

https://production.api.apiture.com/errors/tooManyRequests/v1.0.0
The client has sent too many requests in a given amount of time, exceeding rate limiting. Remediation: Slow down the rate of API calls.

Schema: Inline

Status	Description
4XX	Unknown
	Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Status	Description
5XX	Unknown
	Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Response Schema

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.

Credit Real-Time Payments

Real-time payments debited from an internal account and credited to the recipient's account

listCreditRealTimePayments

Code samples

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

GET https://api.apiture.com/banking/creditRealTimePayments HTTP/1.1
Host: api.apiture.com
Accept: application/json

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

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

};

fetch('https://api.apiture.com/banking/creditRealTimePayments',
{
  method: 'GET',

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

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

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

Return a collection of credit real-time payments

GET https://api.apiture.com/banking/creditRealTimePayments

Return a paginated collection of credit real-time payments. The result is ordered by default in reverse chronological order based on the created date (createdAt) of the credit real-time payments.

Parameters

Parameter	Description
`customerId` `in: query`	`resourceId` Restrict payment resources based on the customer ID. This is the ID of the customer that created the real-time payment. `minLength: 6` `maxLength: 48` `pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"`
`recipientName` `in: query`	`string(text)` Return only credit real-time payments whose `recipient.name` contains this substring of at least two characters, ignoring case. `format: text` `minLength: 2` `maxLength: 140`
`state` `in: query`	`array[string]` Return only credit real-time payments whose `state` matches one of the items in this pipe-delimited list. `unique items` `minItems: 1` `maxItems: 8` `pipe-delimited` items: `string` » enum values: `pending`, `pendingApproval`, `rejected`, `scheduled`, `processing`, `processed`, `completed`, `failed`
`trackingNumber` `in: query`	`realTimePaymentTrackingNumber` Return only credit real-time payments whose `trackingNumber` matches this value. `minLength: 6` `maxLength: 9` `pattern: "^[0-9]+$"`
`processedAt` `in: query`	`dateRange` Return only credit real-time payments whose `processedAt` date matches with the value or date range. Can search up to 2 years in the past. Date ranges use range notation. Examples: `[2023-05-01,2023-05-31]` between May 1 and 31, 2023, inclusive `[2023-05-01,2023-06-01)` on or after May 1, but before June 1 (in May, 2023) `[2023-05-19,]` on or after May 19, 2023 `[,2023-05-19]` on or before May 19, 2023 `2023-05-19` uploaded on May 19, 2023. `maxLength: 24` `pattern: "^\\d{4}-\\d{2}-\\d{2}\|([[(](\\d{4}-\\d{2}-\\d{2},(\\d{4}-\\d{2}-\\d{2})?\|,\\d{4}-\\d{2}-\\d{2})[)\\]])$"`
`accounts` `in: query`	`bankingAccountIdSelection` Return only credit real-time payments which were sent from one of these accounts. `unique items` `minItems: 1` `maxItems: 32` `comma-delimited` items: `string` » `minLength: 6` » `maxLength: 48` » `pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"`
`amount` `in: query`	`amountRange` Return only credit real-time payments whose `amount` is in this range. Amount ranges use range notation. The value may have the following forms: `1200.50` match the dollar amount 1,200.50 exactly `[1000.00,1200.00)` matches items where `1000.00 <= amount < 1200.00` `[1000.00,1199.99]` matches items where `1000.00 <= amount <= 1199.99` `(999.99,1200.00)` matches items where `999.99 < amount < 1200.00` `[1200.50,]` matches items where `amount >= 1200.50` `(1200.50,)` matches items where `amount > 1200.50` `[,1200.50]` matches items where `amount <= 1200.50` `(,1200.50)` matches items where `amount < 1200.50` `minLength: 1` `maxLength: 30` `pattern: "^((\\d+(\\.\\d{0,2})?)\|([\\[\$](((\\d+(\\.\\d{0,2})?),((\\d+(\\.\\d{0,2})?))?)\|(,(\\d+(\\.\\d{0,2})?)))[\\]\$]))$"`
`sortBy` `in: query`	`array[string]` The sort order for the items in the response. Use `?sortBy=createdAt` or `?sortBy=-createdAt` to sort by ascending or descending order of the payment's `createdAt` date-time. The default is `-createdAt`. `unique items` `minItems: 1` `maxItems: 1` `comma-delimited` items: `string` » `minLength: 9` » `maxLength: 10` » `pattern: "^-?(createdAt)"`
`start` `in: query`	`string` The location of the next item in the collection. This is an opaque cursor supplied by the API service. Omit this to start at the beginning of the collection. The client does not define this value; the API services automatically pass the `?start=` parameter on the `nextPage_url`. `maxLength: 256` `default: ""` `pattern: "^[-a-zA-Z0-9.,-=_+:;@$]{0,256}$"`
`limit` `in: query`	`integer(int32)` The maximum number of items to return in this paged response. `format: int32` `minimum: 0` `maximum: 1000` `default: 100`

Example responses

200 Response

{
  "nextPage_url": "https://production.api.apiture.com/banking/creditRealTimePayments?start=641f62296ecbf1882c84?limit=100",
  "start": "df8sk3hk4hf8sf",
  "limit": 100,
  "count": 5000,
  "pageNumber": 1,
  "items": [
    {
      "id": "0399abed-fd3d",
      "messageId": "M2015111202120020101BCPF00000000001",
      "createdAt": "2022-05-23T08:01:28.375Z",
      "updatedAt": "2022-05-23T08:02:12.660Z",
      "processedAt": "2022-05-23T08:01:28.375Z",
      "customerId": "4242923b-714e",
      "state": "completed",
      "remainingApprovalsCount": 0,
      "approvalCount": 2,
      "allows": {
        "approve": false,
        "edit": false,
        "submit": true,
        "reject": false,
        "delete": false
      },
      "sourceAccount": {
        "id": "bf23bc970b78d27691e8",
        "nickname": "Premiere Checking",
        "label": "Premiere Checking *1008",
        "maskedNumber": "*1008",
        "type": "checking"
      },
      "amount": {
        "value": "100.00",
        "currency": "USD"
      },
      "sender": {
        "name": "Buffalo Mountain Sports"
      },
      "recipient": {
        "name": "Exquisite Creations Interior Design & Renovation Services"
      }
    },
    {
      "id": "d62c0701-0d74-4836-83f9-ebf3709442ea",
      "messageId": "M2015111202120020101BCPF00000000002",
      "createdAt": "2022-05-26T10:05:44.102Z",
      "updatedAt": "2022-05-26T10:06:32.091Z",
      "processedAt": "2022-05-26T10:05:44.102Z",
      "customerId": "df90dfsds-v9dsf",
      "state": "pending",
      "reasonCode": "insufficientFunds",
      "information": "There are insufficient funds in the account to make this payment.",
      "remainingApprovalsCount": 2,
      "approvalCount": 0,
      "allows": {
        "approve": false,
        "edit": false,
        "submit": true,
        "reject": false,
        "delete": false
      },
      "sourceAccount": {
        "id": "bf23bc970b78d27691e8",
        "nickname": "Premiere Checking",
        "label": "Premiere Checking *1008",
        "maskedNumber": "*1008",
        "type": "checking"
      },
      "amount": {
        "value": "15.00",
        "currency": "USD"
      },
      "sender": {
        "name": "Buffalo Mountain Sports"
      },
      "recipient": {
        "name": "Exquisite Creations Interior Design & Renovation Services"
      }
    }
  ]
}

Responses

Status	Description
200	OK
	OK. A page from the full list of the customer's credit real-time payments. While the `nextPage_url` property is present in the response, the client can fetch the next page of credit real-time payments by performing a `GET` on that URL.
	Schema: `creditRealTimePayments`

Status Description

400 Bad Request

Status	Description
400	Bad Request
	Bad Request. The request body, request headers, and/or query parameters are not well-formed. This problem responsemay have one of the following `type` values: `https://production.api.apiture.com/errors/badRequest/v1.0.0` The request body and/or parameters was not well-formed. Remediation: Correct any syntax or schema errors in the request body or parameters.
	Schema: `Inline`

Bad Request. The request body, request headers, and/or query parameters are not well-formed.

This problem responsemay have one of the following type values:

https://production.api.apiture.com/errors/badRequest/v1.0.0
The request body and/or parameters was not well-formed. Remediation: Correct any syntax or schema errors in the request body or parameters.

Schema: Inline

Status Description

401 Unauthorized

Status	Description
401	Unauthorized
	Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given. This problem responsemay have one of the following `type` values: `https://production.api.apiture.com/errors/unauthorized/v1.0.0` The request lacks valid authentication credentials for the target resource or operation. Remediation: Authenticate the user and pass the required authorization with the request.
	Schema: `Inline`

Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given.

This problem responsemay have one of the following type values:

https://production.api.apiture.com/errors/unauthorized/v1.0.0
The request lacks valid authentication credentials for the target resource or operation. Remediation: Authenticate the user and pass the required authorization with the request.

Schema: Inline

Status Description

403 Forbidden

Status	Description
403	Forbidden
	Forbidden. The authenticated caller is not authorized to perform the requested operation. This problem responsemay have one of the following `type` values: `https://production.api.apiture.com/errors/forbidden/v1.0.0` The user or agent is not allowed to perform this operation; authentication credentials were provided in the request, but the server considers them insufficient to grant access. Remediation: Check the user's permissions and entitlements before attempting the operation. `https://production.api.apiture.com/errors/customerDisabled/v1.0.0` The customer is disabled. Remediation: Have the customer contact the financial institution for support. `https://production.api.apiture.com/errors/antiMalwareRequired/v1.0.0` The financial institution requires the customer to have anti-malware software installed. Remediation: Direct the user to the software requirements guide to install the correct anti-malware software. `https://production.api.apiture.com/errors/modificationForbidden/v1.0.0` The customer is properly authenticated but not authorized to create, modify, or delete resources. Remediation: Avoid modification operation for customers with read-only authorization. `https://production.api.apiture.com/errors/challengeRequired/v1.0.0` The operation requires the customer to complete an identity challenge. Remediation: Complete the challenge as per the problem response, and add an additional `Challenge` header to the call. The `attributes` object in the error may have the properties defined by the `requiredIdentityChallenge` schema. `https://production.api.apiture.com/errors/challengeBlocked/v1.0.0` The user has failed challenges too many times and is blocked from attempting more or performing operations which require additional authentication. Remediation: Have the user end their login session and login again. `https://production.api.apiture.com/errors/noIdentityChallengeFactors/v1.0.0` This operation requires an identity challenge, but the user does not have the necessary registered authentication factors. Remediation: Have the user register one or more challenge security code delivery factors. `https://production.api.apiture.com/errors/invalidIdentityChallengeHeader/v1.0.0` The additional on-time `Challenge` header in this request is expired, already used, or otherwise invalid. Remediation: Supply a valid, unexpired, unclaimed `Challenge` header in the request.
	Schema: `Inline`

Forbidden. The authenticated caller is not authorized to perform the requested operation.

This problem responsemay have one of the following type values:

https://production.api.apiture.com/errors/forbidden/v1.0.0
The user or agent is not allowed to perform this operation; authentication credentials were provided in the request, but the server considers them insufficient to grant access. Remediation: Check the user's permissions and entitlements before attempting the operation.
https://production.api.apiture.com/errors/customerDisabled/v1.0.0
The customer is disabled. Remediation: Have the customer contact the financial institution for support.
https://production.api.apiture.com/errors/antiMalwareRequired/v1.0.0
The financial institution requires the customer to have anti-malware software installed. Remediation: Direct the user to the software requirements guide to install the correct anti-malware software.
https://production.api.apiture.com/errors/modificationForbidden/v1.0.0
The customer is properly authenticated but not authorized to create, modify, or delete resources. Remediation: Avoid modification operation for customers with read-only authorization.
https://production.api.apiture.com/errors/challengeRequired/v1.0.0
The operation requires the customer to complete an identity challenge. Remediation: Complete the challenge as per the problem response, and add an additional Challenge header to the call. The attributes object in the error may have the properties defined by the requiredIdentityChallenge schema.
https://production.api.apiture.com/errors/challengeBlocked/v1.0.0
The user has failed challenges too many times and is blocked from attempting more or performing operations which require additional authentication. Remediation: Have the user end their login session and login again.
https://production.api.apiture.com/errors/noIdentityChallengeFactors/v1.0.0
This operation requires an identity challenge, but the user does not have the necessary registered authentication factors. Remediation: Have the user register one or more challenge security code delivery factors.
https://production.api.apiture.com/errors/invalidIdentityChallengeHeader/v1.0.0
The additional on-time Challenge header in this request is expired, already used, or otherwise invalid. Remediation: Supply a valid, unexpired, unclaimed Challenge header in the request.

Schema: Inline

Status Description

422 Unprocessable Entity

Unprocessable Entity. The request body and/or query parameters were well-formed but otherwise invalid.

This problem responsemay have one of the following type values:

https://production.api.apiture.com/errors/invalidAccountIds/v1.0.0
One or more account IDs are invalid and do not correspond to accounts. Remediation: Remove the invalid account IDs from the request and try again. The attributes object in the error may have the properties defined for invalidAccountIds.

Schema: problemResponse

Status Description

429 Too Many Requests

Status	Description
429	Too Many Requests
	Too Many Requests. The client has sent too many requests in a given amount of time. This problem responsemay have one of the following `type` values: `https://production.api.apiture.com/errors/tooManyRequests/v1.0.0` The client has sent too many requests in a given amount of time, exceeding rate limiting. Remediation: Slow down the rate of API calls.
	Schema: `Inline`

Too Many Requests. The client has sent too many requests in a given amount of time.

This problem responsemay have one of the following type values:

https://production.api.apiture.com/errors/tooManyRequests/v1.0.0
The client has sent too many requests in a given amount of time, exceeding rate limiting. Remediation: Slow down the rate of API calls.

Schema: Inline

Status	Description
4XX	Unknown
	Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Status	Description
5XX	Unknown
	Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

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.

createCreditRealTimePayment

Code samples

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

POST https://api.apiture.com/banking/creditRealTimePayments HTTP/1.1
Host: api.apiture.com
Content-Type: application/json
Accept: application/json

const fetch = require('node-fetch');
const inputBody = '{
  "customerId": "4242923b-714e",
  "sourceAccount": {
    "id": "bf23bc970b78d27691e8",
    "nickname": "Premiere Checking",
    "label": "Premiere Checking *1008",
    "maskedNumber": "*1008",
    "type": "checking"
  },
  "amount": {
    "value": "100.00",
    "currency": "USD"
  },
  "sender": {
    "governmentIssuedId": "112223333",
    "name": "Buffalo Mountain Sports",
    "address": {
      "address1": "123 Main Street",
      "address2": "Building 14, Suite 1500",
      "locality": "Miami",
      "regionCode": "FL",
      "countryCode": "US",
      "postalCode": "12345"
    }
  },
  "recipient": {
    "name": "Exquisite Creations Interior Design & Renovation Services",
    "address": {
      "address1": "123 Hierarchy Lane",
      "locality": "Miami",
      "regionCode": "FL",
      "countryCode": "US",
      "postalCode": "12003"
    },
    "fullAccountNumber": "123456789",
    "institution": {
      "name": "Bank of America",
      "routingNumber": "123123123"
    }
  },
  "endToEndId": "E2E-Ref001",
  "remittanceAdvice": {
    "method": "email",
    "address": "info@example.com",
    "message": "Payment for invoice INV-123"
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/banking/creditRealTimePayments',
{
  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',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.apiture.com/banking/creditRealTimePayments',
  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',
  'Authorization' => 'Bearer {access-token}'
}

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

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

Create a new credit real-time payment

POST https://api.apiture.com/banking/creditRealTimePayments

Create a new real-time payment to credit a recipient's account from funds in an internal account.

Once a commercial user successfully creates a credit real-time payment, the state is set as pendingApproval and requires approval in order to transition to the scheduled state.

Once a retail user successfully creates a credit real-time payment, the state is set as scheduled and immediately begins processing.

Body parameter

{
  "customerId": "4242923b-714e",
  "sourceAccount": {
    "id": "bf23bc970b78d27691e8",
    "nickname": "Premiere Checking",
    "label": "Premiere Checking *1008",
    "maskedNumber": "*1008",
    "type": "checking"
  },
  "amount": {
    "value": "100.00",
    "currency": "USD"
  },
  "sender": {
    "governmentIssuedId": "112223333",
    "name": "Buffalo Mountain Sports",
    "address": {
      "address1": "123 Main Street",
      "address2": "Building 14, Suite 1500",
      "locality": "Miami",
      "regionCode": "FL",
      "countryCode": "US",
      "postalCode": "12345"
    }
  },
  "recipient": {
    "name": "Exquisite Creations Interior Design & Renovation Services",
    "address": {
      "address1": "123 Hierarchy Lane",
      "locality": "Miami",
      "regionCode": "FL",
      "countryCode": "US",
      "postalCode": "12003"
    },
    "fullAccountNumber": "123456789",
    "institution": {
      "name": "Bank of America",
      "routingNumber": "123123123"
    }
  },
  "endToEndId": "E2E-Ref001",
  "remittanceAdvice": {
    "method": "email",
    "address": "info@example.com",
    "message": "Payment for invoice INV-123"
  }
}

Parameters

Parameter	Description
`body`	`newCreditRealTimePayment` (required) The data necessary to create a new credit real-time payment.

Example responses

201 Response

{
  "id": "0399abed-fd3d",
  "messageId": "M2015111202120020101BCPF00000000001",
  "createdAt": "2022-05-23T08:01:28.375Z",
  "updatedAt": "2022-05-23T08:02:12.660Z",
  "processedAt": "2022-05-23T08:01:28.375Z",
  "customerId": "4242923b-714e",
  "state": "completed",
  "remainingApprovalsCount": 1,
  "approvalCount": 1,
  "allows": {
    "approve": false,
    "edit": false,
    "submit": true,
    "reject": false,
    "delete": false
  },
  "sourceAccount": {
    "id": "bf23bc970b78d27691e8",
    "nickname": "Premiere Checking",
    "label": "Premiere Checking *1008",
    "maskedNumber": "*1008",
    "type": "checking"
  },
  "amount": {
    "value": "100.00",
    "currency": "USD"
  },
  "sender": {
    "governmentIssuedId": "112223333",
    "name": "Buffalo Mountain Sports",
    "address": {
      "address1": "123 Main Street",
      "address2": "Building 14, Suite 1500",
      "locality": "Miami",
      "regionCode": "FL",
      "countryCode": "US",
      "postalCode": "12345"
    },
    "contact": {
      "name": "John Smith",
      "emailAddress": "johnsmith.doe@business.com",
      "phoneNumber": "+19105550155"
    }
  },
  "recipient": {
    "name": "Exquisite Creations Interior Design & Renovation Services",
    "address": {
      "address1": "123 Hierarchy Lane",
      "locality": "Miami",
      "regionCode": "FL",
      "countryCode": "US",
      "postalCode": "12003"
    },
    "maskedAccountNumber": "*6789",
    "fullAccountNumber": "123456789",
    "institution": {
      "name": "Bank of America",
      "routingNumber": "123123123"
    }
  },
  "confirmationId": "12345",
  "endToEndId": "E2E-Ref001",
  "trackingNumber": "12345678",
  "remittanceAdvice": {
    "method": "email",
    "address": "info@example.com",
    "message": "Payment for invoice INV-123"
  },
  "approvers": [
    {
      "name": "Tom Allison",
      "id": "327d8bea-2553",
      "identification": "to...58@wellsroofing.com"
    },
    {
      "name": "Silvia Wilkenson",
      "id": "06cf8996-d093",
      "identification": "si...42@wellsroofing.com"
    }
  ],
  "approvals": [
    {
      "name": "Tom Allison",
      "id": "327d8bea-2553",
      "identification": "si...42@wellsroofing.com",
      "approvedAt": "2022-04-25T09:02:57.375Z"
    },
    null
  ],
  "problems": []
}

Responses

Status	Description
201	Created
	Created.
	Schema: `creditRealTimePayment`
Header	`Location` `string` `uri-reference`
	The URI of the new credit real-time payment.

Status Description

400 Bad Request

Status	Description
400	Bad Request
	Bad Request. The request body, request headers, and/or query parameters are not well-formed. This problem responsemay have one of the following `type` values: `https://production.api.apiture.com/errors/badRequest/v1.0.0` The request body and/or parameters was not well-formed. Remediation: Correct any syntax or schema errors in the request body or parameters.
	Schema: `Inline`

Bad Request. The request body, request headers, and/or query parameters are not well-formed.

This problem responsemay have one of the following type values:

https://production.api.apiture.com/errors/badRequest/v1.0.0
The request body and/or parameters was not well-formed. Remediation: Correct any syntax or schema errors in the request body or parameters.

Schema: Inline

Status Description

401 Unauthorized

Status	Description
401	Unauthorized
	Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given. This problem responsemay have one of the following `type` values: `https://production.api.apiture.com/errors/unauthorized/v1.0.0` The request lacks valid authentication credentials for the target resource or operation. Remediation: Authenticate the user and pass the required authorization with the request.
	Schema: `Inline`

Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given.

This problem responsemay have one of the following type values:

https://production.api.apiture.com/errors/unauthorized/v1.0.0
The request lacks valid authentication credentials for the target resource or operation. Remediation: Authenticate the user and pass the required authorization with the request.

Schema: Inline

Status Description

403 Forbidden

Status	Description
403	Forbidden
	Forbidden. The authenticated caller is not authorized to perform the requested operation. This problem responsemay have one of the following `type` values: `https://production.api.apiture.com/errors/forbidden/v1.0.0` The user or agent is not allowed to perform this operation; authentication credentials were provided in the request, but the server considers them insufficient to grant access. Remediation: Check the user's permissions and entitlements before attempting the operation. `https://production.api.apiture.com/errors/customerDisabled/v1.0.0` The customer is disabled. Remediation: Have the customer contact the financial institution for support. `https://production.api.apiture.com/errors/antiMalwareRequired/v1.0.0` The financial institution requires the customer to have anti-malware software installed. Remediation: Direct the user to the software requirements guide to install the correct anti-malware software. `https://production.api.apiture.com/errors/modificationForbidden/v1.0.0` The customer is properly authenticated but not authorized to create, modify, or delete resources. Remediation: Avoid modification operation for customers with read-only authorization. `https://production.api.apiture.com/errors/challengeRequired/v1.0.0` The operation requires the customer to complete an identity challenge. Remediation: Complete the challenge as per the problem response, and add an additional `Challenge` header to the call. The `attributes` object in the error may have the properties defined by the `requiredIdentityChallenge` schema. `https://production.api.apiture.com/errors/challengeBlocked/v1.0.0` The user has failed challenges too many times and is blocked from attempting more or performing operations which require additional authentication. Remediation: Have the user end their login session and login again. `https://production.api.apiture.com/errors/noIdentityChallengeFactors/v1.0.0` This operation requires an identity challenge, but the user does not have the necessary registered authentication factors. Remediation: Have the user register one or more challenge security code delivery factors. `https://production.api.apiture.com/errors/invalidIdentityChallengeHeader/v1.0.0` The additional on-time `Challenge` header in this request is expired, already used, or otherwise invalid. Remediation: Supply a valid, unexpired, unclaimed `Challenge` header in the request.
	Schema: `Inline`

Forbidden. The authenticated caller is not authorized to perform the requested operation.

This problem responsemay have one of the following type values:

https://production.api.apiture.com/errors/forbidden/v1.0.0
The user or agent is not allowed to perform this operation; authentication credentials were provided in the request, but the server considers them insufficient to grant access. Remediation: Check the user's permissions and entitlements before attempting the operation.
https://production.api.apiture.com/errors/customerDisabled/v1.0.0
The customer is disabled. Remediation: Have the customer contact the financial institution for support.
https://production.api.apiture.com/errors/antiMalwareRequired/v1.0.0
The financial institution requires the customer to have anti-malware software installed. Remediation: Direct the user to the software requirements guide to install the correct anti-malware software.
https://production.api.apiture.com/errors/modificationForbidden/v1.0.0
The customer is properly authenticated but not authorized to create, modify, or delete resources. Remediation: Avoid modification operation for customers with read-only authorization.
https://production.api.apiture.com/errors/challengeRequired/v1.0.0
The operation requires the customer to complete an identity challenge. Remediation: Complete the challenge as per the problem response, and add an additional Challenge header to the call. The attributes object in the error may have the properties defined by the requiredIdentityChallenge schema.
https://production.api.apiture.com/errors/challengeBlocked/v1.0.0
The user has failed challenges too many times and is blocked from attempting more or performing operations which require additional authentication. Remediation: Have the user end their login session and login again.
https://production.api.apiture.com/errors/noIdentityChallengeFactors/v1.0.0
This operation requires an identity challenge, but the user does not have the necessary registered authentication factors. Remediation: Have the user register one or more challenge security code delivery factors.
https://production.api.apiture.com/errors/invalidIdentityChallengeHeader/v1.0.0
The additional on-time Challenge header in this request is expired, already used, or otherwise invalid. Remediation: Supply a valid, unexpired, unclaimed Challenge header in the request.

Schema: Inline

Status Description

422 Unprocessable Entity

Unprocessable Entity. The request body and/or query parameters were well-formed but otherwise invalid.

This problem responsemay have one of the following type values:

https://production.api.apiture.com/errors/invalidRealTimePaymentSourceAccount/v1.0.0
The chosen source account does not exist, is not accessible, or is not entitled for real-time payments. Remediation: Choose an existing source account with the correct entitlement for real-time payments.
https://production.api.apiture.com/errors/invalidRealTimePaymentAmount/v1.0.0
The amount is $0.00, is more than 14 total digits, or the amount of the real-time payment exceeds the allowed limit within a certain period. Remediation: Change the amount to a value greater than $0.00 with no more than 14 total digits, that does not exceed the allowed limit and resubmit.
https://production.api.apiture.com/errors/invalidRealTimePaymentRecipientRoutingNumber/v1.0.0
The routing number for the recipient financial institution is invalid. Remediation: Use a valid routing number.
https://production.api.apiture.com/errors/invalidRealTimePaymentRecipientAccount/v1.0.0
The chosen recipient account does not exist, is not accessible, or is not entitled for real-time payments. Remediation: Choose an existing recipient account with the correct entitlement for real-time payments.
https://production.api.apiture.com/errors/emptyRealTimePaymentRecipientAddress/v1.0.0
The address object was included for the recipient but no fields were included inside the address object. Remediation: Either do not include the address object for the recipient or include at least one field inside the address object.
https://production.api.apiture.com/errors/emptyRealTimePaymentSenderAddress/v1.0.0
The address object was included for the sender but no fields were included inside the address object. Remediation: Either do not include the address object for the sender or include at least one field inside the address object.
https://production.api.apiture.com/errors/missingRealTimePaymentRecipientAddressFields/v1.0.0
At least one field has been provided for the recipient address but address1, countryCode, locality, regionName/regionCode, or postalCode is missing. Remediation: If any fields are provided for the recipient address, provide address1, countryCode, locality, regionName/regionCode, and postalCode.
https://production.api.apiture.com/errors/missingRealTimePaymentSenderAddressFields/v1.0.0
At least one field has been provided for the sender address but address1, countryCode, locality, regionName/regionCode, or postalCode is missing. Remediation: If any fields are provided for the recipient address, provide address1, countryCode, locality, regionName/regionCode, and postalCode.
https://production.api.apiture.com/errors/remittanceAdviceEmailAddressTooLong/v1.0.0
When the remittance advice method is email, the address can be no longer than 255 characters. Remediation: Shorten the address of the remittance advice to 255 characters or less if the method is email.
https://production.api.apiture.com/errors/invalidRealTimePaymentRecipientUsPostalCode/v1.0.0
The recipient's countryCode is US but the postalCode is not in the correct format. Remediation: If the recipient's countryCode is US, provide a value for postalCode that is either a five digit US ZIP code or a ten character ZIP+4.
https://production.api.apiture.com/errors/invalidRealTimePaymentSenderUsPostalCode/v1.0.0
The sender's countryCode is US but the postalCode is not in the correct format. Remediation: If the sender's countryCode is US, provide a value for postalCode that is either a five digit US ZIP code or a ten character ZIP+4.
https://production.api.apiture.com/errors/institutionDoesNotSupportRealTimePayments/v1.0.0
The routing number is valid but the financial institution does not support real-time payments. Remediation: Use a routing number for a financial institution that does support real-time payments.

Schema: problemResponse

Status Description

429 Too Many Requests

Status	Description
429	Too Many Requests
	Too Many Requests. The client has sent too many requests in a given amount of time. This problem responsemay have one of the following `type` values: `https://production.api.apiture.com/errors/tooManyRequests/v1.0.0` The client has sent too many requests in a given amount of time, exceeding rate limiting. Remediation: Slow down the rate of API calls.
	Schema: `Inline`

Too Many Requests. The client has sent too many requests in a given amount of time.

This problem responsemay have one of the following type values:

https://production.api.apiture.com/errors/tooManyRequests/v1.0.0
The client has sent too many requests in a given amount of time, exceeding rate limiting. Remediation: Slow down the rate of API calls.

Schema: Inline

Status	Description
4XX	Unknown
	Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Status	Description
5XX	Unknown
	Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

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.

getCreditRealTimePayment

Code samples

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

GET https://api.apiture.com/banking/creditRealTimePayments/{creditRealTimePaymentId} HTTP/1.1
Host: api.apiture.com
Accept: application/json

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

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

};

fetch('https://api.apiture.com/banking/creditRealTimePayments/{creditRealTimePaymentId}',
{
  method: 'GET',

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

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

};

$.ajax({
  url: 'https://api.apiture.com/banking/creditRealTimePayments/{creditRealTimePaymentId}',
  method: 'get',

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

require 'rest-client'
require 'json'

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

result = RestClient.get 'https://api.apiture.com/banking/creditRealTimePayments/{creditRealTimePaymentId}',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.get('https://api.apiture.com/banking/creditRealTimePayments/{creditRealTimePaymentId}', params={

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

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

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

Fetch a representation of this credit real-time payment

GET https://api.apiture.com/banking/creditRealTimePayments/{creditRealTimePaymentId}

Return the JSON representation of this credit real-time payment resource.

Parameters

Parameter	Description
`unmasked` `in: query`	`boolean` When requesting a credit real-time payment, `sender.governmentIssuedId` and `recipient.fullAccountNumber` are not included in the response by default, for security reasons. Include this query parameter with a value of `true` to request that the response body includes the `sender.governmentIssuedId` and `recipient.fullAccountNumber`. Such requests are auditable. `default: false`
`creditRealTimePaymentId` `in: path`	`externalResourceId` (required) The unique identifier of this credit real-time payment. This is an opaque string. This value corresponds to the `id` of a credit real-time payment resource. `read-only` `format: text` `minLength: 1` `maxLength: 256`

Example responses

200 Response

{
  "id": "0399abed-fd3d",
  "messageId": "M2015111202120020101BCPF00000000001",
  "createdAt": "2022-05-23T08:01:28.375Z",
  "updatedAt": "2022-05-23T08:02:12.660Z",
  "processedAt": "2022-05-23T08:01:28.375Z",
  "customerId": "4242923b-714e",
  "state": "completed",
  "remainingApprovalsCount": 1,
  "approvalCount": 1,
  "allows": {
    "approve": false,
    "edit": false,
    "submit": true,
    "reject": false,
    "delete": false
  },
  "sourceAccount": {
    "id": "bf23bc970b78d27691e8",
    "nickname": "Premiere Checking",
    "label": "Premiere Checking *1008",
    "maskedNumber": "*1008",
    "type": "checking"
  },
  "amount": {
    "value": "100.00",
    "currency": "USD"
  },
  "sender": {
    "governmentIssuedId": "112223333",
    "name": "Buffalo Mountain Sports",
    "address": {
      "address1": "123 Main Street",
      "address2": "Building 14, Suite 1500",
      "locality": "Miami",
      "regionCode": "FL",
      "countryCode": "US",
      "postalCode": "12345"
    },
    "contact": {
      "name": "John Smith",
      "emailAddress": "johnsmith.doe@business.com",
      "phoneNumber": "+19105550155"
    }
  },
  "recipient": {
    "name": "Exquisite Creations Interior Design & Renovation Services",
    "address": {
      "address1": "123 Hierarchy Lane",
      "locality": "Miami",
      "regionCode": "FL",
      "countryCode": "US",
      "postalCode": "12003"
    },
    "maskedAccountNumber": "*6789",
    "fullAccountNumber": "123456789",
    "institution": {
      "name": "Bank of America",
      "routingNumber": "123123123"
    }
  },
  "confirmationId": "12345",
  "endToEndId": "E2E-Ref001",
  "trackingNumber": "12345678",
  "remittanceAdvice": {
    "method": "email",
    "address": "info@example.com",
    "message": "Payment for invoice INV-123"
  },
  "approvers": [
    {
      "name": "Tom Allison",
      "id": "327d8bea-2553",
      "identification": "to...58@wellsroofing.com"
    },
    {
      "name": "Silvia Wilkenson",
      "id": "06cf8996-d093",
      "identification": "si...42@wellsroofing.com"
    }
  ],
  "approvals": [
    {
      "name": "Tom Allison",
      "id": "327d8bea-2553",
      "identification": "si...42@wellsroofing.com",
      "approvedAt": "2022-04-25T09:02:57.375Z"
    },
    null
  ],
  "problems": []
}

Responses

Status	Description
200	OK
	OK.
	Schema: `creditRealTimePayment`

Status Description

401 Unauthorized

Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given.

This problem responsemay have one of the following type values:

https://production.api.apiture.com/errors/unauthorized/v1.0.0
The request lacks valid authentication credentials for the target resource or operation. Remediation: Authenticate the user and pass the required authorization with the request.

Schema: Inline

Status Description

403 Forbidden

Forbidden. The authenticated caller is not authorized to perform the requested operation.

This problem responsemay have one of the following type values:

https://production.api.apiture.com/errors/forbidden/v1.0.0
The user or agent is not allowed to perform this operation; authentication credentials were provided in the request, but the server considers them insufficient to grant access. Remediation: Check the user's permissions and entitlements before attempting the operation.
https://production.api.apiture.com/errors/customerDisabled/v1.0.0
The customer is disabled. Remediation: Have the customer contact the financial institution for support.
https://production.api.apiture.com/errors/antiMalwareRequired/v1.0.0
The financial institution requires the customer to have anti-malware software installed. Remediation: Direct the user to the software requirements guide to install the correct anti-malware software.
https://production.api.apiture.com/errors/modificationForbidden/v1.0.0
The customer is properly authenticated but not authorized to create, modify, or delete resources. Remediation: Avoid modification operation for customers with read-only authorization.
https://production.api.apiture.com/errors/challengeRequired/v1.0.0
The operation requires the customer to complete an identity challenge. Remediation: Complete the challenge as per the problem response, and add an additional Challenge header to the call. The attributes object in the error may have the properties defined by the requiredIdentityChallenge schema.
https://production.api.apiture.com/errors/challengeBlocked/v1.0.0
The user has failed challenges too many times and is blocked from attempting more or performing operations which require additional authentication. Remediation: Have the user end their login session and login again.
https://production.api.apiture.com/errors/noIdentityChallengeFactors/v1.0.0
This operation requires an identity challenge, but the user does not have the necessary registered authentication factors. Remediation: Have the user register one or more challenge security code delivery factors.
https://production.api.apiture.com/errors/invalidIdentityChallengeHeader/v1.0.0
The additional on-time Challenge header in this request is expired, already used, or otherwise invalid. Remediation: Supply a valid, unexpired, unclaimed Challenge header in the request.

Schema: Inline

Status	Description
404	Not Found
	Not Found. There is no such credit real-time payment resource at the specified `{creditRealTimePaymentId}`.
	Schema: `problemResponse`

Status Description

429 Too Many Requests

Too Many Requests. The client has sent too many requests in a given amount of time.

This problem responsemay have one of the following type values:

https://production.api.apiture.com/errors/tooManyRequests/v1.0.0
The client has sent too many requests in a given amount of time, exceeding rate limiting. Remediation: Slow down the rate of API calls.

Schema: Inline

Status	Description
4XX	Unknown
	Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Status	Description
5XX	Unknown
	Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Response Schema

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.

patchCreditRealTimePayment

Code samples

# You can also use wget
curl -X PATCH https://api.apiture.com/banking/creditRealTimePayments/{creditRealTimePaymentId} \
  -H 'Content-Type: application/merge-patch+json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

PATCH https://api.apiture.com/banking/creditRealTimePayments/{creditRealTimePaymentId} HTTP/1.1
Host: api.apiture.com
Content-Type: application/merge-patch+json
Accept: application/json

const fetch = require('node-fetch');
const inputBody = '{
  "customerId": "4242923b-714e",
  "sourceAccount": {
    "id": "bf23bc970b78d27691e8",
    "nickname": "Premiere Checking",
    "label": "Premiere Checking *1008",
    "maskedNumber": "*1008",
    "type": "checking"
  },
  "amount": {
    "value": "100.00",
    "currency": "USD"
  },
  "sender": {
    "governmentIssuedId": "112223333",
    "name": "Buffalo Mountain Sports",
    "address": {
      "address1": "123 Main Street",
      "address2": "Building 14, Suite 1500",
      "locality": "Miami",
      "regionCode": "FL",
      "countryCode": "US",
      "postalCode": "12345"
    }
  },
  "recipient": {
    "name": "Exquisite Creations Interior Design & Renovation Services",
    "address": {
      "address1": "123 Hierarchy Lane",
      "locality": "Miami",
      "regionCode": "FL",
      "countryCode": "US",
      "postalCode": "12003"
    },
    "fullAccountNumber": "123456789",
    "institution": {
      "name": "Bank of America",
      "routingNumber": "123123123"
    }
  },
  "endToEndId": "E2E-Ref001",
  "remittanceAdvice": {
    "method": "email",
    "address": "info@example.com",
    "message": "Payment for invoice INV-123"
  }
}';
const headers = {
  'Content-Type':'application/merge-patch+json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/banking/creditRealTimePayments/{creditRealTimePaymentId}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

var headers = {
  'Content-Type':'application/merge-patch+json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.apiture.com/banking/creditRealTimePayments/{creditRealTimePaymentId}',
  method: 'patch',

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

require 'rest-client'
require 'json'

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

result = RestClient.patch 'https://api.apiture.com/banking/creditRealTimePayments/{creditRealTimePaymentId}',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.patch('https://api.apiture.com/banking/creditRealTimePayments/{creditRealTimePaymentId}', params={

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

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

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

Update the credit real-time payment

PATCH https://api.apiture.com/banking/creditRealTimePayments/{creditRealTimePaymentId}

Perform a partial update of the credit real-time payment as per JSON Merge Patch. Only fields in the request body are updated on the resource; fields which are omitted are not updated.

Body parameter

{
  "customerId": "4242923b-714e",
  "sourceAccount": {
    "id": "bf23bc970b78d27691e8",
    "nickname": "Premiere Checking",
    "label": "Premiere Checking *1008",
    "maskedNumber": "*1008",
    "type": "checking"
  },
  "amount": {
    "value": "100.00",
    "currency": "USD"
  },
  "sender": {
    "governmentIssuedId": "112223333",
    "name": "Buffalo Mountain Sports",
    "address": {
      "address1": "123 Main Street",
      "address2": "Building 14, Suite 1500",
      "locality": "Miami",
      "regionCode": "FL",
      "countryCode": "US",
      "postalCode": "12345"
    }
  },
  "recipient": {
    "name": "Exquisite Creations Interior Design & Renovation Services",
    "address": {
      "address1": "123 Hierarchy Lane",
      "locality": "Miami",
      "regionCode": "FL",
      "countryCode": "US",
      "postalCode": "12003"
    },
    "fullAccountNumber": "123456789",
    "institution": {
      "name": "Bank of America",
      "routingNumber": "123123123"
    }
  },
  "endToEndId": "E2E-Ref001",
  "remittanceAdvice": {
    "method": "email",
    "address": "info@example.com",
    "message": "Payment for invoice INV-123"
  }
}

Parameters

Parameter	Description
`unmasked` `in: query`	`boolean` When updating a credit real-time payment, `sender.governmentIssuedId` and `recipient.fullAccountNumber` are not included in the response by default, for security reasons. Include this query parameter with a value of `true` to request that the response body includes the `sender.governmentIssuedId` and `recipient.fullAccountNumber`. Such requests are auditable. `default: false`
`body`	`creditRealTimePaymentPatch` (required) The updated credit real-time payment.
`creditRealTimePaymentId` `in: path`	`externalResourceId` (required) The unique identifier of this credit real-time payment. This is an opaque string. This value corresponds to the `id` of a credit real-time payment resource. `read-only` `format: text` `minLength: 1` `maxLength: 256`

Example responses

200 Response

{
  "id": "0399abed-fd3d",
  "messageId": "M2015111202120020101BCPF00000000001",
  "createdAt": "2022-05-23T08:01:28.375Z",
  "updatedAt": "2022-05-23T08:02:12.660Z",
  "processedAt": "2022-05-23T08:01:28.375Z",
  "customerId": "4242923b-714e",
  "state": "completed",
  "remainingApprovalsCount": 1,
  "approvalCount": 1,
  "allows": {
    "approve": false,
    "edit": false,
    "submit": true,
    "reject": false,
    "delete": false
  },
  "sourceAccount": {
    "id": "bf23bc970b78d27691e8",
    "nickname": "Premiere Checking",
    "label": "Premiere Checking *1008",
    "maskedNumber": "*1008",
    "type": "checking"
  },
  "amount": {
    "value": "100.00",
    "currency": "USD"
  },
  "sender": {
    "governmentIssuedId": "112223333",
    "name": "Buffalo Mountain Sports",
    "address": {
      "address1": "123 Main Street",
      "address2": "Building 14, Suite 1500",
      "locality": "Miami",
      "regionCode": "FL",
      "countryCode": "US",
      "postalCode": "12345"
    },
    "contact": {
      "name": "John Smith",
      "emailAddress": "johnsmith.doe@business.com",
      "phoneNumber": "+19105550155"
    }
  },
  "recipient": {
    "name": "Exquisite Creations Interior Design & Renovation Services",
    "address": {
      "address1": "123 Hierarchy Lane",
      "locality": "Miami",
      "regionCode": "FL",
      "countryCode": "US",
      "postalCode": "12003"
    },
    "maskedAccountNumber": "*6789",
    "fullAccountNumber": "123456789",
    "institution": {
      "name": "Bank of America",
      "routingNumber": "123123123"
    }
  },
  "confirmationId": "12345",
  "endToEndId": "E2E-Ref001",
  "trackingNumber": "12345678",
  "remittanceAdvice": {
    "method": "email",
    "address": "info@example.com",
    "message": "Payment for invoice INV-123"
  },
  "approvers": [
    {
      "name": "Tom Allison",
      "id": "327d8bea-2553",
      "identification": "to...58@wellsroofing.com"
    },
    {
      "name": "Silvia Wilkenson",
      "id": "06cf8996-d093",
      "identification": "si...42@wellsroofing.com"
    }
  ],
  "approvals": [
    {
      "name": "Tom Allison",
      "id": "327d8bea-2553",
      "identification": "si...42@wellsroofing.com",
      "approvedAt": "2022-04-25T09:02:57.375Z"
    },
    null
  ],
  "problems": []
}

Responses

Status	Description
200	OK
	OK.
	Schema: `creditRealTimePayment`

Status Description

400 Bad Request

Bad Request. The request body, request headers, and/or query parameters are not well-formed.

This problem responsemay have one of the following type values:

https://production.api.apiture.com/errors/badRequest/v1.0.0
The request body and/or parameters was not well-formed. Remediation: Correct any syntax or schema errors in the request body or parameters.

Schema: Inline

Status Description

401 Unauthorized

Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given.

This problem responsemay have one of the following type values:

https://production.api.apiture.com/errors/unauthorized/v1.0.0
The request lacks valid authentication credentials for the target resource or operation. Remediation: Authenticate the user and pass the required authorization with the request.

Schema: Inline

Status Description

403 Forbidden

Forbidden. The authenticated caller is not authorized to perform the requested operation.

This problem responsemay have one of the following type values:

https://production.api.apiture.com/errors/forbidden/v1.0.0
The user or agent is not allowed to perform this operation; authentication credentials were provided in the request, but the server considers them insufficient to grant access. Remediation: Check the user's permissions and entitlements before attempting the operation.
https://production.api.apiture.com/errors/customerDisabled/v1.0.0
The customer is disabled. Remediation: Have the customer contact the financial institution for support.
https://production.api.apiture.com/errors/antiMalwareRequired/v1.0.0
The financial institution requires the customer to have anti-malware software installed. Remediation: Direct the user to the software requirements guide to install the correct anti-malware software.
https://production.api.apiture.com/errors/modificationForbidden/v1.0.0
The customer is properly authenticated but not authorized to create, modify, or delete resources. Remediation: Avoid modification operation for customers with read-only authorization.
https://production.api.apiture.com/errors/challengeRequired/v1.0.0
The operation requires the customer to complete an identity challenge. Remediation: Complete the challenge as per the problem response, and add an additional Challenge header to the call. The attributes object in the error may have the properties defined by the requiredIdentityChallenge schema.
https://production.api.apiture.com/errors/challengeBlocked/v1.0.0
The user has failed challenges too many times and is blocked from attempting more or performing operations which require additional authentication. Remediation: Have the user end their login session and login again.
https://production.api.apiture.com/errors/noIdentityChallengeFactors/v1.0.0
This operation requires an identity challenge, but the user does not have the necessary registered authentication factors. Remediation: Have the user register one or more challenge security code delivery factors.
https://production.api.apiture.com/errors/invalidIdentityChallengeHeader/v1.0.0
The additional on-time Challenge header in this request is expired, already used, or otherwise invalid. Remediation: Supply a valid, unexpired, unclaimed Challenge header in the request.

Schema: Inline

Status	Description
404	Not Found
	Not Found. There is no such credit real-time payment resource at the specified `{creditRealTimePaymentId}`.
	Schema: `problemResponse`

Status Description

409 Conflict

Conflict. The request conflicts with the state of the application.

This problem responsemay have one of the following type values:

https://production.api.apiture.com/errors/conflict/v1.0.0
The request could not be completed due to a conflict with the current state of the target resource. Remediation: Try another operation that is allowed.

Schema: problemResponse

Status Description

422 Unprocessable Entity

Unprocessable Entity. The request body and/or query parameters were well formed but otherwise invalid.

This problem responsemay have one of the following type values:

https://production.api.apiture.com/errors/invalidRealTimePaymentSourceAccount/v1.0.0
The chosen source account does not exist, is not accessible, or is not entitled for real-time payments. Remediation: Choose an existing source account with the correct entitlement for real-time payments.
https://production.api.apiture.com/errors/invalidRealTimePaymentAmount/v1.0.0
The amount is $0.00, is more than 14 total digits, or the amount of the real-time payment exceeds the allowed limit within a certain period. Remediation: Change the amount to a value greater than $0.00 with no more than 14 total digits, that does not exceed the allowed limit and resubmit.
https://production.api.apiture.com/errors/invalidRealTimePaymentRecipientRoutingNumber/v1.0.0
The routing number for the recipient financial institution is invalid. Remediation: Use a valid routing number.
https://production.api.apiture.com/errors/invalidRealTimePaymentRecipientAccount/v1.0.0
The chosen recipient account does not exist, is not accessible, or is not entitled for real-time payments. Remediation: Choose an existing recipient account with the correct entitlement for real-time payments.
https://production.api.apiture.com/errors/emptyRealTimePaymentRecipientAddress/v1.0.0
The address object was included for the recipient but no fields were included inside the address object. Remediation: Either do not include the address object for the recipient or include at least one field inside the address object.
https://production.api.apiture.com/errors/emptyRealTimePaymentSenderAddress/v1.0.0
The address object was included for the sender but no fields were included inside the address object. Remediation: Either do not include the address object for the sender or include at least one field inside the address object.
https://production.api.apiture.com/errors/remittanceAdviceEmailAddressTooLong/v1.0.0
When the remittance advice method is email, the address can be no longer than 255 characters. Remediation: Shorten the address of the remittance advice to 255 characters or less if the method is email.
https://production.api.apiture.com/errors/invalidRealTimePaymentRecipientUsPostalCode/v1.0.0
The recipient's countryCode is US but the postalCode is not in the correct format. Remediation: If the recipient's countryCode is US, provide a value for postalCode that is either a five digit US ZIP code or a ten character ZIP+4.
https://production.api.apiture.com/errors/invalidRealTimePaymentSenderUsPostalCode/v1.0.0
The sender's countryCode is US but the postalCode is not in the correct format. Remediation: If the sender's countryCode is US, provide a value for postalCode that is either a five digit US ZIP code or a ten character ZIP+4.
https://production.api.apiture.com/errors/institutionDoesNotSupportRealTimePayments/v1.0.0
The routing number is valid but the financial institution does not support real-time payments. Remediation: Use a routing number for a financial institution that does support real-time payments.
https://production.api.apiture.com/errors/invalidRealTimePaymentStateForEdit/v1.0.0
The edit operation is not allowed if the credit real-time payment allows.edit is false. Remediation: Do not attempt to update a real-time payment if allows.edit is false.

Schema: problemResponse

Status Description

429 Too Many Requests

Too Many Requests. The client has sent too many requests in a given amount of time.

This problem responsemay have one of the following type values:

https://production.api.apiture.com/errors/tooManyRequests/v1.0.0
The client has sent too many requests in a given amount of time, exceeding rate limiting. Remediation: Slow down the rate of API calls.

Schema: Inline

Status	Description
4XX	Unknown
	Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Status	Description
5XX	Unknown
	Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

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.

listEligibleCreditRealTimePaymentApprovers

Code samples

# You can also use wget
curl -X GET https://api.apiture.com/banking/creditRealTimePaymentEligibleApprovers?creditRealTimePayments=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.apiture.com/banking/creditRealTimePaymentEligibleApprovers?creditRealTimePayments=string HTTP/1.1
Host: api.apiture.com
Accept: application/json

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

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

};

fetch('https://api.apiture.com/banking/creditRealTimePaymentEligibleApprovers?creditRealTimePayments=string',
{
  method: 'GET',

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

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

};

$.ajax({
  url: 'https://api.apiture.com/banking/creditRealTimePaymentEligibleApprovers',
  method: 'get',
  data: '?creditRealTimePayments=string',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

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

result = RestClient.get 'https://api.apiture.com/banking/creditRealTimePaymentEligibleApprovers',
  params: {
  'creditRealTimePayments' => '[creditRealTimePaymentIds](#schema-creditRealTimePaymentIds)'
}, headers: headers

p JSON.parse(result)

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

r = requests.get('https://api.apiture.com/banking/creditRealTimePaymentEligibleApprovers', params={
  'creditRealTimePayments': [
  "string"
]
}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

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

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

List Eligible Approvers for Credit Real-Time Payments

GET https://api.apiture.com/banking/creditRealTimePaymentEligibleApprovers

Return a list of customers eligible to approve a list of credit real-time payments.

The response of this operation may be reused as the request for the addCreditRealTimePaymentApprovers operation, possibly after filtering the approvers list to reflect user selection.

Parameters

Parameter	Description
`creditRealTimePayments` `in: query`	`creditRealTimePaymentIds` (required) A list of credit real-time payment IDs for building the list of eligible approvers. `minItems: 1` `maxItems: 100` `comma-delimited` items: `string` » `minLength: 6` » `maxLength: 48` » `pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"`

Example responses

200 Response

{
  "items": [
    {
      "creditRealTimePaymentId": "d366bc49-49a7",
      "groupId": "group-00",
      "approvers": [
        {
          "name": "Tom Allison",
          "id": "327d8bea-2553",
          "identification": "to...58@wellsroofing.com"
        },
        {
          "name": "Silvia Wilkenson",
          "id": "06cf8996-d093",
          "identification": "si...42@wellsroofing.com"
        }
      ]
    },
    {
      "creditRealTimePaymentId": "8ea05bfc-0e9c",
      "groupId": "group-00",
      "approvers": [
        {
          "name": "Tom Allison",
          "id": "327d8bea-2553",
          "identification": "to...58@wellsroofing.com"
        },
        {
          "name": "Silvia Wilkenson",
          "id": "06cf8996-d093",
          "identification": "si...42@wellsroofing.com"
        }
      ]
    },
    {
      "creditRealTimePaymentId": "071db898-b220",
      "groupId": "group-01",
      "approvers": [
        {
          "name": "Tom Allison",
          "id": "327d8bea-2553",
          "identification": "to...58@wellsroofing.com"
        },
        {
          "name": "Carl Thompson",
          "id": "d7da1cc5-8056",
          "identification": "ca...39@wellsroofing.com"
        }
      ]
    }
  ]
}

Responses

Status	Description
200	OK
	OK. The operation succeeded.
	Schema: `bulkEligibleCreditRealTimePaymentApprovers`

Status Description

400 Bad Request

Bad Request. The request body, request headers, and/or query parameters are not well-formed.

This problem responsemay have one of the following type values:

https://production.api.apiture.com/errors/badRequest/v1.0.0
The request body and/or parameters was not well-formed. Remediation: Correct any syntax or schema errors in the request body or parameters.

Schema: Inline

Status Description

401 Unauthorized

Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given.

This problem responsemay have one of the following type values:

https://production.api.apiture.com/errors/unauthorized/v1.0.0
The request lacks valid authentication credentials for the target resource or operation. Remediation: Authenticate the user and pass the required authorization with the request.

Schema: Inline

Status Description

403 Forbidden

Forbidden. The authenticated caller is not authorized to perform the requested operation.

This problem responsemay have one of the following type values:

https://production.api.apiture.com/errors/forbidden/v1.0.0
The user or agent is not allowed to perform this operation; authentication credentials were provided in the request, but the server considers them insufficient to grant access. Remediation: Check the user's permissions and entitlements before attempting the operation.
https://production.api.apiture.com/errors/customerDisabled/v1.0.0
The customer is disabled. Remediation: Have the customer contact the financial institution for support.
https://production.api.apiture.com/errors/antiMalwareRequired/v1.0.0
The financial institution requires the customer to have anti-malware software installed. Remediation: Direct the user to the software requirements guide to install the correct anti-malware software.
https://production.api.apiture.com/errors/modificationForbidden/v1.0.0
The customer is properly authenticated but not authorized to create, modify, or delete resources. Remediation: Avoid modification operation for customers with read-only authorization.
https://production.api.apiture.com/errors/challengeRequired/v1.0.0
The operation requires the customer to complete an identity challenge. Remediation: Complete the challenge as per the problem response, and add an additional Challenge header to the call. The attributes object in the error may have the properties defined by the requiredIdentityChallenge schema.
https://production.api.apiture.com/errors/challengeBlocked/v1.0.0
The user has failed challenges too many times and is blocked from attempting more or performing operations which require additional authentication. Remediation: Have the user end their login session and login again.
https://production.api.apiture.com/errors/noIdentityChallengeFactors/v1.0.0
This operation requires an identity challenge, but the user does not have the necessary registered authentication factors. Remediation: Have the user register one or more challenge security code delivery factors.
https://production.api.apiture.com/errors/invalidIdentityChallengeHeader/v1.0.0
The additional on-time Challenge header in this request is expired, already used, or otherwise invalid. Remediation: Supply a valid, unexpired, unclaimed Challenge header in the request.

Schema: Inline

Status	Description
404	Not Found
	Not Found. There is no such credit real-time payment resource at the specified `{creditRealTimePaymentId}`.
	Schema: `problemResponse`

Status	Description
409	Conflict
	Conflict. Listing eligible approvers failed for all credit real-time payments. This may be due to a configuration error or other problem that prevents listing approvers.
	Schema: `problemResponse`

Status Description

422 Unprocessable Entity

Unprocessable Entity. The request body and/or query parameters were well-formed but otherwise invalid.

This problem responsemay have one of the following type values:

https://production.api.apiture.com/errors/unprocessableEntity/v1.0.0
The syntax of the request entity is correct but was unable to process the contained instructions. Remediation: Provide a semantically correct request.

Schema: Inline

Status Description

429 Too Many Requests

Too Many Requests. The client has sent too many requests in a given amount of time.

This problem responsemay have one of the following type values:

https://production.api.apiture.com/errors/tooManyRequests/v1.0.0
The client has sent too many requests in a given amount of time, exceeding rate limiting. Remediation: Slow down the rate of API calls.

Schema: Inline

Status	Description
4XX	Unknown
	Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Status	Description
5XX	Unknown
	Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

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 422

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.

deleteCreditRealTimePayments

Code samples

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

POST https://api.apiture.com/banking/deletedCreditRealTimePayments HTTP/1.1
Host: api.apiture.com
Content-Type: application/json
Accept: application/json

const fetch = require('node-fetch');
const inputBody = '{
  "realTimePaymentIds": [
    "0399abed-fd3d",
    "d62c0701-0d74-4836-83f9-ebf3709442ea"
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/banking/deletedCreditRealTimePayments',
{
  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',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.apiture.com/banking/deletedCreditRealTimePayments',
  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',
  'Authorization' => 'Bearer {access-token}'
}

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

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

Delete Credit Real-Time Payments

POST https://api.apiture.com/banking/deletedCreditRealTimePayments

Delete one or more credit real-time payments.

Deletion of one or more credit real-time payments may fail if those payments were previously deleted. The creditRealTimePayment.allows.delete property must be true on each payment for the current customer to delete the payment. If the creditRealTimePayment.allows.delete property is false for some but not all of the individual payments in the list, deletion for the individual payment will fail. The failure will be indicated with the response 400 invalidRealTimePaymentStateForDelete in the response body, and the other payments in the request will still be processed. If the creditRealTimePayment.allows.delete property is false for all of the individual payments in the list, deletion for all the payments will fail with the response 422 invalidRealTimePaymentsStateForDelete.

The 200 response indicates a partial success and includes details on any failed deletions. The 204 response indicates that all of the credit real-time payments were successfully deleted. The 422 response indicates that none of the credit real-time payments were successfully deleted.

Body parameter

{
  "realTimePaymentIds": [
    "0399abed-fd3d",
    "d62c0701-0d74-4836-83f9-ebf3709442ea"
  ]
}

Parameters

Parameter	Description
`body`	`bulkCreditRealTimePaymentDeletionRequest` (required) Request containing the credit real-time payments to delete.

Example responses

200 Response

[
  {
    "id": "0399abed-fd3d",
    "succeeded": false,
    "problems": [
      {
        "id": "3fbad566-be86-4b22-9ba6-3ca99fdc0799",
        "type": "https://production.api.apiture.com/errors/invalidRealTimePaymentId/v1.0.0",
        "title": "Credit Real-Time Payment Not Found",
        "status": 422,
        "occurredAt": "2022-04-25T12:42:21.375Z",
        "detail": "No real-time payment exists for the requested real-time payment ID",
        "instance": "https://production.api.apiture.com/banking/creditRealTimePayments/0399abed-fd3d"
      }
    ]
  },
  {
    "id": "d62c0701-0d74-4836-83f9-ebf3709442ea",
    "succeeded": true
  }
]

Responses

Status	Description
200	OK
	OK. The request was successfully processed. However, deleting one or more credit real-time payments has failed; the response body indicates which succeeded and which failed. This response may have one of the following `type` values: `https://production.api.apiture.com/errors/invalidRealTimePaymentId/v1.0.0` The specified real-time payment ID is invalid or does not refer to an existing real-time payment. Remediation: Specify the ID of an existing real-time payment for which the user has access. `https://production.api.apiture.com/errors/invalidRealTimePaymentStateForDelete/v1.0.0` The delete operation is not allowed if the credit real-time payment `allows.delete` is `false`. Remediation: Resolve any problems in the credit real-time payment so that the payment `allows.delete` is `true`.
	Schema: `bulkCreditRealTimePaymentDeletionResponse`
204	No Content
	No Content. The operation succeeded but returned no response body.

Status Description

400 Bad Request

Bad Request. The request body, request headers, and/or query parameters are not well-formed.

This problem responsemay have one of the following type values:

https://production.api.apiture.com/errors/badRequest/v1.0.0
The request body and/or parameters was not well-formed. Remediation: Correct any syntax or schema errors in the request body or parameters.

Schema: Inline

Status Description

401 Unauthorized

Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given.

This problem responsemay have one of the following type values:

https://production.api.apiture.com/errors/unauthorized/v1.0.0
The request lacks valid authentication credentials for the target resource or operation. Remediation: Authenticate the user and pass the required authorization with the request.

Schema: Inline

Status Description

403 Forbidden

Forbidden. The authenticated caller is not authorized to perform the requested operation.

This problem responsemay have one of the following type values:

https://production.api.apiture.com/errors/forbidden/v1.0.0
The user or agent is not allowed to perform this operation; authentication credentials were provided in the request, but the server considers them insufficient to grant access. Remediation: Check the user's permissions and entitlements before attempting the operation.
https://production.api.apiture.com/errors/customerDisabled/v1.0.0
The customer is disabled. Remediation: Have the customer contact the financial institution for support.
https://production.api.apiture.com/errors/antiMalwareRequired/v1.0.0
The financial institution requires the customer to have anti-malware software installed. Remediation: Direct the user to the software requirements guide to install the correct anti-malware software.
https://production.api.apiture.com/errors/modificationForbidden/v1.0.0
The customer is properly authenticated but not authorized to create, modify, or delete resources. Remediation: Avoid modification operation for customers with read-only authorization.
https://production.api.apiture.com/errors/challengeRequired/v1.0.0
The operation requires the customer to complete an identity challenge. Remediation: Complete the challenge as per the problem response, and add an additional Challenge header to the call. The attributes object in the error may have the properties defined by the requiredIdentityChallenge schema.
https://production.api.apiture.com/errors/challengeBlocked/v1.0.0
The user has failed challenges too many times and is blocked from attempting more or performing operations which require additional authentication. Remediation: Have the user end their login session and login again.
https://production.api.apiture.com/errors/noIdentityChallengeFactors/v1.0.0
This operation requires an identity challenge, but the user does not have the necessary registered authentication factors. Remediation: Have the user register one or more challenge security code delivery factors.
https://production.api.apiture.com/errors/invalidIdentityChallengeHeader/v1.0.0
The additional on-time Challenge header in this request is expired, already used, or otherwise invalid. Remediation: Supply a valid, unexpired, unclaimed Challenge header in the request.

Schema: Inline

Status Description

422 Unprocessable Entity

Unprocessable Entity. The request body and/or query parameters were well formed but otherwise invalid.

This problem responsemay have one of the following type values:

https://production.api.apiture.com/errors/invalidRealTimePaymentIds/v1.0.0
All of the real-time payment IDs are invalid or do not refer to an existing real-time payment. Remediation: Specify the IDs of existing real-time payments for which the user has access.
https://production.api.apiture.com/errors/invalidRealTimePaymentsStateForDelete/v1.0.0
The delete operation is not allowed if the credit real-time payments allows.delete are false. Remediation: Resolve any problems in credit real-time payments so that each payment allows.delete is true.

Schema: problemResponse

Status Description

429 Too Many Requests

Too Many Requests. The client has sent too many requests in a given amount of time.

This problem responsemay have one of the following type values:

https://production.api.apiture.com/errors/tooManyRequests/v1.0.0
The client has sent too many requests in a given amount of time, exceeding rate limiting. Remediation: Slow down the rate of API calls.

Schema: Inline

Status	Description
4XX	Unknown
	Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Status	Description
5XX	Unknown
	Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

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.

Credit Real-Time Payment Actions

Actions on credit real-time payments

submitCreditRealTimePayment

Code samples

# You can also use wget
curl -X POST https://api.apiture.com/banking/creditRealTimePayments/{creditRealTimePaymentId}/submitted \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.apiture.com/banking/creditRealTimePayments/{creditRealTimePaymentId}/submitted HTTP/1.1
Host: api.apiture.com
Accept: application/json

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

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

};

fetch('https://api.apiture.com/banking/creditRealTimePayments/{creditRealTimePaymentId}/submitted',
{
  method: 'POST',

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

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

};

$.ajax({
  url: 'https://api.apiture.com/banking/creditRealTimePayments/{creditRealTimePaymentId}/submitted',
  method: 'post',

  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.post 'https://api.apiture.com/banking/creditRealTimePayments/{creditRealTimePaymentId}/submitted',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.post('https://api.apiture.com/banking/creditRealTimePayments/{creditRealTimePaymentId}/submitted', params={

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

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

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

Submit a credit real-time payment

POST https://api.apiture.com/banking/creditRealTimePayments/{creditRealTimePaymentId}/submitted

Submit a credit real-time payment for approval or scheduling. If the customer has the approval entitlement, this action does not automatically add the customer to the creditRealTimePayment.approvers list. The customer should manually approve the payment through the approveCreditRealTimePayment operation. The creditRealTimePayment.allows.submit property must be true on the payment for the current customer to submit the payment. This operation is idempotent: no changes are made if the payment is already in the pendingApproval or scheduled state.

For commercial customers: once submitted, the credit real-time payment transitions to the pendingApproval state. For retail customers: once submitted, the credit real-time payment transitions to the scheduled state.

Parameters

Parameter	Description
`unmasked` `in: query`	`boolean` When submitting a credit real-time payment, `sender.governmentIssuedId` and `recipient.fullAccountNumber` are not included in the response by default, for security reasons. Include this query parameter with a value of `true` to request that the response body includes the `sender.governmentIssuedId` and `recipient.fullAccountNumber`. Such requests are auditable. `default: false`
`creditRealTimePaymentId` `in: path`	`externalResourceId` (required) The unique identifier of this credit real-time payment. This is an opaque string. This value corresponds to the `id` of a credit real-time payment resource. `read-only` `format: text` `minLength: 1` `maxLength: 256`

Example responses

200 Response

{
  "id": "0399abed-fd3d",
  "messageId": "M2015111202120020101BCPF00000000001",
  "createdAt": "2022-05-23T08:01:28.375Z",
  "updatedAt": "2022-05-23T08:02:12.660Z",
  "processedAt": "2022-05-23T08:01:28.375Z",
  "customerId": "4242923b-714e",
  "state": "completed",
  "remainingApprovalsCount": 1,
  "approvalCount": 1,
  "allows": {
    "approve": false,
    "edit": false,
    "submit": true,
    "reject": false,
    "delete": false
  },
  "sourceAccount": {
    "id": "bf23bc970b78d27691e8",
    "nickname": "Premiere Checking",
    "label": "Premiere Checking *1008",
    "maskedNumber": "*1008",
    "type": "checking"
  },
  "amount": {
    "value": "100.00",
    "currency": "USD"
  },
  "sender": {
    "governmentIssuedId": "112223333",
    "name": "Buffalo Mountain Sports",
    "address": {
      "address1": "123 Main Street",
      "address2": "Building 14, Suite 1500",
      "locality": "Miami",
      "regionCode": "FL",
      "countryCode": "US",
      "postalCode": "12345"
    },
    "contact": {
      "name": "John Smith",
      "emailAddress": "johnsmith.doe@business.com",
      "phoneNumber": "+19105550155"
    }
  },
  "recipient": {
    "name": "Exquisite Creations Interior Design & Renovation Services",
    "address": {
      "address1": "123 Hierarchy Lane",
      "locality": "Miami",
      "regionCode": "FL",
      "countryCode": "US",
      "postalCode": "12003"
    },
    "maskedAccountNumber": "*6789",
    "fullAccountNumber": "123456789",
    "institution": {
      "name": "Bank of America",
      "routingNumber": "123123123"
    }
  },
  "confirmationId": "12345",
  "endToEndId": "E2E-Ref001",
  "trackingNumber": "12345678",
  "remittanceAdvice": {
    "method": "email",
    "address": "info@example.com",
    "message": "Payment for invoice INV-123"
  },
  "approvers": [
    {
      "name": "Tom Allison",
      "id": "327d8bea-2553",
      "identification": "to...58@wellsroofing.com"
    },
    {
      "name": "Silvia Wilkenson",
      "id": "06cf8996-d093",
      "identification": "si...42@wellsroofing.com"
    }
  ],
  "approvals": [
    {
      "name": "Tom Allison",
      "id": "327d8bea-2553",
      "identification": "si...42@wellsroofing.com",
      "approvedAt": "2022-04-25T09:02:57.375Z"
    },
    null
  ],
  "problems": []
}

Responses

Status	Description
200	OK
	OK. The operation succeeded.
	Schema: `creditRealTimePayment`

Status Description

400 Bad Request

Bad Request. The request body, request headers, and/or query parameters are not well-formed.

This problem responsemay have one of the following type values:

https://production.api.apiture.com/errors/badRequest/v1.0.0
The request body and/or parameters was not well-formed. Remediation: Correct any syntax or schema errors in the request body or parameters.

Schema: Inline

Status Description

401 Unauthorized

Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given.

This problem responsemay have one of the following type values:

https://production.api.apiture.com/errors/unauthorized/v1.0.0
The request lacks valid authentication credentials for the target resource or operation. Remediation: Authenticate the user and pass the required authorization with the request.

Schema: Inline

Status Description

403 Forbidden

Forbidden. The authenticated caller is not authorized to perform the requested operation.

This problem responsemay have one of the following type values:

https://production.api.apiture.com/errors/forbidden/v1.0.0
The user or agent is not allowed to perform this operation; authentication credentials were provided in the request, but the server considers them insufficient to grant access. Remediation: Check the user's permissions and entitlements before attempting the operation.
https://production.api.apiture.com/errors/customerDisabled/v1.0.0
The customer is disabled. Remediation: Have the customer contact the financial institution for support.
https://production.api.apiture.com/errors/antiMalwareRequired/v1.0.0
The financial institution requires the customer to have anti-malware software installed. Remediation: Direct the user to the software requirements guide to install the correct anti-malware software.
https://production.api.apiture.com/errors/modificationForbidden/v1.0.0
The customer is properly authenticated but not authorized to create, modify, or delete resources. Remediation: Avoid modification operation for customers with read-only authorization.
https://production.api.apiture.com/errors/challengeRequired/v1.0.0
The operation requires the customer to complete an identity challenge. Remediation: Complete the challenge as per the problem response, and add an additional Challenge header to the call. The attributes object in the error may have the properties defined by the requiredIdentityChallenge schema.
https://production.api.apiture.com/errors/challengeBlocked/v1.0.0
The user has failed challenges too many times and is blocked from attempting more or performing operations which require additional authentication. Remediation: Have the user end their login session and login again.
https://production.api.apiture.com/errors/noIdentityChallengeFactors/v1.0.0
This operation requires an identity challenge, but the user does not have the necessary registered authentication factors. Remediation: Have the user register one or more challenge security code delivery factors.
https://production.api.apiture.com/errors/invalidIdentityChallengeHeader/v1.0.0
The additional on-time Challenge header in this request is expired, already used, or otherwise invalid. Remediation: Supply a valid, unexpired, unclaimed Challenge header in the request.

Schema: Inline

Status	Description
404	Not Found
	Not Found. There is no such credit real-time payment resource at the specified `{creditRealTimePaymentId}`.
	Schema: `problemResponse`

Status Description

409 Conflict

Conflict. The request to submit the credit real-time payment is not allowed. Either the payment still has problems which prevent it from being submitted, or its state is scheduled or beyond.

This problem responsemay have one of the following type values:

https://production.api.apiture.com/errors/invalidRealTimePaymentStateForSubmit/v1.0.0
The submit operation is not allowed if the credit real-time payment allows.submit is false. Remediation: Resolve any problems in the credit real-time payment so that the payment allows.submit is true.

Schema: problemResponse

Status Description

422 Unprocessable Entity

Unprocessable Entity. The request body and/or query parameters were well-formed but otherwise invalid.

This problem responsemay have one of the following type values:

https://production.api.apiture.com/errors/unprocessableEntity/v1.0.0
The syntax of the request entity is correct but was unable to process the contained instructions. Remediation: Provide a semantically correct request.

Schema: Inline

Status Description

429 Too Many Requests

Too Many Requests. The client has sent too many requests in a given amount of time.

This problem responsemay have one of the following type values:

https://production.api.apiture.com/errors/tooManyRequests/v1.0.0
The client has sent too many requests in a given amount of time, exceeding rate limiting. Remediation: Slow down the rate of API calls.

Schema: Inline

Status	Description
4XX	Unknown
	Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Status	Description
5XX	Unknown
	Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

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 422

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.

addCreditRealTimePaymentApprovers

Code samples

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

POST https://api.apiture.com/banking/creditRealTimePaymentApprovers HTTP/1.1
Host: api.apiture.com
Content-Type: application/json
Accept: application/json

const fetch = require('node-fetch');
const inputBody = '{
  "items": [
    {
      "creditRealTimePaymentId": "d366bc49-49a7",
      "groupId": "group-00",
      "approvers": [
        {
          "name": "Tom Allison",
          "id": "327d8bea-2553",
          "identification": "to...58@wellsroofing.com"
        },
        {
          "name": "Silvia Wilkenson",
          "id": "06cf8996-d093",
          "identification": "si...42@wellsroofing.com"
        }
      ]
    },
    {
      "creditRealTimePaymentId": "8ea05bfc-0e9c",
      "groupId": "group-00",
      "approvers": [
        {
          "name": "Tom Allison",
          "id": "327d8bea-2553",
          "identification": "to...58@wellsroofing.com"
        },
        {
          "name": "Silvia Wilkenson",
          "id": "06cf8996-d093",
          "identification": "si...42@wellsroofing.com"
        }
      ]
    },
    {
      "creditRealTimePaymentId": "071db898-b220",
      "groupId": "group-01",
      "approvers": [
        {
          "name": "Tom Allison",
          "id": "327d8bea-2553",
          "identification": "to...58@wellsroofing.com"
        },
        {
          "name": "Carl Thompson",
          "id": "d7da1cc5-8056",
          "identification": "ca...39@wellsroofing.com"
        }
      ]
    }
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/banking/creditRealTimePaymentApprovers',
{
  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',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.apiture.com/banking/creditRealTimePaymentApprovers',
  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',
  'Authorization' => 'Bearer {access-token}'
}

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

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

Add approvers to credit real-time payments

POST https://api.apiture.com/banking/creditRealTimePaymentApprovers

Add approvers to a set of credit real-time payments. This operation also notifies those approvers that they need to review then approve or reject each of the payments. This operation is only allowed if the payment is in a pendingApproval state and has no errors. Approvers may only approve a payment if creditRealTimePayment.allows.approve is true.

The request body for this operation may be derived from the response of the listEligibleCreditRealTimePaymentApprovers operation, possibly with a subset of approvers per payment based on user selection.

The 204 response indicates the approvers were successfully added to all payments. The 200 response indicates a partial success and includes details on any failed additions, such as a payment has begun processing.

Body parameter

{
  "items": [
    {
      "creditRealTimePaymentId": "d366bc49-49a7",
      "groupId": "group-00",
      "approvers": [
        {
          "name": "Tom Allison",
          "id": "327d8bea-2553",
          "identification": "to...58@wellsroofing.com"
        },
        {
          "name": "Silvia Wilkenson",
          "id": "06cf8996-d093",
          "identification": "si...42@wellsroofing.com"
        }
      ]
    },
    {
      "creditRealTimePaymentId": "8ea05bfc-0e9c",
      "groupId": "group-00",
      "approvers": [
        {
          "name": "Tom Allison",
          "id": "327d8bea-2553",
          "identification": "to...58@wellsroofing.com"
        },
        {
          "name": "Silvia Wilkenson",
          "id": "06cf8996-d093",
          "identification": "si...42@wellsroofing.com"
        }
      ]
    },
    {
      "creditRealTimePaymentId": "071db898-b220",
      "groupId": "group-01",
      "approvers": [
        {
          "name": "Tom Allison",
          "id": "327d8bea-2553",
          "identification": "to...58@wellsroofing.com"
        },
        {
          "name": "Carl Thompson",
          "id": "d7da1cc5-8056",
          "identification": "ca...39@wellsroofing.com"
        }
      ]
    }
  ]
}

Parameters

Parameter	Description
`body`	`bulkCreditRealTimePaymentApproversRequest` (required) The data necessary to add the approvers of credit real-time payments.

Example responses

200 Response

[
  {
    "id": "0399abed-fd3d",
    "succeeded": false,
    "problems": [
      {
        "id": "3fbad566-be86-4b22-9ba6-3ca99fdc0799",
        "type": "https://production.api.apiture.com/errors/invalidRealTimePaymentId/v1.0.0",
        "title": "Credit Real-Time Payment Not Found",
        "status": 422,
        "occurredAt": "2022-04-25T12:42:21.375Z",
        "detail": "No real-time payment exists for the requested real-time payment ID",
        "instance": "https://production.api.apiture.com/banking/creditRealTimePayments/0399abed-fd3d"
      }
    ]
  },
  {
    "id": "d62c0701-0d74-4836-83f9-ebf3709442ea",
    "succeeded": true
  }
]

Responses

Status	Description
200	OK
	OK. The request was successfully processed. However, adding approvers to one or more credit real-time payments has failed; the response body indicates which succeeded and which failed. This response may have one of the following `type` values: `https://production.api.apiture.com/errors/invalidRealTimePaymentId/v1.0.0` The specified real-time payment ID is invalid or does not refer to an existing real-time payment. Remediation: Specify the ID of an existing real-time payment for which the user has access. `https://production.api.apiture.com/errors/invalidRealTimePaymentStateForAddApprovers/v1.0.0` The credit real-time payment cannot have approvers added when in the current state. Remediation: The credit real-time payment state must be `pendingApproval`. `https://production.api.apiture.com/errors/invalidRealTimePaymentApprover/v1.0.0` The requested approver is not eligible for approving this credit real-time payment. Remediation: Pass only eligible approvers from the `listEligibleCreditRealTimePaymentApprovers` operation.
	Schema: `creditRealTimePaymentBulkApprovers`
204	No Content
	No Content. The operation succeeded but returned no response body.

Status Description

400 Bad Request

Bad Request. The request body, request headers, and/or query parameters are not well-formed.

This problem responsemay have one of the following type values:

https://production.api.apiture.com/errors/badRequest/v1.0.0
The request body and/or parameters was not well-formed. Remediation: Correct any syntax or schema errors in the request body or parameters.

Schema: Inline

Status Description

401 Unauthorized

Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given.

This problem responsemay have one of the following type values:

https://production.api.apiture.com/errors/unauthorized/v1.0.0
The request lacks valid authentication credentials for the target resource or operation. Remediation: Authenticate the user and pass the required authorization with the request.

Schema: Inline

Status Description

403 Forbidden

Forbidden. The authenticated caller is not authorized to perform the requested operation.

This problem responsemay have one of the following type values:

https://production.api.apiture.com/errors/forbidden/v1.0.0
The user or agent is not allowed to perform this operation; authentication credentials were provided in the request, but the server considers them insufficient to grant access. Remediation: Check the user's permissions and entitlements before attempting the operation.
https://production.api.apiture.com/errors/customerDisabled/v1.0.0
The customer is disabled. Remediation: Have the customer contact the financial institution for support.
https://production.api.apiture.com/errors/antiMalwareRequired/v1.0.0
The financial institution requires the customer to have anti-malware software installed. Remediation: Direct the user to the software requirements guide to install the correct anti-malware software.
https://production.api.apiture.com/errors/modificationForbidden/v1.0.0
The customer is properly authenticated but not authorized to create, modify, or delete resources. Remediation: Avoid modification operation for customers with read-only authorization.
https://production.api.apiture.com/errors/challengeRequired/v1.0.0
The operation requires the customer to complete an identity challenge. Remediation: Complete the challenge as per the problem response, and add an additional Challenge header to the call. The attributes object in the error may have the properties defined by the requiredIdentityChallenge schema.
https://production.api.apiture.com/errors/challengeBlocked/v1.0.0
The user has failed challenges too many times and is blocked from attempting more or performing operations which require additional authentication. Remediation: Have the user end their login session and login again.
https://production.api.apiture.com/errors/noIdentityChallengeFactors/v1.0.0
This operation requires an identity challenge, but the user does not have the necessary registered authentication factors. Remediation: Have the user register one or more challenge security code delivery factors.
https://production.api.apiture.com/errors/invalidIdentityChallengeHeader/v1.0.0
The additional on-time Challenge header in this request is expired, already used, or otherwise invalid. Remediation: Supply a valid, unexpired, unclaimed Challenge header in the request.

Schema: Inline

Status	Description
422	Unprocessable Entity
	Unprocessable Entity. The request body and/or query parameters were well formed but otherwise invalid.
	Schema: `problemResponse`

Status Description

429 Too Many Requests

Too Many Requests. The client has sent too many requests in a given amount of time.

This problem responsemay have one of the following type values:

https://production.api.apiture.com/errors/tooManyRequests/v1.0.0
The client has sent too many requests in a given amount of time, exceeding rate limiting. Remediation: Slow down the rate of API calls.

Schema: Inline

Status	Description
4XX	Unknown
	Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Status	Description
5XX	Unknown
	Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

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.

approveCreditRealTimePayments

Code samples

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

POST https://api.apiture.com/banking/creditRealTimePaymentApprovals HTTP/1.1
Host: api.apiture.com
Content-Type: application/json
Accept: application/json

const fetch = require('node-fetch');
const inputBody = '{
  "realTimePaymentIds": [
    "0399abed-fd3d",
    "d62c0701-0d74-4836-83f9-ebf3709442ea"
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/banking/creditRealTimePaymentApprovals',
{
  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',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.apiture.com/banking/creditRealTimePaymentApprovals',
  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',
  'Authorization' => 'Bearer {access-token}'
}

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

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

Approve Credit Real-Time Payments

POST https://api.apiture.com/banking/creditRealTimePaymentApprovals

Approve one or more credit real-time payments for processing.

The creditRealTimePayment.allows.approve property must be true on each payment for the current customer to approve the payment. This operation is only allowed if the payment is in a pendingApproval state and has no errors. This operation is idempotent: no changes are made to a payment if the customer has already approved it.

This adds the approver to the creditRealTimePayment.approvers list of each payment unless already listed. If all the required approvals have been given, the payment changes to the scheduled state to be processed.

This operation may successfully approve some payments and fail on others. This includes failures due to the customer's permissions (for example if a payment's allows.approve is false) or the state of one or more payments. Errors and problems are returned in the problems list in the corresponding payments in the response items. This operation may require an additional authentication challenge to verify the customer's identity.

The 200 response indicates a partial success and includes details on any failed approvals. The 204 response indicates that all of the credit real-time payments were successfully approved. The 422 response indicates that none of the credit real-time payments were successfully approved.

Body parameter

{
  "realTimePaymentIds": [
    "0399abed-fd3d",
    "d62c0701-0d74-4836-83f9-ebf3709442ea"
  ]
}

Parameters

Parameter	Description
`body`	`bulkCreditRealTimePaymentApprovalRequest` (required) Request data accompanying the action to approve the credit real-time payment.

Example responses

200 Response

[
  {
    "id": "0399abed-fd3d",
    "succeeded": false,
    "problems": [
      {
        "id": "3fbad566-be86-4b22-9ba6-3ca99fdc0799",
        "type": "https://production.api.apiture.com/errors/invalidRealTimePaymentId/v1.0.0",
        "title": "Credit Real-Time Payment Not Found",
        "status": 422,
        "occurredAt": "2022-04-25T12:42:21.375Z",
        "detail": "No real-time payment exists for the requested real-time payment ID",
        "instance": "https://production.api.apiture.com/banking/creditRealTimePayments/0399abed-fd3d"
      }
    ]
  },
  {
    "id": "d62c0701-0d74-4836-83f9-ebf3709442ea",
    "succeeded": true
  }
]

Responses

Status	Description
200	OK
	OK. The request was successfully processed. However, approving one or more credit real-time payments has failed; the response body indicates which succeeded and which failed. This response may have one of the following `type` values: `https://production.api.apiture.com/errors/invalidRealTimePaymentId/v1.0.0` The specified real-time payment ID is invalid or does not refer to an existing real-time payment. Remediation: Specify the ID of an existing real-time payment for which the user has access. `https://production.api.apiture.com/errors/invalidRealTimePaymentStateForApprove/v1.0.0` The approve operation is not allowed if the credit real-time payment `allows.approve` is `false`. Remediation: Resolve any problems in the credit real-time payment so that the payment `allows.approve` is `true`. `https://production.api.apiture.com/errors/invalidRealTimePaymentSourceAccount/v1.0.0` The chosen source account does not exist, is not accessible, or is not entitled for real-time payments. Remediation: Choose an existing source account with the correct entitlement for real-time payments. `https://production.api.apiture.com/errors/realTimePaymentLimitExceeded/v1.0.0` The credit real-time payment exceed a daily, transaction, or temporary limit. Remediation: Pass an amount for the credit real-time payment that does not exceed the daily, transaction, or temporary limit. `https://production.api.apiture.com/errors/invalidRealTimePaymentRecipientRoutingNumber/v1.0.0` The routing number for the recipient financial institution is invalid. Remediation: Use a valid routing number. `https://production.api.apiture.com/errors/invalidRealTimePaymentRecipientAccount/v1.0.0` The chosen recipient account does not exist, is not accessible, or is not entitled for real-time payments. Remediation: Choose an existing recipient account with the correct entitlement for real-time payments. `https://production.api.apiture.com/errors/institutionDoesNotSupportRealTimePayments/v1.0.0` The routing number is valid but the financial institution does not support real-time payments. Remediation: Use a routing number for a financial institution that does support real-time payments.
	Schema: `bulkCreditRealTimePaymentApprovalResponse`
204	No Content
	No Content. The operation succeeded but returned no response body.

Status Description

400 Bad Request

Bad Request. The request body, request headers, and/or query parameters are not well-formed.

This problem responsemay have one of the following type values:

https://production.api.apiture.com/errors/badRequest/v1.0.0
The request body and/or parameters was not well-formed. Remediation: Correct any syntax or schema errors in the request body or parameters.

Schema: Inline

Status Description

401 Unauthorized

Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given.

This problem responsemay have one of the following type values:

https://production.api.apiture.com/errors/unauthorized/v1.0.0
The request lacks valid authentication credentials for the target resource or operation. Remediation: Authenticate the user and pass the required authorization with the request.

Schema: Inline

Status Description

403 Forbidden

Forbidden. The authenticated caller is not authorized to perform the requested operation.

This problem responsemay have one of the following type values:

https://production.api.apiture.com/errors/forbidden/v1.0.0
The user or agent is not allowed to perform this operation; authentication credentials were provided in the request, but the server considers them insufficient to grant access. Remediation: Check the user's permissions and entitlements before attempting the operation.
https://production.api.apiture.com/errors/customerDisabled/v1.0.0
The customer is disabled. Remediation: Have the customer contact the financial institution for support.
https://production.api.apiture.com/errors/antiMalwareRequired/v1.0.0
The financial institution requires the customer to have anti-malware software installed. Remediation: Direct the user to the software requirements guide to install the correct anti-malware software.
https://production.api.apiture.com/errors/modificationForbidden/v1.0.0
The customer is properly authenticated but not authorized to create, modify, or delete resources. Remediation: Avoid modification operation for customers with read-only authorization.
https://production.api.apiture.com/errors/challengeRequired/v1.0.0
The operation requires the customer to complete an identity challenge. Remediation: Complete the challenge as per the problem response, and add an additional Challenge header to the call. The attributes object in the error may have the properties defined by the requiredIdentityChallenge schema.
https://production.api.apiture.com/errors/challengeBlocked/v1.0.0
The user has failed challenges too many times and is blocked from attempting more or performing operations which require additional authentication. Remediation: Have the user end their login session and login again.
https://production.api.apiture.com/errors/noIdentityChallengeFactors/v1.0.0
This operation requires an identity challenge, but the user does not have the necessary registered authentication factors. Remediation: Have the user register one or more challenge security code delivery factors.
https://production.api.apiture.com/errors/invalidIdentityChallengeHeader/v1.0.0
The additional on-time Challenge header in this request is expired, already used, or otherwise invalid. Remediation: Supply a valid, unexpired, unclaimed Challenge header in the request.

Schema: Inline

Status Description

422 Unprocessable Entity

Unprocessable Entity. The request body and/or query parameters were well formed but otherwise invalid.

This problem responsemay have one of the following type values:

https://production.api.apiture.com/errors/invalidRealTimePaymentIds/v1.0.0
All of the real-time payment IDs are invalid or do not refer to an existing real-time payment. Remediation: Specify the IDs of existing real-time payments for which the user has access.
https://production.api.apiture.com/errors/invalidRealTimePaymentsStateForApprove/v1.0.0
The approve operation is not allowed if the credit real-time payments allows.approve are false. Remediation: Resolve any problems in the credit real-time payments so that each payment allows.approve is true.
https://production.api.apiture.com/errors/invalidRealTimePaymentSourceAccounts/v1.0.0
The chosen source accounts do not exist, are not accessible, or are not entitled for real-time payments. Remediation: Choose existing source accounts with the correct entitlement for real-time payments.
https://production.api.apiture.com/errors/realTimePaymentsLimitExceeded/v1.0.0
The credit real-time payments exceed a daily, transaction, or temporary limit. Remediation: Pass an amount for each credit real-time payment that does not exceed the daily, transaction, or temporary limit.
https://production.api.apiture.com/errors/invalidRealTimePaymentRecipientRoutingNumbers/v1.0.0
The routing number for the recipient financial institution for each credit real-time payment is invalid. Remediation: Use a valid routing number for each credit real-time payment.
https://production.api.apiture.com/errors/invalidRealTimePaymentRecipientAccounts/v1.0.0
The chosen recipient accounts do not exist, are not accessible, or are not entitled for real-time payments. Remediation: Choose existing recipient accounts with the correct entitlement for real-time payments.
https://production.api.apiture.com/errors/institutionsDoNotSupportRealTimePayments/v1.0.0
The routing numbers are valid but the financial institutions do not support real-time payments. Remediation: Use routing numbers for financial institutions that support real-time payments.

Schema: problemResponse

Status Description

429 Too Many Requests

Too Many Requests. The client has sent too many requests in a given amount of time.

This problem responsemay have one of the following type values:

https://production.api.apiture.com/errors/tooManyRequests/v1.0.0
The client has sent too many requests in a given amount of time, exceeding rate limiting. Remediation: Slow down the rate of API calls.

Schema: Inline

Status	Description
4XX	Unknown
	Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Status	Description
5XX	Unknown
	Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

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.

rejectCreditRealTimePayments

Code samples

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

POST https://api.apiture.com/banking/rejectedCreditRealTimePayments HTTP/1.1
Host: api.apiture.com
Content-Type: application/json
Accept: application/json

const fetch = require('node-fetch');
const inputBody = '{
  "realTimePaymentIds": [
    "0399abed-fd3d",
    "d62c0701-0d74-4836-83f9-ebf3709442ea"
  ],
  "reason": "Rejection reason"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/banking/rejectedCreditRealTimePayments',
{
  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',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.apiture.com/banking/rejectedCreditRealTimePayments',
  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',
  'Authorization' => 'Bearer {access-token}'
}

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

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

Reject Credit Real-Time Payments

POST https://api.apiture.com/banking/rejectedCreditRealTimePayments

Reject one or more credit real-time payments.

The creditRealTimePayment.allows.reject property must be true on each payment for the current customer to reject the payment. If the creditRealTimePayment.allows.reject property is false for some but not all of the individual payments in the list, rejection for the individual payment will fail. The failure will be indicated with the response 400 invalidRealTimePaymentStateForReject in the response body, and the other payments in the request will still be processed. If the creditRealTimePayment.allows.reject property is false for all of the individual payments in the list, rejection for all the payments will fail with the response 422 invalidRealTimePaymentsStateForDelete.

Once rejected, each credit real-time payment transitions to the rejected state. This operation is idempotent: no changes are made if the payments are already in the rejected state.

The 200 response indicates a partial success and includes details on any failed rejections. The 204 response indicates that all of the credit real-time payments were successfully rejected. The 422 response indicates that none of the credit real-time payments were successfully rejected.

Body parameter

{
  "realTimePaymentIds": [
    "0399abed-fd3d",
    "d62c0701-0d74-4836-83f9-ebf3709442ea"
  ],
  "reason": "Rejection reason"
}

Parameters

Parameter	Description
`body`	`bulkCreditRealTimePaymentRejectionRequest` (required) Request containing the credit real-time payments to reject.

Example responses

200 Response

[
  {
    "id": "0399abed-fd3d",
    "succeeded": false,
    "problems": [
      {
        "id": "3fbad566-be86-4b22-9ba6-3ca99fdc0799",
        "type": "https://production.api.apiture.com/errors/invalidRealTimePaymentId/v1.0.0",
        "title": "Credit Real-Time Payment Not Found",
        "status": 422,
        "occurredAt": "2022-04-25T12:42:21.375Z",
        "detail": "No real-time payment exists for the requested real-time payment ID",
        "instance": "https://production.api.apiture.com/banking/creditRealTimePayments/0399abed-fd3d"
      }
    ]
  },
  {
    "id": "d62c0701-0d74-4836-83f9-ebf3709442ea",
    "succeeded": true
  }
]

Responses

Status	Description
200	OK
	OK. The request was successfully processed. However, rejecting one or more credit real-time payments has failed; the response body indicates which succeeded and which failed. This response may have one of the following `type` values: `https://production.api.apiture.com/errors/invalidRealTimePaymentId/v1.0.0` The specified real-time payment ID is invalid or does not refer to an existing real-time payment. Remediation: Specify the ID of an existing real-time payment for which the user has access. `https://production.api.apiture.com/errors/invalidRealTimePaymentStateForReject/v1.0.0` The reject operation is not allowed if the credit real-time payment `allows.reject` is `false`. Remediation: Resolve any problems in the credit real-time payment so that the payment `allows.reject` is `true`.
	Schema: `bulkCreditRealTimePaymentRejectionResponse`
204	No Content
	No Content. The operation succeeded but returned no response body.

Status Description

400 Bad Request

Bad Request. The request body, request headers, and/or query parameters are not well-formed.

This problem responsemay have one of the following type values:

https://production.api.apiture.com/errors/badRequest/v1.0.0
The request body and/or parameters was not well-formed. Remediation: Correct any syntax or schema errors in the request body or parameters.

Schema: Inline

Status Description

401 Unauthorized

Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given.

This problem responsemay have one of the following type values:

https://production.api.apiture.com/errors/unauthorized/v1.0.0
The request lacks valid authentication credentials for the target resource or operation. Remediation: Authenticate the user and pass the required authorization with the request.

Schema: Inline

Status Description

403 Forbidden

Forbidden. The authenticated caller is not authorized to perform the requested operation.

This problem responsemay have one of the following type values:

https://production.api.apiture.com/errors/forbidden/v1.0.0
The user or agent is not allowed to perform this operation; authentication credentials were provided in the request, but the server considers them insufficient to grant access. Remediation: Check the user's permissions and entitlements before attempting the operation.
https://production.api.apiture.com/errors/customerDisabled/v1.0.0
The customer is disabled. Remediation: Have the customer contact the financial institution for support.
https://production.api.apiture.com/errors/antiMalwareRequired/v1.0.0
The financial institution requires the customer to have anti-malware software installed. Remediation: Direct the user to the software requirements guide to install the correct anti-malware software.
https://production.api.apiture.com/errors/modificationForbidden/v1.0.0
The customer is properly authenticated but not authorized to create, modify, or delete resources. Remediation: Avoid modification operation for customers with read-only authorization.
https://production.api.apiture.com/errors/challengeRequired/v1.0.0
The operation requires the customer to complete an identity challenge. Remediation: Complete the challenge as per the problem response, and add an additional Challenge header to the call. The attributes object in the error may have the properties defined by the requiredIdentityChallenge schema.
https://production.api.apiture.com/errors/challengeBlocked/v1.0.0
The user has failed challenges too many times and is blocked from attempting more or performing operations which require additional authentication. Remediation: Have the user end their login session and login again.
https://production.api.apiture.com/errors/noIdentityChallengeFactors/v1.0.0
This operation requires an identity challenge, but the user does not have the necessary registered authentication factors. Remediation: Have the user register one or more challenge security code delivery factors.
https://production.api.apiture.com/errors/invalidIdentityChallengeHeader/v1.0.0
The additional on-time Challenge header in this request is expired, already used, or otherwise invalid. Remediation: Supply a valid, unexpired, unclaimed Challenge header in the request.

Schema: Inline

Status Description

422 Unprocessable Entity

Unprocessable Entity. The request body and/or query parameters were well formed but otherwise invalid.

This problem responsemay have one of the following type values:

https://production.api.apiture.com/errors/invalidRealTimePaymentIds/v1.0.0
All of the real-time payment IDs are invalid or do not refer to an existing real-time payment. Remediation: Specify the IDs of existing real-time payments for which the user has access.
https://production.api.apiture.com/errors/invalidRealTimePaymentsStateForReject/v1.0.0
The reject operation is not allowed if the credit real-time payments allows.reject are false. Remediation: Resolve any problems in the credit real-time payments so that each payment allows.reject is true.

Schema: problemResponse

Status Description

429 Too Many Requests

Too Many Requests. The client has sent too many requests in a given amount of time.

This problem responsemay have one of the following type values:

https://production.api.apiture.com/errors/tooManyRequests/v1.0.0
The client has sent too many requests in a given amount of time, exceeding rate limiting. Remediation: Slow down the rate of API calls.

Schema: Inline

Status	Description
4XX	Unknown
	Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Status	Description
5XX	Unknown
	Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

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.

Credit Real-Time Payment Recipients

Recipients for credit real-time payments

checkRecipientAccountEligibility

Code samples

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

POST https://api.apiture.com/banking/eligibleRecipientAccounts HTTP/1.1
Host: api.apiture.com
Content-Type: application/json
Accept: application/json

const fetch = require('node-fetch');
const inputBody = '{
  "customerId": "4242923b-714e",
  "recipientName": "Exquisite Creations Interior Design & Renovation Services",
  "fullAccountNumber": "123456789",
  "routingNumber": "123123123"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/banking/eligibleRecipientAccounts',
{
  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',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.apiture.com/banking/eligibleRecipientAccounts',
  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',
  'Authorization' => 'Bearer {access-token}'
}

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

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

Check eligibility of the recipient account for receiving credit real-time payments

POST https://api.apiture.com/banking/eligibleRecipientAccounts

Check whether the given recipient account is eligible to receive credit real-time payments. Factors that influence eligibility include the type of the account and whether the financial institution that holds the recipient account allows real-time payments.

Body parameter

{
  "customerId": "4242923b-714e",
  "recipientName": "Exquisite Creations Interior Design & Renovation Services",
  "fullAccountNumber": "123456789",
  "routingNumber": "123123123"
}

Parameters

Parameter	Description
`body`	`realTimePaymentRecipientAccountEligibilityRequest` (required) Data necessary to identify a recipient account.

Example responses

200 Response

{
  "eligible": true,
  "institutionName": "Bank of America",
  "problems": []
}

Responses

Status Description

200 OK

OK. The eligibility check succeeded. If the recipient account is not eligible to receive credit real-time payments, the response body will indicate the reason if this information is available.

This response may have one of the following type values:

https://production.api.apiture.com/errors/invalidRealTimePaymentRecipientRoutingNumber/v1.0.0
The routing number for the recipient financial institution is invalid. Remediation: Use a valid routing number.
https://production.api.apiture.com/errors/invalidRealTimePaymentRecipientAccount/v1.0.0
The chosen recipient account does not exist, is not accessible, or is not entitled for real-time payments. Remediation: Choose an existing recipient account with the correct entitlement for real-time payments.
https://production.api.apiture.com/errors/institutionDoesNotSupportRealTimePayments/v1.0.0
The routing number is valid but the financial institution does not support real-time payments. Remediation: Use a routing number for a financial institution that does support real-time payments.

Schema: realTimePaymentRecipientAccountEligibility

Status Description

400 Bad Request

Bad Request. The request body, request headers, and/or query parameters are not well-formed.

This problem responsemay have one of the following type values:

https://production.api.apiture.com/errors/badRequest/v1.0.0
The request body and/or parameters was not well-formed. Remediation: Correct any syntax or schema errors in the request body or parameters.

Schema: Inline

Status Description

401 Unauthorized

Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given.

This problem responsemay have one of the following type values:

https://production.api.apiture.com/errors/unauthorized/v1.0.0
The request lacks valid authentication credentials for the target resource or operation. Remediation: Authenticate the user and pass the required authorization with the request.

Schema: Inline

Status Description

403 Forbidden

Forbidden. The authenticated caller is not authorized to perform the requested operation.

This problem responsemay have one of the following type values:

https://production.api.apiture.com/errors/forbidden/v1.0.0
The user or agent is not allowed to perform this operation; authentication credentials were provided in the request, but the server considers them insufficient to grant access. Remediation: Check the user's permissions and entitlements before attempting the operation.
https://production.api.apiture.com/errors/customerDisabled/v1.0.0
The customer is disabled. Remediation: Have the customer contact the financial institution for support.
https://production.api.apiture.com/errors/antiMalwareRequired/v1.0.0
The financial institution requires the customer to have anti-malware software installed. Remediation: Direct the user to the software requirements guide to install the correct anti-malware software.
https://production.api.apiture.com/errors/modificationForbidden/v1.0.0
The customer is properly authenticated but not authorized to create, modify, or delete resources. Remediation: Avoid modification operation for customers with read-only authorization.
https://production.api.apiture.com/errors/challengeRequired/v1.0.0
The operation requires the customer to complete an identity challenge. Remediation: Complete the challenge as per the problem response, and add an additional Challenge header to the call. The attributes object in the error may have the properties defined by the requiredIdentityChallenge schema.
https://production.api.apiture.com/errors/challengeBlocked/v1.0.0
The user has failed challenges too many times and is blocked from attempting more or performing operations which require additional authentication. Remediation: Have the user end their login session and login again.
https://production.api.apiture.com/errors/noIdentityChallengeFactors/v1.0.0
This operation requires an identity challenge, but the user does not have the necessary registered authentication factors. Remediation: Have the user register one or more challenge security code delivery factors.
https://production.api.apiture.com/errors/invalidIdentityChallengeHeader/v1.0.0
The additional on-time Challenge header in this request is expired, already used, or otherwise invalid. Remediation: Supply a valid, unexpired, unclaimed Challenge header in the request.

Schema: Inline

Status Description

404 Not Found

Not found. There is no such resource at the request URL.

This problem responsemay have one of the following type values:

https://production.api.apiture.com/errors/notFound/v1.0.0
The resource at the requested URL does not exist. Remediation: Use the URL of an existing resource.

Schema: Inline

Status	Description
422	Unprocessable Entity
	Unprocessable Entity.
	Schema: `problemResponse`

Status Description

429 Too Many Requests

Too Many Requests. The client has sent too many requests in a given amount of time.

This problem responsemay have one of the following type values:

https://production.api.apiture.com/errors/tooManyRequests/v1.0.0
The client has sent too many requests in a given amount of time, exceeding rate limiting. Remediation: Slow down the rate of API calls.

Schema: Inline

Status	Description
4XX	Unknown
	Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Status	Description
5XX	Unknown
	Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

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.

listRealTimePaymentRecipients

Code samples

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

GET https://api.apiture.com/banking/realTimePaymentRecipients HTTP/1.1
Host: api.apiture.com
Accept: application/json

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

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

};

fetch('https://api.apiture.com/banking/realTimePaymentRecipients',
{
  method: 'GET',

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

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

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

Return a list of unique recipients

GET https://api.apiture.com/banking/realTimePaymentRecipients

Return a list of unique credit real-time payment recipients, limited to two hundred recipients. The payment's createdAt date-time descending is used to gather up to two hundred recipients by recency. The list is then sorted by the recipient's name ascending and then by the recipient's accountNumber ascending.

Parameters

Parameter	Description
`unmasked` `in: query`	`boolean` When requesting credit real-time payment recipients, `fullAccountNumber` is not included in the response by default, for security reasons. Include this query parameter with a value of `true` to request that the response body includes the `fullAccountNumber`. Such requests are auditable. `default: false`
`customerId` `in: query`	`resourceId` Restrict recipient resources based on the customer ID. This is the ID of the customer that created the real-time payment. `minLength: 6` `maxLength: 48` `pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"`

Example responses

200 Response

{
  "customerId": "4242923b-714e",
  "items": [
    {
      "name": "Billy Bob Jordan",
      "address": {
        "address1": "123 Maple Lane",
        "locality": "Jacksonville",
        "regionCode": "FL",
        "countryCode": "US",
        "postalCode": "33333"
      },
      "maskedAccountNumber": "*1111",
      "fullAccountNumber": "111111111",
      "institution": {
        "name": "Wells Fargo",
        "routingNumber": "222222222"
      }
    },
    {
      "name": "Exquisite Creations Interior Design & Renovation Services",
      "address": {
        "address1": "123 Hierarchy Lane",
        "locality": "Miami",
        "regionCode": "FL",
        "countryCode": "US",
        "postalCode": "12003"
      },
      "maskedAccountNumber": "*6789",
      "fullAccountNumber": "123456789",
      "institution": {
        "name": "Bank of America",
        "routingNumber": "123123123"
      }
    }
  ]
}

Responses

Status	Description
200	OK
	OK. A list of the most recent unique recipients.
	Schema: `realTimePaymentRecipients`

Status Description

401 Unauthorized

Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given.

This problem responsemay have one of the following type values:

https://production.api.apiture.com/errors/unauthorized/v1.0.0
The request lacks valid authentication credentials for the target resource or operation. Remediation: Authenticate the user and pass the required authorization with the request.

Schema: Inline

Status Description

403 Forbidden

Forbidden. The authenticated caller is not authorized to perform the requested operation.

This problem responsemay have one of the following type values:

https://production.api.apiture.com/errors/forbidden/v1.0.0
The user or agent is not allowed to perform this operation; authentication credentials were provided in the request, but the server considers them insufficient to grant access. Remediation: Check the user's permissions and entitlements before attempting the operation.
https://production.api.apiture.com/errors/customerDisabled/v1.0.0
The customer is disabled. Remediation: Have the customer contact the financial institution for support.
https://production.api.apiture.com/errors/antiMalwareRequired/v1.0.0
The financial institution requires the customer to have anti-malware software installed. Remediation: Direct the user to the software requirements guide to install the correct anti-malware software.
https://production.api.apiture.com/errors/modificationForbidden/v1.0.0
The customer is properly authenticated but not authorized to create, modify, or delete resources. Remediation: Avoid modification operation for customers with read-only authorization.
https://production.api.apiture.com/errors/challengeRequired/v1.0.0
The operation requires the customer to complete an identity challenge. Remediation: Complete the challenge as per the problem response, and add an additional Challenge header to the call. The attributes object in the error may have the properties defined by the requiredIdentityChallenge schema.
https://production.api.apiture.com/errors/challengeBlocked/v1.0.0
The user has failed challenges too many times and is blocked from attempting more or performing operations which require additional authentication. Remediation: Have the user end their login session and login again.
https://production.api.apiture.com/errors/noIdentityChallengeFactors/v1.0.0
This operation requires an identity challenge, but the user does not have the necessary registered authentication factors. Remediation: Have the user register one or more challenge security code delivery factors.
https://production.api.apiture.com/errors/invalidIdentityChallengeHeader/v1.0.0
The additional on-time Challenge header in this request is expired, already used, or otherwise invalid. Remediation: Supply a valid, unexpired, unclaimed Challenge header in the request.

Schema: Inline

Status Description

429 Too Many Requests

Too Many Requests. The client has sent too many requests in a given amount of time.

This problem responsemay have one of the following type values:

https://production.api.apiture.com/errors/tooManyRequests/v1.0.0
The client has sent too many requests in a given amount of time, exceeding rate limiting. Remediation: Slow down the rate of API calls.

Schema: Inline

Status	Description
4XX	Unknown
	Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Status	Description
5XX	Unknown
	Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Response Schema

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.

listRecentRealTimePaymentRecipients

Code samples

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

GET https://api.apiture.com/banking/recentRealTimePaymentRecipients HTTP/1.1
Host: api.apiture.com
Accept: application/json

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

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

};

fetch('https://api.apiture.com/banking/recentRealTimePaymentRecipients',
{
  method: 'GET',

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

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

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

Return a list of the most recent unique recipients

GET https://api.apiture.com/banking/recentRealTimePaymentRecipients

Return a list of the most recent unique credit real-time payment recipients, limited to five recipients.

Parameters

Parameter	Description
`unmasked` `in: query`	`boolean` When requesting credit real-time payment recipients, `fullAccountNumber` is not included in the response by default, for security reasons. Include this query parameter with a value of `true` to request that the response body includes the `fullAccountNumber`. Such requests are auditable. `default: false`
`customerId` `in: query`	`resourceId` Restrict recipient resources based on the customer ID. This is the ID of the customer that created the real-time payment. `minLength: 6` `maxLength: 48` `pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"`

Example responses

200 Response

{
  "customerId": "4242923b-714e",
  "items": [
    {
      "name": "Exquisite Creations Interior Design & Renovation Services",
      "address": {
        "address1": "123 Hierarchy Lane",
        "locality": "Miami",
        "regionCode": "FL",
        "countryCode": "US",
        "postalCode": "12003"
      },
      "maskedAccountNumber": "*6789",
      "fullAccountNumber": "123456789",
      "institution": {
        "name": "Bank of America",
        "routingNumber": "123123123"
      }
    },
    {
      "name": "Billy Bob Jordan",
      "address": {
        "address1": "123 Maple Lane",
        "locality": "Jacksonville",
        "regionCode": "FL",
        "countryCode": "US",
        "postalCode": "33333"
      },
      "maskedAccountNumber": "*1111",
      "fullAccountNumber": "111111111",
      "institution": {
        "name": "Wells Fargo",
        "routingNumber": "222222222"
      }
    }
  ]
}

Responses

Status	Description
200	OK
	OK. A list of the most recent unique recipients.
	Schema: `recentRealTimePaymentRecipients`

Status Description

401 Unauthorized

Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given.

This problem responsemay have one of the following type values:

https://production.api.apiture.com/errors/unauthorized/v1.0.0
The request lacks valid authentication credentials for the target resource or operation. Remediation: Authenticate the user and pass the required authorization with the request.

Schema: Inline

Status Description

403 Forbidden

Forbidden. The authenticated caller is not authorized to perform the requested operation.

This problem responsemay have one of the following type values:

https://production.api.apiture.com/errors/forbidden/v1.0.0
The user or agent is not allowed to perform this operation; authentication credentials were provided in the request, but the server considers them insufficient to grant access. Remediation: Check the user's permissions and entitlements before attempting the operation.
https://production.api.apiture.com/errors/customerDisabled/v1.0.0
The customer is disabled. Remediation: Have the customer contact the financial institution for support.
https://production.api.apiture.com/errors/antiMalwareRequired/v1.0.0
The financial institution requires the customer to have anti-malware software installed. Remediation: Direct the user to the software requirements guide to install the correct anti-malware software.
https://production.api.apiture.com/errors/modificationForbidden/v1.0.0
The customer is properly authenticated but not authorized to create, modify, or delete resources. Remediation: Avoid modification operation for customers with read-only authorization.
https://production.api.apiture.com/errors/challengeRequired/v1.0.0
The operation requires the customer to complete an identity challenge. Remediation: Complete the challenge as per the problem response, and add an additional Challenge header to the call. The attributes object in the error may have the properties defined by the requiredIdentityChallenge schema.
https://production.api.apiture.com/errors/challengeBlocked/v1.0.0
The user has failed challenges too many times and is blocked from attempting more or performing operations which require additional authentication. Remediation: Have the user end their login session and login again.
https://production.api.apiture.com/errors/noIdentityChallengeFactors/v1.0.0
This operation requires an identity challenge, but the user does not have the necessary registered authentication factors. Remediation: Have the user register one or more challenge security code delivery factors.
https://production.api.apiture.com/errors/invalidIdentityChallengeHeader/v1.0.0
The additional on-time Challenge header in this request is expired, already used, or otherwise invalid. Remediation: Supply a valid, unexpired, unclaimed Challenge header in the request.

Schema: Inline

Status Description

429 Too Many Requests

Too Many Requests. The client has sent too many requests in a given amount of time.

This problem responsemay have one of the following type values:

https://production.api.apiture.com/errors/tooManyRequests/v1.0.0
The client has sent too many requests in a given amount of time, exceeding rate limiting. Remediation: Slow down the rate of API calls.

Schema: Inline

Status	Description
4XX	Unknown
	Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Status	Description
5XX	Unknown
	Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Response Schema

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.

Real-Time Payment History Records

History records for real-time payments

listRealTimePaymentHistoryRecords

Code samples

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

GET https://api.apiture.com/banking/realTimePayments/{realTimePaymentId}/realTimePaymentHistoryRecords HTTP/1.1
Host: api.apiture.com
Accept: application/json

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

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

};

fetch('https://api.apiture.com/banking/realTimePayments/{realTimePaymentId}/realTimePaymentHistoryRecords',
{
  method: 'GET',

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

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

};

$.ajax({
  url: 'https://api.apiture.com/banking/realTimePayments/{realTimePaymentId}/realTimePaymentHistoryRecords',
  method: 'get',

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

require 'rest-client'
require 'json'

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

result = RestClient.get 'https://api.apiture.com/banking/realTimePayments/{realTimePaymentId}/realTimePaymentHistoryRecords',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.get('https://api.apiture.com/banking/realTimePayments/{realTimePaymentId}/realTimePaymentHistoryRecords', params={

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

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

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

Return real-time payment history records

GET https://api.apiture.com/banking/realTimePayments/{realTimePaymentId}/realTimePaymentHistoryRecords

Return a list of history records for this real-time payment. The result is ordered in reverse chronological order based on the occurredAt date of the history records.

Parameters

Parameter	Description
`realTimePaymentId` `in: path`	`externalResourceId` (required) The unique identifier of this real-time payment. This is an opaque string. This value corresponds to the `id` of a real-time payment resource. `read-only` `format: text` `minLength: 1` `maxLength: 256`

Example responses

200 Response

{
  "items": [
    {
      "type": "approved",
      "customerId": "b9815cc6-85a7",
      "customerName": "Alex Frank",
      "occurredAt": "2022-07-29T04:18:49.375Z"
    },
    {
      "type": "requestedApproval",
      "customerId": "4242923b-714e",
      "customerName": "Karl Knox",
      "occurredAt": "2022-07-28T12:54:30.000Z"
    },
    {
      "type": "updated",
      "customerId": "4242923b-714e",
      "customerName": "Karl Knox",
      "occurredAt": "2022-07-28T12:49:22.000Z",
      "updateType": "amountUpdated"
    },
    {
      "type": "created",
      "customerId": "4242923b-714e",
      "customerName": "Karl Knox",
      "occurredAt": "2022-07-28T12:44:46.375Z"
    }
  ]
}

Responses

Status	Description
200	OK
	OK.
	Schema: `realTimePaymentHistoryRecords`

Status Description

400 Bad Request

Bad Request. The request body, request headers, and/or query parameters are not well-formed.

This problem responsemay have one of the following type values:

https://production.api.apiture.com/errors/badRequest/v1.0.0
The request body and/or parameters was not well-formed. Remediation: Correct any syntax or schema errors in the request body or parameters.

Schema: Inline

Status Description

401 Unauthorized

Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given.

This problem responsemay have one of the following type values:

https://production.api.apiture.com/errors/unauthorized/v1.0.0
The request lacks valid authentication credentials for the target resource or operation. Remediation: Authenticate the user and pass the required authorization with the request.

Schema: Inline

Status Description

403 Forbidden

Forbidden. The authenticated caller is not authorized to perform the requested operation.

This problem responsemay have one of the following type values:

https://production.api.apiture.com/errors/forbidden/v1.0.0
The user or agent is not allowed to perform this operation; authentication credentials were provided in the request, but the server considers them insufficient to grant access. Remediation: Check the user's permissions and entitlements before attempting the operation.
https://production.api.apiture.com/errors/customerDisabled/v1.0.0
The customer is disabled. Remediation: Have the customer contact the financial institution for support.
https://production.api.apiture.com/errors/antiMalwareRequired/v1.0.0
The financial institution requires the customer to have anti-malware software installed. Remediation: Direct the user to the software requirements guide to install the correct anti-malware software.
https://production.api.apiture.com/errors/modificationForbidden/v1.0.0
The customer is properly authenticated but not authorized to create, modify, or delete resources. Remediation: Avoid modification operation for customers with read-only authorization.
https://production.api.apiture.com/errors/challengeRequired/v1.0.0
The operation requires the customer to complete an identity challenge. Remediation: Complete the challenge as per the problem response, and add an additional Challenge header to the call. The attributes object in the error may have the properties defined by the requiredIdentityChallenge schema.
https://production.api.apiture.com/errors/challengeBlocked/v1.0.0
The user has failed challenges too many times and is blocked from attempting more or performing operations which require additional authentication. Remediation: Have the user end their login session and login again.
https://production.api.apiture.com/errors/noIdentityChallengeFactors/v1.0.0
This operation requires an identity challenge, but the user does not have the necessary registered authentication factors. Remediation: Have the user register one or more challenge security code delivery factors.
https://production.api.apiture.com/errors/invalidIdentityChallengeHeader/v1.0.0
The additional on-time Challenge header in this request is expired, already used, or otherwise invalid. Remediation: Supply a valid, unexpired, unclaimed Challenge header in the request.

Schema: Inline

Status	Description
404	Not Found
	Not Found. There is no such real-time payment resource at the specified `{realTimePaymentId}`.
	Schema: `problemResponse`

Status Description

422 Unprocessable Entity

Unprocessable Entity. The request body and/or query parameters were well-formed but otherwise invalid.

This problem responsemay have one of the following type values:

https://production.api.apiture.com/errors/unprocessableEntity/v1.0.0
The syntax of the request entity is correct but was unable to process the contained instructions. Remediation: Provide a semantically correct request.

Schema: Inline

Status Description

429 Too Many Requests

Too Many Requests. The client has sent too many requests in a given amount of time.

This problem responsemay have one of the following type values:

https://production.api.apiture.com/errors/tooManyRequests/v1.0.0
The client has sent too many requests in a given amount of time, exceeding rate limiting. Remediation: Slow down the rate of API calls.

Schema: Inline

Status	Description
4XX	Unknown
	Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Status	Description
5XX	Unknown
	Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

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 422

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

accountLabel

"Checking *1008"

Account Label (v1.0.0)

The human-readable label for this account. This is either the nickname (if assigned for the current customer), or the product.label concatenated with the maskedNumber.

type: string(text)

format: text
minLength: 1
maxLength: 80

accountNickname

"Payroll Checking"

Account Nickname (v1.2.0)

The nickname (friendly name) the customer has given this account. Each customer can define their own nickname for the same account. If omitted, the customer has not set a nickname.

type: string(text)

format: text
maxLength: 50

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}$"

amountRange

"[1000.00,1200.00)"

Amount Range (v1.2.2)

A monetary amount range, supporting inclusive or exclusive endpoints. The value may have the following forms:

1200.50 match the dollar amount 1,200.50 exactly
[1000.00,1200.00) matches items where 1000.00 <= amount < 1200.00
[1000.00,1199.99] matches items where 1000.00 <= amount <= 1199.99
(999.99,1200.00) matches items where 999.99 < amount < 1200.00
[1200.50,] matches items where amount >= 1200.50
(1200.50,) matches items where amount > 1200.50
[,1200.50] matches items where amount <= 1200.50
(,1200.50) matches items where amount < 1200.50

type: string

minLength: 1
maxLength: 30
pattern: "^((\d+(\.\d{0,2})?)|([\[$](((\d+(\.\d{0,2})?),((\d+(\.\d{0,2})?))?)|(,(\d+(\.\d{0,2})?)))[\]$]))$"

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`

bankingAccountIdSelection

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

Account ID Selection (v1.1.0)

A comma-separated list of unique opaque account IDs. Each value is the id of a resource in the Accounts API. The list is limited to 32 account IDs.

bankingAccountIdSelection is an array schema.

Array Elements

type: array: [resourceId]

unique items
minItems: 1
maxItems: 32

bulkCreditRealTimePaymentApprovalRequest

{
  "realTimePaymentIds": [
    "0399abed-fd3d",
    "d62c0701-0d74-4836-83f9-ebf3709442ea"
  ]
}

Bulk Credit Real-Time Payment Approval Request (v1.0.0)

A request to approve a set of credit real-time payments.

Properties

Name	Description
`Bulk Credit Real-Time Payment Approval Request (v1.0.0)`	`object` A request to approve a set of credit real-time payments.
`realTimePaymentIds`	`array: [resourceId]` (required) A list of real-time payment IDs to apply an operation to. `minItems: 1` `maxItems: 100` items: `string` » `minLength: 6` » `maxLength: 48` » `pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"`

bulkCreditRealTimePaymentApprovalResponse

[
  {
    "id": "0399abed-fd3d",
    "succeeded": false,
    "problems": [
      {
        "id": "3fbad566-be86-4b22-9ba6-3ca99fdc0799",
        "type": "https://production.api.apiture.com/errors/invalidRealTimePaymentId/v1.0.0",
        "title": "Credit Real-Time Payment Not Found",
        "status": 422,
        "occurredAt": "2022-04-25T12:42:21.375Z",
        "detail": "No real-time payment exists for the requested real-time payment ID",
        "instance": "https://production.api.apiture.com/banking/creditRealTimePayments/0399abed-fd3d"
      }
    ]
  },
  {
    "id": "d62c0701-0d74-4836-83f9-ebf3709442ea",
    "succeeded": true
  }
]

Bulk Credit Real-Time Payment Approval Response (v1.0.0)

Response from the request to approve a set of credit real-time payments.

Properties

Name	Description
`Bulk Credit Real-Time Payment Approval Response (v1.0.0)`	`object` Response from the request to approve a set of credit real-time payments.
`items`	`array: [allOf]` (required) The result of attempting to perform an action on a set of real-time payments in the request. Items in the array correspond (in order) to each real-time payment in the request. `minItems: 1` `maxItems: 100` items:
`» Bulk Real-Time Payment Operation Response Item (v1.0.0)`	`bulkRealTimePaymentOperationResponseItem` The result of attempting to perform an action on one real-time payment from the list of real-time payments in the request.

bulkCreditRealTimePaymentApproverList

{
  "creditRealTimePaymentId": "071db898-b220",
  "groupId": "group-01",
  "approvers": [
    {
      "name": "Tom Allison",
      "id": "327d8bea-2553",
      "identification": "to...58@wellsroofing.com"
    },
    {
      "name": "Carl Thompson",
      "id": "d7da1cc5-8056",
      "identification": "ca...39@wellsroofing.com"
    }
  ]
}

Bulk Credit Real-Time Payment and Approvers (v1.0.0)

A credit real-time payment and a list of customers who are eligible to approve the payment. This may include problems encountered while building a list of eligible customers.

Properties

Name	Description
`Bulk Credit Real-Time Payment and Approvers (v1.0.0)`	`object` A credit real-time payment and a list of customers who are eligible to approve the payment. This may include problems encountered while building a list of eligible customers.
`creditRealTimePaymentId`	`resourceId` (required) The resource ID of the credit real-time payment. `minLength: 6` `maxLength: 48` `pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"`
`groupId`	`string` An opaque string which identifies similar lists of approvers. All items with the same `groupId` have the same set of approvers. `minLength: 1` `maxLength: 16` `pattern: "^[-_:.~$a-zA-Z0-9]+$"`
`approvers`	`array: [creditRealTimePaymentApprover]` (required) The list of eligible approvers. This can be empty if no eligible approvers were found, and the `problems` array will describe why. `minItems: 0` `maxItems: 1000` items: `object`
`problems`	`array: [creditRealTimePaymentProblem]` If there was a problem building a list of eligible approvers for the credit real-time payment, this describes why. For example, this may happen if the payment is in the incorrect state for approval (i.e. not `pendingApproval`), or if there are no eligible approvers configured. `minItems: 0` `maxItems: 100` items: `object`

bulkCreditRealTimePaymentApprovers

{
  "items": [
    {
      "creditRealTimePaymentId": "8ea05bfc-0e9c",
      "groupId": "group-00",
      "approvers": [
        {
          "name": "Tom Allison",
          "id": "327d8bea-2553",
          "identification": "to...58@wellsroofing.com"
        },
        {
          "name": "Silvia Wilkenson",
          "id": "06cf8996-d093",
          "identification": "si...42@wellsroofing.com"
        }
      ]
    },
    {
      "creditRealTimePaymentId": "071db898-b220",
      "groupId": "group-01",
      "approvers": [
        {
          "name": "Tom Allison",
          "id": "327d8bea-2553",
          "identification": "to...58@wellsroofing.com"
        },
        {
          "name": "Carl Thompson",
          "id": "d7da1cc5-8056",
          "identification": "ca...39@wellsroofing.com"
        }
      ]
    }
  ]
}

Bulk Credit Real-Time Payment Approvers (v1.0.0)

A list of credit real-time payments and the customers who are eligible to approve each of those credit real-time payments.

Properties

Name	Description
`Bulk Credit Real-Time Payment Approvers (v1.0.0)`	`object` A list of credit real-time payments and the customers who are eligible to approve each of those credit real-time payments.
`items`	`array: [bulkCreditRealTimePaymentApproverList]` (required) The list of credit real-time payments and list of customers eligible to approve the payment. `minItems: 1` `maxItems: 100` items: `object`

bulkCreditRealTimePaymentApproversRequest

{
  "items": [
    {
      "creditRealTimePaymentId": "d366bc49-49a7",
      "groupId": "group-00",
      "approvers": [
        {
          "name": "Tom Allison",
          "id": "327d8bea-2553",
          "identification": "to...58@wellsroofing.com"
        },
        {
          "name": "Silvia Wilkenson",
          "id": "06cf8996-d093",
          "identification": "si...42@wellsroofing.com"
        }
      ]
    },
    {
      "creditRealTimePaymentId": "8ea05bfc-0e9c",
      "groupId": "group-00",
      "approvers": [
        {
          "name": "Tom Allison",
          "id": "327d8bea-2553",
          "identification": "to...58@wellsroofing.com"
        },
        {
          "name": "Silvia Wilkenson",
          "id": "06cf8996-d093",
          "identification": "si...42@wellsroofing.com"
        }
      ]
    },
    {
      "creditRealTimePaymentId": "071db898-b220",
      "groupId": "group-01",
      "approvers": [
        {
          "name": "Tom Allison",
          "id": "327d8bea-2553",
          "identification": "to...58@wellsroofing.com"
        },
        {
          "name": "Carl Thompson",
          "id": "d7da1cc5-8056",
          "identification": "ca...39@wellsroofing.com"
        }
      ]
    }
  ]
}

Bulk Credit Real-Time Payment Approvers Request (v1.0.0)

A request to add approvers to a list of credit real-time payments.

Properties

Name	Description
`Bulk Credit Real-Time Payment Approvers Request (v1.0.0)`	`object` A request to add approvers to a list of credit real-time payments.
`items`	`array: [creditRealTimePaymentApproverList]` (required) The list of credit real-time payments and list of customers eligible to approve the payment. `minItems: 1` `maxItems: 1000` items: `object`
`approverLists`	`array: [creditRealTimePaymentApprovers]` A list of credit real-time payments and corresponding approvers. `minItems: 1` `maxItems: 1000` items: `object`

bulkCreditRealTimePaymentDeletionRequest

{
  "realTimePaymentIds": [
    "0399abed-fd3d",
    "d62c0701-0d74-4836-83f9-ebf3709442ea"
  ]
}

Bulk Credit Real-Time Payment Deletion Request (v2.0.0)

A request to delete a set of credit real-time payments.

Properties

Name	Description
`Bulk Credit Real-Time Payment Deletion Request (v2.0.0)`	`object` A request to delete a set of credit real-time payments.
`realTimePaymentIds`	`array: [resourceId]` (required) A list of real-time payment IDs to apply an operation to. `minItems: 1` `maxItems: 100` items: `string` » `minLength: 6` » `maxLength: 48` » `pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"`

bulkCreditRealTimePaymentDeletionResponse

[
  {
    "id": "0399abed-fd3d",
    "succeeded": false,
    "problems": [
      {
        "id": "3fbad566-be86-4b22-9ba6-3ca99fdc0799",
        "type": "https://production.api.apiture.com/errors/invalidRealTimePaymentId/v1.0.0",
        "title": "Credit Real-Time Payment Not Found",
        "status": 422,
        "occurredAt": "2022-04-25T12:42:21.375Z",
        "detail": "No real-time payment exists for the requested real-time payment ID",
        "instance": "https://production.api.apiture.com/banking/creditRealTimePayments/0399abed-fd3d"
      }
    ]
  },
  {
    "id": "d62c0701-0d74-4836-83f9-ebf3709442ea",
    "succeeded": true
  }
]

Bulk Credit Real-Time Payment Deletion Response (v2.0.0)

Response from the request to delete a set of credit real-time payments.

Properties

Name	Description
`Bulk Credit Real-Time Payment Deletion Response (v2.0.0)`	`object` Response from the request to delete a set of credit real-time payments.
`items`	`array: [allOf]` (required) The result of attempting to perform an action on a set of real-time payments in the request. Items in the array correspond (in order) to each real-time payment in the request. `minItems: 1` `maxItems: 100` items:
`» Bulk Real-Time Payment Operation Response Item (v1.0.0)`	`bulkRealTimePaymentOperationResponseItem` The result of attempting to perform an action on one real-time payment from the list of real-time payments in the request.

bulkCreditRealTimePaymentRejectionRequest

{
  "realTimePaymentIds": [
    "0399abed-fd3d",
    "d62c0701-0d74-4836-83f9-ebf3709442ea"
  ],
  "reason": "Rejection reason"
}

Bulk Credit Real-Time Payment Rejection Request (v3.0.0)

A request to reject a set of credit real-time payments.

Properties

Name	Description
`Bulk Credit Real-Time Payment Rejection Request (v3.0.0)`	`object` A request to reject a set of credit real-time payments.
`realTimePaymentIds`	`array: [resourceId]` (required) A list of real-time payment IDs to apply an operation to. `minItems: 1` `maxItems: 100` items: `string` » `minLength: 6` » `maxLength: 48` » `pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"`
`reason`	`string(text)` (required) The reason for rejecting the credit real-time payment during review. `format: text` `minLength: 1` `maxLength: 80`

bulkCreditRealTimePaymentRejectionResponse

[
  {
    "id": "0399abed-fd3d",
    "succeeded": false,
    "problems": [
      {
        "id": "3fbad566-be86-4b22-9ba6-3ca99fdc0799",
        "type": "https://production.api.apiture.com/errors/invalidRealTimePaymentId/v1.0.0",
        "title": "Credit Real-Time Payment Not Found",
        "status": 422,
        "occurredAt": "2022-04-25T12:42:21.375Z",
        "detail": "No real-time payment exists for the requested real-time payment ID",
        "instance": "https://production.api.apiture.com/banking/creditRealTimePayments/0399abed-fd3d"
      }
    ]
  },
  {
    "id": "d62c0701-0d74-4836-83f9-ebf3709442ea",
    "succeeded": true
  }
]

Bulk Credit Real-Time Payment Rejection Response (v1.0.0)

Response from the request to reject a set of credit real-time payments.

Properties

Name	Description
`Bulk Credit Real-Time Payment Rejection Response (v1.0.0)`	`object` Response from the request to reject a set of credit real-time payments.
`items`	`array: [allOf]` (required) The result of attempting to perform an action on a set of real-time payments in the request. Items in the array correspond (in order) to each real-time payment in the request. `minItems: 1` `maxItems: 100` items:
`» Bulk Real-Time Payment Operation Response Item (v1.0.0)`	`bulkRealTimePaymentOperationResponseItem` The result of attempting to perform an action on one real-time payment from the list of real-time payments in the request.

bulkEligibleCreditRealTimePaymentApprovers

{
  "items": [
    {
      "creditRealTimePaymentId": "d366bc49-49a7",
      "groupId": "group-00",
      "approvers": [
        {
          "name": "Tom Allison",
          "id": "327d8bea-2553",
          "identification": "to...58@wellsroofing.com"
        },
        {
          "name": "Silvia Wilkenson",
          "id": "06cf8996-d093",
          "identification": "si...42@wellsroofing.com"
        }
      ]
    },
    {
      "creditRealTimePaymentId": "8ea05bfc-0e9c",
      "groupId": "group-00",
      "approvers": [
        {
          "name": "Tom Allison",
          "id": "327d8bea-2553",
          "identification": "to...58@wellsroofing.com"
        },
        {
          "name": "Silvia Wilkenson",
          "id": "06cf8996-d093",
          "identification": "si...42@wellsroofing.com"
        }
      ]
    },
    {
      "creditRealTimePaymentId": "071db898-b220",
      "groupId": "group-01",
      "approvers": [
        {
          "name": "Tom Allison",
          "id": "327d8bea-2553",
          "identification": "to...58@wellsroofing.com"
        },
        {
          "name": "Carl Thompson",
          "id": "d7da1cc5-8056",
          "identification": "ca...39@wellsroofing.com"
        }
      ]
    }
  ]
}

Bulk Eligible Credit Real-Time Payment Approvers (v1.0.0)

A list of customers eligible to approve one or more credit real-time payments. In the example, items[0] and items[1] both have the same groupId value, indicating that those two payments have the same list of approvers, while the approver list for the third payment (items[2]) differs.

Properties

Name	Description
`Bulk Eligible Credit Real-Time Payment Approvers (v1.0.0)`	`object` A list of customers eligible to approve one or more credit real-time payments. In the example, `items[0]` and `items[1]` both have the same `groupId` value, indicating that those two payments have the same list of approvers, while the approver list for the third payment (`items[2]`) differs.
`items`	`array: [bulkCreditRealTimePaymentApproverList]` (required) The list of credit real-time payments and list of customers eligible to approve the payment. `minItems: 1` `maxItems: 100` items: `object`

bulkRealTimePaymentOperationResponseItem

{
  "id": "0399abed-fd3d",
  "succeeded": false,
  "problems": [
    {
      "id": "3fbad566-be86-4b22-9ba6-3ca99fdc0799",
      "type": "https://production.api.apiture.com/errors/accountNotFound/v1.0.0",
      "title": "Credit Real-Time Payment Not Found",
      "status": 422,
      "occurredAt": "2022-04-25T12:42:21.375Z",
      "detail": "No real-time payment exists for the requested real-time payment ID",
      "instance": "https://production.api.apiture.com/banking/transfers/bb709151-575041fcd617"
    }
  ]
}

Bulk Real-Time Payment Operation Response Item (v1.0.0)

An item in a bulk real-time payment operation response.

Properties

Name	Description
`Bulk Real-Time Payment Operation Response Item (v1.0.0)`	`object` An item in a bulk real-time payment operation response.
`id`	`readOnlyResourceId` (required) The real-time payment ID. `read-only` `minLength: 6` `maxLength: 48` `pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"`
`succeeded`	`boolean` (required) `true` if the operation was successful for the real-time payment.
`problems`	`array: [apiProblem]` If the operation for this real-time payment failed (`succeeded` is `false`), this describes why. This may include forbidden, conflict, or other 4xx error or problem types that can occur with individual real-time payment operation calls. `maxItems: 100` items: `object`

challengeFactor

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

Challenge Factor (v1.2.1)

A challenge factor. See requiredIdentityChallenge for multiple examples.

Properties

Name Description

Challenge Factor (v1.2.1) object
A challenge factor. See requiredIdentityChallenge for multiple examples.

id

challengeFactorId
The ID of an a challenge factor. This ID is unique within the challenge factors associated with a challenge. The client should pass this id value as the factorId when starting or verifying a challenge factor.

Note: The id will become required in a future update to this schema.
minLength: 3
maxLength: 48
pattern: "^[-a-zA-Z0-9$_]{3,48}$"

type

challengeFactorType (required)

The name of challenge factor.

challengeFactorType strings may have one of the following enumerated values:

Value	Description
`sms`	SMS: One-time passcode sent to the primary mobile phone number
`email`	Email: One-time passcode sent to the primary email address
`voice`	Voice: One-time passcode communicated via automated voice phone call
`authenticatorToken`	authenticator Token: One-time passcode issued by a pre-registered hardware device, such as a token key fob, or an authenticator app
`securityQuestions`	Security Questions: Prompt with the user's security questions registered with their security profile

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

labels array: [string]
A list of text label which identifies the channel(s) through which the user completes the challenge. For an sms or voice challenge, the only label item is the last four digits of the corresponding phone number. For an email challenge, each label is the masked email address.
minItems: 1
maxItems: 4
items: string(text)
» format: text
» maxLength: 300

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

challengeFactorId

"string"

Challenge Factor ID (v1.0.0)

The ID of an a challenge factor. This ID is unique within the factors offered with a challenge.

type: string

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

challengeFactorType

"sms"

Challenge Factor Type (v1.0.0)

The name of challenge factor.

challengeFactorType strings may have one of the following enumerated values:

Value	Description
`sms`	SMS: One-time passcode sent to the primary mobile phone number
`email`	Email: One-time passcode sent to the primary email address
`voice`	Voice: One-time passcode communicated via automated voice phone call
`authenticatorToken`	authenticator Token: One-time passcode issued by a pre-registered hardware device, such as a token key fob, or an authenticator app
`securityQuestions`	Security Questions: Prompt with the user's security questions registered with their security profile

type: string

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

challengeOperationId

"string"

Challenge Operation ID (v1.0.1)

The ID of an operation/action for which the user must verify their identity via an identity challenge. This is passed when starting a challenge factor or when validating the identity challenge responses.

type: string

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

challengePromptId

"string"

Challenge Prompt ID (v1.0.0)

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

type: string

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

challengeSecurityQuestion

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

Challenge Security Question (v1.0.1)

A single security question within the questions array of the challengeSecurityQuestions

Properties

Name	Description
`Challenge Security Question (v1.0.1)`	`object` A single security question within the `questions` array of the `challengeSecurityQuestions`
`id`	`challengePromptId` (required) The unique ID of security question prompt. This should be included in the `challengeVerification` response as the `promptId`. `minLength: 1` `maxLength: 48` `pattern: "^[-_:.~$a-zA-Z0-9]+$"`
`prompt`	`string(text)` (required) The text prompt of this security question. `format: text` `maxLength: 80`

challengeSecurityQuestions

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

Challenge Security Questions (v1.0.1)

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

Properties

Name	Description
`Challenge Security Questions (v1.0.1)`	`object` Describes a `securityQuestions` challenge. This is omitted if the challenge `type` is not `securityQuestions`.
`questions`	`array: [challengeSecurityQuestion]` (required) The array of security questions. `minItems: 1` `maxItems: 8` items: `object`

countryCode

"US"

Country Code (v1.0.0)

The ISO-3611 alpha-2 value for a country.

type: string

minLength: 2
maxLength: 2
pattern: "^[A-Za-z]{2}$"

creditRealTimePayment

{
  "id": "0399abed-fd3d",
  "messageId": "M2015111202120020101BCPF00000000001",
  "createdAt": "2022-05-23T08:01:28.375Z",
  "updatedAt": "2022-05-23T08:02:12.660Z",
  "processedAt": "2022-05-23T08:01:28.375Z",
  "customerId": "4242923b-714e",
  "state": "completed",
  "remainingApprovalsCount": 1,
  "approvalCount": 1,
  "allows": {
    "approve": false,
    "edit": false,
    "submit": true,
    "reject": false,
    "delete": false
  },
  "sourceAccount": {
    "id": "bf23bc970b78d27691e8",
    "nickname": "Premiere Checking",
    "label": "Premiere Checking *1008",
    "maskedNumber": "*1008",
    "type": "checking"
  },
  "amount": {
    "value": "100.00",
    "currency": "USD"
  },
  "sender": {
    "governmentIssuedId": "112223333",
    "name": "Buffalo Mountain Sports",
    "address": {
      "address1": "123 Main Street",
      "address2": "Building 14, Suite 1500",
      "locality": "Miami",
      "regionCode": "FL",
      "countryCode": "US",
      "postalCode": "12345"
    },
    "contact": {
      "name": "John Smith",
      "emailAddress": "johnsmith.doe@business.com",
      "phoneNumber": "+19105550155"
    }
  },
  "recipient": {
    "name": "Exquisite Creations Interior Design & Renovation Services",
    "address": {
      "address1": "123 Hierarchy Lane",
      "locality": "Miami",
      "regionCode": "FL",
      "countryCode": "US",
      "postalCode": "12003"
    },
    "maskedAccountNumber": "*6789",
    "fullAccountNumber": "123456789",
    "institution": {
      "name": "Bank of America",
      "routingNumber": "123123123"
    }
  },
  "confirmationId": "12345",
  "endToEndId": "E2E-Ref001",
  "trackingNumber": "12345678",
  "remittanceAdvice": {
    "method": "email",
    "address": "info@example.com",
    "message": "Payment for invoice INV-123"
  },
  "approvers": [
    {
      "name": "Tom Allison",
      "id": "327d8bea-2553",
      "identification": "to...58@wellsroofing.com"
    },
    {
      "name": "Silvia Wilkenson",
      "id": "06cf8996-d093",
      "identification": "si...42@wellsroofing.com"
    }
  ],
  "approvals": [
    {
      "name": "Tom Allison",
      "id": "327d8bea-2553",
      "identification": "si...42@wellsroofing.com",
      "approvedAt": "2022-04-25T09:02:57.375Z"
    },
    null
  ],
  "problems": []
}

Credit Real-Time Payment (v7.1.0)

Representation of a credit real-time payment resource.

Properties

Name	Description
`Credit Real-Time Payment (v7.1.0)`	`object` Representation of a credit real-time payment resource.
`id`	`readOnlyResourceId` (required) The unique identifier for this real-time payment resource. This is an immutable opaque string. `read-only` `minLength: 6` `maxLength: 48` `pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"`
`messageId`	`externalResourceId(text)` (required) Unique id generated by the initiating system or institution, used to reference the payment for the purpose of sender/receiver communication. `read-only` `format: text` `minLength: 1` `maxLength: 256`
`createdAt`	`readOnlyTimestamp(date-time)` (required) The date and time when the real-time payment was created, in `YYYY-MM-DDThh:mm:ss.sssZ` RFC 3339 `date-time` UTC format. `read-only` `format: date-time` `minLength: 20` `maxLength: 30`
`updatedAt`	`readOnlyTimestamp(date-time)` (required) The date and time when the credit real-time payment was updated, in `YYYY-MM-DDThh:mm:ss.sssZ` RFC 3339 `date-time` UTC format. `read-only` `format: date-time` `minLength: 20` `maxLength: 30`
`processedAt`	`readOnlyTimestamp(date-time)` The date and time when the credit real-time payment was processed, in `YYYY-MM-DDThh:mm:ss.sssZ` RFC 3339 `date-time` UTC format. This is only populated when the credit real-time payment's `state` is `processed`, `completed`, or `failed`. `read-only` `format: date-time` `minLength: 20` `maxLength: 30`
`customerId`	`realTimePaymentCustomerId` The ID of the customer who created the credit real-time payment. `read-only` `minLength: 6` `maxLength: 48` `pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"`
`state`	`creditRealTimePaymentState` (required) The state of the credit real-time payment. enum values: `pending`, `pendingApproval`, `rejected`, `scheduled`, `processing`, `processed`, `completed`, `failed`
`reasonCode`	`creditRealTimePaymentReasonCode` The reason that a credit real-time payment is in its current state. Normally, this explains why the state is still `pending` and not eligible to be approved or processed. enum values: `insufficientFunds`, `accountNotFound`, `none`
`information`	`string(text)` A text string with additional information about the status of the credit real-time payment. `format: text` `maxLength: 100`
`remainingApprovalsCount`	`integer(int32)` (required) The number of the remaining approvals that are required before the credit real-time payment can be scheduled. This property only applies if the `state` of the credit real-time payment is `pendingApproval`. `format: int32` `minimum: 0` `maximum: 3`
`approvalCount`	`integer(int32)` (required) The number of approvals given for the credit real-time payment. `format: int32` `minimum: 0` `maximum: 3`
`allows`	`creditRealTimePaymentAllows` (required) Indicates what credit real-time payment actions are allowed for the current customer, given the user's entitlements and the state of the credit real-time payment.
`stateReason`	`string(text)` The `reason` given when someone rejected the credit real-time payment during review. This string is only present if the `state` is `rejected`, a `reason` was given and the `state` has not changed since the reason was given. `format: text` `maxLength: 80`
`rejectionReason`	`string(text)` The external processor (such as The Clearing House) provided reason for rejecting the real-time payment. This is omitted when there is not a provided rejection reason. `format: text` `maxLength: 105`
`sourceAccount`	`creditRealTimePaymentAccountReference` (required) The banking account used to send the credit real-time payment. This is always an internal banking account of the user.
`amount`	`realTimePaymentAmount` (required) The ISO 20022 settlement amount of the real-time payment. The maximum allowed total digits is 14, and the maximum allowed fractional digits is 2.
`sender`	`creditRealTimePaymentSender` (required) The sender of the credit real-time payment.
`recipient`	`realTimePaymentRecipient` (required) The recipient of the credit real-time payment.
`confirmationId`	`realTimePaymentConfirmationId(text)` (required) Unique ID generated by the initiating system or institution for the purpose of tracking the payment. `read-only` `format: text` `minLength: 1` `maxLength: 256`
`endToEndId`	`realTimePaymentEndToEndId(text)` Information supplied by the initiating party (user or business) to identify the payment. This not required to be unique and is immutable once submitted. `format: text` `maxLength: 35`
`trackingNumber`	`realTimePaymentTrackingNumber` (required) A unique tracking number for this payment. Unlike the `id`, this numeric value is visible to the customer, and can be used to lookup a payment by this ID. `minLength: 6` `maxLength: 9` `pattern: "^[0-9]+$"`
`remittanceAdvice`	`remittanceAdvice` Information related to remittance advice of the real-time payment. Remittance advice is supplemental information sent from the payer to the payee that includes information about the payment such as amount and invoice number(s) in order to assist with account reconciliation and record-keeping.
`approvers`	`array: [creditRealTimePaymentApprover]` (required) An array of customers that are entitled to approve this credit real-time payment. `read-only` `minItems: 0` `maxItems: 8` items: `object`
`approvals`	`array: [creditRealTimePaymentApproval \| null]` (required) An array of approvals. A `null` item indicates a required approval is still pending. The length of this array indicates how many approvals are needed before this credit real-time payment may be actively scheduled for processing. `read-only` `minItems: 0` `maxItems: 3` items: `object \| null` » `nullable`
`problems`	`array: [creditRealTimePaymentProblem]` A list of problems that prevent approving the credit real-time payment. `maxItems: 1000` items: `object`

creditRealTimePaymentAccountReference

{
  "id": "bf23bc970b78d27691e8",
  "nickname": "Payroll Checking",
  "label": "Payroll Checking *1008",
  "maskedNumber": "*1008",
  "type": "checking"
}

Credit Real-Time Payment Account Reference (v2.0.0)

The banking account used to send the credit real-time payment. This is always an internal banking account of the user.

Properties

Name Description

Credit Real-Time Payment Account Reference (v2.0.0) object
The banking account used to send the credit real-time payment. This is always an internal banking account of the user.

id resourceId (required)
The unique ID of a banking account.
minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"

label accountLabel(text)
The human-readable label for this account. This is either the nickname (if assigned for the current customer), or the product.label concatenated with the maskedNumber.
format: text
minLength: 1
maxLength: 80

nickname accountNickname(text)
The nickname (friendly name) the customer has given this account. Each customer can define their own nickname for the same account. If omitted, the customer has not set a nickname.
format: text
maxLength: 50

maskedNumber maskedAccountNumber
A masked account number: an asterisk * followed by one to four characters of the fullAccountNumber.
minLength: 2
maxLength: 5
pattern: "^\\*[- _a-zA-Z0-9.]{1,4}$"

type

creditRealTimePaymentProductType

The type (or category) of banking product for the credit real-time payment.

creditRealTimePaymentProductType strings may have one of the following enumerated values:

Value	Description
`savings`	Savings: Savings Account
`checking`	Checking: Checking Account
`loan`	Loan: Loan Account
`moneyMarket`	Money Market: Money Market Account

enum values: savings, checking, loan, moneyMarket

creditRealTimePaymentAccountReferencePatch

{
  "id": "bf23bc970b78d27691e8",
  "nickname": "Payroll Checking",
  "label": "Payroll Checking *1008",
  "maskedNumber": "*1008",
  "type": "checking"
}

Credit Real-Time Payment Account Reference Patch (v2.0.0)

A representation of a patch to the banking account used to send the credit real-time payment. This is always an internal banking account of the user.

Properties

Name Description

Credit Real-Time Payment Account Reference Patch (v2.0.0) object
A representation of a patch to the banking account used to send the credit real-time payment. This is always an internal banking account of the user.

id resourceId
The unique ID of a banking account.
minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"

type

creditRealTimePaymentProductType

The type (or category) of banking product for the credit real-time payment.

creditRealTimePaymentProductType strings may have one of the following enumerated values:

Value	Description
`savings`	Savings: Savings Account
`checking`	Checking: Checking Account
`loan`	Loan: Loan Account
`moneyMarket`	Money Market: Money Market Account

enum values: savings, checking, loan, moneyMarket

creditRealTimePaymentAllows

{
  "approve": false,
  "edit": false,
  "submit": true,
  "reject": false,
  "delete": false
}

Credit Real-Time Payment Allows (v1.0.0)

Indicates what credit real-time payment actions are allowed for the current customer, given the user's entitlements and the state of the credit real-time payment.

Properties

Name	Description
`Credit Real-Time Payment Allows (v1.0.0)`	`object` Indicates what credit real-time payment actions are allowed for the current customer, given the user's entitlements and the state of the credit real-time payment.
`approve`	`boolean` (required) The customer is allowed to approve the credit real-time payment.
`edit`	`boolean` (required) The customer is allowed to edit the credit real-time payment.
`submit`	`boolean` (required) The customer is allowed to submit the credit real-time payments for approval.
`reject`	`boolean` (required) The customer is allowed to reject the credit real-time payment.
`delete`	`boolean` (required) The customer is allowed to delete the credit real-time payment.

creditRealTimePaymentApproval

{
  "name": "Tom Allison",
  "id": "327d8bea-2553",
  "identification": "to...58@wellsroofing.com",
  "approvedAt": "2022-05-23T08:01:28.375Z"
}

Credit Real-Time Payment Approval (v1.0.0)

The customer who approved a credit real-time payment, and when it was approved.

Properties

Name	Description
`Credit Real-Time Payment Approval (v1.0.0)`	`object \| null` The customer who approved a credit real-time payment, and when it was approved. `nullable`
`id`	`resourceId` (required) The unique `id` of the approver `minLength: 6` `maxLength: 48` `pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"`
`name`	`string(text)` (required) The approvers's full name. `format: text` `minLength: 2` `maxLength: 50`
`identification`	`string(text)` Descriptive identifying text about the approver, such as a (masked) email address. `format: text` `maxLength: 64`
`approvedAt`	`readOnlyTimestamp(date-time)` (required) The date-time when the approver last approved this credit real-time payment. `read-only` `format: date-time` `minLength: 20` `maxLength: 30`

creditRealTimePaymentApprover

{
  "id": "327d8bea-2553",
  "name": "Tom Allison",
  "identification": "to...58@wellsroofing.com"
}

Credit Real-Time Payment Approver (v1.0.0)

A reference to a customer that is entitled to approve the containing credit real-time payment.

Properties

Name	Description
`Credit Real-Time Payment Approver (v1.0.0)`	`object` A reference to a customer that is entitled to approve the containing credit real-time payment.
`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`
`identification`	`string(text)` Descriptive identifying text about the approver, such as a (masked) email address. `format: text` `maxLength: 64`

creditRealTimePaymentApproverList

{
  "creditRealTimePaymentId": "071db898-b220",
  "groupId": "group-01",
  "approvers": [
    {
      "name": "Tom Allison",
      "id": "327d8bea-2553",
      "identification": "to...58@wellsroofing.com"
    },
    {
      "name": "Carl Thompson",
      "id": "d7da1cc5-8056",
      "identification": "ca...39@wellsroofing.com"
    }
  ]
}

Credit Real-Time Payment And Approvers (v1.0.0)

A credit real-time payment and a list of customers who are eligible to approve the payment.

Properties

Name	Description
`Credit Real-Time Payment And Approvers (v1.0.0)`	`object` A credit real-time payment and a list of customers who are eligible to approve the payment.
`creditRealTimePaymentId`	`resourceId` (required) The resource ID of the credit real-time payment. `minLength: 6` `maxLength: 48` `pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"`
`groupId`	`string` An opaque string which identifies similar lists of approvers. All items with the same `groupId` have the same set of approvers. `minLength: 1` `maxLength: 16` `pattern: "^[-_:.~$a-zA-Z0-9]+$"`
`approvers`	`array: [creditRealTimePaymentApprover]` (required) The list of eligible approvers. This can be empty if no eligible approvers were found, and the `problems` array will describe why. `minItems: 0` `maxItems: 1000` items: `object`

creditRealTimePaymentApprovers

{
  "items": [
    {
      "creditRealTimePaymentId": "8ea05bfc-0e9c",
      "groupId": "group-00",
      "approvers": [
        {
          "name": "Tom Allison",
          "id": "327d8bea-2553",
          "identification": "to...58@wellsroofing.com"
        },
        {
          "name": "Silvia Wilkenson",
          "id": "06cf8996-d093",
          "identification": "si...42@wellsroofing.com"
        }
      ]
    },
    {
      "creditRealTimePaymentId": "071db898-b220",
      "groupId": "group-01",
      "approvers": [
        {
          "name": "Tom Allison",
          "id": "327d8bea-2553",
          "identification": "to...58@wellsroofing.com"
        },
        {
          "name": "Carl Thompson",
          "id": "d7da1cc5-8056",
          "identification": "ca...39@wellsroofing.com"
        }
      ]
    }
  ]
}

Credit Real-Time Payment Approvers (v1.0.0)

A list of credit real-time payments and the customers to assign to approve that payment.

Properties

Name	Description
`Credit Real-Time Payment Approvers (v1.0.0)`	`object` A list of credit real-time payments and the customers to assign to approve that payment.
`items`	`array: [creditRealTimePaymentApproverList]` (required) The list of credit real-time payments and list of customers eligible to approve the payment. `minItems: 1` `maxItems: 1000` items: `object`

creditRealTimePaymentBulkApprovers

[
  {
    "id": "0399abed-fd3d",
    "succeeded": false,
    "problems": [
      {
        "id": "3fbad566-be86-4b22-9ba6-3ca99fdc0799",
        "type": "https://production.api.apiture.com/errors/invalidRealTimePaymentId/v1.0.0",
        "title": "Credit Real-Time Payment Not Found",
        "status": 422,
        "occurredAt": "2022-04-25T12:42:21.375Z",
        "detail": "No real-time payment exists for the requested real-time payment ID",
        "instance": "https://production.api.apiture.com/banking/creditRealTimePayments/0399abed-fd3d"
      }
    ]
  },
  {
    "id": "d62c0701-0d74-4836-83f9-ebf3709442ea",
    "succeeded": true
  }
]

Credit Real-Time Payment Bulk Approvers (v1.0.0)

Response from the request to add approvers to a set of credit real-time payments.

Properties

Name	Description
`Credit Real-Time Payment Bulk Approvers (v1.0.0)`	`object` Response from the request to add approvers to a set of credit real-time payments.
`items`	`array: [allOf]` The result of attempting to perform an action on a set of real-time payments in the request. Items in the array correspond (in order) to each real-time payment in the request. `minItems: 1` `maxItems: 100` items:
`» Bulk Real-Time Payment Operation Response Item (v1.0.0)`	`bulkRealTimePaymentOperationResponseItem` The result of attempting to perform an action on one real-time payment from the list of real-time payments in the request.

creditRealTimePaymentGovernmentIssuedId

"112223333"

Credit Real-Time Payment Government Issued Id (v1.0.0)

The government issued ID of the sender.

For Social Security Number (SSN), Employer Identification Number (EIN), Individual Taxpayer Identification Number (ITIN), or any other National Identification Number for non-USA countries, omit all delimiters.

type: string(text)

format: text
minLength: 1
maxLength: 35

creditRealTimePaymentIds

[
  "string"
]

Credit Real-Time Payment IDs (v1.0.1)

A list of credit real-time payment IDs to apply an operation to.

creditRealTimePaymentIds is an array schema.

Array Elements

type: array: [resourceId]

minItems: 1
maxItems: 100

creditRealTimePaymentItem

{
  "id": "0399abed-fd3d",
  "messageId": "M2015111202120020101BCPF00000000001",
  "createdAt": "2022-05-23T08:01:28.375Z",
  "updatedAt": "2022-05-23T08:02:12.660Z",
  "processedAt": "2022-05-23T08:01:28.375Z",
  "customerId": "4242923b-714e",
  "state": "completed",
  "remainingApprovalsCount": 0,
  "approvalCount": 2,
  "allows": {
    "approve": false,
    "edit": false,
    "submit": true,
    "reject": false,
    "delete": false
  },
  "sourceAccount": {
    "id": "bf23bc970b78d27691e8",
    "nickname": "Premiere Checking",
    "label": "Premiere Checking *1008",
    "maskedNumber": "*1008",
    "type": "checking"
  },
  "amount": {
    "value": "100.00",
    "currency": "USD"
  },
  "sender": {
    "name": "Buffalo Mountain Sports"
  },
  "recipient": {
    "name": "Exquisite Creations Interior Design & Renovation Services"
  }
}

Credit Real-Time Payment Item (v5.0.0)

Summary representation of a credit real-time payment resource in real-time payments collections. To fetch the full representation of this real-time payment, use the getCreditRealTimePayment operation, passing this item's id field as the creditRealTimePaymentId path parameter.

Properties

Name	Description
`Credit Real-Time Payment Item (v5.0.0)`	`object` Summary representation of a credit real-time payment resource in real-time payments collections. To fetch the full representation of this real-time payment, use the `getCreditRealTimePayment` operation, passing this item's `id` field as the `creditRealTimePaymentId` path parameter.
`id`	`readOnlyResourceId` (required) The unique identifier for this real-time payment resource. This is an immutable opaque string. `read-only` `minLength: 6` `maxLength: 48` `pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"`
`messageId`	`externalResourceId(text)` (required) Unique id generated by the initiating system or institution, used to reference the payment for the purpose of sender/receiver communication. `read-only` `format: text` `minLength: 1` `maxLength: 256`
`createdAt`	`readOnlyTimestamp(date-time)` (required) The date and time when the real-time payment was created, in `YYYY-MM-DDThh:mm:ss.sssZ` RFC 3339 `date-time` UTC format. `read-only` `format: date-time` `minLength: 20` `maxLength: 30`
`updatedAt`	`readOnlyTimestamp(date-time)` (required) The date and time when the credit real-time payment was updated, in `YYYY-MM-DDThh:mm:ss.sssZ` RFC 3339 `date-time` UTC format. `read-only` `format: date-time` `minLength: 20` `maxLength: 30`
`processedAt`	`readOnlyTimestamp(date-time)` The date and time when the credit real-time payment was processed, in `YYYY-MM-DDThh:mm:ss.sssZ` RFC 3339 `date-time` UTC format. This is only populated when the credit real-time payment's `state` is `processed`, `completed`, or `failed`. `read-only` `format: date-time` `minLength: 20` `maxLength: 30`
`customerId`	`realTimePaymentCustomerId` The ID of the customer who created the credit real-time payment. `read-only` `minLength: 6` `maxLength: 48` `pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"`
`state`	`creditRealTimePaymentState` (required) The state of the credit real-time payment. enum values: `pending`, `pendingApproval`, `rejected`, `scheduled`, `processing`, `processed`, `completed`, `failed`
`reasonCode`	`creditRealTimePaymentReasonCode` The reason that a credit real-time payment is in its current state. Normally, this explains why the state is still `pending` and not eligible to be approved or processed. enum values: `insufficientFunds`, `accountNotFound`, `none`
`information`	`string(text)` A text string with additional information about the status of the credit real-time payment. `format: text` `maxLength: 100`
`remainingApprovalsCount`	`integer(int32)` (required) The number of the remaining approvals that are required before the credit real-time payment can be scheduled. This property only applies if the `state` of the credit real-time payment is `pendingApproval`. `format: int32` `minimum: 0` `maximum: 3`
`approvalCount`	`integer(int32)` (required) The number of approvals given for the credit real-time payment. `format: int32` `minimum: 0` `maximum: 3`
`allows`	`creditRealTimePaymentAllows` (required) Indicates what credit real-time payment actions are allowed for the current customer, given the user's entitlements and the state of the credit real-time payment.
`sourceAccount`	`creditRealTimePaymentAccountReference` (required) The banking account used to send the credit real-time payment. This is always an internal banking account of the user.
`amount`	`realTimePaymentAmount` (required) The ISO 20022 settlement amount of the real-time payment. The maximum allowed total digits is 14, and the maximum allowed fractional digits is 2.
`sender`	`creditRealTimePaymentSenderSummary` (required) A summary version of the sender of the credit real-time payment.
`recipient`	`realTimePaymentRecipientSummary` (required) A summary version of the real-time payment recipient.

creditRealTimePaymentPatch

{
  "customerId": "4242923b-714e",
  "sourceAccount": {
    "id": "bf23bc970b78d27691e8",
    "nickname": "Premiere Checking",
    "label": "Premiere Checking *1008",
    "maskedNumber": "*1008",
    "type": "checking"
  },
  "amount": {
    "value": "100.00",
    "currency": "USD"
  },
  "sender": {
    "governmentIssuedId": "112223333",
    "name": "Buffalo Mountain Sports",
    "address": {
      "address1": "123 Main Street",
      "address2": "Building 14, Suite 1500",
      "locality": "Miami",
      "regionCode": "FL",
      "countryCode": "US",
      "postalCode": "12345"
    }
  },
  "recipient": {
    "name": "Exquisite Creations Interior Design & Renovation Services",
    "address": {
      "address1": "123 Hierarchy Lane",
      "locality": "Miami",
      "regionCode": "FL",
      "countryCode": "US",
      "postalCode": "12003"
    },
    "fullAccountNumber": "123456789",
    "institution": {
      "name": "Bank of America",
      "routingNumber": "123123123"
    }
  },
  "endToEndId": "E2E-Ref001",
  "remittanceAdvice": {
    "method": "email",
    "address": "info@example.com",
    "message": "Payment for invoice INV-123"
  }
}

Credit Real-Time Payment Patch (v5.0.0)

Representation of a patch to a credit real-time payment resource.

Properties

Name	Description
`Credit Real-Time Payment Patch (v5.0.0)`	`object` Representation of a patch to a credit real-time payment resource.
`customerId`	`realTimePaymentCustomerId` The ID of the customer who created the credit real-time payment. `read-only` `minLength: 6` `maxLength: 48` `pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"`
`sourceAccount`	`creditRealTimePaymentAccountReferencePatch` A representation of a patch to the banking account used to send the credit real-time payment. This is always an internal banking account of the user.
`amount`	`realTimePaymentAmount` The ISO 20022 settlement amount of the real-time payment. The maximum allowed total digits is 14, and the maximum allowed fractional digits is 2.
`sender`	`creditRealTimePaymentSenderPatch` Representation of a patch to the sender of the credit real-time payment.
`recipient`	`realTimePaymentRecipientPatch` Representation of a patch to the recipient of the credit real-time payment.
`endToEndId`	`realTimePaymentEndToEndId(text)` Information supplied by the initiating party (user or business) to identify the payment. This not required to be unique and is immutable once submitted. `format: text` `maxLength: 35`
`remittanceAdvice`	`remittanceAdvice` Information related to remittance advice of the real-time payment. Remittance advice is supplemental information sent from the payer to the payee that includes information about the payment such as amount and invoice number(s) in order to assist with account reconciliation and record-keeping.

creditRealTimePaymentProblem

{
  "type": "https://production.api.apiture.com/errors/pastCutoffTime/v1.0.0",
  "title": "Past cutoff time",
  "detail": "The current time is past the financial institution's cutoff time.",
  "attributes": {
    "referencedAt": "2022-07-13T020:52:19.375Z",
    "cutoffAt": "2022-07-13T10:00:00.000Z"
  }
}

Credit Real-Time Payment Problem (v1.0.0)

Describes a problem with a credit real-time payment that prevents applying an operation change to the payment. Clients should get the most recent revision of the credit real-time payment to check for problems.

Properties

Name	Description
`Credit Real-Time Payment Problem (v1.0.0)`	`object` Describes a problem with a credit real-time payment that prevents applying an operation change to the payment. Clients should get the most recent revision of the credit real-time payment to check for problems.
`type`	`string(uri-reference)` (required) A URI reference (RFC3986) that identifies the problem type. This is the URL of human-readable HTML documentation for the problem type. `format: uri-reference` `maxLength: 2048`
`title`	`string(text)` (required) 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`
`detail`	`string(text)` (required) A human-readable explanation specific to this occurrence of the problem. `format: text` `maxLength: 256`
`attributes`	`object` Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

creditRealTimePaymentProductType

"savings"

Credit Real-Time Payment Product Type (v2.0.0)

The type (or category) of banking product for the credit real-time payment.

creditRealTimePaymentProductType strings may have one of the following enumerated values:

Value	Description
`savings`	Savings: Savings Account
`checking`	Checking: Checking Account
`loan`	Loan: Loan Account
`moneyMarket`	Money Market: Money Market Account

type: string

enum values: savings, checking, loan, moneyMarket

creditRealTimePaymentReasonCode

"insufficientFunds"

Credit Real-Time Payment Reason Code (v3.0.0)

The reason that a real-time payment is in its current state. Normally, this explains why the state is still pending and not eligible to be approved or processed. Some reasonCode values may only be associated with specific state values.

state: pending may have these reasonCode values:
- insufficientFunds
- accountNotFound
- none

creditRealTimePaymentReasonCode strings may have one of the following enumerated values:

Value	Description
`insufficientFunds`	Insufficient Funds: The credit real-time payment was created but is not able to be approved or scheduled due to insufficient funding account balance
`accountNotFound`	Account Not Found: The credit real-time payment was created but is not able to be approved or scheduled since the source account has been deleted since the payment was created
`none`	None: The credit real-time payment has no problems and is eligible for submission and approval

type: string

enum values: insufficientFunds, accountNotFound, none

creditRealTimePaymentSender

{
  "governmentIssuedId": "112223333",
  "name": "Buffalo Mountain Sports",
  "address": {
    "address1": "123 Main Street",
    "address2": "Building 14, Suite 1500",
    "locality": "Miami",
    "regionCode": "FL",
    "countryCode": "US",
    "postalCode": "12345"
  },
  "contact": {
    "name": "John Smith",
    "emailAddress": "johnsmith.doe@business.com",
    "phoneNumber": "+19105550155"
  }
}

Credit Real-Time Payment Sender (v4.0.0)

The sender of the credit real-time payment.

Properties

Name	Description
`Credit Real-Time Payment Sender (v4.0.0)`	`object` The sender of the credit real-time payment.
`name`	`string(text)` (required) The name of the sender. `format: text` `maxLength: 140`
`governmentIssuedId`	`creditRealTimePaymentGovernmentIssuedId(text)` The government issued ID of the sender. For Social Security Number (SSN), Employer Identification Number (EIN), Individual Taxpayer Identification Number (ITIN), or any other National Identification Number for non-USA countries, omit all delimiters. `format: text` `minLength: 1` `maxLength: 35`
`address`	`isoCompliantPartialAddress` (required) The address of the sender. If any fields are provided, `address1`, `countryCode`, `locality`, `regionName`/`regionCode`, and `postalCode` are required.
`contact`	`realTimePaymentContact` Sender contact information that can be used for communication about the payment.

creditRealTimePaymentSenderPatch

{
  "governmentIssuedId": "112223333",
  "name": "Buffalo Mountain Sports",
  "address": {
    "address1": "123 Main Street",
    "address2": "Building 14, Suite 1500",
    "locality": "Miami",
    "regionCode": "FL",
    "countryCode": "US",
    "postalCode": "12345"
  },
  "contact": {
    "name": "John Smith",
    "emailAddress": "johnsmith.doe@business.com",
    "phoneNumber": "+19105550155"
  }
}

Credit Real-Time Payment Sender Patch (v3.0.0)

Representation of a patch to the sender of the credit real-time payment.

Properties

Name	Description
`Credit Real-Time Payment Sender Patch (v3.0.0)`	`object` Representation of a patch to the sender of the credit real-time payment.
`name`	`string(text)` The name of the sender. `format: text` `maxLength: 140`
`governmentIssuedId`	`creditRealTimePaymentGovernmentIssuedId(text)` The government issued ID of the sender. For Social Security Number (SSN), Employer Identification Number (EIN), Individual Taxpayer Identification Number (ITIN), or any other National Identification Number for non-USA countries, omit all delimiters. `format: text` `minLength: 1` `maxLength: 35`
`address`	`isoCompliantPartialAddress` The address of the sender.
`contact`	`realTimePaymentContact` Sender contact information that can be used for communication about the payment.

creditRealTimePaymentSenderSummary

{
  "name": "Buffalo Mountain Sports"
}

Credit Real-Time Payment Sender Summary (v2.0.0)

A summary version of the sender of the credit real-time payment.

Properties

Name	Description
`Credit Real-Time Payment Sender Summary (v2.0.0)`	`object` A summary version of the sender of the credit real-time payment.
`name`	`string(text)` (required) The name of the sender. `format: text` `maxLength: 140`

creditRealTimePaymentState

"pending"

Credit Real-Time Payment State (v2.0.0)

Indicates the status of the credit real-time payment.

creditRealTimePaymentState strings may have one of the following enumerated values:

Value	Description
`pending`	Pending: A credit real-time payment that has incomplete or erroneous data, or has not yet been submitted for approval
`pendingApproval`	Pending Approval: At least one approval is necessary before the credit real-time payment may be scheduled
`rejected`	Rejected: An approver rejected a credit real-time payment
`scheduled`	Scheduled: A credit real-time payment that is scheduled to be processed
`processing`	Processing: A credit real-time payment that has begun the payment process
`processed`	Processed: A credit real-time payment that has completed internal processing and has been sent to the external payment provider
`completed`	Completed: The third party processor has responded that the credit real-time payment has been successfully sent to the recipient
`failed`	Failed: The third party processor has responded that the credit real-time payment has failed and was not sent to the recipient

type: string

enum values: pending, pendingApproval, rejected, scheduled, processing, processed, completed, failed

creditRealTimePayments

{
  "nextPage_url": "https://production.api.apiture.com/banking/creditRealTimePayments?start=641f62296ecbf1882c84?limit=100",
  "start": "df8sk3hk4hf8sf",
  "limit": 100,
  "count": 5000,
  "pageNumber": 1,
  "items": [
    {
      "id": "0399abed-fd3d",
      "messageId": "M2015111202120020101BCPF00000000001",
      "createdAt": "2022-05-23T08:01:28.375Z",
      "updatedAt": "2022-05-23T08:02:12.660Z",
      "processedAt": "2022-05-23T08:01:28.375Z",
      "customerId": "4242923b-714e",
      "state": "completed",
      "remainingApprovalsCount": 0,
      "approvalCount": 2,
      "allows": {
        "approve": false,
        "edit": false,
        "submit": true,
        "reject": false,
        "delete": false
      },
      "sourceAccount": {
        "id": "bf23bc970b78d27691e8",
        "nickname": "Premiere Checking",
        "label": "Premiere Checking *1008",
        "maskedNumber": "*1008",
        "type": "checking"
      },
      "amount": {
        "value": "100.00",
        "currency": "USD"
      },
      "sender": {
        "name": "Buffalo Mountain Sports"
      },
      "recipient": {
        "name": "Exquisite Creations Interior Design & Renovation Services"
      }
    },
    {
      "id": "d62c0701-0d74-4836-83f9-ebf3709442ea",
      "messageId": "M2015111202120020101BCPF00000000002",
      "createdAt": "2022-05-26T10:05:44.102Z",
      "updatedAt": "2022-05-26T10:06:32.091Z",
      "processedAt": "2022-05-26T10:05:44.102Z",
      "customerId": "df90dfsds-v9dsf",
      "state": "pending",
      "reasonCode": "insufficientFunds",
      "information": "There are insufficient funds in the account to make this payment.",
      "remainingApprovalsCount": 2,
      "approvalCount": 0,
      "allows": {
        "approve": false,
        "edit": false,
        "submit": true,
        "reject": false,
        "delete": false
      },
      "sourceAccount": {
        "id": "bf23bc970b78d27691e8",
        "nickname": "Premiere Checking",
        "label": "Premiere Checking *1008",
        "maskedNumber": "*1008",
        "type": "checking"
      },
      "amount": {
        "value": "15.00",
        "currency": "USD"
      },
      "sender": {
        "name": "Buffalo Mountain Sports"
      },
      "recipient": {
        "name": "Exquisite Creations Interior Design & Renovation Services"
      }
    }
  ]
}

Credit Real-Time Payment Collection (v5.1.0)

A page of zero or more credit real-time payments. The items in the collection are ordered in the items array.

Properties

Name	Description
`Credit Real-Time Payment Collection (v5.1.0)`	`object` A page of zero or more credit real-time payments. The items in the collection are ordered in the `items` array.
`limit`	`integer(int32)` (required) The number of items requested for this page response. The length of the `items` array may be less that `limit`. `format: int32` `minimum: 0` `maximum: 10000`
`nextPage_url`	`string(uri-reference)` The URL of the next page of resources. If this URL is omitted, there are no more resources in the collection. `read-only` `format: uri-reference` `maxLength: 8000`
`start`	`string(text)` The opaque cursor that specifies the starting location of this page of items. `format: text` `maxLength: 256`
`count`	`integer(int64)` The total number of items that matched the request. This is only present if the API service can efficiently compute it. `format: int64` `minimum: 0` `maximum: 4000000000`
`pageNumber`	`integer(int32)` The current page number. `format: int32` `minimum: 0` `maximum: 4000000000`
`items`	`array: [creditRealTimePaymentItem]` (required) An array containing credit real-time payment items. `maxItems: 10000` items: `object`

currencyCode

"str"

(v1.0.0)*

A ISO 4217 currency code This is always upper case ASCII. Crypto currencies with codes longer that 3 characters are not supported.

type: string(text)

format: text
minLength: 3
maxLength: 3
pattern: "^[A-Z]{3}$"

customerReference

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

Customer Reference (v1.1.2)

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.2)`	`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`

dateRange

"2022-05-19"

Date Range (v1.0.0)

A date range, supporting inclusive or exclusive endpoints. Dates ranges use dates expressed in YYYY-MM-DD RFC 3339 date format. The value may have the following forms:

YYYY-MM-DD match the date exactly; equivalent to matching dates in the range [YYYY-MM-DD,YYYY-MM-DD]
[YYYY-MM-DD,YYYY-MM-DD] between two dates, inclusive of the endpoints
(YYYY-MM-DD,YYYY-MM-DD) between two dates, exclusive of the endpoints
[YYYY-MM-DD,] on or after the date
(YYYY-MM-DD,) after the date
[,YYYY-MM-DD] before or on the date
(,YYYY-MM-DD) before the date

type: string

maxLength: 24
pattern: "^\d{4}-\d{2}-\d{2}|([[(](\d{4}-\d{2}-\d{2},(\d{4}-\d{2}-\d{2})?|,\d{4}-\d{2}-\d{2})[)\]])$"

debitRealTimePayment

{
  "id": "0399abed-fd3d",
  "messageId": "M2015111202120020101BCPF00000000001",
  "createdAt": "2022-05-23T08:01:28.375Z",
  "availableAt": "2022-05-23T08:01:28.375Z",
  "state": "received",
  "targetAccount": {
    "id": "bf23bc970b78d27691e8",
    "nickname": "Premiere Checking",
    "label": "Premiere Checking *1008",
    "maskedNumber": "*1008",
    "type": "checking"
  },
  "amount": {
    "value": "100.00",
    "currency": "USD"
  },
  "sender": {
    "name": "Exquisite Creations Interior Design & Renovation Services",
    "address": {
      "address1": "1805 Tiburon Dr.",
      "address2": "Building 14, Suite 1500",
      "locality": "Wilmington",
      "regionCode": "NC",
      "countryCode": "US",
      "postalCode": "28403"
    },
    "contact": {
      "name": "Janine Doe",
      "emailAddress": "janine.doe@creations.com",
      "phoneNumber": "+19105550155"
    }
  },
  "confirmationId": "12345",
  "endToEndId": "E2E-Ref001",
  "remittanceAdvice": {
    "method": "email",
    "address": "info@example.com",
    "message": "Payment for invoice INV-123"
  }
}

Debit Real-Time Payment (v4.0.2)

Representation of a debit real-time payment resource.

Properties

Name	Description
`Debit Real-Time Payment (v4.0.2)`	`object` Representation of a debit real-time payment resource.
`id`	`readOnlyResourceId` (required) The unique identifier for this real-time payment resource. This is an immutable opaque string. `read-only` `minLength: 6` `maxLength: 48` `pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"`
`messageId`	`externalResourceId(text)` (required) Unique id generated by the initiating system or institution, used to reference the payment for the purpose of sender/receiver communication. `read-only` `format: text` `minLength: 1` `maxLength: 256`
`createdAt`	`readOnlyTimestamp(date-time)` (required) The date and time when the real-time payment was created, in `YYYY-MM-DDThh:mm:ss.sssZ` RFC 3339 `date-time` UTC format. `read-only` `format: date-time` `minLength: 20` `maxLength: 30`
`availableAt`	`readOnlyTimestamp(date-time)` (required) The date and time when funds become available to the recipient, in `YYYY-MM-DDThh:mm:ss.sssZ` RFC 3339 `date-time` UTC format. `read-only` `format: date-time` `minLength: 20` `maxLength: 30`
`state`	`debitRealTimePaymentState` (required) The state of the debit real-time payment. enum values: `received`
`targetAccount`	`debitRealTimePaymentAccountReference` (required) The banking account into which the debit real-time payment was deposited. This is always an internal banking account of the user.
`amount`	`realTimePaymentAmount` (required) The ISO 20022 settlement amount of the real-time payment. The maximum allowed total digits is 14, and the maximum allowed fractional digits is 2.
`sender`	`debitRealTimePaymentSender` (required) The sender of the debit real-time payment.
`confirmationId`	`realTimePaymentConfirmationId(text)` (required) Unique ID generated by the initiating system or institution for the purpose of tracking the payment. `read-only` `format: text` `minLength: 1` `maxLength: 256`
`endToEndId`	`realTimePaymentEndToEndId(text)` Information supplied by the initiating party (user or business) to identify the payment. This not required to be unique and is immutable once submitted. `format: text` `maxLength: 35`
`remittanceAdvice`	`remittanceAdvice` Information related to remittance advice of the real-time payment. Remittance advice is supplemental information sent from the payer to the payee that includes information about the payment such as amount and invoice number(s) in order to assist with account reconciliation and record-keeping.

debitRealTimePaymentAccountReference

{
  "id": "bf23bc970b78d27691e8",
  "nickname": "Payroll Checking",
  "label": "Payroll Checking *1008",
  "maskedNumber": "*1008",
  "type": "checking"
}

Debit Real-Time Payment Account Reference (v3.0.0)

The banking account into which the debit real-time payment was deposited. This is always an internal banking account of the user.

Properties

Name Description

Debit Real-Time Payment Account Reference (v3.0.0) object
The banking account into which the debit real-time payment was deposited. This is always an internal banking account of the user.

id resourceId (required)
The unique ID of a banking account.
minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"

type

productType

The type (or category) of banking product.

productType strings may have one of the following enumerated values:

Value	Description
`savings`	Savings: Savings Account
`checking`	Checking: Checking Account
`cd`	CD: Certificate of Deposit Account
`ira`	IRA: Individual Retirement Account
`loan`	Loan: Loan Account
`creditCard`	Credit Card: Credit Card Account
`moneyMarket`	Money Market: Money Market Account
`healthSavings`	Health Savings: Health Savings Account

enum values: savings, checking, cd, ira, loan, creditCard, moneyMarket, healthSavings

debitRealTimePaymentItem

{
  "id": "0399abed-fd3d",
  "messageId": "M2015111202120020101BCPF00000000001",
  "createdAt": "2022-05-23T08:01:28.375Z",
  "availableAt": "2022-05-23T08:01:28.375Z",
  "state": "received",
  "targetAccount": {
    "id": "bf23bc970b78d27691e8",
    "nickname": "Premiere Checking",
    "label": "Premiere Checking *1008",
    "maskedNumber": "*1008",
    "type": "checking"
  },
  "amount": {
    "value": "100.00",
    "currency": "USD"
  },
  "sender": {
    "name": "Exquisite Creations Interior Design & Renovation Services"
  }
}

Debit Real-Time Payment Item (v4.0.1)

Summary representation of a debit real-time payment resource in real-time payments collections. To fetch the full representation of this real-time payment, use the getDebitRealTimePayment operation, passing this item's id field as the debitRealTimePaymentId path parameter.

Properties

Name	Description
`Debit Real-Time Payment Item (v4.0.1)`	`object` Summary representation of a debit real-time payment resource in real-time payments collections. To fetch the full representation of this real-time payment, use the `getDebitRealTimePayment` operation, passing this item's `id` field as the `debitRealTimePaymentId` path parameter.
`id`	`readOnlyResourceId` (required) The unique identifier for this real-time payment resource. This is an immutable opaque string. `read-only` `minLength: 6` `maxLength: 48` `pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"`
`messageId`	`externalResourceId(text)` (required) Unique id generated by the initiating system or institution, used to reference the payment for the purpose of sender/receiver communication. `read-only` `format: text` `minLength: 1` `maxLength: 256`
`createdAt`	`readOnlyTimestamp(date-time)` (required) The date and time when the real-time payment was created, in `YYYY-MM-DDThh:mm:ss.sssZ` RFC 3339 `date-time` UTC format. `read-only` `format: date-time` `minLength: 20` `maxLength: 30`
`availableAt`	`readOnlyTimestamp(date-time)` (required) The date and time when funds become available to the recipient, in `YYYY-MM-DDThh:mm:ss.sssZ` RFC 3339 `date-time` UTC format. `read-only` `format: date-time` `minLength: 20` `maxLength: 30`
`state`	`debitRealTimePaymentState` (required) The state of the debit real-time payment. enum values: `received`
`targetAccount`	`debitRealTimePaymentAccountReference` (required) The banking account into which the debit real-time payment was deposited. This is always an internal banking account of the user.
`amount`	`realTimePaymentAmount` (required) The ISO 20022 settlement amount of the real-time payment. The maximum allowed total digits is 14, and the maximum allowed fractional digits is 2.
`sender`	`debitRealTimePaymentSenderSummary` (required) A summary version of the sender of the debit real-time payment.

debitRealTimePaymentSender

{
  "name": "Buffalo Mountain Sports",
  "address": {
    "address1": "123 Main Street",
    "address2": "Building 14, Suite 1500",
    "locality": "Miami",
    "regionCode": "FL",
    "countryCode": "US",
    "postalCode": "12345"
  },
  "contact": {
    "name": "John Smith",
    "emailAddress": "johnsmith.doe@business.com",
    "phoneNumber": "+19105550155"
  }
}

Debit Real-Time Payment Sender (v3.0.0)

The sender of the debit real-time payment.

Properties

Name	Description
`Debit Real-Time Payment Sender (v3.0.0)`	`object` The sender of the debit real-time payment.
`name`	`string(text)` (required) The name of the sender. `format: text` `maxLength: 140`
`address`	`isoCompliantPartialAddress` The address of the sender.
`contact`	`realTimePaymentContact` Sender contact information that can be used for communication about the payment.

debitRealTimePaymentSenderSummary

{
  "name": "Buffalo Mountain Sports"
}

Debit Real-Time Payment Sender Summary (v2.0.0)

A summary version of the sender of the debit real-time payment.

Properties

Name	Description
`Debit Real-Time Payment Sender Summary (v2.0.0)`	`object` A summary version of the sender of the debit real-time payment.
`name`	`string(text)` (required) The name of the sender. `format: text` `maxLength: 140`

debitRealTimePaymentState

"received"

Debit Real-Time Payment State (v2.0.0)

Indicates the status of the debit real-time payment.

debitRealTimePaymentState strings may have one of the following enumerated values:

Value	Description
`received`	Received: A debit real-time payment that has been received

type: string

enum values: received

debitRealTimePayments

{
  "nextPage_url": "https://production.api.apiture.com/banking/debitRealTimePayments?start=641f62296ecbf1882c84?limit=100",
  "start": "df8sk3hk4hf8sf",
  "limit": 100,
  "count": 5000,
  "pageNumber": 1,
  "items": [
    {
      "id": "0399abed-fd3d",
      "messageId": "M2015111202120020101BCPF00000000001",
      "createdAt": "2022-05-23T08:01:28.375Z",
      "availableAt": "2022-05-23T08:01:28.375Z",
      "state": "received",
      "targetAccount": {
        "id": "bf23bc970b78d27691e8",
        "nickname": "Premiere Checking",
        "label": "Premiere Checking *1008",
        "maskedNumber": "*1008",
        "type": "checking"
      },
      "amount": {
        "value": "100.00",
        "currency": "USD"
      },
      "sender": {
        "name": "Exquisite Creations Interior Design & Renovation Services"
      }
    },
    {
      "id": "d62c0701-0d74-4836-83f9-ebf3709442ea",
      "messageId": "M2015111202120020101BCPF00000000002",
      "createdAt": "2022-05-26T10:05:44.102Z",
      "availableAt": "2022-05-26T10:05:44.102Z",
      "state": "received",
      "targetAccount": {
        "id": "bf23bc970b78d27691e8",
        "nickname": "Premiere Checking",
        "label": "Premiere Checking *1008",
        "maskedNumber": "*1008",
        "type": "checking"
      },
      "amount": {
        "value": "15.00",
        "currency": "USD"
      },
      "sender": {
        "name": "Billy Bob Jordan"
      }
    }
  ]
}

Debit Real-Time Payment Collection (v4.1.0)

A page of zero or more debit real-time payments. The items in the collection are ordered in the items array.

Properties

Name	Description
`Debit Real-Time Payment Collection (v4.1.0)`	`object` A page of zero or more debit real-time payments. The items in the collection are ordered in the `items` array.
`limit`	`integer(int32)` (required) The number of items requested for this page response. The length of the `items` array may be less that `limit`. `format: int32` `minimum: 0` `maximum: 10000`
`nextPage_url`	`string(uri-reference)` The URL of the next page of resources. If this URL is omitted, there are no more resources in the collection. `read-only` `format: uri-reference` `maxLength: 8000`
`start`	`string(text)` The opaque cursor that specifies the starting location of this page of items. `format: text` `maxLength: 256`
`count`	`integer(int64)` The total number of items that matched the request. This is only present if the API service can efficiently compute it. `format: int64` `minimum: 0` `maximum: 4000000000`
`pageNumber`	`integer(int32)` The current page number. `format: int32` `minimum: 0` `maximum: 4000000000`
`items`	`array: [debitRealTimePaymentItem]` (required) An array containing debit real-time payment items `maxItems: 10000` items: `object`

eligibleCreditRealTimePaymentApprovers

{
  "items": [
    {
      "creditRealTimePaymentId": "d366bc49-49a7",
      "groupId": "group-00",
      "approvers": [
        {
          "name": "Tom Allison",
          "id": "327d8bea-2553",
          "identification": "to...58@wellsroofing.com"
        },
        {
          "name": "Silvia Wilkenson",
          "id": "06cf8996-d093",
          "identification": "si...42@wellsroofing.com"
        }
      ]
    },
    {
      "creditRealTimePaymentId": "8ea05bfc-0e9c",
      "groupId": "group-00",
      "approvers": [
        {
          "name": "Tom Allison",
          "id": "327d8bea-2553",
          "identification": "to...58@wellsroofing.com"
        },
        {
          "name": "Silvia Wilkenson",
          "id": "06cf8996-d093",
          "identification": "si...42@wellsroofing.com"
        }
      ]
    },
    {
      "creditRealTimePaymentId": "071db898-b220",
      "groupId": "group-01",
      "approvers": [
        {
          "name": "Tom Allison",
          "id": "327d8bea-2553",
          "identification": "to...58@wellsroofing.com"
        },
        {
          "name": "Carl Thompson",
          "id": "d7da1cc5-8056",
          "identification": "ca...39@wellsroofing.com"
        }
      ]
    }
  ]
}

Eligible Credit Real-Time Payment Approvers (v1.0.0)

Properties

Name	Description
`Eligible Credit Real-Time Payment Approvers (v1.0.0)`	`object` A list of customers eligible to approve one or more credit real-time payments. In the example, `items[0]` and `items[1]` both have the same `groupId` value, indicating that those two payments have the same list of approvers, while the approver list for the third payment (`items[2]`) differs.
`items`	`array: [creditRealTimePaymentApproverList]` (required) The list of credit real-time payments and list of customers eligible to approve the payment. `minItems: 1` `maxItems: 1000` items: `object`

externalResourceId

"string"

External Resource Identifier (v1.1.0)

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

type: string(text)

read-only
format: text
minLength: 1
maxLength: 256

isoCompliantPartialAddress

{
  "address1": "1805 Tiburon Dr.",
  "address2": "Building 14, Suite 1500",
  "locality": "Wilmington",
  "regionCode": "NC",
  "countryCode": "US",
  "postalCode": "28403"
}

ISO-Compliant Partial Address (v1.0.1)

A partial ISO 20022 postal address that can hold a US address or an international (non-US) postal addresses. Partial addresses do not require any property to have a value.

Properties

Name	Description
`ISO-Compliant Partial Address (v1.0.1)`	`object` A partial ISO 20022 postal address that can hold a US address or an international (non-US) postal addresses. Partial addresses do not require any property to have a value.
`address1`	`string(text)` The first line of the postal address. In the US, this typically includes the building number and street name. `format: text` `maxLength: 70`
`address2`	`string(text)` The second line of the street address. This should only be used if it has a value. Typical values include building numbers, suite numbers, and other identifying information beyond the first line of the postal address. `format: text` `maxLength: 70`
`locality`	`string(text)` The city/town/municipality of the address. `format: text` `maxLength: 35`
`countryCode`	`countryCode` The ISO-3611 alpha-2 value for a country. `minLength: 2` `maxLength: 2` `pattern: "^[A-Za-z]{2}$"`
`regionName`	`string(text)` The state, district, or outlying area of the postal address. This is required if `countryCode` is not `US`. `regionCode` and `regionName` are mutually exclusive. `format: text` `minLength: 1` `maxLength: 35`
`regionCode`	`string` The state, district, or outlying area of the postal address. This is required if `countryCode` is `US`. `regionCode` and `regionName` are mutually exclusive. `minLength: 2` `maxLength: 2` `pattern: "^[A-Za-z]{2}$"`
`postalCode`	`isoCompliantPostalCode(text)` The ISO 20022 postal code, which varies in format by country. For postal codes in the US, this should be a five digit US ZIP code or ten character ZIP+4. `format: text` `minLength: 2` `maxLength: 16`

isoCompliantPostalCode

"20521"

ISO-Compliant Postal code (v1.0.0)

The ISO 20022 postal code, which varies in format by country. For postal codes in the US, this should be a five digit US ZIP code or ten character ZIP+4.

type: string(text)

format: text
minLength: 2
maxLength: 16

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.1)

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(decimal)

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

money

{
  "value": "1000.00",
  "currency": "USD"
}

Money (v1.0.2)

An amount of money in a specific currency.

Properties

Name	Description
`Money (v1.0.2)`	`object` An amount of money in a specific currency.
`value`	`monetaryValue(decimal)` The net monetary value. A negative amount denotes a debit; a positive amount denotes a credit. The numeric value is represented as a string so that it can be exact with no loss of precision. `format: decimal` `maxLength: 16` `pattern: "^(0\|[1-9][0-9]*)\\.[0-9][0-9]$"`
`currency`	`currencyCode(text)` The ISO 4217 currency code for this monetary value. `format: text` `minLength: 3` `maxLength: 3` `pattern: "^[A-Z]{3}$"`

newCreditRealTimePayment

{
  "customerId": "4242923b-714e",
  "sourceAccount": {
    "id": "bf23bc970b78d27691e8",
    "nickname": "Premiere Checking",
    "label": "Premiere Checking *1008",
    "maskedNumber": "*1008",
    "type": "checking"
  },
  "amount": {
    "value": "100.00",
    "currency": "USD"
  },
  "sender": {
    "governmentIssuedId": "112223333",
    "name": "Buffalo Mountain Sports",
    "address": {
      "address1": "123 Main Street",
      "address2": "Building 14, Suite 1500",
      "locality": "Miami",
      "regionCode": "FL",
      "countryCode": "US",
      "postalCode": "12345"
    }
  },
  "recipient": {
    "name": "Exquisite Creations Interior Design & Renovation Services",
    "address": {
      "address1": "123 Hierarchy Lane",
      "locality": "Miami",
      "regionCode": "FL",
      "countryCode": "US",
      "postalCode": "12003"
    },
    "fullAccountNumber": "123456789",
    "institution": {
      "name": "Bank of America",
      "routingNumber": "123123123"
    }
  },
  "endToEndId": "E2E-Ref001",
  "remittanceAdvice": {
    "method": "email",
    "address": "info@example.com",
    "message": "Payment for invoice INV-123"
  }
}

New Credit Real-Time Payment (v5.0.0)

Representation used to create a new credit real-time payment.

Properties

Name	Description
`New Credit Real-Time Payment (v5.0.0)`	`object` Representation used to create a new credit real-time payment.
`customerId`	`realTimePaymentCustomerId` The ID of the customer who created the credit real-time payment. `read-only` `minLength: 6` `maxLength: 48` `pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"`
`sourceAccount`	`creditRealTimePaymentAccountReference` (required) The banking account used to send the credit real-time payment. This is always an internal banking account of the user.
`amount`	`realTimePaymentAmount` (required) The ISO 20022 settlement amount of the real-time payment. The maximum allowed total digits is 14, and the maximum allowed fractional digits is 2.
`sender`	`creditRealTimePaymentSender` (required) The sender of the credit real-time payment.
`recipient`	`newRealTimePaymentRecipient` (required) Representation of a new recipient of the credit real-time payment.
`endToEndId`	`realTimePaymentEndToEndId(text)` Information supplied by the initiating party (user or business) to identify the payment. This not required to be unique and is immutable once submitted. `format: text` `maxLength: 35`
`remittanceAdvice`	`remittanceAdvice` Information related to remittance advice of the real-time payment. Remittance advice is supplemental information sent from the payer to the payee that includes information about the payment such as amount and invoice number(s) in order to assist with account reconciliation and record-keeping.

newRealTimePaymentRecipient

{
  "name": "Exquisite Creations Interior Design & Renovation Services",
  "address": {
    "address1": "123 Hierarchy Lane",
    "locality": "Miami",
    "regionCode": "FL",
    "countryCode": "US",
    "postalCode": "12003"
  },
  "fullAccountNumber": "123456789",
  "institution": {
    "name": "Bank of America",
    "routingNumber": "123123123"
  }
}

New Real-Time Payment Recipient (v2.0.0)

Representation of a new recipient of the credit real-time payment.

Properties

Name	Description
`New Real-Time Payment Recipient (v2.0.0)`	`object` Representation of a new recipient of the credit real-time payment.
`name`	`realTimePaymentRecipientName(text)` (required) The name of the recipient. `format: text` `minLength: 1` `maxLength: 140`
`address`	`isoCompliantPartialAddress` The address of the recipient. If any fields are provided, `address1`, `countryCode`, `locality`, `regionName`/`regionCode`, and `postalCode` are required.
`fullAccountNumber`	`realTimePaymentRecipientAccountNumber(text)` (required) The recipient's account number used for the real-time payment. `format: text` `minLength: 1` `maxLength: 34`
`institution`	`recipientInstitution` (required) The financial institution of the recipient used for the real-time payment.

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.

productType

"savings"

Product Type (v2.2.0)

The type (or category) of banking product.

productType strings may have one of the following enumerated values:

Value	Description
`savings`	Savings: Savings Account
`checking`	Checking: Checking Account
`cd`	CD: Certificate of Deposit Account
`ira`	IRA: Individual Retirement Account
`loan`	Loan: Loan Account
`creditCard`	Credit Card: Credit Card Account
`moneyMarket`	Money Market: Money Market Account
`healthSavings`	Health Savings: Health Savings Account

type: string

enum values: savings, checking, cd, ira, loan, creditCard, moneyMarket, healthSavings

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

realTimePaymentAmount

{
  "value": "1000.00",
  "currency": "USD",
  "amount": {
    "value": "100.00",
    "currency": "USD"
  }
}

Real-Time Payment Amount (v1.0.0)

The ISO 20022 settlement amount of the real-time payment. The maximum allowed total digits is 14, and the maximum allowed fractional digits is 2.

Properties

Name	Description
`Real-Time Payment Amount (v1.0.0)`	`object` The ISO 20022 settlement amount of the real-time payment. The maximum allowed total digits is 14, and the maximum allowed fractional digits is 2.
`value`	`monetaryValue(decimal)` The net monetary value. A negative amount denotes a debit; a positive amount denotes a credit. The numeric value is represented as a string so that it can be exact with no loss of precision. `format: decimal` `maxLength: 16` `pattern: "^(0\|[1-9][0-9]*)\\.[0-9][0-9]$"`
`currency`	`currencyCode(text)` The ISO 4217 currency code for this monetary value. `format: text` `minLength: 3` `maxLength: 3` `pattern: "^[A-Z]{3}$"`

realTimePaymentConfirmationId

"12345"

Real-Time Payment Confirmation ID (v1.0.0)

Unique ID generated by the initiating system or institution for the purpose of tracking the payment.

type: string(text)

read-only
format: text
minLength: 1
maxLength: 256

realTimePaymentContact

{
  "name": "John Smith",
  "emailAddress": "johnsmith.doe@business.com",
  "phoneNumber": "+19105550155"
}

Real-Time Payment Contact (v1.0.0)

The contact information for the individual or business entity which sent the real-time payment.

Properties

Name	Description
`Real-Time Payment Contact (v1.0.0)`	`object` The contact information for the individual or business entity which sent the real-time payment.
`name`	`string(text)` The name of the payment contact. `format: text` `maxLength: 140`
`emailAddress`	`string(email)` The email address of the payment contact. `format: email` `maxLength: 255`
`phoneNumber`	`simplePhoneNumber(phone-number)` The phone number of the payment contact. `format: phone-number` `minLength: 5` `maxLength: 20`

realTimePaymentCustomerId

"4242923b-714e"

Real-Time Payment Customer ID (v1.0.0)

The ID of the customer who created the credit real-time payment.

type: string

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

realTimePaymentEndToEndId

"E2E-Ref001"

Real-Time Payment End-To-End ID (v1.0.1)

Information supplied by the initiating party (user or business) to identify the payment. This not required to be unique and is immutable once submitted.

type: string(text)

format: text
maxLength: 35

realTimePaymentHistoryRecord

{
  "type": "created",
  "customerId": "4242923b-714e",
  "customerName": "Karl Knox",
  "occurredAt": "2022-07-28T12:44:46.375Z"
}

Real-Time Payment History Record (v1.0.0)

Representation of a real-time payment history record resource.

Properties

Name	Description
`Real-Time Payment History Record (v1.0.0)`	`object` Representation of a real-time payment history record resource.
`type`	`realTimePaymentHistoryRecordType` (required) The type of real-time payment activity; this describes what the customer did with the real-time payment. enum values: `created`, `approved`, `requestedApproval`, `rejected`, `updated`
`customerId`	`readOnlyResourceId` (required) The ID of the customer who performed the action. `read-only` `minLength: 6` `maxLength: 48` `pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"`
`customerName`	`string(text)` (required) The name of the customer who performed the action. This is the customer's name at the time the action occurred. `format: text` `maxLength: 50`
`occurredAt`	`readOnlyTimestamp(date-time)` (required) The date and time when the customer performed the action. `read-only` `format: date-time` `minLength: 20` `maxLength: 30`
`approvers`	`array: [realTimePaymentHistoryRecordApprover]` A list of customers who were added as approvers for this real-time payment. This field is set only if `type` is `approvalRequested`. `maxItems: 8` items: `object`
`reason`	`string(text)` The reason given for rejecting a real-time payment. This field is set only if `type` is `rejected`. `format: text` `maxLength: 80`
`updateTypes`	`array: [realTimePaymentHistoryUpdateTypeItem]` For the `type` of `updated`, this indicates how the real-time payment was updated. Additional details for this changeset beyond the first 50 changes are excluded. `maxItems: 50` items: `object`

realTimePaymentHistoryRecordApprover

{
  "id": "string",
  "name": "string"
}

Real-Time Payment History Record Approver (v1.0.0)

Representation of a real-time payment history record approver.

Properties

Name	Description
`Real-Time Payment History Record Approver (v1.0.0)`	`object` Representation of a real-time payment history record approver.
`id`	`readOnlyResourceId` The ID of the customer who was asked to approve this payment. `read-only` `minLength: 6` `maxLength: 48` `pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"`
`name`	`string(text)` The name of the customer who was asked to approve this payment. `format: text` `minLength: 2` `maxLength: 50`

realTimePaymentHistoryRecordType

"created"

Real-Time Payment History Record Type (v1.0.0)

The type of a real-time payment history record.

realTimePaymentHistoryRecordType strings may have one of the following enumerated values:

Value	Description
`created`	Created: The customer created this real-time payment
`approved`	Approved: The customer approved this real-time payment
`requestedApproval`	Requested Approval: The customer requested approval of this real-time payment by adding approvers
`rejected`	Rejected: The customer rejected this real-time payment
`updated`	Updated: The customer updated this real-time payment

type: string

enum values: created, approved, requestedApproval, rejected, updated

realTimePaymentHistoryRecords

{
  "items": [
    {
      "type": "approved",
      "customerId": "b9815cc6-85a7",
      "customerName": "Alex Frank",
      "occurredAt": "2022-07-29T04:18:49.375Z"
    },
    {
      "type": "requestedApproval",
      "customerId": "4242923b-714e",
      "customerName": "Karl Knox",
      "occurredAt": "2022-07-28T12:54:30.000Z"
    },
    {
      "type": "updated",
      "customerId": "4242923b-714e",
      "customerName": "Karl Knox",
      "occurredAt": "2022-07-28T12:49:22.000Z",
      "updateType": "amountUpdated"
    },
    {
      "type": "created",
      "customerId": "4242923b-714e",
      "customerName": "Karl Knox",
      "occurredAt": "2022-07-28T12:44:46.375Z"
    }
  ]
}

Real-Time Payment History Record Collection (v1.1.0)

Collection of real-time payment history records.

Properties

Name	Description
`Real-Time Payment History Record Collection (v1.1.0)`	`object` Collection of real-time payment history records.
`items`	`array: [realTimePaymentHistoryRecord]` (required) An array containing real-time payment history record items. `maxItems: 10000` items: `object`

realTimePaymentHistoryUpdateType

"sourceAccountUpdated"

Real-Time Payment History Update Type (v1.0.0)

Describes how a real-time payment was updated.

realTimePaymentHistoryUpdateType strings may have one of the following enumerated values:

Value	Description
`sourceAccountUpdated`	Source Account Updated: The source account was updated for this real-time payment
`amountUpdated`	Amount Updated: The amount was updated for this real-time payment
`senderIdUpdated`	Sender ID Updated: The sender ID was updated for this real-time payment
`senderNameUpdated`	Sender Name Updated: The sender name was updated for this real-time payment
`senderAddressUpdated`	Sender Address Updated: The sender address was updated for this real-time payment
`senderContactNameUpdated`	Sender Contact Name Updated: The sender contact name was updated for this real-time payment
`senderContactEmailAddressUpdated`	Sender Contact Email Address Updated: The sender contact email address was updated for this real-time payment
`senderContactPhoneNumberUpdated`	Sender Contact Phone Number Updated: The sender contact phone number was updated for this real-time payment
`recipientNameUpdated`	Recipient Name Updated: The recipient name was updated for this real-time payment
`recipientAddressUpdated`	Recipient Address Updated: The recipient address was updated for this real-time payment
`recipientAccountNumberUpdated`	Recipient Account Number Updated: The recipient account number was updated for this real-time payment
`recipientInstitutionNameUpdated`	Recipient Institution Name Updated: The recipient institution name was updated for this real-time payment
`recipientInstitutionRoutingNumberUpdated`	Recipient Institution Routing Number Updated: The recipient institution routing number was updated for this real-time payment
`endToEndIdUpdated`	End to End ID Updated: The end to end ID was updated for this real-time payment
`remittanceAdviceMethodUpdated`	Remittance Advice Method Updated: The remittance advice method was updated for this real-time payment
`remittanceAdviceAddressUpdated`	Remittance Advice Address Updated: The remittance advice address was updated for this real-time payment
`remittanceAdviceMessageUpdated`	Remittance Advice Message Updated: The remittance advice message was updated for this real-time payment

type: string

enum values: sourceAccountUpdated, amountUpdated, senderIdUpdated, senderNameUpdated, senderAddressUpdated, senderContactNameUpdated, senderContactEmailAddressUpdated, senderContactPhoneNumberUpdated, recipientNameUpdated, recipientAddressUpdated, recipientAccountNumberUpdated, recipientInstitutionNameUpdated, recipientInstitutionRoutingNumberUpdated, endToEndIdUpdated, remittanceAdviceMethodUpdated, remittanceAdviceAddressUpdated, remittanceAdviceMessageUpdated

realTimePaymentHistoryUpdateTypeItem

{
  "type": "sourceAccountUpdated"
}

Real-Time Payment History Update Type Item (v1.0.0)

The summary of what was updated on a real-time payment.

Properties

Name Description

Real-Time Payment History Update Type Item (v1.0.0) object
The summary of what was updated on a real-time payment.

type realTimePaymentHistoryUpdateType (required)
The canonical type representing an update.
enum values: sourceAccountUpdated, amountUpdated, senderIdUpdated, senderNameUpdated, senderAddressUpdated, senderContactNameUpdated, senderContactEmailAddressUpdated, senderContactPhoneNumberUpdated, recipientNameUpdated, recipientAddressUpdated, recipientAccountNumberUpdated, recipientInstitutionNameUpdated, recipientInstitutionRoutingNumberUpdated, endToEndIdUpdated, remittanceAdviceMethodUpdated, remittanceAdviceAddressUpdated, remittanceAdviceMessageUpdated

realTimePaymentRecipient

{
  "name": "Exquisite Creations Interior Design & Renovation Services",
  "address": {
    "address1": "123 Hierarchy Lane",
    "locality": "Miami",
    "regionCode": "FL",
    "countryCode": "US",
    "postalCode": "12003"
  },
  "maskedAccountNumber": "*6789",
  "fullAccountNumber": "123456789",
  "institution": {
    "name": "Bank of America",
    "routingNumber": "123123123"
  }
}

Real-Time Payment Recipient (v3.0.0)

The recipient of the credit real-time payment.

Properties

Name	Description
`Real-Time Payment Recipient (v3.0.0)`	`object` The recipient of the credit real-time payment.
`name`	`realTimePaymentRecipientName(text)` (required) The name of the recipient. `format: text` `minLength: 1` `maxLength: 140`
`address`	`isoCompliantPartialAddress` The address of the recipient. If any fields are provided, `address1`, `countryCode`, `locality`, `regionName`/`regionCode`, and `postalCode` are required.
`fullAccountNumber`	`realTimePaymentRecipientAccountNumber(text)` The recipient's account number used for the real-time payment. `format: text` `minLength: 1` `maxLength: 34`
`institution`	`recipientInstitution` (required) The financial institution of the recipient used for the real-time payment.
`maskedAccountNumber`	`maskedAccountNumber` (required) A masked account number: an asterisk `` followed by one to four characters of the `fullAccountNumber`. `minLength: 2` `maxLength: 5` `pattern: "^\\[- _a-zA-Z0-9.]{1,4}$"`

realTimePaymentRecipientAccountEligibility

{
  "eligible": true,
  "institutionName": "Bank of America",
  "problems": []
}

Recipient Account Eligibility (v1.0.0)

Response for a real-time payments eligibility check for a recipient account.

Properties

Name	Description
`Recipient Account Eligibility (v1.0.0)`	`object` Response for a real-time payments eligibility check for a recipient account.
`eligible`	`boolean` (required) `true` if the recipient account is eligible to receive credit real-time payments.
`institutionName`	`realTimePaymentRecipientInstitutionName(text)` The name of the institution. `format: text` `maxLength: 140`
`problems`	`array: [apiProblem]` If the recipient account is not eligible to receive credit real-time payments (`eligible` is `false`), this describes why, if this information is available. `maxItems: 4` items: `object`

realTimePaymentRecipientAccountEligibilityRequest

{
  "customerId": "4242923b-714e",
  "recipientName": "Exquisite Creations Interior Design & Renovation Services",
  "fullAccountNumber": "123456789",
  "routingNumber": "123123123"
}

Recipient Account Eligibility Request (v3.0.0)

Request for a real-time payments eligibility check for a recipient account.

Properties

Name	Description
`Recipient Account Eligibility Request (v3.0.0)`	`object` Request for a real-time payments eligibility check for a recipient account.
`customerId`	`realTimePaymentCustomerId` The ID of the customer who created the credit real-time payment. `read-only` `minLength: 6` `maxLength: 48` `pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"`
`recipientName`	`realTimePaymentRecipientName(text)` The name of the recipient. `format: text` `minLength: 1` `maxLength: 140`
`fullAccountNumber`	`realTimePaymentRecipientAccountNumber(text)` (required) The recipient's account number used for the real-time payment. `format: text` `minLength: 1` `maxLength: 34`
`routingNumber`	`accountRoutingNumber` (required) An account ABA routing and transit number. `minLength: 9` `maxLength: 9` `pattern: "^[0-9]{9}$"`

realTimePaymentRecipientAccountNumber

"123456789"

(v1.0.0)*

The recipient's account number used for the real-time payment.

type: string(text)

format: text
minLength: 1
maxLength: 34

realTimePaymentRecipientInstitutionName

"Bank of America"

Recipient Institution Name (v1.0.0)

The name of the institution.

type: string(text)

format: text
maxLength: 140

realTimePaymentRecipientName

"Exquisite Creations Interior Design & Renovation Services"

(v1.0.0)*

The name of the recipient.

type: string(text)

format: text
minLength: 1
maxLength: 140

realTimePaymentRecipientPatch

{
  "name": "Exquisite Creations Interior Design & Renovation Services",
  "address": {
    "address1": "123 Hierarchy Lane",
    "locality": "Miami",
    "regionCode": "FL",
    "countryCode": "US",
    "postalCode": "12003"
  },
  "fullAccountNumber": "123456789",
  "institution": {
    "name": "Bank of America",
    "routingNumber": "123123123"
  }
}

Real-Time Payment Recipient Patch (v2.0.0)

Representation of a patch to the recipient of the credit real-time payment.

Properties

Name	Description
`Real-Time Payment Recipient Patch (v2.0.0)`	`object` Representation of a patch to the recipient of the credit real-time payment.
`name`	`realTimePaymentRecipientName(text)` The name of the recipient. `format: text` `minLength: 1` `maxLength: 140`
`address`	`isoCompliantPartialAddress` The address of the recipient.
`fullAccountNumber`	`realTimePaymentRecipientAccountNumber(text)` The recipient's account number used for the real-time payment. `format: text` `minLength: 1` `maxLength: 34`
`institution`	`recipientInstitutionPatch` The financial institution of the recipient used for the real-time payment.

realTimePaymentRecipientSummary

{
  "name": "Exquisite Creations Interior Design & Renovation Services"
}

Real-Time Payment Recipient Summary (v1.0.1)

A summary version of the real-time payment recipient.

Properties

Name	Description
`Real-Time Payment Recipient Summary (v1.0.1)`	`object` A summary version of the real-time payment recipient.
`name`	`realTimePaymentRecipientName(text)` (required) The name of the recipient. `format: text` `minLength: 1` `maxLength: 140`

realTimePaymentRecipients

{
  "customerId": "4242923b-714e",
  "items": [
    {
      "name": "Billy Bob Jordan",
      "address": {
        "address1": "123 Maple Lane",
        "locality": "Jacksonville",
        "regionCode": "FL",
        "countryCode": "US",
        "postalCode": "33333"
      },
      "maskedAccountNumber": "*1111",
      "fullAccountNumber": "111111111",
      "institution": {
        "name": "Wells Fargo",
        "routingNumber": "222222222"
      }
    },
    {
      "name": "Exquisite Creations Interior Design & Renovation Services",
      "address": {
        "address1": "123 Hierarchy Lane",
        "locality": "Miami",
        "regionCode": "FL",
        "countryCode": "US",
        "postalCode": "12003"
      },
      "maskedAccountNumber": "*6789",
      "fullAccountNumber": "123456789",
      "institution": {
        "name": "Bank of America",
        "routingNumber": "123123123"
      }
    }
  ]
}

Real-Time Payment Recipients List (v2.0.0)

A list of the most recent unique credit real-time payment recipients, limited to two hundred recipients. The items in the list are ordered in the items array.

Properties

Name	Description
`Real-Time Payment Recipients List (v2.0.0)`	`object` A list of the most recent unique credit real-time payment recipients, limited to two hundred recipients. The items in the list are ordered in the `items` array.
`customerId`	`realTimePaymentCustomerId` The ID of the customer who created the credit real-time payment. `read-only` `minLength: 6` `maxLength: 48` `pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"`
`items`	`array: [realTimePaymentRecipient]` (required) An array containing the most recent unique recipients `maxItems: 200` items: `object`

realTimePaymentTrackingNumber

"12345678"

Real-Time Payment Tracking Number (v1.0.0)

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

type: string

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

recentRealTimePaymentRecipients

{
  "customerId": "4242923b-714e",
  "items": [
    {
      "name": "Exquisite Creations Interior Design & Renovation Services",
      "address": {
        "address1": "123 Hierarchy Lane",
        "locality": "Miami",
        "regionCode": "FL",
        "countryCode": "US",
        "postalCode": "12003"
      },
      "maskedAccountNumber": "*6789",
      "fullAccountNumber": "123456789",
      "institution": {
        "name": "Bank of America",
        "routingNumber": "123123123"
      }
    },
    {
      "name": "Billy Bob Jordan",
      "address": {
        "address1": "123 Maple Lane",
        "locality": "Jacksonville",
        "regionCode": "FL",
        "countryCode": "US",
        "postalCode": "33333"
      },
      "maskedAccountNumber": "*1111",
      "fullAccountNumber": "111111111",
      "institution": {
        "name": "Wells Fargo",
        "routingNumber": "222222222"
      }
    }
  ]
}

Recent Real-Time Payment Recipients List (v3.0.0)

A list of the most recent unique credit real-time payment recipients, limited to five recipients. The items in the list are ordered in the items array.

Properties

Name	Description
`Recent Real-Time Payment Recipients List (v3.0.0)`	`object` A list of the most recent unique credit real-time payment recipients, limited to five recipients. The items in the list are ordered in the `items` array.
`customerId`	`realTimePaymentCustomerId` The ID of the customer who created the credit real-time payment. `read-only` `minLength: 6` `maxLength: 48` `pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"`
`items`	`array: [realTimePaymentRecipient]` (required) An array containing the most recent unique recipients `maxItems: 5` items: `object`

recipientInstitution

{
  "name": "Bank of America",
  "routingNumber": "123123123"
}

Recipient Institution (v2.0.1)

A representation of a financial institution used for real-time payments.

Properties

Name	Description
`Recipient Institution (v2.0.1)`	`object` A representation of a financial institution used for real-time payments.
`name`	`realTimePaymentRecipientInstitutionName(text)` The name of the institution. `format: text` `maxLength: 140`
`routingNumber`	`accountRoutingNumber` (required) An account ABA routing and transit number. `minLength: 9` `maxLength: 9` `pattern: "^[0-9]{9}$"`

recipientInstitutionPatch

{
  "name": "Bank of America",
  "routingNumber": "123123123"
}

Recipient Institution Patch (v1.0.1)

A representation of a patch to the financial institution used for real-time payments.

Properties

Name	Description
`Recipient Institution Patch (v1.0.1)`	`object` A representation of a patch to the financial institution used for real-time payments.
`name`	`realTimePaymentRecipientInstitutionName(text)` The name of the institution. `format: text` `maxLength: 140`
`routingNumber`	`accountRoutingNumber` An account ABA routing and transit number. `minLength: 9` `maxLength: 9` `pattern: "^[0-9]{9}$"`

remittanceAdvice

{
  "method": "email",
  "address": "info@example.com",
  "message": "Payment for invoice INV-123"
}

Remittance Advice (v1.0.2)

Information related to remittance advice of the real-time payment. Remittance advice is supplemental information sent from the payer to the payee that includes information about the payment such as amount and invoice number(s) in order to assist with account reconciliation and record-keeping.

Properties

Name Description

Remittance Advice (v1.0.2) object
Information related to remittance advice of the real-time payment. Remittance advice is supplemental information sent from the payer to the payee that includes information about the payment such as amount and invoice number(s) in order to assist with account reconciliation and record-keeping.

method

remittanceAdviceMethod

Indicates the method used to electronically deliver the remittance advice information.

remittanceAdviceMethod strings may have one of the following enumerated values:

Value	Description
`email`	Email: Indicates that the remittance advice information is delivered by email
`uri`	URI: Indicates that the remittance advice information is available on a web page at a URL

enum values: email, uri

address string(text)
Depending on the remittanceAdviceMethod, this is either an email address or a URI used to digitally deliver remittance advice information.
format: text
maxLength: 2048

message string(text)
Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle in an unstructured form.
format: text
maxLength: 140

remittanceAdviceMethod

"email"

Remittance Advice Method (v1.0.1)

Indicates the method used to electronically deliver the remittance advice information.

remittanceAdviceMethod strings may have one of the following enumerated values:

Value	Description
`email`	Email: Indicates that the remittance advice information is delivered by email
`uri`	URI: Indicates that the remittance advice information is available on a web page at a URL

type: string

enum values: email, uri

requiredIdentityChallenge

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

Required Challenge (v1.2.3)

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

Properties

Name	Description
`Required Challenge (v1.2.3)`	`object` A request from the service for the user to verify their identity. This contains a challenge ID, the corresponding operation ID, and a list of challenge factors for identity verification. The user must complete one of these challenge factors to satisfy the challenge. This schema defines the attributes in the 401 Unauthorized problem response when the 401 problem type name is `challengeRequired`. See the "Challenge API" for details.
`operationId`	`challengeOperationId` (required) The ID of an operation/action for which the user must verify their identity via an identity challenge. This is passed when starting a challenge factor or when validating the identity challenge responses. `minLength: 6` `maxLength: 48` `pattern: "^[-a-zA-Z0-9$_]{6,48}$"`
`challengeId`	`readOnlyResourceId` (required) The unique ID of this challenge instance. This is an opaque string. This is passed when starting a challenge factor or when validating the identity challenge responses. `read-only` `minLength: 6` `maxLength: 48` `pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"`
`factors`	`array: [challengeFactor]` (required) A list of challenge factors. The user must complete one of these challenge factors. The `labels` in each factor identify one or more channels the user may use, such as a list of email addresses the system may use to send a one-time passcode to the user. *Note: The same channel may be used by multiple factors in the array of factors. For example, the user's primary mobile phone number may be used for both an `sms` factor and a `voice` factor. `minItems: 1` `maxItems: 8` items: `object`

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}$"

simplePhoneNumber

"+19105550155"

Simple Phone Number (v1.1.0)

The phone number as a string. The service strips all spaces, hyphens, periods and parentheses from input. The default country code prefix is +1. Phone numbers are returned in responses in E.164 format with a leading +, country code (up to 3 digits) and subscriber number for a total of up to 15 digits. See Phone Number Representations for more information. If the number is masked to hide Personally Identifiable Information, all but the last four digits are replaced with one or more *, such as *1234.

type: string(phone-number)

format: phone-number
minLength: 5
maxLength: 20

Generated by @apiture/api-doc 3.2.4 on Wed Mar 26 2025 19:42:30 GMT+0000 (Coordinated Universal Time).