Shell HTTP Node.JS JavaScript Ruby Python Java Go

Debit Cards v0.24.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.

The Debit Card Management API provides operations for managing debit cards issued by a financial institution. This API allows card holders to perform various operations on their debit cards, linked to checking or savings accounts, such as monitoring usage.

Gathering Cards

When retrieving a list of debit cards, a card provider allows either gathering the list within the context of an account or gathering the list within the context of the current customer or member. Card providers only allow one of these contexts; the list cannot be gathered by both the customer and the account.

The card provider context is retrieved using the getDebitCardProvider operation. This operation's response contains provider.context which has the value of account or customer.

If the provider.context is account, find a valid debit card account using the listAccounts operation with ?productType=savings|checking|moneyMarket. Upon success of the listAccounts operation, use an id from the response as the accountId path parameter on listDebitCards to retrieve all debit cards for the debit card account represented by that id.

If the provider.context is customer, instead use listCustomerDebitCards to retrieve a list of the customer's debit cards.

Use provider.merchantCategories to determine which merchant categories are allowed within alert subscriptions and transaction rules.

Identity Challenges

The card provider also indicates whether operations in the API are enabled for the current financial institution, as well as if they require an identity challenge to be completed before invoking the operation as a security measure. For example, the changeDebitCardPin operation may require a completed identity challenge.

If provider.operations.changeDebitCardPin.requiresIdentityChallenge is true, the client should call createDebitCardChallenge or createCustomerDebitCardChallenge, depending on the value of provider.context, passing in a request body { "type": "changePin" } to create a new identity challenge for the changeDebitCardPin operation, then start the new challenge. Once the challenge process completes, pass the generated challengeToken in the completed challenge as the Challenge request header on the changeDebitCardPin operation. See the "Challenges API" for additional information.

Primary Account Numbers (PANs)

A primary account number (PAN) is a numeric identifier assigned to debit cards for financial transactions. It typically consists of 16 digits and can be found on the front or back of a debit card. The PAN helps financial institutions, merchants, and other entities securely identify account holders during transactions.

Activating Cards

Debit cards are activated through the activateDebitCard operation. Cards are activated by submitting the full card number of the new card and other additional card details for verification.

Lost, Stolen or Damaged Cards

When cards are lost, stolen, or damaged, they can be reported to the financial institution and a new card will be sent to the primary address of the primary cardholder. When a card is reported as damaged, the card is reissued. A reissued card has the same PAN as the damaged card, but a different expiration date and security code. Cards reported as lost or stolen are replaced with cards that have a new PAN, as well as a different expiration date and security code. Cards can be reported as lost, stolen, or damaged through the reportDebitCard operation. When cards are reported as lost or stolen, they have a state of disabled until the replacement cards are activated. Cards reported as damaged may be used until the reissued card is activated.

Travel Notifications

When traveling, cardholders can create travel notifications when they plan to use their cards outside their typical geographic regions, so that such use is not tagged as possibly fraudulent. Travel notifications are unrelated to other notification channels, such as in-app notifications, email, or SMS. Travel notifications are independent of any transaction rules, such as authorized regions, and as such, do not change the values set for transaction rules. Some financial institutions may allow authorized region rules to be ignored.

Alert Subscriptions

Customers or members can manage alert subscriptions. Alert subscriptions define how a customer or member wants to be notified on specified communication channels, such as e-mail or device notifications. Each alert subscription can configure a different communication channel to send alerts to. Some alert subscriptions require additional configuration.

Transaction Rules

Customers or members can also manage transaction rules. Transaction rules allow the financial institution to automatically deny transactions on behalf of the customer or member. For example, card transactions can be denied based on the geographic location of the merchant or if a transaction exceeds a specified threshold.

Download OpenAPI Definition (YAML)

Base URLs:

Terms of service

Email: Apiture Web: Apiture

License: Apiture API License

Authentication

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

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

Debit Cards

Banking Debit Cards

listCustomerDebitCards

Code samples

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


GET https://api.apiture.com/banking/debitCards 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/debitCards',
{
  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/debitCards',
  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/debitCards',
  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/debitCards', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://api.apiture.com/banking/debitCards");
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/debitCards", data)
    req.Header = headers

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

Return a collection of debit card resources

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

Return a collection of debit card resources for the current customer or member. The list may be empty if the customer or member does not have any debit cards. If the customer or member is not the primary cardholder, they will only see debit card resources for which they are authorized.

Use this operation if the debit card provider context is customer. If the debit card provider context is account, use listDebitCards instead.

Example responses

200 Response

{
  "items": [
    {
      "id": "0399abed-fd3d",
      "type": "physical",
      "state": "active",
      "issuerIdentificationNumber": "4242",
      "displayName": "PHIL DUCIARY",
      "cardholder": {
        "name": "Phil Duciary",
        "type": "primary"
      },
      "maskedAccountNumber": "*1000",
      "allows": {
        "activate": false,
        "viewTransactions": true,
        "viewUnmaskedSecurityCode": true,
        "reportLost": true,
        "reportFound": false,
        "reportStolen": true,
        "reportDamaged": true,
        "lock": true,
        "unlock": false,
        "changePin": true,
        "manageTravelNotifications": true
      }
    }
  ]
}

Responses

StatusDescription
200 OK
OK.
Schema: debitCards
StatusDescription
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:

Schema: Inline
StatusDescription
403 Forbidden

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

This problem responsemay have one of the following type values:

Schema: Inline
StatusDescription
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:

StatusDescription
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:

Schema: Inline
StatusDescription
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
StatusDescription
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.

getCustomerDebitCard

Code samples

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


GET https://api.apiture.com/banking/debitCards/{debitCardId} HTTP/1.1
Host: api.apiture.com
Accept: application/json
Challenge: string


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

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

};

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

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


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

};

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

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


require 'rest-client'
require 'json'

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

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

p JSON.parse(result)


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

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

}, headers = headers)

print r.json()


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

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

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

Fetch a representation of this debit card resource

GET https://api.apiture.com/banking/debitCards/{debitCardId}

Return the JSON representation of this debit card resource.

Some actions may not be available based on the cardholder type.

The full debit card number and security code is not included in the response by default for security reasons. Include the unmasked query parameter with a comma-separated list of properties to request that the response body includes the full debit card number and security code, if available. The security code is not available on physical cards requiring activation. Such requests are auditable.

Note: This operation may require an identity challenge as described above in Identity Challenges. See the "Challenges API" for completing the identity challenge.

Parameters

ParameterDescription
debitCardId
in: path
 externalResourceId (required)
The unique identifier of this debit card. This is an opaque string.
read-only
format: text
minLength: 1
maxLength: 256
unmasked
in: query
 array[string]
When requesting details for a card, the full account number is not included in the response by default for security reasons. The security code is not included for physical cards, and may not be requested until the card has been activated. Because digitally issued cards do not require activation, there are not any restrictions on requesting the unmasked security code.

Include this query parameter with a comma-separated list of properties to unmask in the response body. Such requests are auditable.
unique items
minItems: 1
maxItems: 2
comma-delimited
items: string
» enum values: fullAccountNumber, securityCode

Challenge
in: header
 challengeToken
This operation may require a completed challenge. If the first attempt calling this operation fails with a 403 challengeRequired error, the client should complete the challenge flow as described in the Challenges API, then retry the operation with this Challenge request header using the challengeToken returned at the end of that flow. If this is passed but the value is invalid, the operation fails with a 403 status code and the invalidIdentityChallengeHeader problem type.
minLength: 6
maxLength: 255
pattern: "^[-_:.~%$a-zA-Z0-9]{6,255}$"

Example responses

200 Response

{
  "id": "0399abed-fd3d",
  "type": "physical",
  "state": "active",
  "issuerIdentificationNumber": "4242",
  "displayName": "PHIL DUCIARY",
  "cardholder": {
    "name": "Phil Duciary",
    "type": "primary",
    "address": {
      "address1": "1805 Tiburon Dr.",
      "locality": "Wilmington",
      "regionCode": "NC",
      "countryCode": "US",
      "postalCode": "28403"
    }
  },
  "maskedAccountNumber": "*1000",
  "expirationMonth": "12",
  "expirationYear": "29",
  "allows": {
    "activate": false,
    "viewTransactions": true,
    "viewUnmaskedSecurityCode": true,
    "reportLost": true,
    "reportFound": false,
    "reportStolen": true,
    "reportDamaged": true,
    "lock": true,
    "unlock": false,
    "changePin": true,
    "manageTravelNotifications": true
  }
}

Responses

StatusDescription
200 OK
OK.
Schema: debitCard
StatusDescription
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:

Schema: Inline
StatusDescription
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:

Schema: Inline
StatusDescription
403 Forbidden

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

This problem responsemay have one of the following type values:

Schema: Inline
StatusDescription
404 Not Found

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

This problem responsemay have one of the following type values:

Schema: Inline
StatusDescription
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:

StatusDescription
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:

Schema: Inline
StatusDescription
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
StatusDescription
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.

listDebitCards

Code samples

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


GET https://api.apiture.com/banking/accounts/{accountId}/debitCards 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/accounts/{accountId}/debitCards',
{
  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/accounts/{accountId}/debitCards',
  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/accounts/{accountId}/debitCards',
  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/accounts/{accountId}/debitCards', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://api.apiture.com/banking/accounts/{accountId}/debitCards");
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/accounts/{accountId}/debitCards", data)
    req.Header = headers

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

Return a collection of debit cards

GET https://api.apiture.com/banking/accounts/{accountId}/debitCards

Return a collection of debit cards for the current customer or member.

Use this operation if the debit card provider context is account. If the debit card provider context is customer, use listCustomerDebitCards instead.

Parameters

ParameterDescription
accountId
in: path
 resourceId (required)
The unique identifier of this account resource. This is an opaque string.
minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"

Example responses

200 Response

{
  "items": [
    {
      "id": "0399abed-fd3d",
      "type": "physical",
      "state": "active",
      "issuerIdentificationNumber": "4242",
      "displayName": "PHIL DUCIARY",
      "cardholder": {
        "name": "Phil Duciary",
        "type": "primary"
      },
      "maskedAccountNumber": "*1000",
      "allows": {
        "activate": false,
        "viewTransactions": true,
        "viewUnmaskedSecurityCode": true,
        "reportLost": true,
        "reportFound": false,
        "reportStolen": true,
        "reportDamaged": true,
        "lock": true,
        "unlock": false,
        "changePin": true,
        "manageTravelNotifications": true
      }
    }
  ]
}

Responses

StatusDescription
200 OK
OK.
Schema: debitCards
StatusDescription
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:

Schema: Inline
StatusDescription
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:

Schema: Inline
StatusDescription
403 Forbidden

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

This problem responsemay have one of the following type values:

Schema: Inline
StatusDescription
404 Not Found

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

This problem responsemay have one of the following type values:

Schema: Inline
StatusDescription
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:

StatusDescription
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:

Schema: Inline
StatusDescription
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
StatusDescription
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.

getDebitCard

Code samples

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


GET https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId} 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/accounts/{accountId}/debitCards/{debitCardId}',
{
  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/accounts/{accountId}/debitCards/{debitCardId}',
  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/accounts/{accountId}/debitCards/{debitCardId}',
  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/accounts/{accountId}/debitCards/{debitCardId}', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}");
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/accounts/{accountId}/debitCards/{debitCardId}", data)
    req.Header = headers

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

Fetch a representation of this debit card

GET https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}

Return the JSON representation of this debit card resource.

The full debit card number is not included in the response by default, for security reasons. Include the unmasked query parameter with a value of true to request that the response body includes the full debit card number. Such requests are auditable.

Parameters

ParameterDescription
accountId
in: path
 resourceId (required)
The unique identifier of this account resource. This is an opaque string.
minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
debitCardId
in: path
 externalResourceId (required)
The unique identifier of this debit card. This is an opaque string.
read-only
format: text
minLength: 1
maxLength: 256
unmasked
in: query
 array[string]
When requesting details for a card, the full account number is not included in the response by default for security reasons. The security code is not included for physical cards, and may not be requested until the card has been activated. Because digitally issued cards do not require activation, there are not any restrictions on requesting the unmasked security code.

Include this query parameter with a comma-separated list of properties to unmask in the response body. Such requests are auditable.
unique items
minItems: 1
maxItems: 2
comma-delimited
items: string
» enum values: fullAccountNumber, securityCode

Example responses

200 Response

{
  "id": "0399abed-fd3d",
  "type": "physical",
  "state": "active",
  "issuerIdentificationNumber": "4242",
  "displayName": "PHIL DUCIARY",
  "cardholder": {
    "name": "Phil Duciary",
    "type": "primary",
    "address": {
      "address1": "1805 Tiburon Dr.",
      "locality": "Wilmington",
      "regionCode": "NC",
      "countryCode": "US",
      "postalCode": "28403"
    }
  },
  "maskedAccountNumber": "*1000",
  "expirationMonth": "12",
  "expirationYear": "29",
  "allows": {
    "activate": false,
    "viewTransactions": true,
    "viewUnmaskedSecurityCode": true,
    "reportLost": true,
    "reportFound": false,
    "reportStolen": true,
    "reportDamaged": true,
    "lock": true,
    "unlock": false,
    "changePin": true,
    "manageTravelNotifications": true
  }
}

Responses

StatusDescription
200 OK
OK.
Schema: debitCard
StatusDescription
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:

Schema: Inline
StatusDescription
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:

Schema: Inline
StatusDescription
403 Forbidden

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

This problem responsemay have one of the following type values:

Schema: Inline
StatusDescription
404 Not Found

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

This problem responsemay have one of the following type values:

Schema: problemResponse
StatusDescription
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:

StatusDescription
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:

Schema: Inline
StatusDescription
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
StatusDescription
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.

listDebitCardTransactions

Code samples

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


GET https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/transactions 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/accounts/{accountId}/debitCards/{debitCardId}/transactions',
{
  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/accounts/{accountId}/debitCards/{debitCardId}/transactions',
  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/accounts/{accountId}/debitCards/{debitCardId}/transactions',
  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/accounts/{accountId}/debitCards/{debitCardId}/transactions', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/transactions");
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/accounts/{accountId}/debitCards/{debitCardId}/transactions", data)
    req.Header = headers

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

Return a collection of transaction summaries for a debit card resource

GET https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/transactions

Return a paginated collection of debit card transactions. The nextPage_url in the response is a pagination link.

Parameters

ParameterDescription
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
occurredOn
in: query
 string

Return only transactions whose occurredOn date is in this date range. Dates ranges use dates expressed in YYYY-MM-DD RFC 3339 date format. Each account has an implicit default transaction history range of n days. This is normally 30 days but may be shorter for accounts with high activity. This n day period is applied to any unbounded date ranges. The default date range is the most recent n days.

Example date ranges:

  • 2023-05-19 match transactions occurring on May 19, 2023.
  • [2023-05-01,2023-05-31] match transactions occurring between May 1 and 31, 2023, inclusive
  • [2023-05-01,2023-06-01) match transactions occurring in May, 2023 (on or after May 1, but before June 1)
  • [2023-05-09,] match transactions n days on or after May 9, 2023
  • (2023-05-09,) match transactions n days after May 9, 2023
  • [,2023-05-09] match transactions n days on or before May 9, 2023
  • (,2023-05-09) match transactions n days before but excluding May 9, 2023

minLength: 10
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})[)\\]])$"
sortBy
in: query
 array[string]
The sort order for the items in the response. Use ?sortBy=occurredOn or ?sortBy=-occurredOn to sort by ascending or descending order of the transactions's occurredOn date.
unique items
minItems: 1
maxItems: 1
default: ["-occurredOn"]
comma-delimited
items: string
» minLength: 10
» maxLength: 11
» pattern: "^-?(occurredOn)"
accountId
in: path
 resourceId (required)
The unique identifier of this account resource. This is an opaque string.
minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
debitCardId
in: path
 externalResourceId (required)
The unique identifier of this debit card. This is an opaque string.
read-only
format: text
minLength: 1
maxLength: 256

Example responses

200 Response

{
  "start": "d1b48af913464aa49fcb07065dcc0616",
  "limit": 10,
  "nextPage_url": "https://production.api.apiture.com/banking/accounts/0399abed-fd3d/debitCards/d2d01f5e-f64a/transactions?start=6117a4dcefb841cab7316cef1ac8b58c&limit=10",
  "items": [
    {
      "occurredOn": "2024-01-16",
      "description": "**MACYS1234",
      "amount": "52.05",
      "direction": "credit"
    },
    {
      "occurredOn": "2024-01-15",
      "description": "**MACYS1234",
      "amount": "-52.05",
      "direction": "debit"
    },
    {
      "occurredOn": "2024-01-13",
      "description": "**WALMART1337",
      "amount": "-49.85",
      "direction": "debit"
    }
  ]
}

Responses

StatusDescription
200 OK
OK.
Schema: debitCardTransactions
StatusDescription
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:

Schema: Inline
StatusDescription
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:

Schema: Inline
StatusDescription
403 Forbidden

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

This problem responsemay have one of the following type values:

Schema: Inline
StatusDescription
404 Not Found

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

This problem responsemay have one of the following type values:

Schema: problemResponse
StatusDescription
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:

Schema: problemResponse
StatusDescription
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:

Schema: Inline
StatusDescription
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
StatusDescription
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.

Debit Card Providers

Debit Card Providers

getDebitCardProvider

Code samples

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


GET https://api.apiture.com/banking/debitCardProvider 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/debitCardProvider',
{
  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/debitCardProvider',
  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/debitCardProvider',
  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/debitCardProvider', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://api.apiture.com/banking/debitCardProvider");
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/debitCardProvider", data)
    req.Header = headers

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

Fetch a representation of the debit card provider

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

Return the JSON representation of the debit card provider resource.

Example responses

200 Response

{
  "context": "account",
  "operations": {
    "listCustomerDebitCards": {
      "enabled": false,
      "requiresIdentityChallenge": false
    },
    "getCustomerDebitCard": {
      "enabled": false,
      "requiresIdentityChallenge": false
    },
    "getCustomerDebitCardUnmaskedProperties": {
      "enabled": false,
      "requiresIdentityChallenge": false
    },
    "lockCustomerDebitCard": {
      "enabled": false,
      "requiresIdentityChallenge": false
    },
    "unlockCustomerDebitCard": {
      "enabled": false,
      "requiresIdentityChallenge": false
    },
    "createCustomerDebitCardChallenge": {
      "enabled": false,
      "requiresIdentityChallenge": false
    },
    "listDebitCards": {
      "enabled": true,
      "requiresIdentityChallenge": false
    },
    "getDebitCard": {
      "enabled": true,
      "requiresIdentityChallenge": false
    },
    "getDebitCardUnmaskedProperties": {
      "enabled": true,
      "requiresIdentityChallenge": true
    },
    "createDebitCardChallenge": {
      "enabled": true,
      "requiresIdentityChallenge": false
    },
    "changeDebitCardPin": {
      "enabled": true,
      "requiresIdentityChallenge": true
    },
    "listDebitCardTransactions": {
      "enabled": true,
      "requiresIdentityChallenge": false
    },
    "getDebitCardTransactionRules": {
      "enabled": true,
      "requiresIdentityChallenge": false
    },
    "patchDebitCardTransactionRules": {
      "enabled": true,
      "requiresIdentityChallenge": false
    },
    "getDebitCardAlerts": {
      "enabled": true,
      "requiresIdentityChallenge": false
    },
    "patchDebitCardAlertSubscriptions": {
      "enabled": true,
      "requiresIdentityChallenge": false
    },
    "activateDebitCard": {
      "enabled": true,
      "requiresIdentityChallenge": false
    },
    "reportDebitCard": {
      "enabled": true,
      "requiresIdentityChallenge": false
    },
    "lockDebitCard": {
      "enabled": true,
      "requiresIdentityChallenge": false
    },
    "unlockDebitCard": {
      "enabled": true,
      "requiresIdentityChallenge": true
    },
    "listDebitCardTravelNotifications": {
      "enabled": true,
      "requiresIdentityChallenge": false
    },
    "createDebitCardTravelNotification": {
      "enabled": true,
      "requiresIdentityChallenge": false
    },
    "getDebitCardTravelNotification": {
      "enabled": true,
      "requiresIdentityChallenge": false
    },
    "patchDebitCardTravelNotification": {
      "enabled": true,
      "requiresIdentityChallenge": false
    },
    "deleteDebitCardTravelNotification": {
      "enabled": true,
      "requiresIdentityChallenge": false
    },
    "listDebitCardRegions": {
      "enabled": true,
      "requiresIdentityChallenge": false
    },
    "createDebitCardRegion": {
      "enabled": true,
      "requiresIdentityChallenge": false
    },
    "getDebitCardRegion": {
      "enabled": true,
      "requiresIdentityChallenge": false
    },
    "patchDebitCardRegion": {
      "enabled": true,
      "requiresIdentityChallenge": false
    },
    "deleteDebitCardRegion": {
      "enabled": true,
      "requiresIdentityChallenge": false
    }
  },
  "merchantCategories": [
    "ageRestricted",
    "education",
    "entertainment",
    "foodAndDining",
    "giftsAndDonations",
    "household",
    "insurance",
    "personalCare",
    "shopping",
    "transportation",
    "travel",
    "other"
  ],
  "cardRegionType": "coordinates"
}

Responses

StatusDescription
200 OK
OK.
Schema: debitCardProvider
StatusDescription
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:

Schema: Inline
StatusDescription
403 Forbidden

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

This problem responsemay have one of the following type values:

Schema: Inline
StatusDescription
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:

Schema: Inline
StatusDescription
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
StatusDescription
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.

Debit Card Travel Notifications

Debit Card Travel Notifications

listDebitCardTravelNotifications

Code samples

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


GET https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/travelNotifications 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/accounts/{accountId}/debitCards/{debitCardId}/travelNotifications',
{
  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/accounts/{accountId}/debitCards/{debitCardId}/travelNotifications',
  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/accounts/{accountId}/debitCards/{debitCardId}/travelNotifications',
  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/accounts/{accountId}/debitCards/{debitCardId}/travelNotifications', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/travelNotifications");
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/accounts/{accountId}/debitCards/{debitCardId}/travelNotifications", data)
    req.Header = headers

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

Return a collection of debit card travel notifications

GET https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/travelNotifications

Return a collection of travel notifications.

Parameters

ParameterDescription
accountId
in: path
 resourceId (required)
The unique identifier of this account resource. This is an opaque string.
minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
debitCardId
in: path
 externalResourceId (required)
The unique identifier of this debit card. This is an opaque string.
read-only
format: text
minLength: 1
maxLength: 256

Example responses

200 Response

{
  "items": [
    {
      "id": "ebf3709442ea-4836",
      "departingOn": "2024-11-03",
      "returningOn": "2024-11-17",
      "countryCode": "UK",
      "phoneNumber": "5555555555",
      "notes": "Visiting family",
      "allows": {
        "edit": false,
        "delete": false
      }
    },
    {
      "id": "0399abed-fd3d",
      "departingOn": "2024-06-01",
      "returningOn": "2024-06-10",
      "countryCode": "US",
      "regionCode": "FL",
      "phoneNumber": "5555555555",
      "notes": "Disney, Universal and Sea World",
      "allows": {
        "edit": false,
        "delete": false
      }
    },
    {
      "id": "d62c0701-0d74-4836-83f9-ebf3709442ea",
      "departingOn": "2024-03-20",
      "returningOn": "2024-03-24",
      "countryCode": "US",
      "regionCode": "DC",
      "phoneNumber": "5555555555",
      "allows": {
        "edit": false,
        "delete": false
      }
    }
  ]
}

Responses

StatusDescription
200 OK
OK.
Schema: debitCardTravelNotifications
StatusDescription
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:

Schema: Inline
StatusDescription
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:

Schema: Inline
StatusDescription
403 Forbidden

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

This problem responsemay have one of the following type values:

Schema: Inline
StatusDescription
404 Not Found

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

This problem responsemay have one of the following type values:

Schema: problemResponse
StatusDescription
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:

StatusDescription
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:

Schema: Inline
StatusDescription
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
StatusDescription
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.

createDebitCardTravelNotification

Code samples

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


POST https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/travelNotifications HTTP/1.1
Host: api.apiture.com
Content-Type: application/json
Accept: application/json


const fetch = require('node-fetch');
const inputBody = '{
  "departingOn": "2024-06-01",
  "returningOn": "2024-06-10",
  "countryCode": "US",
  "regionCode": "FL",
  "phoneNumber": "5555555555",
  "notes": "Disney, Universal and Sea World"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/travelNotifications',
{
  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/accounts/{accountId}/debitCards/{debitCardId}/travelNotifications',
  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/accounts/{accountId}/debitCards/{debitCardId}/travelNotifications',
  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/accounts/{accountId}/debitCards/{debitCardId}/travelNotifications', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/travelNotifications");
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/accounts/{accountId}/debitCards/{debitCardId}/travelNotifications", data)
    req.Header = headers

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

Create a new travel notification

POST https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/travelNotifications

Create a new travel notification within the travel notifications collection.

Body parameter

{
  "departingOn": "2024-06-01",
  "returningOn": "2024-06-10",
  "countryCode": "US",
  "regionCode": "FL",
  "phoneNumber": "5555555555",
  "notes": "Disney, Universal and Sea World"
}

Parameters

ParameterDescription
body newTravelNotification (required)
The data necessary to create a new travel notification.
accountId
in: path
 resourceId (required)
The unique identifier of this account resource. This is an opaque string.
minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
debitCardId
in: path
 externalResourceId (required)
The unique identifier of this debit card. This is an opaque string.
read-only
format: text
minLength: 1
maxLength: 256

Example responses

201 Response

{
  "id": "0399abed-fd3d",
  "departingOn": "2024-06-01",
  "returningOn": "2024-06-10",
  "countryCode": "US",
  "regionCode": "FL",
  "phoneNumber": "5555555555",
  "notes": "Disney, Universal and Sea World",
  "allows": {
    "edit": false,
    "delete": false
  }
}

Responses

StatusDescription
201 Created
Created.
Schema: travelNotification
HeaderLocation
string uri-reference
The URI of the new debit card travel notification.
StatusDescription
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:

Schema: Inline
StatusDescription
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:

Schema: Inline
StatusDescription
403 Forbidden

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

This problem responsemay have one of the following type values:

Schema: Inline
StatusDescription
404 Not Found

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

This problem responsemay have one of the following type values:

Schema: problemResponse
StatusDescription
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:

StatusDescription
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:

Schema: Inline
StatusDescription
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
StatusDescription
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.

getDebitCardTravelNotification

Code samples

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


GET https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/travelNotifications/{travelNotificationId} 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/accounts/{accountId}/debitCards/{debitCardId}/travelNotifications/{travelNotificationId}',
{
  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/accounts/{accountId}/debitCards/{debitCardId}/travelNotifications/{travelNotificationId}',
  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/accounts/{accountId}/debitCards/{debitCardId}/travelNotifications/{travelNotificationId}',
  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/accounts/{accountId}/debitCards/{debitCardId}/travelNotifications/{travelNotificationId}', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/travelNotifications/{travelNotificationId}");
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/accounts/{accountId}/debitCards/{debitCardId}/travelNotifications/{travelNotificationId}", data)
    req.Header = headers

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

Fetch a representation of this travel notification

GET https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/travelNotifications/{travelNotificationId}

Return the JSON representation of this travel notification resource.

Parameters

ParameterDescription
accountId
in: path
 resourceId (required)
The unique identifier of this account resource. This is an opaque string.
minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
debitCardId
in: path
 externalResourceId (required)
The unique identifier of this debit card. This is an opaque string.
read-only
format: text
minLength: 1
maxLength: 256
travelNotificationId
in: path
 externalResourceId (required)
The unique identifier of this travel notification. This is an opaque string.
read-only
format: text
minLength: 1
maxLength: 256

Example responses

200 Response

{
  "id": "0399abed-fd3d",
  "departingOn": "2024-06-01",
  "returningOn": "2024-06-10",
  "countryCode": "US",
  "regionCode": "FL",
  "phoneNumber": "5555555555",
  "notes": "Disney, Universal and Sea World",
  "allows": {
    "edit": false,
    "delete": false
  }
}

Responses

StatusDescription
200 OK
OK.
Schema: travelNotification
StatusDescription
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:

Schema: Inline
StatusDescription
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:

Schema: Inline
StatusDescription
403 Forbidden

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

This problem responsemay have one of the following type values:

Schema: Inline
StatusDescription
404 Not Found

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

This problem responsemay have one of the following type values:

Schema: problemResponse
StatusDescription
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:

StatusDescription
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:

Schema: Inline
StatusDescription
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
StatusDescription
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.

patchDebitCardTravelNotification

Code samples

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


PATCH https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/travelNotifications/{travelNotificationId} HTTP/1.1
Host: api.apiture.com
Content-Type: application/merge-patch+json
Accept: application/json


const fetch = require('node-fetch');
const inputBody = '{
  "departingOn": "2021-10-30",
  "returningOn": "2021-10-30",
  "countryCode": "US",
  "regionCode": "NC",
  "phoneNumber": "+19105550155",
  "notes": "string"
}';
const headers = {
  'Content-Type':'application/merge-patch+json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/travelNotifications/{travelNotificationId}',
{
  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/accounts/{accountId}/debitCards/{debitCardId}/travelNotifications/{travelNotificationId}',
  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/accounts/{accountId}/debitCards/{debitCardId}/travelNotifications/{travelNotificationId}',
  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/accounts/{accountId}/debitCards/{debitCardId}/travelNotifications/{travelNotificationId}', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/travelNotifications/{travelNotificationId}");
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/accounts/{accountId}/debitCards/{debitCardId}/travelNotifications/{travelNotificationId}", data)
    req.Header = headers

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

Update this travel notification

PATCH https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/travelNotifications/{travelNotificationId}

Perform a partial update of this travel notification 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

{
  "departingOn": "2021-10-30",
  "returningOn": "2021-10-30",
  "countryCode": "US",
  "regionCode": "NC",
  "phoneNumber": "+19105550155",
  "notes": "string"
}

Parameters

ParameterDescription
body travelNotificationPatch (required)
The new travel notification.
accountId
in: path
 resourceId (required)
The unique identifier of this account resource. This is an opaque string.
minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
debitCardId
in: path
 externalResourceId (required)
The unique identifier of this debit card. This is an opaque string.
read-only
format: text
minLength: 1
maxLength: 256
travelNotificationId
in: path
 externalResourceId (required)
The unique identifier of this travel notification. This is an opaque string.
read-only
format: text
minLength: 1
maxLength: 256

Example responses

200 Response

{
  "id": "0399abed-fd3d",
  "departingOn": "2024-06-01",
  "returningOn": "2024-06-10",
  "countryCode": "US",
  "regionCode": "FL",
  "phoneNumber": "5555555555",
  "notes": "Disney, Universal and Sea World",
  "allows": {
    "edit": false,
    "delete": false
  }
}

Responses

StatusDescription
200 OK
OK.
Schema: travelNotification
204 No Content
No Content. The operation succeeded but returned no response body.
StatusDescription
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:

Schema: Inline
StatusDescription
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:

Schema: Inline
StatusDescription
403 Forbidden

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

This problem responsemay have one of the following type values:

Schema: Inline
StatusDescription
404 Not Found

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

This problem responsemay have one of the following type values:

Schema: problemResponse
StatusDescription
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:

Schema: Inline
StatusDescription
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:

Schema: Inline
StatusDescription
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
StatusDescription
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.

deleteDebitCardTravelNotification

Code samples

# You can also use wget
curl -X DELETE https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/travelNotifications/{travelNotificationId} \
  -H 'Accept: application/problem+json' \
  -H 'Authorization: Bearer {access-token}'


DELETE https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/travelNotifications/{travelNotificationId} HTTP/1.1
Host: api.apiture.com
Accept: application/problem+json


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

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

};

fetch('https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/travelNotifications/{travelNotificationId}',
{
  method: 'DELETE',

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


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

};

$.ajax({
  url: 'https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/travelNotifications/{travelNotificationId}',
  method: 'delete',

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


require 'rest-client'
require 'json'

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

result = RestClient.delete 'https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/travelNotifications/{travelNotificationId}',
  params: {
  }, headers: headers

p JSON.parse(result)


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

r = requests.delete('https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/travelNotifications/{travelNotificationId}', params={

}, headers = headers)

print r.json()


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


package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/travelNotifications/{travelNotificationId}", data)
    req.Header = headers

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

Delete this travel notification resource

DELETE https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/travelNotifications/{travelNotificationId}

Delete this travel notification resource.

Parameters

ParameterDescription
accountId
in: path
 resourceId (required)
The unique identifier of this account resource. This is an opaque string.
minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
debitCardId
in: path
 externalResourceId (required)
The unique identifier of this debit card. This is an opaque string.
read-only
format: text
minLength: 1
maxLength: 256
travelNotificationId
in: path
 externalResourceId (required)
The unique identifier of this travel notification. This is an opaque string.
read-only
format: text
minLength: 1
maxLength: 256

Example responses

400 Response

{
  "id": "3fbad566-be86-4b22-9ba6-3ca99fdc0799",
  "type": "https://production.api.apiture.com/errors/badRequest/v1.0.0",
  "title": "Bad Request",
  "status": 400,
  "occurredAt": "2022-04-25T12:42:21.375Z",
  "detail": "Input did not parse as JSON",
  "instance": "https://production.api.apiture.com/banking/transfers/bb709151-575041fcd617"
}

Responses

StatusDescription
204 No Content
No Content. The operation succeeded but returned no response body.
StatusDescription
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:

Schema: Inline
StatusDescription
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:

Schema: Inline
StatusDescription
403 Forbidden

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

This problem responsemay have one of the following type values:

Schema: Inline
StatusDescription
404 Not Found

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

This problem responsemay have one of the following type values:

Schema: problemResponse
StatusDescription
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:

StatusDescription
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:

Schema: Inline
StatusDescription
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
StatusDescription
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.

Debit Card Controls

Debit Card Controls

getDebitCardTransactionRules

Code samples

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


GET https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/transactionRules 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/accounts/{accountId}/debitCards/{debitCardId}/transactionRules',
{
  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/accounts/{accountId}/debitCards/{debitCardId}/transactionRules',
  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/accounts/{accountId}/debitCards/{debitCardId}/transactionRules',
  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/accounts/{accountId}/debitCards/{debitCardId}/transactionRules', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/transactionRules");
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/accounts/{accountId}/debitCards/{debitCardId}/transactionRules", data)
    req.Header = headers

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

Return this debit card's transaction rules

GET https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/transactionRules

Return transaction rules for this debit card. Each debit card on an account maintains its own set of rules.

Parameters

ParameterDescription
accountId
in: path
 resourceId (required)
The unique identifier of this account resource. This is an opaque string.
minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
debitCardId
in: path
 externalResourceId (required)
The unique identifier of this debit card. This is an opaque string.
read-only
format: text
minLength: 1
maxLength: 256

Example responses

200 Response

{
  "transactionLimit": 10000000,
  "monthlySpendingLimit": 10000000,
  "allowInternationalTransactions": true,
  "merchantCategories": [
    "ageRestricted"
  ],
  "transactionCategories": [
    "atm"
  ],
  "authorizedRegions": [
    {
      "id": "0399abed-fd3d",
      "name": "Disney World's Magic Kingdom",
      "type": "coordinates",
      "coordinates": {
        "latitude": 28.4188,
        "longitude": -81.5818,
        "radius": "5mi"
      }
    }
  ]
}

Responses

StatusDescription
200 OK
OK.
Schema: cardTransactionRules
StatusDescription
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:

Schema: Inline
StatusDescription
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:

Schema: Inline
StatusDescription
403 Forbidden

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

This problem responsemay have one of the following type values:

Schema: Inline
StatusDescription
404 Not Found

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

This problem responsemay have one of the following type values:

Schema: problemResponse
StatusDescription
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:

StatusDescription
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:

Schema: Inline
StatusDescription
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
StatusDescription
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.

patchDebitCardTransactionRules

Code samples

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


PATCH https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/transactionRules HTTP/1.1
Host: api.apiture.com
Content-Type: application/merge-patch+json
Accept: application/json


const fetch = require('node-fetch');
const inputBody = '{
  "transactionLimit": 10000000,
  "monthlySpendingLimit": 10000000,
  "allowInternationalTransactions": true,
  "merchantCategories": [
    "ageRestricted"
  ],
  "transactionCategories": [
    "atm"
  ],
  "authorizedRegions": [
    {
      "id": "0399abed-fd3d",
      "name": "Disney World's Magic Kingdom",
      "type": "coordinates",
      "coordinates": {
        "latitude": 28.4188,
        "longitude": -81.5818,
        "radius": "5mi"
      }
    }
  ]
}';
const headers = {
  'Content-Type':'application/merge-patch+json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/transactionRules',
{
  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/accounts/{accountId}/debitCards/{debitCardId}/transactionRules',
  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/accounts/{accountId}/debitCards/{debitCardId}/transactionRules',
  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/accounts/{accountId}/debitCards/{debitCardId}/transactionRules', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/transactionRules");
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/accounts/{accountId}/debitCards/{debitCardId}/transactionRules", data)
    req.Header = headers

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

Update debit card transaction rules

PATCH https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/transactionRules

Perform a partial update of this debit card's transaction rules 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

{
  "transactionLimit": 10000000,
  "monthlySpendingLimit": 10000000,
  "allowInternationalTransactions": true,
  "merchantCategories": [
    "ageRestricted"
  ],
  "transactionCategories": [
    "atm"
  ],
  "authorizedRegions": [
    {
      "id": "0399abed-fd3d",
      "name": "Disney World's Magic Kingdom",
      "type": "coordinates",
      "coordinates": {
        "latitude": 28.4188,
        "longitude": -81.5818,
        "radius": "5mi"
      }
    }
  ]
}

Parameters

ParameterDescription
body cardTransactionRulesPatch (required)
The new card transaction rules configuration.
accountId
in: path
 resourceId (required)
The unique identifier of this account resource. This is an opaque string.
minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
debitCardId
in: path
 externalResourceId (required)
The unique identifier of this debit card. This is an opaque string.
read-only
format: text
minLength: 1
maxLength: 256

Example responses

200 Response

{
  "transactionLimit": 10000000,
  "monthlySpendingLimit": 10000000,
  "allowInternationalTransactions": true,
  "merchantCategories": [
    "ageRestricted"
  ],
  "transactionCategories": [
    "atm"
  ],
  "authorizedRegions": [
    {
      "id": "0399abed-fd3d",
      "name": "Disney World's Magic Kingdom",
      "type": "coordinates",
      "coordinates": {
        "latitude": 28.4188,
        "longitude": -81.5818,
        "radius": "5mi"
      }
    }
  ]
}

Responses

StatusDescription
200 OK
OK.
Schema: cardTransactionRules
204 No Content
No Content. The operation succeeded but returned no response body.
StatusDescription
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:

Schema: Inline
StatusDescription
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:

Schema: Inline
StatusDescription
403 Forbidden

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

This problem responsemay have one of the following type values:

Schema: Inline
StatusDescription
404 Not Found

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

This problem responsemay have one of the following type values:

Schema: problemResponse
StatusDescription
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:

Schema: problemResponse
StatusDescription
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:

Schema: Inline
StatusDescription
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
StatusDescription
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.

getDebitCardAlerts

Code samples

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


GET https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/alertSubscriptions 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/accounts/{accountId}/debitCards/{debitCardId}/alertSubscriptions',
{
  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/accounts/{accountId}/debitCards/{debitCardId}/alertSubscriptions',
  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/accounts/{accountId}/debitCards/{debitCardId}/alertSubscriptions',
  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/accounts/{accountId}/debitCards/{debitCardId}/alertSubscriptions', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/alertSubscriptions");
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/accounts/{accountId}/debitCards/{debitCardId}/alertSubscriptions", data)
    req.Header = headers

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

Return this debit card's alert subscriptions

GET https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/alertSubscriptions

Return alerts subscriptions for this debit card. Each debit card on an account maintains its own set of alert subscriptions. Allowed alert subscriptions may be limited by the cardholder type.

Parameters

ParameterDescription
accountId
in: path
 resourceId (required)
The unique identifier of this account resource. This is an opaque string.
minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
debitCardId
in: path
 externalResourceId (required)
The unique identifier of this debit card. This is an opaque string.
read-only
format: text
minLength: 1
maxLength: 256

Example responses

200 Response

{
  "transactionLimit": {
    "communicationChannels": [
      {
        "id": "0399abed-fd3d",
        "label": "Max.Pike@example.com",
        "type": "email"
      }
    ],
    "threshold": 10000000
  },
  "monthlySpendingLimit": {
    "communicationChannels": [
      {
        "id": "0399abed-fd3d",
        "label": "Max.Pike@example.com",
        "type": "email"
      }
    ],
    "threshold": 10000000
  },
  "transactionOccurred": {
    "communicationChannels": [
      {
        "id": "0399abed-fd3d",
        "label": "Max.Pike@example.com",
        "type": "email"
      }
    ]
  },
  "transactionDeclined": {
    "communicationChannels": [
      {
        "id": "0399abed-fd3d",
        "label": "Max.Pike@example.com",
        "type": "email"
      }
    ]
  },
  "merchantCategories": {
    "communicationChannels": [
      {
        "id": "0399abed-fd3d",
        "label": "Max.Pike@example.com",
        "type": "email"
      }
    ],
    "categories": [
      "ageRestricted"
    ]
  },
  "transactionCategories": {
    "communicationChannels": [
      {
        "id": "0399abed-fd3d",
        "label": "Max.Pike@example.com",
        "type": "email"
      }
    ],
    "categories": [
      "atm"
    ]
  },
  "allowedRegions": {
    "communicationChannels": [
      {
        "id": "0399abed-fd3d",
        "label": "Max.Pike@example.com",
        "type": "email"
      }
    ],
    "regions": [
      {
        "id": "0399abed-fd3d",
        "name": "Disney World's Magic Kingdom",
        "type": "coordinates",
        "coordinates": {
          "latitude": 28.4188,
          "longitude": -81.5818,
          "radius": "5mi"
        }
      }
    ]
  }
}

Responses

StatusDescription
200 OK
OK.
Schema: cardAlertSubscriptions
StatusDescription
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:

Schema: Inline
StatusDescription
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:

Schema: Inline
StatusDescription
403 Forbidden

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

This problem responsemay have one of the following type values:

Schema: Inline
StatusDescription
404 Not Found

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

This problem responsemay have one of the following type values:

Schema: problemResponse
StatusDescription
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:

StatusDescription
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:

Schema: Inline
StatusDescription
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
StatusDescription
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.

patchDebitCardAlertSubscriptions

Code samples

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


PATCH https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/alertSubscriptions HTTP/1.1
Host: api.apiture.com
Content-Type: application/merge-patch+json
Accept: application/json


const fetch = require('node-fetch');
const inputBody = '{
  "transactionLimit": {
    "communicationChannels": [
      {
        "id": "0399abed-fd3d",
        "label": "Max.Pike@example.com",
        "type": "email"
      }
    ],
    "threshold": 10000000
  },
  "monthlySpendingLimit": {
    "communicationChannels": [
      {
        "id": "0399abed-fd3d",
        "label": "Max.Pike@example.com",
        "type": "email"
      }
    ],
    "threshold": 10000000
  },
  "transactionOccurred": {
    "communicationChannels": [
      {
        "id": "0399abed-fd3d",
        "label": "Max.Pike@example.com",
        "type": "email"
      }
    ]
  },
  "transactionDeclined": {
    "communicationChannels": [
      {
        "id": "0399abed-fd3d",
        "label": "Max.Pike@example.com",
        "type": "email"
      }
    ]
  },
  "merchantCategories": {
    "communicationChannels": [
      {
        "id": "0399abed-fd3d",
        "label": "Max.Pike@example.com",
        "type": "email"
      }
    ],
    "categories": [
      "ageRestricted"
    ]
  },
  "transactionCategories": {
    "communicationChannels": [
      {
        "id": "0399abed-fd3d",
        "label": "Max.Pike@example.com",
        "type": "email"
      }
    ],
    "categories": [
      "atm"
    ]
  },
  "allowedRegions": {
    "communicationChannels": [
      {
        "id": "0399abed-fd3d",
        "label": "Max.Pike@example.com",
        "type": "email"
      }
    ],
    "regions": [
      {
        "id": "0399abed-fd3d",
        "name": "Disney World's Magic Kingdom",
        "type": "coordinates",
        "coordinates": {
          "latitude": 28.4188,
          "longitude": -81.5818,
          "radius": "5mi"
        }
      }
    ]
  }
}';
const headers = {
  'Content-Type':'application/merge-patch+json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/alertSubscriptions',
{
  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/accounts/{accountId}/debitCards/{debitCardId}/alertSubscriptions',
  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/accounts/{accountId}/debitCards/{debitCardId}/alertSubscriptions',
  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/accounts/{accountId}/debitCards/{debitCardId}/alertSubscriptions', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/alertSubscriptions");
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/accounts/{accountId}/debitCards/{debitCardId}/alertSubscriptions", data)
    req.Header = headers

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

Update debit card alert subscriptions

PATCH https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/alertSubscriptions

Perform a partial update of this debit card's alert subscriptions 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

{
  "transactionLimit": {
    "communicationChannels": [
      {
        "id": "0399abed-fd3d",
        "label": "Max.Pike@example.com",
        "type": "email"
      }
    ],
    "threshold": 10000000
  },
  "monthlySpendingLimit": {
    "communicationChannels": [
      {
        "id": "0399abed-fd3d",
        "label": "Max.Pike@example.com",
        "type": "email"
      }
    ],
    "threshold": 10000000
  },
  "transactionOccurred": {
    "communicationChannels": [
      {
        "id": "0399abed-fd3d",
        "label": "Max.Pike@example.com",
        "type": "email"
      }
    ]
  },
  "transactionDeclined": {
    "communicationChannels": [
      {
        "id": "0399abed-fd3d",
        "label": "Max.Pike@example.com",
        "type": "email"
      }
    ]
  },
  "merchantCategories": {
    "communicationChannels": [
      {
        "id": "0399abed-fd3d",
        "label": "Max.Pike@example.com",
        "type": "email"
      }
    ],
    "categories": [
      "ageRestricted"
    ]
  },
  "transactionCategories": {
    "communicationChannels": [
      {
        "id": "0399abed-fd3d",
        "label": "Max.Pike@example.com",
        "type": "email"
      }
    ],
    "categories": [
      "atm"
    ]
  },
  "allowedRegions": {
    "communicationChannels": [
      {
        "id": "0399abed-fd3d",
        "label": "Max.Pike@example.com",
        "type": "email"
      }
    ],
    "regions": [
      {
        "id": "0399abed-fd3d",
        "name": "Disney World's Magic Kingdom",
        "type": "coordinates",
        "coordinates": {
          "latitude": 28.4188,
          "longitude": -81.5818,
          "radius": "5mi"
        }
      }
    ]
  }
}

Parameters

ParameterDescription
body cardAlertSubscriptionsPatch (required)
The new card alert subscription.
accountId
in: path
 resourceId (required)
The unique identifier of this account resource. This is an opaque string.
minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
debitCardId
in: path
 externalResourceId (required)
The unique identifier of this debit card. This is an opaque string.
read-only
format: text
minLength: 1
maxLength: 256

Example responses

200 Response

{
  "transactionLimit": {
    "communicationChannels": [
      {
        "id": "0399abed-fd3d",
        "label": "Max.Pike@example.com",
        "type": "email"
      }
    ],
    "threshold": 10000000
  },
  "monthlySpendingLimit": {
    "communicationChannels": [
      {
        "id": "0399abed-fd3d",
        "label": "Max.Pike@example.com",
        "type": "email"
      }
    ],
    "threshold": 10000000
  },
  "transactionOccurred": {
    "communicationChannels": [
      {
        "id": "0399abed-fd3d",
        "label": "Max.Pike@example.com",
        "type": "email"
      }
    ]
  },
  "transactionDeclined": {
    "communicationChannels": [
      {
        "id": "0399abed-fd3d",
        "label": "Max.Pike@example.com",
        "type": "email"
      }
    ]
  },
  "merchantCategories": {
    "communicationChannels": [
      {
        "id": "0399abed-fd3d",
        "label": "Max.Pike@example.com",
        "type": "email"
      }
    ],
    "categories": [
      "ageRestricted"
    ]
  },
  "transactionCategories": {
    "communicationChannels": [
      {
        "id": "0399abed-fd3d",
        "label": "Max.Pike@example.com",
        "type": "email"
      }
    ],
    "categories": [
      "atm"
    ]
  },
  "allowedRegions": {
    "communicationChannels": [
      {
        "id": "0399abed-fd3d",
        "label": "Max.Pike@example.com",
        "type": "email"
      }
    ],
    "regions": [
      {
        "id": "0399abed-fd3d",
        "name": "Disney World's Magic Kingdom",
        "type": "coordinates",
        "coordinates": {
          "latitude": 28.4188,
          "longitude": -81.5818,
          "radius": "5mi"
        }
      }
    ]
  }
}

Responses

StatusDescription
200 OK
OK.
Schema: cardAlertSubscriptions
204 No Content
No Content. The operation succeeded but returned no response body.
StatusDescription
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:

Schema: Inline
StatusDescription
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:

Schema: Inline
StatusDescription
403 Forbidden

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

This problem responsemay have one of the following type values:

Schema: Inline
StatusDescription
404 Not Found

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

This problem responsemay have one of the following type values:

Schema: problemResponse
StatusDescription
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:

StatusDescription
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:

Schema: Inline
StatusDescription
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
StatusDescription
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.

Debit Card Regions

Debit Card Regions

listDebitCardRegions

Code samples

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


GET https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/regions 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/accounts/{accountId}/debitCards/{debitCardId}/regions',
{
  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/accounts/{accountId}/debitCards/{debitCardId}/regions',
  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/accounts/{accountId}/debitCards/{debitCardId}/regions',
  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/accounts/{accountId}/debitCards/{debitCardId}/regions', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/regions");
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/accounts/{accountId}/debitCards/{debitCardId}/regions", data)
    req.Header = headers

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

Return a collection of named card regions

GET https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/regions

Return a collection of named card regions. These regions define additional travel-related geographic areas where the cardholder plans to use the card. These regions act as a hint to the financial institution and/or card provider that use of the card in those regions is not fraudulent.

Parameters

ParameterDescription
accountId
in: path
 resourceId (required)
The unique identifier of this account resource. This is an opaque string.
minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
debitCardId
in: path
 externalResourceId (required)
The unique identifier of this debit card. This is an opaque string.
read-only
format: text
minLength: 1
maxLength: 256

Example responses

200 Response

{
  "items": [
    {
      "id": "0399abed-fd3d",
      "name": "Disney World's Magic Kingdom",
      "type": "coordinates",
      "coordinates": {
        "latitude": 28.4188,
        "longitude": -81.5818,
        "radius": "5mi"
      }
    },
    {
      "id": "d62c0701-0d74-4836-83f9-ebf3709442ea",
      "name": "Washington D.C.",
      "type": "coordinates",
      "coordinates": {
        "latitude": 38.8875,
        "longitude": -77.0364,
        "radius": "3mi"
      }
    }
  ]
}

Responses

StatusDescription
200 OK
OK.
Schema: cardRegions
StatusDescription
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:

Schema: Inline
StatusDescription
403 Forbidden

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

This problem responsemay have one of the following type values:

Schema: Inline
StatusDescription
404 Not Found

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

This problem responsemay have one of the following type values:

Schema: problemResponse
StatusDescription
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:

Schema: Inline
StatusDescription
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
StatusDescription
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.

createDebitCardRegion

Code samples

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


POST https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/regions HTTP/1.1
Host: api.apiture.com
Content-Type: application/json
Accept: application/json


const fetch = require('node-fetch');
const inputBody = '{
  "name": "Disney World's Magic Kingdom",
  "type": "coordinates",
  "coordinates": {
    "latitude": 28.4188,
    "longitude": -81.5818,
    "radius": "5mi"
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/regions',
{
  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/accounts/{accountId}/debitCards/{debitCardId}/regions',
  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/accounts/{accountId}/debitCards/{debitCardId}/regions',
  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/accounts/{accountId}/debitCards/{debitCardId}/regions', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/regions");
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/accounts/{accountId}/debitCards/{debitCardId}/regions", data)
    req.Header = headers

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

Create a new card region

POST https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/regions

Create a new named card region within the card regions collection. The new region defines an additional geographic areas where the cardholder plans to use the card during travel.

Body parameter

{
  "name": "Disney World's Magic Kingdom",
  "type": "coordinates",
  "coordinates": {
    "latitude": 28.4188,
    "longitude": -81.5818,
    "radius": "5mi"
  }
}

Parameters

ParameterDescription
body newCardRegion (required)
The data necessary to create a new region.
accountId
in: path
 resourceId (required)
The unique identifier of this account resource. This is an opaque string.
minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
debitCardId
in: path
 externalResourceId (required)
The unique identifier of this debit card. This is an opaque string.
read-only
format: text
minLength: 1
maxLength: 256

Example responses

201 Response

{
  "id": "0399abed-fd3d",
  "name": "Disney World's Magic Kingdom",
  "type": "coordinates",
  "coordinates": {
    "latitude": 28.4188,
    "longitude": -81.5818,
    "radius": "5mi"
  }
}

Responses

StatusDescription
201 Created
Created.
Schema: cardRegion
HeaderLocation
string uri-reference
The URI of the new card region.
StatusDescription
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:

Schema: Inline
StatusDescription
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:

Schema: Inline
StatusDescription
403 Forbidden

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

This problem responsemay have one of the following type values:

Schema: Inline
StatusDescription
404 Not Found

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

This problem responsemay have one of the following type values:

Schema: problemResponse
StatusDescription
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:

Schema: Inline
StatusDescription
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:

Schema: Inline
StatusDescription
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
StatusDescription
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.

getDebitCardRegion

Code samples

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


GET https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/regions/{regionId} 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/accounts/{accountId}/debitCards/{debitCardId}/regions/{regionId}',
{
  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/accounts/{accountId}/debitCards/{debitCardId}/regions/{regionId}',
  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/accounts/{accountId}/debitCards/{debitCardId}/regions/{regionId}',
  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/accounts/{accountId}/debitCards/{debitCardId}/regions/{regionId}', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/regions/{regionId}");
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/accounts/{accountId}/debitCards/{debitCardId}/regions/{regionId}", data)
    req.Header = headers

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

Fetch a representation of this card region

GET https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/regions/{regionId}

Return the JSON representation of this card region resource.

Parameters

ParameterDescription
accountId
in: path
 resourceId (required)
The unique identifier of this account resource. This is an opaque string.
minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
debitCardId
in: path
 externalResourceId (required)
The unique identifier of this debit card. This is an opaque string.
read-only
format: text
minLength: 1
maxLength: 256
regionId
in: path
 externalResourceId (required)
The unique identifier of this region. This is an opaque string.
read-only
format: text
minLength: 1
maxLength: 256

Example responses

200 Response

{
  "id": "0399abed-fd3d",
  "name": "Disney World's Magic Kingdom",
  "type": "coordinates",
  "coordinates": {
    "latitude": 28.4188,
    "longitude": -81.5818,
    "radius": "5mi"
  }
}

Responses

StatusDescription
200 OK
OK.
Schema: cardRegion
StatusDescription
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:

Schema: Inline
StatusDescription
403 Forbidden

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

This problem responsemay have one of the following type values:

Schema: Inline
StatusDescription
404 Not Found

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

This problem responsemay have one of the following type values:

Schema: problemResponse
StatusDescription
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:

Schema: Inline
StatusDescription
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
StatusDescription
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.

patchDebitCardRegion

Code samples

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


PATCH https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/regions/{regionId} HTTP/1.1
Host: api.apiture.com
Content-Type: application/merge-patch+json
Accept: application/json


const fetch = require('node-fetch');
const inputBody = '{
  "name": "Disney World's Magic Kingdom Park"
}';
const headers = {
  'Content-Type':'application/merge-patch+json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/regions/{regionId}',
{
  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/accounts/{accountId}/debitCards/{debitCardId}/regions/{regionId}',
  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/accounts/{accountId}/debitCards/{debitCardId}/regions/{regionId}',
  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/accounts/{accountId}/debitCards/{debitCardId}/regions/{regionId}', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/regions/{regionId}");
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/accounts/{accountId}/debitCards/{debitCardId}/regions/{regionId}", data)
    req.Header = headers

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

Update this card region

PATCH https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/regions/{regionId}

Perform a partial update of this card region as per JSON Merge Patch format and processing rules. Only fields in the request body are updated on the resource; fields which are omitted are not updated.

Body parameter

{
  "name": "Disney World's Magic Kingdom Park"
}

Parameters

ParameterDescription
body cardRegionPatch (required)
The fields to update within the card region.
accountId
in: path
 resourceId (required)
The unique identifier of this account resource. This is an opaque string.
minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
debitCardId
in: path
 externalResourceId (required)
The unique identifier of this debit card. This is an opaque string.
read-only
format: text
minLength: 1
maxLength: 256
regionId
in: path
 externalResourceId (required)
The unique identifier of this region. This is an opaque string.
read-only
format: text
minLength: 1
maxLength: 256

Example responses

200 Response

{
  "id": "0399abed-fd3d",
  "name": "Disney World's Magic Kingdom",
  "type": "coordinates",
  "coordinates": {
    "latitude": 28.4188,
    "longitude": -81.5818,
    "radius": "5mi"
  }
}

Responses

StatusDescription
200 OK
OK.
Schema: cardRegion
StatusDescription
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:

Schema: Inline
StatusDescription
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:

Schema: Inline
StatusDescription
403 Forbidden

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

This problem responsemay have one of the following type values:

Schema: Inline
StatusDescription
404 Not Found

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

This problem responsemay have one of the following type values:

Schema: problemResponse
StatusDescription
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:

Schema: Inline
StatusDescription
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:

Schema: Inline
StatusDescription
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
StatusDescription
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.

deleteDebitCardRegion

Code samples

# You can also use wget
curl -X DELETE https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/regions/{regionId} \
  -H 'Accept: application/problem+json' \
  -H 'Authorization: Bearer {access-token}'


DELETE https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/regions/{regionId} HTTP/1.1
Host: api.apiture.com
Accept: application/problem+json


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

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

};

fetch('https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/regions/{regionId}',
{
  method: 'DELETE',

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


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

};

$.ajax({
  url: 'https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/regions/{regionId}',
  method: 'delete',

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


require 'rest-client'
require 'json'

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

result = RestClient.delete 'https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/regions/{regionId}',
  params: {
  }, headers: headers

p JSON.parse(result)


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

r = requests.delete('https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/regions/{regionId}', params={

}, headers = headers)

print r.json()


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


package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/regions/{regionId}", data)
    req.Header = headers

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

Delete this card region resource

DELETE https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/regions/{regionId}

Delete this card region resource and any resources that are owned by it.

Parameters

ParameterDescription
accountId
in: path
 resourceId (required)
The unique identifier of this account resource. This is an opaque string.
minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
debitCardId
in: path
 externalResourceId (required)
The unique identifier of this debit card. This is an opaque string.
read-only
format: text
minLength: 1
maxLength: 256
regionId
in: path
 externalResourceId (required)
The unique identifier of this region. This is an opaque string.
read-only
format: text
minLength: 1
maxLength: 256

Example responses

401 Response

{
  "id": "3fbad566-be86-4b22-9ba6-3ca99fdc0799",
  "type": "https://production.api.apiture.com/errors/unauthorized/v1.0.0",
  "title": "Unauthorized",
  "status": 401,
  "occurredAt": "2022-04-25T12:42:21.375Z",
  "detail": "The request lacks valid authentication credentials",
  "instance": "https://production.api.apiture.com/banking/transfers/bb709151-575041fcd617"
}

Responses

StatusDescription
204 No Content
No Content. The operation succeeded but returned no response body.
StatusDescription
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:

Schema: Inline
StatusDescription
403 Forbidden

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

This problem responsemay have one of the following type values:

Schema: Inline
StatusDescription
404 Not Found

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

This problem responsemay have one of the following type values:

Schema: problemResponse
StatusDescription
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:

Schema: Inline
StatusDescription
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
StatusDescription
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.

Debit Card Actions

Banking Debit Card Actions

lockCustomerDebitCard

Code samples

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


POST https://api.apiture.com/banking/debitCards/{debitCardId}/locked 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/debitCards/{debitCardId}/locked',
{
  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/debitCards/{debitCardId}/locked',
  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/debitCards/{debitCardId}/locked',
  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/debitCards/{debitCardId}/locked', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://api.apiture.com/banking/debitCards/{debitCardId}/locked");
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/debitCards/{debitCardId}/locked", data)
    req.Header = headers

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

Lock a Debit Card

POST https://api.apiture.com/banking/debitCards/{debitCardId}/locked

Lock a debit card. This changes the state property of the debit card to locked. The response is the updated representation of the debit card.

A locked debit card may not be used for new purchases until the cardholder unlocks the card.

This is an idempotent action; locking a debit card changes nothing if the card is already locked.

Locking a debit card is not allowed if allows.lock is false.

Parameters

ParameterDescription
debitCardId
in: path
 externalResourceId (required)
The unique identifier of this debit card. This is an opaque string.
read-only
format: text
minLength: 1
maxLength: 256

Example responses

200 Response

{
  "id": "0399abed-fd3d",
  "type": "physical",
  "state": "active",
  "issuerIdentificationNumber": "4242",
  "displayName": "PHIL DUCIARY",
  "cardholder": {
    "name": "Phil Duciary",
    "type": "primary",
    "address": {
      "address1": "1805 Tiburon Dr.",
      "locality": "Wilmington",
      "regionCode": "NC",
      "countryCode": "US",
      "postalCode": "28403"
    }
  },
  "maskedAccountNumber": "*1000",
  "expirationMonth": "12",
  "expirationYear": "29",
  "allows": {
    "activate": false,
    "viewTransactions": true,
    "viewUnmaskedSecurityCode": true,
    "reportLost": true,
    "reportFound": false,
    "reportStolen": true,
    "reportDamaged": true,
    "lock": true,
    "unlock": false,
    "changePin": true,
    "manageTravelNotifications": true
  }
}

Responses

StatusDescription
200 OK
OK. The operation succeeded. The debit card resource was updated and its state changed to locked.

This operation is idempotent: no changes are made if the debit card resource is already locked.

Schema: debitCard
StatusDescription
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:

Schema: Inline
StatusDescription
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:

Schema: Inline
StatusDescription
403 Forbidden

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

This problem responsemay have one of the following type values:

Schema: Inline
StatusDescription
404 Not Found

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

This problem responsemay have one of the following type values:

Schema: problemResponse
StatusDescription
409 Conflict

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

This problem responsemay have one of the following type values:

Schema: problemResponse
StatusDescription
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:

StatusDescription
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:

Schema: Inline
StatusDescription
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
StatusDescription
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.

unlockCustomerDebitCard

Code samples

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


POST https://api.apiture.com/banking/debitCards/{debitCardId}/unlocked 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/debitCards/{debitCardId}/unlocked',
{
  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/debitCards/{debitCardId}/unlocked',
  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/debitCards/{debitCardId}/unlocked',
  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/debitCards/{debitCardId}/unlocked', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://api.apiture.com/banking/debitCards/{debitCardId}/unlocked");
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/debitCards/{debitCardId}/unlocked", data)
    req.Header = headers

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

Unlock a Debit Card

POST https://api.apiture.com/banking/debitCards/{debitCardId}/unlocked

Unlock a debit card. This changes the state property of the debit card to active. The response is the updated representation of the debit card.

This is an idempotent action; unlocking a debit card changes nothing if the card is already locked.

Unlocking a debit card is not allowed if allows.unlock is false.

Parameters

ParameterDescription
debitCardId
in: path
 externalResourceId (required)
The unique identifier of this debit card. This is an opaque string.
read-only
format: text
minLength: 1
maxLength: 256

Example responses

200 Response

{
  "id": "0399abed-fd3d",
  "type": "physical",
  "state": "active",
  "issuerIdentificationNumber": "4242",
  "displayName": "PHIL DUCIARY",
  "cardholder": {
    "name": "Phil Duciary",
    "type": "primary",
    "address": {
      "address1": "1805 Tiburon Dr.",
      "locality": "Wilmington",
      "regionCode": "NC",
      "countryCode": "US",
      "postalCode": "28403"
    }
  },
  "maskedAccountNumber": "*1000",
  "expirationMonth": "12",
  "expirationYear": "29",
  "allows": {
    "activate": false,
    "viewTransactions": true,
    "viewUnmaskedSecurityCode": true,
    "reportLost": true,
    "reportFound": false,
    "reportStolen": true,
    "reportDamaged": true,
    "lock": true,
    "unlock": false,
    "changePin": true,
    "manageTravelNotifications": true
  }
}

Responses

StatusDescription
200 OK
OK. The operation succeeded. The debit card resource was updated.

This operation is idempotent: no changes are made if the debit card resource is already in a state other than locked.

Schema: debitCard
StatusDescription
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:

Schema: Inline
StatusDescription
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:

Schema: Inline
StatusDescription
403 Forbidden

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

This problem responsemay have one of the following type values:

Schema: Inline
StatusDescription
404 Not Found

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

This problem responsemay have one of the following type values:

Schema: problemResponse
StatusDescription
409 Conflict

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

This problem responsemay have one of the following type values:

Schema: problemResponse
StatusDescription
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:

StatusDescription
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:

Schema: Inline
StatusDescription
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
StatusDescription
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.

createCustomerDebitCardChallenge

Code samples

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


POST https://api.apiture.com/banking/debitCards/{debitCardId}/challenges HTTP/1.1
Host: api.apiture.com
Content-Type: application/json
Accept: application/json


const fetch = require('node-fetch');
const inputBody = '{
  "type": "unmaskCardProperties"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/banking/debitCards/{debitCardId}/challenges',
{
  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/debitCards/{debitCardId}/challenges',
  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/debitCards/{debitCardId}/challenges',
  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/debitCards/{debitCardId}/challenges', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://api.apiture.com/banking/debitCards/{debitCardId}/challenges");
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/debitCards/{debitCardId}/challenges", data)
    req.Header = headers

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

Issue a Debit Card Identity Challenge

POST https://api.apiture.com/banking/debitCards/{debitCardId}/challenges

Issue an identity challenge for debit card operations.

See the "Challenges API" for completing the identity challenge.

Body parameter

{
  "type": "unmaskCardProperties"
}

Parameters

ParameterDescription
body cardOperationChallengeRequest
debitCardId
in: path
 externalResourceId (required)
The unique identifier of this debit card. This is an opaque string.
read-only
format: text
minLength: 1
maxLength: 256

Example responses

201 Response

{
  "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"
    }
  ]
}

Responses

StatusDescription
201 Created
Created.
Schema: requiredIdentityChallenge
StatusDescription
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:

Schema: Inline
StatusDescription
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:

Schema: Inline
StatusDescription
403 Forbidden

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

This problem responsemay have one of the following type values:

Schema: Inline
StatusDescription
404 Not Found

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

This problem responsemay have one of the following type values:

Schema: Inline
StatusDescription
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:

StatusDescription
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:

Schema: Inline
StatusDescription
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
StatusDescription
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.

createDebitCardChallenge

Code samples

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


POST https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/challenges HTTP/1.1
Host: api.apiture.com
Content-Type: application/json
Accept: application/json


const fetch = require('node-fetch');
const inputBody = '{
  "type": "unmaskCardProperties"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/challenges',
{
  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/accounts/{accountId}/debitCards/{debitCardId}/challenges',
  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/accounts/{accountId}/debitCards/{debitCardId}/challenges',
  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/accounts/{accountId}/debitCards/{debitCardId}/challenges', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/challenges");
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/accounts/{accountId}/debitCards/{debitCardId}/challenges", data)
    req.Header = headers

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

Issue a Debit Card Identity Challenge

POST https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/challenges

Issue an identity challenge for debit card operations.

See the "Challenges API" for completing the identity challenge.

Body parameter

{
  "type": "unmaskCardProperties"
}

Parameters

ParameterDescription
body cardOperationChallengeRequest
accountId
in: path
 resourceId (required)
The unique identifier of this account resource. This is an opaque string.
minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
debitCardId
in: path
 externalResourceId (required)
The unique identifier of this debit card. This is an opaque string.
read-only
format: text
minLength: 1
maxLength: 256

Example responses

201 Response

{
  "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"
    }
  ]
}

Responses

StatusDescription
201 Created
Created.
Schema: requiredIdentityChallenge
StatusDescription
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:

Schema: Inline
StatusDescription
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:

Schema: Inline
StatusDescription
403 Forbidden

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

This problem responsemay have one of the following type values:

Schema: Inline
StatusDescription
404 Not Found

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

This problem responsemay have one of the following type values:

Schema: problemResponse
StatusDescription
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:

StatusDescription
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:

Schema: Inline
StatusDescription
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
StatusDescription
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.

changeDebitCardPin

Code samples

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


POST https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/pinChange HTTP/1.1
Host: api.apiture.com
Content-Type: application/json
Accept: application/json
Challenge: string


const fetch = require('node-fetch');
const inputBody = '{
  "currentPin": "stri",
  "newPin": "stri"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Challenge':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/pinChange',
{
  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',
  'Challenge':'string',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/pinChange',
  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',
  'Challenge' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/pinChange',
  params: {
  }, headers: headers

p JSON.parse(result)


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

r = requests.post('https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/pinChange', params={

}, headers = headers)

print r.json()


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

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

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

Change a Debit Card PIN

POST https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/pinChange

Change the Personal Identification Number (PIN) for this debit card. The previous PIN used will no longer work after this change.

The debitCard.allows.changePin permission must be true to use this operation, The operation returns a 403 Forbidden, with problem type forbidden, if the currently authenticated user does not have permission to change the PIN.

Note: This operation may require an identity challenge as described above in Identity Challenges. See the "Challenges API" for completing the identity challenge.

Body parameter

{
  "currentPin": "stri",
  "newPin": "stri"
}

Parameters

ParameterDescription
body cardPinChange
accountId
in: path
 resourceId (required)
The unique identifier of this account resource. This is an opaque string.
minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
debitCardId
in: path
 externalResourceId (required)
The unique identifier of this debit card. This is an opaque string.
read-only
format: text
minLength: 1
maxLength: 256
Challenge
in: header
 challengeToken
This operation may require a completed challenge. If the first attempt calling this operation fails with a 403 challengeRequired error, the client should complete the challenge flow as described in the Challenges API, then retry the operation with this Challenge request header using the challengeToken returned at the end of that flow. If this is passed but the value is invalid, the operation fails with a 403 status code and the invalidIdentityChallengeHeader problem type.
minLength: 6
maxLength: 255
pattern: "^[-_:.~%$a-zA-Z0-9]{6,255}$"

Example responses

200 Response

{
  "id": "0399abed-fd3d",
  "type": "physical",
  "state": "active",
  "issuerIdentificationNumber": "4242",
  "displayName": "PHIL DUCIARY",
  "cardholder": {
    "name": "Phil Duciary",
    "type": "primary",
    "address": {
      "address1": "1805 Tiburon Dr.",
      "locality": "Wilmington",
      "regionCode": "NC",
      "countryCode": "US",
      "postalCode": "28403"
    }
  },
  "maskedAccountNumber": "*1000",
  "expirationMonth": "12",
  "expirationYear": "29",
  "allows": {
    "activate": false,
    "viewTransactions": true,
    "viewUnmaskedSecurityCode": true,
    "reportLost": true,
    "reportFound": false,
    "reportStolen": true,
    "reportDamaged": true,
    "lock": true,
    "unlock": false,
    "changePin": true,
    "manageTravelNotifications": true
  }
}

Responses

StatusDescription
200 OK
OK. The operation succeeded. The PIN was updated.
Schema: debitCard
StatusDescription
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:

Schema: Inline
StatusDescription
403 Forbidden

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

This problem responsemay have one of the following type values:

Schema: Inline
StatusDescription
404 Not Found

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

This problem responsemay have one of the following type values:

Schema: problemResponse
StatusDescription
409 Conflict

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

This problem responsemay have one of the following type values:

Schema: problemResponse
StatusDescription
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:

Schema: problemResponse
StatusDescription
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:

Schema: Inline
StatusDescription
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
StatusDescription
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.

activateDebitCard

Code samples

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


POST https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/activated HTTP/1.1
Host: api.apiture.com
Content-Type: application/json
Accept: application/json
Challenge: string


const fetch = require('node-fetch');
const inputBody = '{
  "cardNumber": "4242424242424242",
  "expirationMonth": "03",
  "expirationYear": "28",
  "securityCode": "311"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Challenge':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/activated',
{
  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',
  'Challenge':'string',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/activated',
  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',
  'Challenge' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/activated',
  params: {
  }, headers: headers

p JSON.parse(result)


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

r = requests.post('https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/activated', params={

}, headers = headers)

print r.json()


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

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

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

Activate a Debit Card

POST https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/activated

Activate a debit card.

Activating a card unlocks the card from the disabled state.

This is an idempotent action; Activating a debit card with a state of active has no effect.

Note: This operation may require an identity challenge as described above in Identity Challenges. See the "Challenges API" for completing the identity challenge.

Body parameter

{
  "cardNumber": "4242424242424242",
  "expirationMonth": "03",
  "expirationYear": "28",
  "securityCode": "311"
}

Parameters

ParameterDescription
body debitCardActivationRequest
accountId
in: path
 resourceId (required)
The unique identifier of this account resource. This is an opaque string.
minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
debitCardId
in: path
 externalResourceId (required)
The unique identifier of this debit card. This is an opaque string.
read-only
format: text
minLength: 1
maxLength: 256
Challenge
in: header
 challengeToken
This operation may require a completed challenge. If the first attempt calling this operation fails with a 403 challengeRequired error, the client should complete the challenge flow as described in the Challenges API, then retry the operation with this Challenge request header using the challengeToken returned at the end of that flow. If this is passed but the value is invalid, the operation fails with a 403 status code and the invalidIdentityChallengeHeader problem type.
minLength: 6
maxLength: 255
pattern: "^[-_:.~%$a-zA-Z0-9]{6,255}$"

Example responses

201 Response

{
  "id": "0399abed-fd3d",
  "type": "physical",
  "state": "active",
  "issuerIdentificationNumber": "4242",
  "displayName": "PHIL DUCIARY",
  "cardholder": {
    "name": "Phil Duciary"
  },
  "maskedAccountNumber": "*1000",
  "allows": {
    "activate": false,
    "viewTransactions": true,
    "viewUnmaskedSecurityCode": true,
    "reportLost": true,
    "reportFound": false,
    "reportStolen": true,
    "reportDamaged": true,
    "lock": true,
    "unlock": false,
    "changePin": true,
    "manageTravelNotifications": true
  }
}

Responses

StatusDescription
201 Created
Activated. The debit card has been successfully activated.
Schema: debitCardItem
HeaderLocation
string uri-reference
The URI of the debit card.
StatusDescription
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:

Schema: Inline
StatusDescription
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:

Schema: Inline
StatusDescription
403 Forbidden

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

This problem responsemay have one of the following type values:

Schema: Inline
StatusDescription
404 Not Found

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

This problem responsemay have one of the following type values:

Schema: problemResponse
StatusDescription
409 Conflict

Conflict.

This problem responsemay have one of the following type values:

Schema: problemResponse
StatusDescription
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:

StatusDescription
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:

Schema: Inline
StatusDescription
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
StatusDescription
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.

reportDebitCard

Code samples

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


POST https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/reported HTTP/1.1
Host: api.apiture.com
Content-Type: application/json
Accept: application/json
Challenge: string


const fetch = require('node-fetch');
const inputBody = '{
  "type": "lost",
  "primaryCardholderDateOfBirth": "2021-10-30",
  "dateLost": "2021-10-30",
  "lastUsedDate": "2021-10-30",
  "alternativeShippingMethod": "primaryMethod",
  "temporaryMailingAddress": {
    "address1": "1805 Tiburon Dr.",
    "address2": "Building 14, Suite 1500",
    "locality": "Wilmington",
    "regionCode": "NC",
    "countryCode": "US",
    "postalCode": "28403"
  },
  "pinCompromised": true,
  "additionalInformation": [
    "string"
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Challenge':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/reported',
{
  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',
  'Challenge':'string',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/reported',
  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',
  'Challenge' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/reported',
  params: {
  }, headers: headers

p JSON.parse(result)


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

r = requests.post('https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/reported', params={

}, headers = headers)

print r.json()


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

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

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

Report a Debit Card as Lost, Stolen, or Damaged

POST https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/reported

Report a debit card as lost, stolen, or damaged. Reported cards have their state set to disabled and cannot be used to make purchases. Cards that are lost or stolen are replaced. Replacing a card involves changing the primary access number (PAN). Damaged cards are reissued with the same PAN but different expiration date and security card.

This is an idempotent action; reporting a debit card as lost, stolen, or damaged changes nothing if the card was already reported as damaged and has not yet been replaced or reissued.

Damaged cards are active and can be used for transactions until the reissued card is activated. Once a card is reported as lost or stolen, it is disabled. The replacement card is disabled until it is activated.

Reporting a debit card as lost is not allowed if allows.reportLost is false. Reporting a debit card as stolen is not allowed if allows.reportStolen is false. Reporting a debit card as damaged is not allowed if allows.reportDamaged is false.

Some financial institutions may allow a card reported as lost to be marked as found before a replacement card is sent. A future API operation may support this action. Until then, if the lost card is found, the cardholder should contact the issuing financial institution to cancel the card replacement request.

Note: This operation may require an identity challenge as described above in Identity Challenges. See the "Challenges API" for completing the identity challenge.

Body parameter

{
  "type": "lost",
  "primaryCardholderDateOfBirth": "2021-10-30",
  "dateLost": "2021-10-30",
  "lastUsedDate": "2021-10-30",
  "alternativeShippingMethod": "primaryMethod",
  "temporaryMailingAddress": {
    "address1": "1805 Tiburon Dr.",
    "address2": "Building 14, Suite 1500",
    "locality": "Wilmington",
    "regionCode": "NC",
    "countryCode": "US",
    "postalCode": "28403"
  },
  "pinCompromised": true,
  "additionalInformation": [
    "string"
  ]
}

Parameters

ParameterDescription
body cardReportedRequest
accountId
in: path
 resourceId (required)
The unique identifier of this account resource. This is an opaque string.
minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
debitCardId
in: path
 externalResourceId (required)
The unique identifier of this debit card. This is an opaque string.
read-only
format: text
minLength: 1
maxLength: 256
Challenge
in: header
 challengeToken
This operation may require a completed challenge. If the first attempt calling this operation fails with a 403 challengeRequired error, the client should complete the challenge flow as described in the Challenges API, then retry the operation with this Challenge request header using the challengeToken returned at the end of that flow. If this is passed but the value is invalid, the operation fails with a 403 status code and the invalidIdentityChallengeHeader problem type.
minLength: 6
maxLength: 255
pattern: "^[-_:.~%$a-zA-Z0-9]{6,255}$"

Example responses

200 Response

{
  "id": "0399abed-fd3d",
  "type": "physical",
  "state": "active",
  "issuerIdentificationNumber": "4242",
  "displayName": "PHIL DUCIARY",
  "cardholder": {
    "name": "Phil Duciary",
    "type": "primary",
    "address": {
      "address1": "1805 Tiburon Dr.",
      "locality": "Wilmington",
      "regionCode": "NC",
      "countryCode": "US",
      "postalCode": "28403"
    }
  },
  "maskedAccountNumber": "*1000",
  "expirationMonth": "12",
  "expirationYear": "29",
  "allows": {
    "activate": false,
    "viewTransactions": true,
    "viewUnmaskedSecurityCode": true,
    "reportLost": true,
    "reportFound": false,
    "reportStolen": true,
    "reportDamaged": true,
    "lock": true,
    "unlock": false,
    "changePin": true,
    "manageTravelNotifications": true
  }
}

Responses

StatusDescription
200 OK
OK. All debit cards belonging to the same card group as this debit card resource have been reported as lost, stolen, or damaged.
Schema: debitCard
StatusDescription
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:

Schema: Inline
StatusDescription
403 Forbidden

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

This problem responsemay have one of the following type values:

Schema: Inline
StatusDescription
404 Not Found

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

This problem responsemay have one of the following type values:

Schema: problemResponse
StatusDescription
409 Conflict

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

This problem responsemay have one of the following type values:

Schema: problemResponse
StatusDescription
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:

StatusDescription
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:

Schema: Inline
StatusDescription
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
StatusDescription
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.

lockDebitCard

Code samples

# You can also use wget
curl -X POST https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/locked \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'


POST https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/locked 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/accounts/{accountId}/debitCards/{debitCardId}/locked',
{
  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/accounts/{accountId}/debitCards/{debitCardId}/locked',
  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/accounts/{accountId}/debitCards/{debitCardId}/locked',
  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/accounts/{accountId}/debitCards/{debitCardId}/locked', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/locked");
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/accounts/{accountId}/debitCards/{debitCardId}/locked", data)
    req.Header = headers

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

Lock a Debit Card

POST https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/locked

Lock a debit card. This changes the state property of the debit card to locked. The response is the updated representation of the debit card.

A locked debit card may not be used for new purchases until the cardholder unlocks the card.

This is an idempotent action; locking a debit card changes nothing if the card is already locked.

Locking a debit card is not allowed if allows.lock is false.

Parameters

ParameterDescription
accountId
in: path
 resourceId (required)
The unique identifier of this account resource. This is an opaque string.
minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
debitCardId
in: path
 externalResourceId (required)
The unique identifier of this debit card. This is an opaque string.
read-only
format: text
minLength: 1
maxLength: 256

Example responses

200 Response

{
  "id": "0399abed-fd3d",
  "type": "physical",
  "state": "active",
  "issuerIdentificationNumber": "4242",
  "displayName": "PHIL DUCIARY",
  "cardholder": {
    "name": "Phil Duciary",
    "type": "primary",
    "address": {
      "address1": "1805 Tiburon Dr.",
      "locality": "Wilmington",
      "regionCode": "NC",
      "countryCode": "US",
      "postalCode": "28403"
    }
  },
  "maskedAccountNumber": "*1000",
  "expirationMonth": "12",
  "expirationYear": "29",
  "allows": {
    "activate": false,
    "viewTransactions": true,
    "viewUnmaskedSecurityCode": true,
    "reportLost": true,
    "reportFound": false,
    "reportStolen": true,
    "reportDamaged": true,
    "lock": true,
    "unlock": false,
    "changePin": true,
    "manageTravelNotifications": true
  }
}

Responses

StatusDescription
200 OK
OK. The operation succeeded. The debit card resource was updated and its state changed to locked.

This operation is idempotent: no changes are made if the debit card resource is already locked.

Schema: debitCard
StatusDescription
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:

Schema: Inline
StatusDescription
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:

Schema: Inline
StatusDescription
403 Forbidden

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

This problem responsemay have one of the following type values:

Schema: Inline
StatusDescription
404 Not Found

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

This problem responsemay have one of the following type values:

Schema: problemResponse
StatusDescription
409 Conflict

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

This problem responsemay have one of the following type values:

Schema: problemResponse
StatusDescription
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:

StatusDescription
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:

Schema: Inline
StatusDescription
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
StatusDescription
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.

unlockDebitCard

Code samples

# You can also use wget
curl -X POST https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/unlocked \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'


POST https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/unlocked 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/accounts/{accountId}/debitCards/{debitCardId}/unlocked',
{
  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/accounts/{accountId}/debitCards/{debitCardId}/unlocked',
  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/accounts/{accountId}/debitCards/{debitCardId}/unlocked',
  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/accounts/{accountId}/debitCards/{debitCardId}/unlocked', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/unlocked");
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/accounts/{accountId}/debitCards/{debitCardId}/unlocked", data)
    req.Header = headers

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

Unlock a Debit Card

POST https://api.apiture.com/banking/accounts/{accountId}/debitCards/{debitCardId}/unlocked

Lock a debit card. This changes the state property of the debit card to active. The response is the updated representation of the debit card.

This is an idempotent action; unlocking a debit card changes nothing if the card is already locked.

Unlocking a debit card is not allowed if allows.unlock is false.

Parameters

ParameterDescription
accountId
in: path
 resourceId (required)
The unique identifier of this account resource. This is an opaque string.
minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
debitCardId
in: path
 externalResourceId (required)
The unique identifier of this debit card. This is an opaque string.
read-only
format: text
minLength: 1
maxLength: 256

Example responses

200 Response

{
  "id": "0399abed-fd3d",
  "type": "physical",
  "state": "active",
  "issuerIdentificationNumber": "4242",
  "displayName": "PHIL DUCIARY",
  "cardholder": {
    "name": "Phil Duciary",
    "type": "primary",
    "address": {
      "address1": "1805 Tiburon Dr.",
      "locality": "Wilmington",
      "regionCode": "NC",
      "countryCode": "US",
      "postalCode": "28403"
    }
  },
  "maskedAccountNumber": "*1000",
  "expirationMonth": "12",
  "expirationYear": "29",
  "allows": {
    "activate": false,
    "viewTransactions": true,
    "viewUnmaskedSecurityCode": true,
    "reportLost": true,
    "reportFound": false,
    "reportStolen": true,
    "reportDamaged": true,
    "lock": true,
    "unlock": false,
    "changePin": true,
    "manageTravelNotifications": true
  }
}

Responses

StatusDescription
200 OK
OK. The operation succeeded. The debit card resource was updated.

This operation is idempotent: no changes are made if the debit card resource is already in a state other than locked.

Schema: debitCard
StatusDescription
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:

Schema: Inline
StatusDescription
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:

Schema: Inline
StatusDescription
403 Forbidden

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

This problem responsemay have one of the following type values:

Schema: Inline
StatusDescription
404 Not Found

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

This problem responsemay have one of the following type values:

Schema: problemResponse
StatusDescription
409 Conflict

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

This problem responsemay have one of the following type values:

Schema: problemResponse
StatusDescription
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:

StatusDescription
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:

Schema: Inline
StatusDescription
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
StatusDescription
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.

Schemas

address

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

Address (v1.6.1)

A postal address that can hold a US address or an international (non-US) postal addresses.

Properties

NameDescription
Address (v1.6.1) object
A postal address that can hold a US address or an international (non-US) postal addresses.
address1 string(text) (required)
The first line of the postal address. In the US, this typically includes the building number and street name.
format: text
maxLength: 35
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: 35
locality string(text) (required)
The city/town/municipality of the address.
format: text
maxLength: 30
countryCode countryCode (required)
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: 2
maxLength: 20
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 postalCode (required)
The 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.
minLength: 2
maxLength: 20
pattern: "[0-9A-Za-z][- 0-9A-Za-z]{0,18}[0-9A-Za-z]"

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

NameDescription
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

cardAlertSubscriptionAllowedRegions

{
  "communicationChannels": [
    {
      "id": "0399abed-fd3d",
      "label": "Max.Pike@example.com",
      "type": "email"
    }
  ],
  "regions": [
    {
      "id": "0399abed-fd3d",
      "name": "Disney World's Magic Kingdom",
      "type": "coordinates",
      "coordinates": {
        "latitude": 28.4188,
        "longitude": -81.5818,
        "radius": "5mi"
      }
    }
  ]
}

Card Alert Subscription Known Regions (v2.0.0)

Alert the account holder when a transaction using this card occurs outside the boundaries of all of these regions. An empty array for either regions and communicationChannels means this alert is disabled.

Properties

NameDescription
Card Alert Subscription Known Regions (v2.0.0) object
Alert the account holder when a transaction using this card occurs outside the boundaries of all of these regions. An empty array for either regions and communicationChannels means this alert is disabled.
communicationChannels array: [customerCommunicationChannel] (required)
Channels to communicate this alert subscription.
unique items
minItems: 0
maxItems: 5
items: object
regions array: [cardRegionItem] (required)
Regions excluded for transaction alerts.
unique items
minItems: 0
maxItems: 3
items: object

cardAlertSubscriptionAllowedRegionsPatch

{
  "communicationChannels": [
    {
      "id": "0399abed-fd3d",
      "label": "Max.Pike@example.com",
      "type": "email"
    }
  ],
  "regions": [
    {
      "id": "0399abed-fd3d",
      "name": "Disney World's Magic Kingdom",
      "type": "coordinates",
      "coordinates": {
        "latitude": 28.4188,
        "longitude": -81.5818,
        "radius": "5mi"
      }
    }
  ]
}

Card Alert Subscription Known Regions Patch (v2.0.0)

Alert the account holder when a transaction using this card occurs outside the boundaries of all of these regions. An empty array for either regions and communicationChannels means this alert is disabled.

Properties

NameDescription
Card Alert Subscription Known Regions Patch (v2.0.0) object
Alert the account holder when a transaction using this card occurs outside the boundaries of all of these regions. An empty array for either regions and communicationChannels means this alert is disabled.
communicationChannels array: [customerCommunicationChannel] (required)
Channels to communicate this alert subscription.
unique items
minItems: 0
maxItems: 5
items: object
regions array: [cardRegionReference] (required)
Regions excluded for transaction alerts.
unique items
minItems: 0
maxItems: 3
items: object

cardAlertSubscriptionMerchantCategories

{
  "communicationChannels": [
    {
      "id": "0399abed-fd3d",
      "label": "Max.Pike@example.com",
      "type": "email"
    }
  ],
  "categories": [
    "ageRestricted"
  ]
}
  • (v2.0.0)*

Alert the account holder when a card transaction's merchant category matches any of these categories. An empty array for categories and communication channels means this alert is disabled.

Properties

NameDescription
(v2.0.0) object
Alert the account holder when a card transaction's merchant category matches any of these categories. An empty array for categories and communication channels means this alert is disabled.
communicationChannels array: [customerCommunicationChannel] (required)
Channels to communicate this alert subscription.
unique items
minItems: 0
maxItems: 5
items: object
categories array: [cardMerchantCategories] (required)
Categories used for the transaction alert.
unique items
minItems: 0
maxItems: 12
items: string
» enum values: ageRestricted, ageRestricted.drinkingPlaces, ageRestricted.gambling, ageRestricted.liquorAndCigarStores, ageRestricted.dating, education, education.tuitionFees, education.books, entertainment, entertainment.games, entertainment.musicAndMovies, entertainment.parks, entertainment.other, foodAndDining, foodAndDining.restaurants, foodAndDining.groceries, giftsAndDonations, giftsAndDonations.gifts, giftsAndDonations.donations, household, household.maintenanceOrRepair, household.decorationOrImprovement, household.housekeeping, household.cableUtilities, household.communicationUtilities, household.security, household.chemicalUtilities, household.otherUtilities, household.rentalServices, household.laundry, insurance, personalCare, personalCare.pharmacy, personalCare.beautyProducts, personalCare.doctor, personalCare.sports, personalCare.wellness, personalCare.childrenServices, shopping, shopping.clothing, shopping.electronics, shopping.accessories, shopping.other, transportation, transportation.autoServices, transportation.gasOrFuel, transportation.parking, transportation.toll, transportation.other, travel, travel.autoRentals, travel.airline, travel.train, travel.lodging, travel.other, other, other.atm

cardAlertSubscriptionTransactionCategories

{
  "communicationChannels": [
    {
      "id": "0399abed-fd3d",
      "label": "Max.Pike@example.com",
      "type": "email"
    }
  ],
  "categories": [
    "atm"
  ]
}
  • (v2.0.0)*

Alert the account holder when a transaction using this card has a category matching any of these categories. An empty array for categories and communication channels means this alert is disabled.

Properties

NameDescription
(v2.0.0) object
Alert the account holder when a transaction using this card has a category matching any of these categories. An empty array for categories and communication channels means this alert is disabled.
communicationChannels array: [customerCommunicationChannel] (required)
Channels to communicate this alert subscription.
unique items
minItems: 0
maxItems: 5
items: object
categories array: [cardTransactionCategories] (required)
Categories used for the transaction alert.
unique items
minItems: 0
maxItems: 8
items: string
» enum values: atm, autopay, transfer, physicalMerchant, mailMerchant, phoneMerchant, onlineMerchant, other

cardAlertSubscriptions

{
  "transactionLimit": {
    "communicationChannels": [
      {
        "id": "0399abed-fd3d",
        "label": "Max.Pike@example.com",
        "type": "email"
      }
    ],
    "threshold": 10000000
  },
  "monthlySpendingLimit": {
    "communicationChannels": [
      {
        "id": "0399abed-fd3d",
        "label": "Max.Pike@example.com",
        "type": "email"
      }
    ],
    "threshold": 10000000
  },
  "transactionOccurred": {
    "communicationChannels": [
      {
        "id": "0399abed-fd3d",
        "label": "Max.Pike@example.com",
        "type": "email"
      }
    ]
  },
  "transactionDeclined": {
    "communicationChannels": [
      {
        "id": "0399abed-fd3d",
        "label": "Max.Pike@example.com",
        "type": "email"
      }
    ]
  },
  "merchantCategories": {
    "communicationChannels": [
      {
        "id": "0399abed-fd3d",
        "label": "Max.Pike@example.com",
        "type": "email"
      }
    ],
    "categories": [
      "ageRestricted"
    ]
  },
  "transactionCategories": {
    "communicationChannels": [
      {
        "id": "0399abed-fd3d",
        "label": "Max.Pike@example.com",
        "type": "email"
      }
    ],
    "categories": [
      "atm"
    ]
  },
  "allowedRegions": {
    "communicationChannels": [
      {
        "id": "0399abed-fd3d",
        "label": "Max.Pike@example.com",
        "type": "email"
      }
    ],
    "regions": [
      {
        "id": "0399abed-fd3d",
        "name": "Disney World's Magic Kingdom",
        "type": "coordinates",
        "coordinates": {
          "latitude": 28.4188,
          "longitude": -81.5818,
          "radius": "5mi"
        }
      }
    ]
  }
}

Card Alert Subscriptions (v4.0.0)

Representation of alert subscriptions for a card account.

Properties

NameDescription
Card Alert Subscriptions (v4.0.0) object
Representation of alert subscriptions for a card account.
transactionLimit monetaryThresholdAlertSubscription (required)
Alert the account holder when any transaction exceeds this positive monetary amount in United States Dollars (USD).
monthlySpendingLimit monetaryThresholdAlertSubscription (required)
Alert the account holder when the total of all debits in a monthly period on the account exceeds this positive monetary amount in United States Dollars (USD).
transactionOccurred simpleCardAlertSubscription (required)
Alert the account holder when any transaction using this card occurs.
transactionDeclined requiredCommunicationChannelAlertSubscription (required)
Alert the account holder when any transaction using this card is declined.

This alert requires at least one communication channel to be configured.

merchantCategories cardAlertSubscriptionMerchantCategories (required)
Alert the account holder when a card transaction's merchant category matches any of these categories. An empty array for categories and communication channels means this alert is disabled.
transactionCategories cardAlertSubscriptionTransactionCategories (required)
Alert the account holder when a transaction using this card has a category matching any of these categories. An empty array for categories and communication channels means this alert is disabled.
allowedRegions cardAlertSubscriptionAllowedRegions (required)
Alert the account holder when a transaction using this card occurs outside the boundaries of all of these regions. An empty array for either regions and communicationChannels means this alert is disabled.

cardAlertSubscriptionsPatch

{
  "transactionLimit": {
    "communicationChannels": [
      {
        "id": "0399abed-fd3d",
        "label": "Max.Pike@example.com",
        "type": "email"
      }
    ],
    "threshold": 10000000
  },
  "monthlySpendingLimit": {
    "communicationChannels": [
      {
        "id": "0399abed-fd3d",
        "label": "Max.Pike@example.com",
        "type": "email"
      }
    ],
    "threshold": 10000000
  },
  "transactionOccurred": {
    "communicationChannels": [
      {
        "id": "0399abed-fd3d",
        "label": "Max.Pike@example.com",
        "type": "email"
      }
    ]
  },
  "transactionDeclined": {
    "communicationChannels": [
      {
        "id": "0399abed-fd3d",
        "label": "Max.Pike@example.com",
        "type": "email"
      }
    ]
  },
  "merchantCategories": {
    "communicationChannels": [
      {
        "id": "0399abed-fd3d",
        "label": "Max.Pike@example.com",
        "type": "email"
      }
    ],
    "categories": [
      "ageRestricted"
    ]
  },
  "transactionCategories": {
    "communicationChannels": [
      {
        "id": "0399abed-fd3d",
        "label": "Max.Pike@example.com",
        "type": "email"
      }
    ],
    "categories": [
      "atm"
    ]
  },
  "allowedRegions": {
    "communicationChannels": [
      {
        "id": "0399abed-fd3d",
        "label": "Max.Pike@example.com",
        "type": "email"
      }
    ],
    "regions": [
      {
        "id": "0399abed-fd3d",
        "name": "Disney World's Magic Kingdom",
        "type": "coordinates",
        "coordinates": {
          "latitude": 28.4188,
          "longitude": -81.5818,
          "radius": "5mi"
        }
      }
    ]
  }
}
  • (v3.0.0)*

Representation used to patch existing card alert subscriptions using the JSON Merge Patch format and processing rules. Only included fields are updated on the resource; fields which are omitted are not updated.

Changes to alert subscription configurations may result in no operations performed when triggered.

Properties

NameDescription
(v3.0.0) object
Representation used to patch existing card alert subscriptions using the JSON Merge Patch format and processing rules. Only included fields are updated on the resource; fields which are omitted are not updated.

Changes to alert subscription configurations may result in no operations performed when triggered.

transactionLimit monetaryThresholdAlertSubscription
Alert the account holder when any transaction exceeds this positive monetary amount in United States Dollars (USD).
monthlySpendingLimit monetaryThresholdAlertSubscription
Alert the account holder when the total of all debits in a monthly period on the account exceeds this positive monetary amount in United States Dollars (USD).
transactionOccurred simpleCardAlertSubscription
Alert the account holder when any transaction using this card occurs.
transactionDeclined requiredCommunicationChannelAlertSubscription
Alert the account holder when any transaction using this card is declined.

This alert requires at least one communication channel to be configured.

merchantCategories cardAlertSubscriptionMerchantCategories
Alert the account holder when a card transaction's merchant category matches any of these categories. An empty array for categories and communication channels means this alert is disabled.
transactionCategories cardAlertSubscriptionTransactionCategories
Alert the account holder when a transaction using this card has a category matching any of these categories. An empty array for categories and communication channels means this alert is disabled.
allowedRegions cardAlertSubscriptionAllowedRegionsPatch
Alert the account holder when a transaction using this card occurs outside the boundaries of all of these regions. An empty array for either regions and communicationChannels means this alert is disabled.

cardExpirationMonth

"st"

Card Expiration Month (v1.0.0)

The month portion of the card's MM/YY expiration in MM format.

type: string


minLength: 2
maxLength: 2
pattern: "^(0[1-9]|1[012])$"

cardExpirationYear

"st"

Card Expiration Year (v1.0.0)

The year portion of the year of the card's MM/YY expiration, in YY format (last two digits)

type: string


minLength: 2
maxLength: 2
pattern: "^\d{2}$"

cardLossType

"lost"

Card Loss Type (v1.0.0)

The loss type for the card.

cardLossType strings may have one of the following enumerated values:

ValueDescription
lostLost
stolenStolen
damagedDamaged

type: string


enum values: lost, stolen, damaged

cardMerchantCategories

"ageRestricted"

Card Merchant Categories (v1.1.0)

Categories of card merchants for alerts and transaction rules.

cardMerchantCategories strings may have one of the following enumerated values:

ValueDescription
ageRestrictedAge Restricted:

A merchant providing goods or services with age restrictions, such as gambling or liquor
ageRestricted.drinkingPlacesAge Restricted - Drinking Places:

A merchant that sells alcoholic beverages for consumption on the premises, such as bars, pubs, or clubs
ageRestricted.gamblingAge Restricted - Gambling:

A merchant offering games of chance or betting services, including casinos, lotteries, and sports betting
ageRestricted.liquorAndCigarStoresAge Restricted - Liquor and Cigar Stores:

A merchant that specializes in the sale of alcoholic beverages and tobacco products, including cigars
ageRestricted.datingAge Restricted - Dating:

A merchant offering services for personal matchmaking or dating platforms that require age verification
educationEducation:

A merchant that provides educational services or supplies, including schools, tutoring, and course materials
education.tuitionFeesEducation - Tuition Fees:

A merchant charging fees for educational instruction, including universities, colleges, and private schools
education.booksEducation - Books:

A merchant that sells textbooks or educational materials, including physical and digital formats
entertainmentEntertainment:

A merchant that provides entertainment services, such as an arcade or movie theater
entertainment.gamesEntertainment - Games:

A merchant that sells or provides access to video games, board games, or other interactive gaming experiences
entertainment.musicAndMoviesEntertainment - Music and Movies:

A merchant offering music, movies, or streaming services, either through physical media or digital platforms
entertainment.parksEntertainment - Parks:

A merchant providing access to amusement or theme parks, including rides, shows, and other attractions
entertainment.otherEntertainment - Other:

A merchant that offers other forms of entertainment not covered by the above categories, such as live events or virtual experiences
foodAndDiningFood and Dining:

A merchant that provides food or beverages, either prepared or for later consumption
foodAndDining.restaurantsFood and Dining - Restaurants:

A merchant that sells prepared foods
foodAndDining.groceriesFood and Dining - Groceries:

A merchant that sells pre-packaged or fresh food products
giftsAndDonationsGifts and Donations:

A merchant that facilitates the purchase of gifts or charitable donations
giftsAndDonations.giftsGifts and Donations - Gifts:

A merchant that sells items intended for gifting, such as flowers, greeting cards, or gift baskets
giftsAndDonations.donationsGifts and Donations - Donations:

A merchant that accepts contributions to charitable organizations or causes
householdHousehold:

A merchant that sells household goods, such as rugs or lamps
household.maintenanceOrRepairHousehold - Maintenance or Repair:

A merchant that provides services or goods related to the maintenance or repair of a home, such as plumbing or electrical work
household.decorationOrImprovementHousehold - Decoration or Improvement:

A merchant offering products or services for home decoration or improvement, including furniture, paint, or renovation services
household.housekeepingHousehold - Housekeeping:

A merchant that provides cleaning or housekeeping services, either for regular maintenance or special occasions
household.cableUtilitiesHousehold - Cable Utilities:

A merchant that provides cable television services or related equipment
household.communicationUtilitiesHousehold - Communication Utilities:

A merchant that offers telephone, internet, or other communication services
household.securityHousehold - Security:

A merchant providing home security systems, alarm monitoring, or surveillance equipment
household.chemicalUtilitiesHousehold - Chemical Utilities:

A merchant that offers chemical-based services or products for the home, such as pest control or pool maintenance
household.otherUtilitiesHousehold - Other Utilities:

A merchant offering other utilities services, such as electricity or water supply
household.rentalServicesHousehold - Rental Services:

A merchant that rents household items or equipment, such as tools, furniture, or party supplies
household.laundryHousehold - Laundry:

A merchant providing laundry or dry-cleaning services, including self-service laundromats
insuranceInsurance:

A merchant providing insurance services, including health, auto, home, or life insurance policies
personalCarePersonal Care:

A merchant that sells personal care items
personalCare.pharmacyPersonal Care - Pharmacy:

A merchant that sells prescription or over-the-counter medications, as well as health-related products
personalCare.beautyProductsPersonal Care - Beauty Products:

A merchant offering beauty or skincare products, including makeup, lotions, or hair care items
personalCare.doctorPersonal Care - Doctor:

A merchant providing medical services, such as general practitioners, specialists, or medical clinics
personalCare.sportsPersonal Care - Sports:

A merchant offering sports-related goods or services, such as fitness centers or sporting equipment
personalCare.wellnessPersonal Care - Wellness:

A merchant providing wellness services, such as spas, massage therapy, or alternative medicine
personalCare.childrenServicesPersonal Care - Children Services:

A merchant offering services specific to children, such as daycare, tutoring, or children's health care
shoppingShopping:

A merchant that sells consumer goods
shopping.clothingShopping - Clothing:

A merchant that sells apparel, including formal wear, casual wear, or specialty items such as uniforms or costumes
shopping.electronicsShopping - Electronics:

A merchant that sells electronic devices or accessories, including computers, smartphones, and audio equipment
shopping.accessoriesShopping - Accessories:

A merchant offering items to complement clothing or electronics, such as jewelry, bags, or cases
shopping.otherShopping - Other:

A merchant selling other consumer goods not categorized under clothing, electronics, or accessories
transportationTransportation:

A merchant providing services or goods for transportation, such as public transit, vehicle maintenance, or fuel
transportation.autoServicesTransportation - Auto Services:

A merchant providing services related to vehicle maintenance or repair, including oil changes, tire services, or auto body work
transportation.gasOrFuelTransportation - Gas or Fuel:

A merchant that sells gasoline for vehicles. The merchant may also sell convenience items, such as snacks or beverages
transportation.parkingTransportation - Parking:

A merchant providing parking services, including garages or metered parking facilities
transportation.tollTransportation - Toll:

A merchant that charges fees for access to certain roadways or bridges, typically via toll booths or automated systems
transportation.otherTransportation - Other:

A merchant providing other transportation-related services, such as ride-sharing, taxis, or bicycles
travelTravel:

A merchant providing transportation services, such as an airline
travel.autoRentalsTravel - Auto Rentals:

A merchant offering car rentals, including short-term or long-term vehicle hire
travel.airlineTravel - Airline:

A merchant providing air travel services, including passenger flights or cargo transport
travel.trainTravel - Train:

A merchant providing rail services for passenger or cargo transport, including trains or subways
travel.lodgingTravel - Lodging:

A merchant offering overnight accommodations, such as hotels, motels, or vacation rentals
travel.otherTravel - Other:

A merchant offering other travel-related services, such as cruises, tours, or travel agencies
otherOther:

A merchant not matching other defined categories
other.atmOther - ATM:

A merchant providing access to automated teller machines for cash withdrawals or banking services

type: string


enum values: ageRestricted, ageRestricted.drinkingPlaces, ageRestricted.gambling, ageRestricted.liquorAndCigarStores, ageRestricted.dating, education, education.tuitionFees, education.books, entertainment, entertainment.games, entertainment.musicAndMovies, entertainment.parks, entertainment.other, foodAndDining, foodAndDining.restaurants, foodAndDining.groceries, giftsAndDonations, giftsAndDonations.gifts, giftsAndDonations.donations, household, household.maintenanceOrRepair, household.decorationOrImprovement, household.housekeeping, household.cableUtilities, household.communicationUtilities, household.security, household.chemicalUtilities, household.otherUtilities, household.rentalServices, household.laundry, insurance, personalCare, personalCare.pharmacy, personalCare.beautyProducts, personalCare.doctor, personalCare.sports, personalCare.wellness, personalCare.childrenServices, shopping, shopping.clothing, shopping.electronics, shopping.accessories, shopping.other, transportation, transportation.autoServices, transportation.gasOrFuel, transportation.parking, transportation.toll, transportation.other, travel, travel.autoRentals, travel.airline, travel.train, travel.lodging, travel.other, other, other.atm

cardMonetaryThreshold

10000000
  • (v1.0.0)*

The monetary value, supporting only positive dollar amounts without decimal (cents) values.

type: integer(int32)


format: int32
minimum: 0
maximum: 10000000

cardOperationChallengeRequest

{
  "type": "unmaskCardProperties"
}

Card Operation Challenge Request (v1.0.0)

Properties to manually issue a challenge for card operations.

Properties

NameDescription
Card Operation Challenge Request (v1.0.0) object
Properties to manually issue a challenge for card operations.
type cardOperationChallengeType (required)

Types of operations available for card identity challenges.

cardOperationChallengeType strings may have one of the following enumerated values:

ValueDescription
unmaskCardPropertiesUnmask Card Properties:

A challenge for viewing the unmasked properties of a card
changePinChange PIN:

A challenge for a changing the PIN of a card
reportCardReport Card:

A challenge for reporting cards as lost, stolen or damaged
activateCardActivate Card:

A challenge for activating newly issued cards

enum values: unmaskCardProperties, changePin, reportCard, activateCard

cardOperationChallengeType

"unmaskCardProperties"

Card Operation Challenge Type (v1.1.0)

Types of operations available for card identity challenges.

cardOperationChallengeType strings may have one of the following enumerated values:

ValueDescription
unmaskCardPropertiesUnmask Card Properties:

A challenge for viewing the unmasked properties of a card
changePinChange PIN:

A challenge for a changing the PIN of a card
reportCardReport Card:

A challenge for reporting cards as lost, stolen or damaged
activateCardActivate Card:

A challenge for activating newly issued cards

type: string


enum values: unmaskCardProperties, changePin, reportCard, activateCard

cardPin

"stri"

Card Personal Identification Number (PIN) (v1.0.0)

A numeric value used to validate card usage in authorizing card transactions.

type: string


minLength: 4
maxLength: 4
pattern: "^\d{4}$"

cardPinChange

{
  "currentPin": "stri",
  "newPin": "stri"
}

Card PIN Change (v1.0.0)

Representation used to change a personal identification number (PIN) for a card.

Properties

NameDescription
Card PIN Change (v1.0.0) object
Representation used to change a personal identification number (PIN) for a card.
currentPin cardPin (required)
The current personal identification number (PIN) for the card.
minLength: 4
maxLength: 4
pattern: "^\\d{4}$"
newPin cardPin (required)
The requested new personal identification number (PIN) for a card. This must be different than the current PIN.
minLength: 4
maxLength: 4
pattern: "^\\d{4}$"

cardProviderContext

"account"

Card Provider Context (v1.0.0)

The context of the card provider, indicating which operations to use for listing cards, retrieving card details, and others.

cardProviderContext strings may have one of the following enumerated values:

ValueDescription
accountAccount:

The card provider operations use an account context
customerCustomer/Member:

The card provider operations use a customer or member context

type: string


enum values: account, customer

cardProviderOperation

{
  "enabled": true,
  "requiresIdentityChallenge": true
}

Card Provider Operation (v1.0.0)

Describes if and how a client may access various card-specific operations in this API.

Properties

NameDescription
Card Provider Operation (v1.0.0) object
Describes if and how a client may access various card-specific operations in this API.
enabled boolean (required)
When true, this operation is enabled for the card provider.
requiresIdentityChallenge boolean (required)
When true, this operation requires an identity challenge to be completed.

cardRegion

{
  "id": "0399abed-fd3d",
  "name": "Disney World's Magic Kingdom",
  "type": "coordinates",
  "coordinates": {
    "latitude": 28.4188,
    "longitude": -81.5818,
    "radius": "5mi"
  }
}

Card Region (v2.0.0)

Representation of a named card region resource.

Properties

NameDescription
Card Region (v2.0.0) object
Representation of a named card region resource.
name string(text) (required)
A name describing this geographic region.
format: text
minLength: 1
maxLength: 55
type cardRegionLocationType (required)

The type of the location for this card region.

cardRegionLocationType strings may have one of the following enumerated values:

ValueDescription
coordinatesCoordinates:

The card region is defined by geographical coordinates and radius
addressAddress:

The card region is defined by an address

enum values: coordinates, address
coordinates cardRegionCoordinateLocation
The geographic coordinates for a circular geographic region.

This is required when type is coordinates.
Unevaluated Properties: false

address cardRegionAddressLocation
The address, scoped to a locality, for a geographic region.

This is required when type is address.
Unevaluated Properties: false

id externalResourceId(text) (required)
The unique identifier for this region resource. This is an immutable opaque string.
read-only
format: text
minLength: 1
maxLength: 256

cardRegionAddressLocation

{
  "locality": "Wilmington",
  "countryCode": "US",
  "postalCode": "20521"
}

Card Region Address Location (v1.0.0)

The address for a geographic region, scoped to a specific locality.

Properties

NameDescription
Card Region Address Location (v1.0.0) object
The address for a geographic region, scoped to a specific locality.
Unevaluated Properties: false
locality string(text) (required)
The name of the city, town, or municipality.
format: text
maxLength: 30
countryCode countryCode
The ISO-3611 alpha-2 value for a country.
minLength: 2
maxLength: 2
pattern: "^[A-Za-z]{2}$"
postalCode postalCode (required)
The 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.
minLength: 2
maxLength: 20
pattern: "[0-9A-Za-z][- 0-9A-Za-z]{0,18}[0-9A-Za-z]"

cardRegionCoordinateLocation

{
  "latitude": -90,
  "longitude": -180,
  "radius": "string"
}

Card Region Coordinate Location (v1.0.0)

The coordinates and radius for a circular geographic region.

The latitude and longitude map coordinates define the center of the circular region and the radius defines the circle's radius.

Properties

NameDescription
Card Region Coordinate Location (v1.0.0) object
The coordinates and radius for a circular geographic region.

The latitude and longitude map coordinates define the center of the circular region and the radius defines the circle's radius.
Unevaluated Properties: false

latitude latitude
The north-south angular distance of a point on Earth's surface, as measured from the equator. Distances to the north are expressed as positive numbers. Distances to the south are expressed as negative numbers.
minimum: -90
maximum: 90
longitude longitude
The east-west angular distance of a point on Earth's surface, as measured from the Prime Meridian (passing through Greenwich, England). Distances to the east are expressed as positive numbers. Distances to the west are expressed as negative numbers.
minimum: -180
maximum: 180
radius string
The radius for this circular geographic card region. The unit of measurement may be included following the distance value. Use mi for miles and km for kilometers. When a unit of measurement is not included, the default unit is miles. For example: 5mi (5 miles) or 4km (4 km) or 4.25 (4.25 miles) Up to two decimal places of precision are supported. The minimum radius is 5mi or 8km; the maximum radius is 500mi or 805km.
minLength: 1
maxLength: 6
pattern: "^\\d{1}(\\.\\d{1,2})?(mi|km)?$"

cardRegionItem

{
  "id": "0399abed-fd3d",
  "name": "Disney World's Magic Kingdom",
  "type": "coordinates",
  "coordinates": {
    "latitude": 28.4188,
    "longitude": -81.5818,
    "radius": "5mi"
  }
}

Card Region Item (v2.0.0)

Summary representation of a named card region resource in card regions collection.

Properties

NameDescription
Card Region Item (v2.0.0) object
Summary representation of a named card region resource in card regions collection.
name string(text) (required)
A name describing this geographic region.
format: text
minLength: 1
maxLength: 55
type cardRegionLocationType (required)

The type of the location for this card region.

cardRegionLocationType strings may have one of the following enumerated values:

ValueDescription
coordinatesCoordinates:

The card region is defined by geographical coordinates and radius
addressAddress:

The card region is defined by an address

enum values: coordinates, address
coordinates cardRegionCoordinateLocation
The geographic coordinates for a circular geographic region.

This is required when type is coordinates.
Unevaluated Properties: false

address cardRegionAddressLocation
The address, scoped to a locality, for a geographic region.

This is required when type is address.
Unevaluated Properties: false

id externalResourceId(text) (required)
The unique identifier for this card region resource. This is an immutable opaque string.
read-only
format: text
minLength: 1
maxLength: 256

cardRegionLocationType

"coordinates"

Card Region Location Type (v1.0.0)

The type of the location for this card region.

cardRegionLocationType strings may have one of the following enumerated values:

ValueDescription
coordinatesCoordinates:

The card region is defined by geographical coordinates and radius
addressAddress:

The card region is defined by an address

type: string


enum values: coordinates, address

cardRegionPatch

{
  "name": "Disney World's Magic Kingdom Park"
}

Card Region Patch (v2.0.0)

Representation used to patch a named card region resource.

Properties

NameDescription
Card Region Patch (v2.0.0) object
Representation used to patch a named card region resource.
name string(text)
A name describing this geographic region.
format: text
minLength: 1
maxLength: 55
type cardRegionLocationType

The type of the location for this card region.

cardRegionLocationType strings may have one of the following enumerated values:

ValueDescription
coordinatesCoordinates:

The card region is defined by geographical coordinates and radius
addressAddress:

The card region is defined by an address

enum values: coordinates, address
coordinates cardRegionCoordinateLocation
The geographic coordinates for a circular geographic region.

This is required when type is coordinates.
Unevaluated Properties: false

address cardRegionAddressLocation
The address, scoped to a locality, for a geographic region.

This is required when type is address.
Unevaluated Properties: false

cardRegionReference

{
  "id": "0399abed-fd3d",
  "name": "Disney World's Magic Kingdom",
  "type": "coordinates",
  "coordinates": {
    "latitude": 28.4188,
    "longitude": -81.5818,
    "radius": "5mi"
  }
}

Card Region Reference (v2.0.0)

Reference representation of a region resource.

Properties

NameDescription
Card Region Reference (v2.0.0) object
Reference representation of a region resource.
name string(text) (required)
A name describing this geographic region.
format: text
minLength: 1
maxLength: 55
type cardRegionLocationType (required)

The type of the location for this card region.

cardRegionLocationType strings may have one of the following enumerated values:

ValueDescription
coordinatesCoordinates:

The card region is defined by geographical coordinates and radius
addressAddress:

The card region is defined by an address

enum values: coordinates, address
coordinates cardRegionCoordinateLocation
The geographic coordinates for a circular geographic region.

This is required when type is coordinates.
Unevaluated Properties: false

address cardRegionAddressLocation
The address, scoped to a locality, for a geographic region.

This is required when type is address.
Unevaluated Properties: false

id externalResourceId(text) (required)
The unique identifier for this region resource. This is an immutable opaque string.
read-only
format: text
minLength: 1
maxLength: 256

cardRegions

{
  "items": [
    {
      "id": "0399abed-fd3d",
      "name": "Disney World's Magic Kingdom",
      "type": "coordinates",
      "coordinates": {
        "latitude": 28.4188,
        "longitude": -81.5818,
        "radius": "5mi"
      }
    },
    {
      "id": "d62c0701-0d74-4836-83f9-ebf3709442ea",
      "name": "Washington D.C.",
      "type": "coordinates",
      "coordinates": {
        "latitude": 38.8875,
        "longitude": -77.0364,
        "radius": "3mi"
      }
    }
  ]
}

Card Region Collection (v2.0.0)

Collection of card regions. The items in the collection are ordered in the items array.

Properties

NameDescription
Card Region Collection (v2.0.0) object
Collection of card regions. The items in the collection are ordered in the items array.
items array: [cardRegionItem] (required)
An array containing a page of card region items.
maxItems: 100
items: object

cardReportedRequest

{
  "type": "lost",
  "primaryCardholderDateOfBirth": "2021-10-30",
  "dateLost": "2021-10-30",
  "lastUsedDate": "2021-10-30",
  "alternativeShippingMethod": "primaryMethod",
  "temporaryMailingAddress": {
    "address1": "1805 Tiburon Dr.",
    "address2": "Building 14, Suite 1500",
    "locality": "Wilmington",
    "regionCode": "NC",
    "countryCode": "US",
    "postalCode": "28403"
  },
  "pinCompromised": true,
  "additionalInformation": [
    "string"
  ]
}

Card Reported Request (v2.0.0)

Request body for reporting a card as lost, stolen, or damaged.

Properties

NameDescription
Card Reported Request (v2.0.0) object
Request body for reporting a card as lost, stolen, or damaged.
type cardLossType (required)
The reason the card is being reported.
enum values: lost, stolen, damaged
primaryCardholderDateOfBirth date(date)
The date of birth of the primary cardholder for this credit card account formatted in YYYY-MM-DD RFC 3339 date UTC format.
format: date
minLength: 10
maxLength: 10
dateLost date(date) (required)
The date that any of the cards in this credit card account were discovered as lost, formatted in YYYY-MM-DD RFC 3339 date UTC format.
format: date
minLength: 10
maxLength: 10
lastUsedDate date(date)
The last known date that any of the cards in this credit card account were used for a valid transaction, formatted in YYYY-MM-DD RFC 3339 date UTC format.
format: date
minLength: 10
maxLength: 10
alternativeShippingMethod cardShippingMethod
An alternative shipping method for delivering the replacement cards. Submitted card replacement requests are not affected by changes made by the financial institution to the available shipping methods.

If excluded, the replacement cards are delivered using standard mail.
enum values: primaryMethod, secondaryMethod

temporaryMailingAddress address
A temporary mailing address to deliver the replacement cards.

If excluded, the replacement cards are sent to the customer or member's default mailing address.

pinCompromised boolean (required)
If true, the personal identification number (PIN) for the card needs to be changed.
additionalInformation array: [string]
Additional information to be shared with the financial institution about this card replacement request.
unique items
minItems: 0
maxItems: 3
items: string(text)
» format: text
» maxLength: 75

cardSecurityCode

"stri"

Card Security Code (v1.0.0)

The Card Validation Code (CVC) or Card Validation Value (CVV) on a credit or debit card.

type: string


minLength: 3
maxLength: 4
pattern: "^\d{3,4}$"

cardShippingMethod

"primaryMethod"

Card Shipping Method (v1.0.0)

Shipping method options determined by the financial institution.

cardShippingMethod strings may have one of the following enumerated values:

ValueDescription
primaryMethodPrimary Method:

The primary shipping method from the financial institution
secondaryMethodSecondary Method:

The secondary shipping method from the financial institution

type: string


enum values: primaryMethod, secondaryMethod

cardTransactionCategories

"atm"

Card Transaction Categories (v1.0.0)

Categories of card transactions for alerts and transaction rules.

cardTransactionCategories strings may have one of the following enumerated values:

ValueDescription
atmAutomatic Teller Machine (ATM):

A withdrawal transaction from an ATM
autopayAutopay:

A transaction that occurred from an automated payment
transferTransfer:

A transaction that occurred from a money movement to another account
physicalMerchantPhysical Merchant:

A transaction that occurred at a merchant in a physical location
mailMerchantMail Merchant:

A transaction that occurred through a mail based retailer
phoneMerchantPhone Merchant:

A transaction that occurred through a phone based retailer
onlineMerchantOnline Merchant:

A transaction that occurred through an online retailer
otherOther:

A transaction not matching other categories

type: string


enum values: atm, autopay, transfer, physicalMerchant, mailMerchant, phoneMerchant, onlineMerchant, other

cardTransactionDirection

"debit"

Card Transaction Direction (v1.0.0)

Distinguishes the direction of a card transaction.

cardTransactionDirection strings may have one of the following enumerated values:

ValueDescription
debitDebit:

A debit against the account
creditCredit:

A credit transaction for the account

type: string


enum values: debit, credit

cardTransactionItem

{
  "occurredOn": "2024-01-16",
  "description": "**MACYS1234",
  "amount": "-52.05",
  "direction": "debit"
}

Card Transaction Item (v1.0.0)

Representation of a transaction resource in the card transactions collection.

Properties

NameDescription
Card Transaction Item (v1.0.0) object
Representation of a transaction resource in the card transactions collection.
occurredOn date(date) (required)
The date of the transaction in YYYY-MM-DD RFC 3339 date format. This is derived and immutable.
format: date
minLength: 10
maxLength: 10
description string(text) (required)
The transaction description assigned by the card provider.
format: text
maxLength: 128
amount creditOrDebitValue(decimal) (required)
The monetary value of this card transaction. This is immutable.
format: decimal
maxLength: 16
pattern: "^(-|\\+)?(0|[1-9][0-9]*)\\.[0-9][0-9]$"
direction cardTransactionDirection (required)
The direction of the transaction. This is derived and immutable.
enum values: debit, credit

cardTransactionRules

{
  "transactionLimit": 10000000,
  "monthlySpendingLimit": 10000000,
  "allowInternationalTransactions": true,
  "merchantCategories": [
    "ageRestricted"
  ],
  "transactionCategories": [
    "atm"
  ],
  "authorizedRegions": [
    {
      "id": "0399abed-fd3d",
      "name": "Disney World's Magic Kingdom",
      "type": "coordinates",
      "coordinates": {
        "latitude": 28.4188,
        "longitude": -81.5818,
        "radius": "5mi"
      }
    }
  ]
}

Card Transaction Rules (v5.0.0)

Representation of thresholds or values to have card transactions automatically declined.

Properties

NameDescription
Card Transaction Rules (v5.0.0) object
Representation of thresholds or values to have card transactions automatically declined.
transactionLimit cardMonetaryThreshold(int32) (required)
Decline transactions attempted using this card exceeding this positive monetary amount in United States Dollars (USD).
format: int32
minimum: 0
maximum: 10000000
monthlySpendingLimit cardMonetaryThreshold(int32) (required)
Decline transactions attempted using this card when the monthly spending on the account exceeds this positive monetary amount in United States Dollars (USD).
format: int32
minimum: 0
maximum: 10000000
allowInternationalTransactions boolean (required)
If false, transactions attempts using this card outside of the account's origin country are denied.
merchantCategories array: [cardMerchantCategories] (required)
Decline transactions attempted using this card when the merchant category matches any of these merchant categories. An empty array means there are no merchant category restrictions for transaction authorization.
unique items
minItems: 0
maxItems: 12
items: string
» enum values: ageRestricted, ageRestricted.drinkingPlaces, ageRestricted.gambling, ageRestricted.liquorAndCigarStores, ageRestricted.dating, education, education.tuitionFees, education.books, entertainment, entertainment.games, entertainment.musicAndMovies, entertainment.parks, entertainment.other, foodAndDining, foodAndDining.restaurants, foodAndDining.groceries, giftsAndDonations, giftsAndDonations.gifts, giftsAndDonations.donations, household, household.maintenanceOrRepair, household.decorationOrImprovement, household.housekeeping, household.cableUtilities, household.communicationUtilities, household.security, household.chemicalUtilities, household.otherUtilities, household.rentalServices, household.laundry, insurance, personalCare, personalCare.pharmacy, personalCare.beautyProducts, personalCare.doctor, personalCare.sports, personalCare.wellness, personalCare.childrenServices, shopping, shopping.clothing, shopping.electronics, shopping.accessories, shopping.other, transportation, transportation.autoServices, transportation.gasOrFuel, transportation.parking, transportation.toll, transportation.other, travel, travel.autoRentals, travel.airline, travel.train, travel.lodging, travel.other, other, other.atm
transactionCategories array: [cardTransactionCategories] (required)
Decline transactions attempted using this card whose categories match any of these categories. An empty array means there are no transaction category restrictions for transaction authorization.
unique items
minItems: 0
maxItems: 8
items: string
» enum values: atm, autopay, transfer, physicalMerchant, mailMerchant, phoneMerchant, onlineMerchant, other
authorizedRegions array: [cardRegionItem] (required)
Decline any transactions attempted by this card that do not originate in the defined authorized regions. An empty array means there are no region restrictions for transaction authorization.
unique items
minItems: 0
maxItems: 3
items: object

cardTransactionRulesPatch

{
  "transactionLimit": 10000000,
  "monthlySpendingLimit": 10000000,
  "allowInternationalTransactions": true,
  "merchantCategories": [
    "ageRestricted"
  ],
  "transactionCategories": [
    "atm"
  ],
  "authorizedRegions": [
    {
      "id": "0399abed-fd3d",
      "name": "Disney World's Magic Kingdom",
      "type": "coordinates",
      "coordinates": {
        "latitude": 28.4188,
        "longitude": -81.5818,
        "radius": "5mi"
      }
    }
  ]
}

Card Transaction Rules Patch (v5.0.0)

Representation used to patch existing card transaction rules using the JSON Merge Patch format and processing rules. Only included fields are updated on the resource; fields which are omitted are not updated.

Changes to card transaction rule configurations may result in no operations performed when triggered.

Properties

NameDescription
Card Transaction Rules Patch (v5.0.0) object
Representation used to patch existing card transaction rules using the JSON Merge Patch format and processing rules. Only included fields are updated on the resource; fields which are omitted are not updated.

Changes to card transaction rule configurations may result in no operations performed when triggered.

transactionLimit cardMonetaryThreshold(int32)
Decline transactions attempted using this card exceeding this positive monetary amount in United States Dollars (USD).
format: int32
minimum: 0
maximum: 10000000
monthlySpendingLimit cardMonetaryThreshold(int32)
Decline transactions attempted using this card when the monthly spending on the account exceeds this positive monetary amount in United States Dollars (USD).
format: int32
minimum: 0
maximum: 10000000
allowInternationalTransactions boolean
If false, transactions attempts using this card outside of the account's origin country are denied.
merchantCategories array: [cardMerchantCategories]
Decline transactions attempted using this card when the merchant category matches any of these merchant categories. An empty array means there are no merchant category restrictions for transaction authorization.
unique items
minItems: 0
maxItems: 12
items: string
» enum values: ageRestricted, ageRestricted.drinkingPlaces, ageRestricted.gambling, ageRestricted.liquorAndCigarStores, ageRestricted.dating, education, education.tuitionFees, education.books, entertainment, entertainment.games, entertainment.musicAndMovies, entertainment.parks, entertainment.other, foodAndDining, foodAndDining.restaurants, foodAndDining.groceries, giftsAndDonations, giftsAndDonations.gifts, giftsAndDonations.donations, household, household.maintenanceOrRepair, household.decorationOrImprovement, household.housekeeping, household.cableUtilities, household.communicationUtilities, household.security, household.chemicalUtilities, household.otherUtilities, household.rentalServices, household.laundry, insurance, personalCare, personalCare.pharmacy, personalCare.beautyProducts, personalCare.doctor, personalCare.sports, personalCare.wellness, personalCare.childrenServices, shopping, shopping.clothing, shopping.electronics, shopping.accessories, shopping.other, transportation, transportation.autoServices, transportation.gasOrFuel, transportation.parking, transportation.toll, transportation.other, travel, travel.autoRentals, travel.airline, travel.train, travel.lodging, travel.other, other, other.atm
transactionCategories array: [cardTransactionCategories]
Decline transactions attempted using this card whose categories match any of these categories. An empty array means there are no transaction category restrictions for transaction authorization.
unique items
minItems: 0
maxItems: 8
items: string
» enum values: atm, autopay, transfer, physicalMerchant, mailMerchant, phoneMerchant, onlineMerchant, other
authorizedRegions array: [cardRegionReference]
Decline any transactions attempted by this card that do not originate in the defined authorized regions. An empty array means there are no region restrictions for transaction authorization.
unique items
minItems: 0
maxItems: 3
items: object

cardType

"physical"

Card Type (v1.0.0)

Indicates whether the card is a physical or digitally issued card.

cardType strings may have one of the following enumerated values:

ValueDescription
physicalPhysical:

A physically issued card
digitalDigital:

A card that is only digitally issued

type: string


enum values: physical, digital

cardholder

{
  "name": "Phil Duciary",
  "type": "primary",
  "address": {
    "address1": "1805 Tiburon Dr.",
    "locality": "Wilmington",
    "regionCode": "NC",
    "countryCode": "US",
    "postalCode": "28403"
  }
}

Cardholder (v1.1.0)

Information about the cardholder of an issued credit or debit card.

Properties

NameDescription
Cardholder (v1.1.0) object
Information about the cardholder of an issued credit or debit card.
name string(text) (required)
The name of the credit or debit card cardholder.
format: text
minLength: 3
maxLength: 55
type cardholderType

The type of cardholder for this credit or debit card. For debit cards, this is always primary.

cardholderType strings may have one of the following enumerated values:

ValueDescription
primaryPrimary:

The primary cardholder for this card account
secondarySecondary:

An additional authorized cardholder for this card account

enum values: primary, secondary
address address
A postal address that can hold a US address or an international (non-US) postal addresses.

cardholderSummary

{
  "name": "Phil Duciary",
  "type": "primary"
}

Cardholder Summary (v1.0.0)

Summary information about the cardholder of an issued credit or debit card.

Properties

NameDescription
Cardholder Summary (v1.0.0) object
Summary information about the cardholder of an issued credit or debit card.
name string(text) (required)
The name of the credit or debit card cardholder.
format: text
minLength: 3
maxLength: 55
type cardholderType

The type of cardholder for this credit or debit card. For debit cards, this is always primary.

cardholderType strings may have one of the following enumerated values:

ValueDescription
primaryPrimary:

The primary cardholder for this card account
secondarySecondary:

An additional authorized cardholder for this card account

enum values: primary, secondary

cardholderType

"primary"

Cardholder Type (v1.0.0)

The type of cardholder for this credit or debit card. For debit cards, this is always primary.

cardholderType strings may have one of the following enumerated values:

ValueDescription
primaryPrimary:

The primary cardholder for this card account
secondarySecondary:

An additional authorized cardholder for this card account

type: string


enum values: primary, secondary

challengeFactor

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

Challenge Factor (v1.2.1)

A challenge factor. See requiredIdentityChallenge for multiple examples.

Properties

NameDescription
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:

ValueDescription
smsSMS:

One-time passcode sent to the primary mobile phone number
emailEmail:

One-time passcode sent to the primary email address
voiceVoice:

One-time passcode communicated via automated voice phone call
authenticatorTokenauthenticator Token:

One-time passcode issued by a pre-registered hardware device, such as a token key fob, or an authenticator app
securityQuestionsSecurity 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:

ValueDescription
smsSMS:

One-time passcode sent to the primary mobile phone number
emailEmail:

One-time passcode sent to the primary email address
voiceVoice:

One-time passcode communicated via automated voice phone call
authenticatorTokenauthenticator Token:

One-time passcode issued by a pre-registered hardware device, such as a token key fob, or an authenticator app
securityQuestionsSecurity 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

NameDescription
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

NameDescription
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

challengeToken

"string"

Challenge Token (v1.1.0)

The value of the identity Challenge request header that the client must send when retrying an operation which required a challenge.

type: string


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

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

creditOrDebitValue

"3456.78"

Credit Or Debit Value (v1.1.1)

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

type: string(decimal)


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

customerCommunicationChannel

{
  "id": "0399abed-fd3d",
  "label": "Max.Pike@example.com",
  "type": "email"
}

Customer Communication Channel (v1.0.0)

A customer's communication channel.

Properties

NameDescription
Customer Communication Channel (v1.0.0) object
A customer's communication channel.
id readOnlyResourceId (required)
The identifier of this communication channel. This is derived and immutable.
read-only
minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
label string(text) (required)
A text representation of the communication channel.
format: text
minLength: 5
maxLength: 55
type customerCommunicationFactorType (required)
The classification of this customer communication channel.
enum values: email, sms, device

customerCommunicationFactorType

"email"

Customer Communication Factor Type (v1.0.0)

Identifier of the type of a communication channel.

customerCommunicationFactorType strings may have one of the following enumerated values:

ValueDescription
emailEmail:

Communication delivered by email
smsSMS:

Communication delivered by SMS
deviceDevice:

Communication delivered by a in-app notification on a device

type: string


enum values: email, sms, device

customerUsername

"string"

Customer Username (v2.0.0)

A customer's login username.

type: string(text)


format: text
minLength: 5
maxLength: 20

date

"2021-10-30"

Date (v1.0.0)

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

type: string(date)


format: date
minLength: 10
maxLength: 10

debitCard

{
  "id": "0399abed-fd3d",
  "type": "physical",
  "state": "active",
  "issuerIdentificationNumber": "4242",
  "displayName": "PHIL DUCIARY",
  "cardholder": {
    "name": "Phil Duciary",
    "type": "primary",
    "address": {
      "address1": "1805 Tiburon Dr.",
      "locality": "Wilmington",
      "regionCode": "NC",
      "countryCode": "US",
      "postalCode": "28403"
    }
  },
  "maskedAccountNumber": "*1000",
  "expirationMonth": "12",
  "expirationYear": "29",
  "allows": {
    "activate": false,
    "viewTransactions": true,
    "viewUnmaskedSecurityCode": true,
    "reportLost": true,
    "reportFound": false,
    "reportStolen": true,
    "reportDamaged": true,
    "lock": true,
    "unlock": false,
    "changePin": true,
    "manageTravelNotifications": true
  }
}

Debit Card (v7.0.0)

Representation of a debit card resource.

Properties

NameDescription
Debit Card (v7.0.0) object
Representation of a debit card resource.
id externalResourceId(text) (required)
The unique identifier for this debit card resource. This is an immutable opaque string.
read-only
format: text
minLength: 1
maxLength: 256
type cardType (required)

Indicates whether the card is a physical or digitally issued card.

cardType strings may have one of the following enumerated values:

ValueDescription
physicalPhysical:

A physically issued card
digitalDigital:

A card that is only digitally issued

enum values: physical, digital
state debitCardState (required)

The state of the debit card issued for the debit card account.

debitCardState strings may have one of the following enumerated values:

ValueDescription
activeActive:

The debit card is active
inactiveInactive:

The debit card is inactive
lockedLocked:

The debit card is locked and unable to be used for transactions
disabledDisabled:

The debit card is disabled and unable to be used for transactions. Contact the issuing financial institution for additional information.

enum values: active, inactive, locked, disabled
issuerIdentificationNumber issuerIdentificationNumber
The issuer identification number (IIN) or bank identification number (BIN) of the card.
minLength: 4
maxLength: 8
pattern: "^\\d{4,8}$"
displayName string(text) (required)
The name printed on a physical card, or associated with a digitally issued card.
format: text
minLength: 3
maxLength: 50
lockedBy userAccountReference
If state is locked, the customer or member who initiated the lock on this debit card.
lockedAt timestamp(date-time)
If state is locked, the date-time when this debit card was locked, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. This is derived and immutable.
format: date-time
minLength: 20
maxLength: 30
maskedAccountNumber maskedCardPersonalAccountNumber (required)
A masked card personal account number: an asterisk * followed by the last four digits of the full Personal Account Number (PAN).
minLength: 5
maxLength: 5
pattern: "^\\*\\d{4}$"
allows debitCardAllows (required)
Flags which indicate the permissions the current authorized user has on this debit card resource.
securityCode cardSecurityCode
The card's security code. This property is only present if the request includes securityCode in the list of requested unmasked values and if allows.viewUnmaskedSecurityCode is true.
minLength: 3
maxLength: 4
pattern: "^\\d{3,4}$"
fullAccountNumber fullCardPersonalAccountNumber
The account's full account number. This property is only present if the request includes ?unmasked= with cardNumber included.
minLength: 14
maxLength: 19
pattern: "^\\d{1}[0-9 ]{12,17}\\d{1}$"
expirationMonth cardExpirationMonth
The month portion of the card's MM/YY expiration in MM format.
minLength: 2
maxLength: 2
pattern: "^(0[1-9]|1[012])$"
expirationYear cardExpirationYear
The year portion of the year of the card's MM/YY expiration, in YY format (last two digits)
minLength: 2
maxLength: 2
pattern: "^\\d{2}$"
cardholder cardholder (required)
Information about the cardholder of an issued credit or debit card.
pinExpirationDate date(date)
If included, the date that the current Personal Identification Number (PIN) expires for this debit card.
format: date
minLength: 10
maxLength: 10

debitCardActivationRequest

{
  "cardNumber": "4242424242424242",
  "expirationMonth": "03",
  "expirationYear": "28",
  "securityCode": "311"
}

Debit Card Activation Request (v1.0.0)

Representation used to activate a debit card.

Properties

NameDescription
Debit Card Activation Request (v1.0.0) object
Representation used to activate a debit card.
cardNumber fullCardPersonalAccountNumber (required)
The full account number of the debit card being activated.
minLength: 14
maxLength: 19
pattern: "^\\d{1}[0-9 ]{12,17}\\d{1}$"
expirationMonth cardExpirationMonth (required)
The month the card expires at the end of, in MM format.
minLength: 2
maxLength: 2
pattern: "^(0[1-9]|1[012])$"
expirationYear cardExpirationYear (required)
The last two digits of the year the card expires at the end of.
minLength: 2
maxLength: 2
pattern: "^\\d{2}$"
securityCode cardSecurityCode (required)
The security code associated with the debit card being activated. This is the Card Validation Code (CVC) or Card Validation Value (CVV) on the physical card.
minLength: 3
maxLength: 4
pattern: "^\\d{3,4}$"

debitCardAllows

{
  "activate": true,
  "viewTransactions": true,
  "viewUnmaskedSecurityCode": true,
  "reportLost": true,
  "reportFound": true,
  "reportStolen": null,
  "reportDamaged": true,
  "lock": true,
  "unlock": true,
  "changePin": true,
  "manageTravelNotifications": true
}

Debit Card Allows (v3.1.0)

Flags which indicate the permissions the current authorized user has on this debit card resource.

Properties

NameDescription
Debit Card Allows (v3.1.0) object
Flags which indicate the permissions the current authorized user has on this debit card resource.
activate boolean (required)
If true, the currently authenticated user is authorized to activate the debit card and the card's state allows activation.

Debit cards may be activated when their state is inactive or disabled.

viewTransactions boolean (required)
If true, the currently authenticated user is authorized to view debit card transactions.
viewUnmaskedSecurityCode boolean (required)
If true, the currently authenticated user is authorized to view the unmasked security code for the debit card.
reportLost boolean (required)
If true, the currently authenticated user is authorized to report the card as lost for replacement.
reportFound boolean (required)
If true, the currently authenticated user is authorized to report a lost card as found, canceling replacement.
reportStolen any (required)
If true, the currently authenticated user is authorized to report the card as stolen for replacement.
reportDamaged boolean (required)
If true, the currently authenticated user is authorized to report the card as damaged for reissuing.
lock boolean (required)
If true, the currently authenticated user is authorized to lock the debit card and the card's state allows locking.
unlock boolean (required)
If true, the currently authenticated user is authorized to unlock the debit card and the card's state allows unlocking.
changePin boolean (required)
If true, the currently authenticated user is authorized to change the debit card PIN.
manageTravelNotifications boolean (required)
If true, the currently authenticated user is authorized to manage travel notifications for this debit card resource.

debitCardItem

{
  "id": "0399abed-fd3d",
  "type": "physical",
  "state": "active",
  "issuerIdentificationNumber": "4242",
  "displayName": "PHIL DUCIARY",
  "cardholder": {
    "name": "Phil Duciary"
  },
  "maskedAccountNumber": "*1000",
  "allows": {
    "activate": false,
    "viewTransactions": true,
    "viewUnmaskedSecurityCode": true,
    "reportLost": true,
    "reportFound": false,
    "reportStolen": true,
    "reportDamaged": true,
    "lock": true,
    "unlock": false,
    "changePin": true,
    "manageTravelNotifications": true
  }
}

Debit Card Summary Item (v5.2.0)

Summary representation of a debit card resource.

Properties

NameDescription
Debit Card Summary Item (v5.2.0) object
Summary representation of a debit card resource.
id externalResourceId(text) (required)
The unique identifier for this debit card resource. This is an immutable opaque string.
read-only
format: text
minLength: 1
maxLength: 256
type cardType (required)

Indicates whether the card is a physical or digitally issued card.

cardType strings may have one of the following enumerated values:

ValueDescription
physicalPhysical:

A physically issued card
digitalDigital:

A card that is only digitally issued

enum values: physical, digital
state debitCardState (required)

The state of the debit card issued for the debit card account.

debitCardState strings may have one of the following enumerated values:

ValueDescription
activeActive:

The debit card is active
inactiveInactive:

The debit card is inactive
lockedLocked:

The debit card is locked and unable to be used for transactions
disabledDisabled:

The debit card is disabled and unable to be used for transactions. Contact the issuing financial institution for additional information.

enum values: active, inactive, locked, disabled
issuerIdentificationNumber issuerIdentificationNumber
The issuer identification number (IIN) or bank identification number (BIN) of the card.
minLength: 4
maxLength: 8
pattern: "^\\d{4,8}$"
displayName string(text) (required)
The name printed on a physical card, or associated with a digitally issued card.
format: text
minLength: 3
maxLength: 50
lockedBy userAccountReference
If state is locked, the customer or member who initiated the lock on this debit card.
lockedAt timestamp(date-time)
If state is locked, the date-time when this debit card was locked, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. This is derived and immutable.
format: date-time
minLength: 20
maxLength: 30
maskedAccountNumber maskedCardPersonalAccountNumber (required)
A masked card personal account number: an asterisk * followed by the last four digits of the full Personal Account Number (PAN).
minLength: 5
maxLength: 5
pattern: "^\\*\\d{4}$"
allows debitCardAllows (required)
Flags which indicate the permissions the current authorized user has on this debit card resource.
cardholder cardholderSummary (required)
Properties describing the cardholder.

debitCardMaskedProperties

"fullAccountNumber"

Debit Card Masked Properties (v1.0.0)

Debit card properties that are masked by default. The unmasked values of the properties can be requested using the ?unmasked= query parameter. Such requests are auditable.

debitCardMaskedProperties strings may have one of the following enumerated values:

ValueDescription
fullAccountNumberFull Account Number:

The full Personal Account Number (PAN) of a debit card
securityCodeSecurity Code:

The security code of a debit card

type: string


enum values: fullAccountNumber, securityCode

debitCardOperations

{
  "listCustomerDebitCards": {
    "enabled": true,
    "requiresIdentityChallenge": true
  },
  "getCustomerDebitCard": {
    "enabled": true,
    "requiresIdentityChallenge": true
  },
  "getCustomerDebitCardUnmaskedProperties": {
    "enabled": true,
    "requiresIdentityChallenge": true
  },
  "lockCustomerDebitCard": {
    "enabled": true,
    "requiresIdentityChallenge": true
  },
  "unlockCustomerDebitCard": {
    "enabled": true,
    "requiresIdentityChallenge": true
  },
  "createCustomerDebitCardChallenge": {
    "enabled": true,
    "requiresIdentityChallenge": true
  },
  "listDebitCards": {
    "enabled": true,
    "requiresIdentityChallenge": true
  },
  "getDebitCard": {
    "enabled": true,
    "requiresIdentityChallenge": true
  },
  "getDebitCardUnmaskedProperties": {
    "enabled": true,
    "requiresIdentityChallenge": true
  },
  "createDebitCardChallenge": {
    "enabled": true,
    "requiresIdentityChallenge": true
  },
  "changeDebitCardPin": {
    "enabled": true,
    "requiresIdentityChallenge": true
  },
  "listDebitCardTransactions": {
    "enabled": true,
    "requiresIdentityChallenge": true
  },
  "getDebitCardTransactionRules": {
    "enabled": true,
    "requiresIdentityChallenge": true
  },
  "patchDebitCardTransactionRules": {
    "enabled": true,
    "requiresIdentityChallenge": true
  },
  "getDebitCardAlerts": {
    "enabled": true,
    "requiresIdentityChallenge": true
  },
  "patchDebitCardAlertSubscriptions": {
    "enabled": true,
    "requiresIdentityChallenge": true
  },
  "activateDebitCard": {
    "enabled": true,
    "requiresIdentityChallenge": true
  },
  "reportDebitCard": {
    "enabled": true,
    "requiresIdentityChallenge": true
  },
  "lockDebitCard": {
    "enabled": true,
    "requiresIdentityChallenge": true
  },
  "unlockDebitCard": {
    "enabled": true,
    "requiresIdentityChallenge": true
  },
  "listDebitCardTravelNotifications": {
    "enabled": true,
    "requiresIdentityChallenge": true
  },
  "createDebitCardTravelNotification": {
    "enabled": true,
    "requiresIdentityChallenge": true
  },
  "getDebitCardTravelNotification": {
    "enabled": true,
    "requiresIdentityChallenge": true
  },
  "patchDebitCardTravelNotification": {
    "enabled": true,
    "requiresIdentityChallenge": true
  },
  "deleteDebitCardTravelNotification": {
    "enabled": true,
    "requiresIdentityChallenge": true
  },
  "listDebitCardRegions": {
    "enabled": true,
    "requiresIdentityChallenge": true
  },
  "createDebitCardRegion": {
    "enabled": true,
    "requiresIdentityChallenge": true
  },
  "getDebitCardRegion": {
    "enabled": true,
    "requiresIdentityChallenge": true
  },
  "patchDebitCardRegion": {
    "enabled": true,
    "requiresIdentityChallenge": true
  },
  "deleteDebitCardRegion": {
    "enabled": true,
    "requiresIdentityChallenge": true
  }
}

Debit Card Operations (v2.0.0)

API operations for debit cards within Apiture Digital Banking.

Properties

NameDescription
Debit Card Operations (v2.0.0) object
API operations for debit cards within Apiture Digital Banking.
listCustomerDebitCards cardProviderOperation (required)
Describes if and how a client may access various card-specific operations in this API.
getCustomerDebitCard cardProviderOperation (required)
Describes if and how a client may access various card-specific operations in this API.
getCustomerDebitCardUnmaskedProperties cardProviderOperation (required)
Describes if and how a client may access various card-specific operations in this API.

This operation is tied to parameterized functionality within the getCustomerDebitCard operation. The intent is to clarify that while getCustomerDebitCard may not require an identity challenge, this feature of the operation may.

lockCustomerDebitCard cardProviderOperation (required)
Describes if and how a client may access various card-specific operations in this API.
unlockCustomerDebitCard cardProviderOperation (required)
Describes if and how a client may access various card-specific operations in this API.
createCustomerDebitCardChallenge cardProviderOperation (required)
Describes if and how a client may access various card-specific operations in this API.
listDebitCards cardProviderOperation (required)
Describes if and how a client may access various card-specific operations in this API.
getDebitCard cardProviderOperation (required)
Describes if and how a client may access various card-specific operations in this API.
getDebitCardUnmaskedProperties cardProviderOperation (required)
Describes if and how a client may access various card-specific operations in this API.

This operation is tied to parameterized functionality within the getDebitCard operation. The intent is to clarify that while getDebitCard may not require an identity challenge, this feature of the operation may.

createDebitCardChallenge cardProviderOperation (required)
Describes if and how a client may access various card-specific operations in this API.
changeDebitCardPin cardProviderOperation (required)
Describes if and how a client may access various card-specific operations in this API.
listDebitCardTransactions cardProviderOperation (required)
Describes if and how a client may access various card-specific operations in this API.
getDebitCardTransactionRules cardProviderOperation (required)
Describes if and how a client may access various card-specific operations in this API.
patchDebitCardTransactionRules cardProviderOperation (required)
Describes if and how a client may access various card-specific operations in this API.
getDebitCardAlerts cardProviderOperation (required)
Describes if and how a client may access various card-specific operations in this API.
patchDebitCardAlertSubscriptions cardProviderOperation (required)
Describes if and how a client may access various card-specific operations in this API.
activateDebitCard cardProviderOperation (required)
Describes if and how a client may access various card-specific operations in this API.
reportDebitCard cardProviderOperation (required)
Describes if and how a client may access various card-specific operations in this API.
lockDebitCard cardProviderOperation (required)
Describes if and how a client may access various card-specific operations in this API.
unlockDebitCard cardProviderOperation (required)
Describes if and how a client may access various card-specific operations in this API.
listDebitCardTravelNotifications cardProviderOperation (required)
Describes if and how a client may access various card-specific operations in this API.
createDebitCardTravelNotification cardProviderOperation (required)
Describes if and how a client may access various card-specific operations in this API.
getDebitCardTravelNotification cardProviderOperation (required)
Describes if and how a client may access various card-specific operations in this API.
patchDebitCardTravelNotification cardProviderOperation (required)
Describes if and how a client may access various card-specific operations in this API.
deleteDebitCardTravelNotification cardProviderOperation (required)
Describes if and how a client may access various card-specific operations in this API.
listDebitCardRegions cardProviderOperation (required)
Describes if and how a client may access various card-specific operations in this API.
createDebitCardRegion cardProviderOperation (required)
Describes if and how a client may access various card-specific operations in this API.
getDebitCardRegion cardProviderOperation (required)
Describes if and how a client may access various card-specific operations in this API.
patchDebitCardRegion cardProviderOperation (required)
Describes if and how a client may access various card-specific operations in this API.
deleteDebitCardRegion cardProviderOperation (required)
Describes if and how a client may access various card-specific operations in this API.

debitCardProvider

{
  "context": "account",
  "operations": {
    "listCustomerDebitCards": {
      "enabled": false,
      "requiresIdentityChallenge": false
    },
    "getCustomerDebitCard": {
      "enabled": false,
      "requiresIdentityChallenge": false
    },
    "getCustomerDebitCardUnmaskedProperties": {
      "enabled": false,
      "requiresIdentityChallenge": false
    },
    "lockCustomerDebitCard": {
      "enabled": false,
      "requiresIdentityChallenge": false
    },
    "unlockCustomerDebitCard": {
      "enabled": false,
      "requiresIdentityChallenge": false
    },
    "createCustomerDebitCardChallenge": {
      "enabled": false,
      "requiresIdentityChallenge": false
    },
    "listDebitCards": {
      "enabled": true,
      "requiresIdentityChallenge": false
    },
    "getDebitCard": {
      "enabled": true,
      "requiresIdentityChallenge": false
    },
    "getDebitCardUnmaskedProperties": {
      "enabled": true,
      "requiresIdentityChallenge": true
    },
    "createDebitCardChallenge": {
      "enabled": true,
      "requiresIdentityChallenge": false
    },
    "changeDebitCardPin": {
      "enabled": true,
      "requiresIdentityChallenge": true
    },
    "listDebitCardTransactions": {
      "enabled": true,
      "requiresIdentityChallenge": false
    },
    "getDebitCardTransactionRules": {
      "enabled": true,
      "requiresIdentityChallenge": false
    },
    "patchDebitCardTransactionRules": {
      "enabled": true,
      "requiresIdentityChallenge": false
    },
    "getDebitCardAlerts": {
      "enabled": true,
      "requiresIdentityChallenge": false
    },
    "patchDebitCardAlertSubscriptions": {
      "enabled": true,
      "requiresIdentityChallenge": false
    },
    "activateDebitCard": {
      "enabled": true,
      "requiresIdentityChallenge": false
    },
    "reportDebitCard": {
      "enabled": true,
      "requiresIdentityChallenge": false
    },
    "lockDebitCard": {
      "enabled": true,
      "requiresIdentityChallenge": false
    },
    "unlockDebitCard": {
      "enabled": true,
      "requiresIdentityChallenge": true
    },
    "listDebitCardTravelNotifications": {
      "enabled": true,
      "requiresIdentityChallenge": false
    },
    "createDebitCardTravelNotification": {
      "enabled": true,
      "requiresIdentityChallenge": false
    },
    "getDebitCardTravelNotification": {
      "enabled": true,
      "requiresIdentityChallenge": false
    },
    "patchDebitCardTravelNotification": {
      "enabled": true,
      "requiresIdentityChallenge": false
    },
    "deleteDebitCardTravelNotification": {
      "enabled": true,
      "requiresIdentityChallenge": false
    },
    "listDebitCardRegions": {
      "enabled": true,
      "requiresIdentityChallenge": false
    },
    "createDebitCardRegion": {
      "enabled": true,
      "requiresIdentityChallenge": false
    },
    "getDebitCardRegion": {
      "enabled": true,
      "requiresIdentityChallenge": false
    },
    "patchDebitCardRegion": {
      "enabled": true,
      "requiresIdentityChallenge": false
    },
    "deleteDebitCardRegion": {
      "enabled": true,
      "requiresIdentityChallenge": false
    }
  },
  "merchantCategories": [
    "ageRestricted",
    "education",
    "entertainment",
    "foodAndDining",
    "giftsAndDonations",
    "household",
    "insurance",
    "personalCare",
    "shopping",
    "transportation",
    "travel",
    "other"
  ],
  "cardRegionType": "coordinates"
}

Debit Card Provider (v5.0.0)

Representation of the debit card provider resource.

Properties

NameDescription
Debit Card Provider (v5.0.0) object
Representation of the debit card provider resource.
context cardProviderContext (required)

The context of the card provider, indicating which operations to use for listing cards, retrieving card details, and others.

cardProviderContext strings may have one of the following enumerated values:

ValueDescription
accountAccount:

The card provider operations use an account context
customerCustomer/Member:

The card provider operations use a customer or member context

enum values: account, customer
operations debitCardOperations (required)
API operations for debit cards within Apiture Digital Banking.
merchantCategories array: [cardMerchantCategories] (required)
Categories of card merchants for alerts and transaction rules.
unique items
minItems: 0
maxItems: 12
items: string
» enum values: ageRestricted, ageRestricted.drinkingPlaces, ageRestricted.gambling, ageRestricted.liquorAndCigarStores, ageRestricted.dating, education, education.tuitionFees, education.books, entertainment, entertainment.games, entertainment.musicAndMovies, entertainment.parks, entertainment.other, foodAndDining, foodAndDining.restaurants, foodAndDining.groceries, giftsAndDonations, giftsAndDonations.gifts, giftsAndDonations.donations, household, household.maintenanceOrRepair, household.decorationOrImprovement, household.housekeeping, household.cableUtilities, household.communicationUtilities, household.security, household.chemicalUtilities, household.otherUtilities, household.rentalServices, household.laundry, insurance, personalCare, personalCare.pharmacy, personalCare.beautyProducts, personalCare.doctor, personalCare.sports, personalCare.wellness, personalCare.childrenServices, shopping, shopping.clothing, shopping.electronics, shopping.accessories, shopping.other, transportation, transportation.autoServices, transportation.gasOrFuel, transportation.parking, transportation.toll, transportation.other, travel, travel.autoRentals, travel.airline, travel.train, travel.lodging, travel.other, other, other.atm
cardRegionType cardRegionLocationType (required)
Indicates the required location type for card regions.
enum values: coordinates, address

debitCardState

"active"

Debit Card State (v1.1.0)

The state of the debit card issued for the debit card account.

debitCardState strings may have one of the following enumerated values:

ValueDescription
activeActive:

The debit card is active
inactiveInactive:

The debit card is inactive
lockedLocked:

The debit card is locked and unable to be used for transactions
disabledDisabled:

The debit card is disabled and unable to be used for transactions. Contact the issuing financial institution for additional information.

type: string


enum values: active, inactive, locked, disabled

debitCardTransactions

{
  "start": "d1b48af913464aa49fcb07065dcc0616",
  "limit": 10,
  "nextPage_url": "https://production.api.apiture.com/banking/accounts/0399abed-fd3d/debitCards/d2d01f5e-f64a/transactions?start=6117a4dcefb841cab7316cef1ac8b58c&limit=10",
  "items": [
    {
      "occurredOn": "2024-01-16",
      "description": "**MACYS1234",
      "amount": "52.05",
      "direction": "credit"
    },
    {
      "occurredOn": "2024-01-15",
      "description": "**MACYS1234",
      "amount": "-52.05",
      "direction": "debit"
    },
    {
      "occurredOn": "2024-01-13",
      "description": "**WALMART1337",
      "amount": "-49.85",
      "direction": "debit"
    }
  ]
}

Debit Card Transactions Collection (v2.0.1)

Collection of debit card transactions. The response object may contain the nextPage_url pagination link.

Properties

NameDescription
Debit Card Transactions Collection (v2.0.1) object
Collection of debit card transactions. The response object may contain the nextPage_url pagination link.
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
items array: [cardTransactionItem] (required)
An array containing a page of transaction items.
maxItems: 100
items: object

debitCardTravelNotificationItem

{
  "id": "0399abed-fd3d",
  "departingOn": "2024-06-01",
  "returningOn": "2024-06-10",
  "countryCode": "US",
  "regionCode": "FL",
  "phoneNumber": "5555555555",
  "notes": "Disney, Universal and Sea World",
  "allows": {
    "edit": false,
    "delete": false
  }
}

Debit Card Travel Notification Item (v2.0.0)

Summary representation of a travel notification resource in travel notifications collections. To fetch the full representation of this debit card travel notification, use the getDebitCardTravelNotification operation, passing this item's id field as the travelNotificationId path parameter.

Properties

NameDescription
Debit Card Travel Notification Item (v2.0.0) object
Summary representation of a travel notification resource in travel notifications collections. To fetch the full representation of this debit card travel notification, use the getDebitCardTravelNotification operation, passing this item's id field as the travelNotificationId path parameter.
departingOn date(date) (required)
The date the travel begins in YYYY-MM-DD RFC 3339 date format.
format: date
minLength: 10
maxLength: 10
returningOn date(date) (required)
The date the travel ends in YYYY-MM-DD RFC 3339 date format.
format: date
minLength: 10
maxLength: 10
countryCode countryCode (required)
The country the customer or member is traveling to in the ISO-3611 alpha-2 format.
minLength: 2
maxLength: 2
pattern: "^[A-Za-z]{2}$"
regionCode string
The state, district, or outlying area where the customer or member is traveling when in the United States.

This is required when countryCode is US.
minLength: 2
maxLength: 2
pattern: "^[A-Za-z]{2}$"

phoneNumber simplePhoneNumber(phone-number)
The phone number where the member can be reached at while traveling.
format: phone-number
minLength: 5
maxLength: 20
notes string(text)
Notes from the customer or member regarding their travel.
format: text
minLength: 1
maxLength: 1000
id externalResourceId(text) (required)
The unique identifier for this travel notification resource. This is an immutable opaque string.
read-only
format: text
minLength: 1
maxLength: 256
allows travelNotificationAllows (required)
Flags which indicate the permissions the current authorized user has on this travel notification resource.

debitCardTravelNotifications

{
  "items": [
    {
      "id": "ebf3709442ea-4836",
      "departingOn": "2024-11-03",
      "returningOn": "2024-11-17",
      "countryCode": "UK",
      "phoneNumber": "5555555555",
      "notes": "Visiting family",
      "allows": {
        "edit": false,
        "delete": false
      }
    },
    {
      "id": "0399abed-fd3d",
      "departingOn": "2024-06-01",
      "returningOn": "2024-06-10",
      "countryCode": "US",
      "regionCode": "FL",
      "phoneNumber": "5555555555",
      "notes": "Disney, Universal and Sea World",
      "allows": {
        "edit": false,
        "delete": false
      }
    },
    {
      "id": "d62c0701-0d74-4836-83f9-ebf3709442ea",
      "departingOn": "2024-03-20",
      "returningOn": "2024-03-24",
      "countryCode": "US",
      "regionCode": "DC",
      "phoneNumber": "5555555555",
      "allows": {
        "edit": false,
        "delete": false
      }
    }
  ]
}

Debit Card Travel Notification Collection (v2.0.0)

Collection of debit card travel notifications. The items in the collection are ordered in the items array.

Properties

NameDescription
Debit Card Travel Notification Collection (v2.0.0) object
Collection of debit card travel notifications. The items in the collection are ordered in the items array.
items array: [debitCardTravelNotificationItem] (required)
An array containing debit card travel notification items.
maxItems: 100
items: object

debitCards

{
  "items": [
    {
      "id": "0399abed-fd3d",
      "type": "physical",
      "state": "active",
      "issuerIdentificationNumber": "4242",
      "displayName": "PHIL DUCIARY",
      "cardholder": {
        "name": "Phil Duciary",
        "type": "primary"
      },
      "maskedAccountNumber": "*1000",
      "allows": {
        "activate": false,
        "viewTransactions": true,
        "viewUnmaskedSecurityCode": true,
        "reportLost": true,
        "reportFound": false,
        "reportStolen": true,
        "reportDamaged": true,
        "lock": true,
        "unlock": false,
        "changePin": true,
        "manageTravelNotifications": true
      }
    }
  ]
}

Debit Cards (v4.2.0)

Collection of debit cards.

Properties

NameDescription
Debit Cards (v4.2.0) object
Collection of debit cards.
items array: [debitCardItem] (required)
An array containing debit card items.
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

fullCardPersonalAccountNumber

"4242424242424242"

Full Card Personal Account Number (v1.0.0)

A full personal account number used in a credit or debit card. Spaces in requests are ignored. Spaces are omitted in responses.

type: string


minLength: 14
maxLength: 19
pattern: "^\d{1}[0-9 ]{12,17}\d{1}$"

issuerIdentificationNumber

"379790"
  • (v1.0.0)*

The issuer identification number (IIN) or bank identification number (BIN) of the card.

type: string


minLength: 4
maxLength: 8
pattern: "^\d{4,8}$"

latitude

-90

Latitude (v1.0.0)

The north-south angular distance of a point on Earth's surface, as measured from the equator. Distances to the north are expressed as positive numbers. Distances to the south are expressed as negative numbers.

type: number


minimum: -90
maximum: 90

longitude

-180

Longitude (v1.0.1)

The east-west angular distance of a point on Earth's surface, as measured from the Prime Meridian (passing through Greenwich, England). Distances to the east are expressed as positive numbers. Distances to the west are expressed as negative numbers.

type: number


minimum: -180
maximum: 180

maskedCardPersonalAccountNumber

"*1008"

Masked Card Personal Account Number (v1.0.1)

A masked card personal account number: an asterisk * followed by the last four digits of the full Personal Account Number (PAN).

type: string


minLength: 5
maxLength: 5
pattern: "^\*\d{4}$"

monetaryThresholdAlertSubscription

{
  "communicationChannels": [
    {
      "id": "0399abed-fd3d",
      "label": "Max.Pike@example.com",
      "type": "email"
    }
  ],
  "threshold": 10000000
}

Monetary Threshold Alert Subscription (v1.0.0)

A card alert subscription based on a monetary threshold and communication channels.

Properties

NameDescription
Monetary Threshold Alert Subscription (v1.0.0) object
A card alert subscription based on a monetary threshold and communication channels.
communicationChannels array: [customerCommunicationChannel] (required)
Channels to communicate this alert subscription.
unique items
minItems: 0
maxItems: 5
items: object
threshold cardMonetaryThreshold(int32) (required)
The monetary value, supporting only positive dollar amounts without decimal (cents) values. Use a threshold of 0 and an empty list of communication channels to disable this alert.
format: int32
minimum: 0
maximum: 10000000

newCardRegion

{
  "name": "Disney World's Magic Kingdom",
  "type": "coordinates",
  "coordinates": {
    "latitude": 28.4188,
    "longitude": -81.5818,
    "radius": "5mi"
  }
}

New Card Region (v2.0.0)

Representation used to create a geographical region for a card.

Properties

NameDescription
New Card Region (v2.0.0) object
Representation used to create a geographical region for a card.
name string(text) (required)
A name describing this geographic region.
format: text
minLength: 1
maxLength: 55
type cardRegionLocationType (required)

The type of the location for this card region.

cardRegionLocationType strings may have one of the following enumerated values:

ValueDescription
coordinatesCoordinates:

The card region is defined by geographical coordinates and radius
addressAddress:

The card region is defined by an address

enum values: coordinates, address
coordinates cardRegionCoordinateLocation
The geographic coordinates for a circular geographic region.

This is required when type is coordinates.
Unevaluated Properties: false

address cardRegionAddressLocation
The address, scoped to a locality, for a geographic region.

This is required when type is address.
Unevaluated Properties: false

newTravelNotification

{
  "departingOn": "2024-06-01",
  "returningOn": "2024-06-10",
  "countryCode": "US",
  "regionCode": "FL",
  "phoneNumber": "5555555555",
  "notes": "Disney, Universal and Sea World"
}

New Travel Notification (v1.0.0)

Representation used to create a new travel notification.

Properties

NameDescription
New Travel Notification (v1.0.0) object
Representation used to create a new travel notification.
departingOn date(date) (required)
The date the travel begins in YYYY-MM-DD RFC 3339 date format.
format: date
minLength: 10
maxLength: 10
returningOn date(date) (required)
The date the travel ends in YYYY-MM-DD RFC 3339 date format.
format: date
minLength: 10
maxLength: 10
countryCode countryCode (required)
The country the customer or member is traveling to in the ISO-3611 alpha-2 format.
minLength: 2
maxLength: 2
pattern: "^[A-Za-z]{2}$"
regionCode string
The state, district, or outlying area where the customer or member is traveling when in the United States.

This is required when countryCode is US.
minLength: 2
maxLength: 2
pattern: "^[A-Za-z]{2}$"

phoneNumber simplePhoneNumber(phone-number) (required)
The phone number where the member can be reached at while traveling.
format: phone-number
minLength: 5
maxLength: 20
notes string(text)
Notes from the customer or member regarding their travel.
format: text
minLength: 1
maxLength: 1000

postalCode

"20521"

Postal code (v1.0.0)

The 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


minLength: 2
maxLength: 20
pattern: "[0-9A-Za-z][- 0-9A-Za-z]{0,18}[0-9A-Za-z]"

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

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

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

requiredCommunicationChannelAlertSubscription

{
  "communicationChannels": [
    {
      "id": "0399abed-fd3d",
      "label": "Max.Pike@example.com",
      "type": "email"
    }
  ]
}

Required Communication Channel Alert (v1.0.0)

A card alert subscription configuration requiring at least one communication channel.

Properties

NameDescription
Required Communication Channel Alert (v1.0.0) object
A card alert subscription configuration requiring at least one communication channel.
communicationChannels array: [customerCommunicationChannel] (required)
Channels to communicate this alert subscription.
unique items
minItems: 1
maxItems: 5
items: object

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

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

simpleCardAlertSubscription

{
  "communicationChannels": [
    {
      "id": "0399abed-fd3d",
      "label": "Max.Pike@example.com",
      "type": "email"
    }
  ]
}

Simple Alert (v1.0.0)

A card alert subscription configuration based on communication channels.

Properties

NameDescription
Simple Alert (v1.0.0) object
A card alert subscription configuration based on communication channels.
communicationChannels array: [customerCommunicationChannel] (required)
Channels to communicate this alert subscription.
unique items
minItems: 0
maxItems: 5
items: object

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

timestamp

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

Timestamp (v1.0.0)

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

type: string(date-time)


format: date-time
minLength: 20
maxLength: 30

travelNotification

{
  "id": "0399abed-fd3d",
  "departingOn": "2024-06-01",
  "returningOn": "2024-06-10",
  "countryCode": "US",
  "regionCode": "FL",
  "phoneNumber": "5555555555",
  "notes": "Disney, Universal and Sea World",
  "allows": {
    "edit": false,
    "delete": false
  }
}

Travel Notification (v2.0.0)

Representation of a travel notification resource.

Properties

NameDescription
Travel Notification (v2.0.0) object
Representation of a travel notification resource.
departingOn date(date) (required)
The date the travel begins in YYYY-MM-DD RFC 3339 date format.
format: date
minLength: 10
maxLength: 10
returningOn date(date) (required)
The date the travel ends in YYYY-MM-DD RFC 3339 date format.
format: date
minLength: 10
maxLength: 10
countryCode countryCode (required)
The country the customer or member is traveling to in the ISO-3611 alpha-2 format.
minLength: 2
maxLength: 2
pattern: "^[A-Za-z]{2}$"
regionCode string
The state, district, or outlying area where the customer or member is traveling when in the United States.

This is required when countryCode is US.
minLength: 2
maxLength: 2
pattern: "^[A-Za-z]{2}$"

phoneNumber simplePhoneNumber(phone-number) (required)
The phone number where the member can be reached at while traveling.
format: phone-number
minLength: 5
maxLength: 20
notes string(text)
Notes from the customer or member regarding their travel.
format: text
minLength: 1
maxLength: 1000
id externalResourceId(text) (required)
The unique identifier for this travel notification resource. This is an immutable opaque string.
read-only
format: text
minLength: 1
maxLength: 256
allows travelNotificationAllows (required)
Flags which indicate the permissions the current authorized user has on this travel notification resource.

travelNotificationAllows

{
  "edit": true,
  "delete": true
}

Travel Notification Allows (v1.0.0)

Flags which indicate the permissions the current authorized user has on this travel notification resource.

Properties

NameDescription
Travel Notification Allows (v1.0.0) object
Flags which indicate the permissions the current authorized user has on this travel notification resource.
edit boolean (required)
If true, the currently authenticated user is authorized to edit this travel notification.
delete boolean (required)
If true, the currently authenticated user is authorized to delete this travel notification.

travelNotificationPatch

{
  "departingOn": "2021-10-30",
  "returningOn": "2021-10-30",
  "countryCode": "US",
  "regionCode": "NC",
  "phoneNumber": "+19105550155",
  "notes": "string"
}

Travel Notification Patch Request (v1.0.0)

Representation used to patch a travel notification using the JSON Merge Patch format and processing rules.

Properties

NameDescription
Travel Notification Patch Request (v1.0.0) object
Representation used to patch a travel notification using the JSON Merge Patch format and processing rules.
departingOn date(date)
The date the travel begins in YYYY-MM-DD RFC 3339 date format.
format: date
minLength: 10
maxLength: 10
returningOn date(date)
The date the travel ends in YYYY-MM-DD RFC 3339 date format.
format: date
minLength: 10
maxLength: 10
countryCode countryCode
The country the customer or member is traveling to in the ISO-3611 alpha-2 format.
minLength: 2
maxLength: 2
pattern: "^[A-Za-z]{2}$"
regionCode string
The state, district, or outlying area where the customer or member is traveling when in the United States.

This is required when countryCode is US.
minLength: 2
maxLength: 2
pattern: "^[A-Za-z]{2}$"

phoneNumber simplePhoneNumber(phone-number)
The phone number where the member can be reached at while traveling.
format: phone-number
minLength: 5
maxLength: 20
notes string(text)
Notes from the customer or member regarding their travel.
format: text
minLength: 1
maxLength: 1000

userAccountReference

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

User Account Reference (v2.0.0)

The representation of a user account.

Properties

NameDescription
User Account Reference (v2.0.0) object
The representation of a user account.
id resourceId (required)
The immutable, unique, opaque identifier for the user.
minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
firstName string(text) (required)
The user's first name.
format: text
maxLength: 56
lastName string(text) (required)
The user's last name.
format: text
maxLength: 56
username customerUsername(text) (required)
The user's login name.
format: text
minLength: 5
maxLength: 20
Generated by @apiture/api-doc 3.2.4 on Thu Feb 27 2025 22:02:31 GMT+0000 (Coordinated Universal Time).
Shell HTTP Node.JS JavaScript Ruby Python Java Go