FDOBI v1.7.1
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
First Data Online Banking API (FDOBI)
FDOBI connects third-party vendor-developed online applications with Apiture Xpress's authenticated client banking data retrieval, end-user device display, and money movement applications.
Download OpenAPI Definition (YAML)
Base URLs:
Authentication
- API Key (
authToken
)- header parameter: Authorization
- The auth token (typically JWT) which identifies a login session. This is required in situations (e.g. mb, reset_passcode) where it does not make sense to use an HTTP Cookie.
- API Key (
csrfToken
)- header parameter: X-XSRF-TOKEN
- The Cross-Site Request Forgery token which will match an HTTP header or some information stored in session server-side which cannot easily be hidden in an email hyperlink. This is not currently required for mb.
olb
Show all Online Banking operations
getAcquisitionLoginIdentify
Code samples
# You can also use wget
curl -X GET /fdobi/acquisition_login/identify \
-H 'Content-Type: application/json' \
-H 'Accept: application/json; charset=ISO-8859-1'
GET /fdobi/acquisition_login/identify HTTP/1.1
Content-Type: application/json
Accept: application/json; charset=ISO-8859-1
var headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1'
};
$.ajax({
url: '/fdobi/acquisition_login/identify',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const inputBody = '{
"institutionId": "string",
"appId": "string",
"cust_type_id": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1'
};
fetch('/fdobi/acquisition_login/identify',
{
method: 'GET',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json; charset=ISO-8859-1'
}
result = RestClient.get '/fdobi/acquisition_login/identify',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json; charset=ISO-8859-1'
}
r = requests.get('/fdobi/acquisition_login/identify', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/acquisition_login/identify");
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{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json; charset=ISO-8859-1"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/fdobi/acquisition_login/identify", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /acquisition_login/identify
This operation returns the details required for Acquisition Login based on FI'S configurations
Body parameter
{
"institutionId": "string",
"appId": "string",
"cust_type_id": "string"
}
Parameters
Parameter | Description |
---|---|
body (body) |
acquisitionLoginIdentifyGetRequest (required) Data necessary for get /acquisition_login/identify |
Try It
Example responses
200 Response
{
"form": {
"attributes": {
"accessId": {
"helpText": "string",
"label": "string",
"maxLength": "string",
"minLength": "string",
"required": true,
"type": "string"
},
"emailAddress": {
"helpText": "string",
"label": "string",
"maxLength": "string",
"minLength": "string",
"required": true,
"type": "string"
},
"institutionId": {
"helpText": "string",
"label": "string",
"maxLength": "string",
"minLength": "string",
"required": true,
"type": "string"
},
"taxIdNum": {
"helpText": "string",
"label": "string",
"maxLength": "string",
"minLength": "string",
"required": true,
"type": "string"
},
"cust_type_id": {
"helpText": "string",
"label": "string",
"maxLength": "string",
"minLength": "string",
"required": true,
"type": "string"
},
"birthDate": {
"helpText": "string",
"label": "string",
"maxLength": "string",
"minLength": "string",
"required": true,
"type": "string"
},
"phone": {
"helpText": "string",
"label": "string",
"maxLength": "string",
"minLength": "string",
"required": true,
"type": "string"
},
"accNum": {
"helpText": "string",
"label": "string",
"maxLength": "string",
"minLength": "string",
"required": true,
"type": "string"
},
"postalCode": {
"helpText": "string",
"label": "string",
"maxLength": "string",
"minLength": "string",
"required": true,
"type": "string"
}
},
"attributeOrder": [
"access_id"
]
}
}
Responses
Status | Description |
---|---|
200 | OK |
Successful response | |
Schema: resetPasscodeIdentifyInstIdResponse |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
postAcquisitionLoginIdentify
Code samples
# You can also use wget
curl -X POST /fdobi/acquisition_login/identify \
-H 'Content-Type: application/json' \
-H 'Accept: application/json; charset=ISO-8859-1'
POST /fdobi/acquisition_login/identify HTTP/1.1
Content-Type: application/json
Accept: application/json; charset=ISO-8859-1
var headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1'
};
$.ajax({
url: '/fdobi/acquisition_login/identify',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const inputBody = '{
"appId": "string",
"emailAddress": "string",
"institutionId": "string",
"accessId": "string",
"taxIdNum": "string",
"accNum": "string",
"phone": "string",
"birthDate": "string",
"memNum": "string",
"cust_type_id": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1'
};
fetch('/fdobi/acquisition_login/identify',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json; charset=ISO-8859-1'
}
result = RestClient.post '/fdobi/acquisition_login/identify',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json; charset=ISO-8859-1'
}
r = requests.post('/fdobi/acquisition_login/identify', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/acquisition_login/identify");
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; charset=ISO-8859-1"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/fdobi/acquisition_login/identify", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /acquisition_login/identify
Gets an auth-token that resembles a session which can be used only for Acquisition Login operations.
Body parameter
{
"appId": "string",
"emailAddress": "string",
"institutionId": "string",
"accessId": "string",
"taxIdNum": "string",
"accNum": "string",
"phone": "string",
"birthDate": "string",
"memNum": "string",
"cust_type_id": "string"
}
appId: string
emailAddress: string
institutionId: string
accessId: string
taxIdNum: string
accNum: string
phone: string
birthDate: string
memNum: string
cust_type_id: string
Parameters
Parameter | Description |
---|---|
body (body) |
acquisitionLoginIdentifyPostRequest (required) Data necessary for post /acquisition_login/identify |
Try It
Example responses
200 Response
{
"authToken": "string"
}
Responses
Status | Description |
---|---|
200 | OK |
Successful response | |
Schema: authTokenResponse |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
getAcquisitionLoginConfirmLogin
Code samples
# You can also use wget
curl -X GET /fdobi/acquisition_login/confirmLogin \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
GET /fdobi/acquisition_login/confirmLogin HTTP/1.1
Accept: application/json; charset=ISO-8859-1
var headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/acquisition_login/confirmLogin',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/acquisition_login/confirmLogin',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.get '/fdobi/acquisition_login/confirmLogin',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.get('/fdobi/acquisition_login/confirmLogin', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/acquisition_login/confirmLogin");
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; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/fdobi/acquisition_login/confirmLogin", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /acquisition_login/confirmLogin
This operation returns the details for reseting customer password
Try It
Example responses
500 Response
{
"error": {
"code": "string",
"id": "string",
"text": "string"
}
}
Responses
Status | Description |
---|---|
200 | OK |
Successful response |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
postAcquisitionLoginConfirmLogin
Code samples
# You can also use wget
curl -X POST /fdobi/acquisition_login/confirmLogin \
-H 'Content-Type: application/json' \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
POST /fdobi/acquisition_login/confirmLogin HTTP/1.1
Content-Type: application/json
Accept: application/json; charset=ISO-8859-1
var headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/acquisition_login/confirmLogin',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const inputBody = '{
"passcodeNew": "string",
"passcodeNewConfirm": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/acquisition_login/confirmLogin',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.post '/fdobi/acquisition_login/confirmLogin',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.post('/fdobi/acquisition_login/confirmLogin', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/acquisition_login/confirmLogin");
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; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/fdobi/acquisition_login/confirmLogin", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /acquisition_login/confirmLogin
This operation actually resets customer password and the new password can be used to login OLB
Body parameter
{
"passcodeNew": "string",
"passcodeNewConfirm": "string"
}
passcodeNew: string
passcodeNewConfirm: string
Parameters
Parameter | Description |
---|---|
body (body) |
acquisitionLoginConfirmLoginPostRequest (required) Data necessary for post /acquisition_login/confirmLogin |
Try It
Example responses
500 Response
{
"error": {
"code": "string",
"id": "string",
"text": "string"
}
}
Responses
Status | Description |
---|---|
200 | OK |
Successful response |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
getResetPasscodeIdentifyInstitutionId
Code samples
# You can also use wget
curl -X GET /fdobi/reset_passcode/identify/{institutionId} \
-H 'Accept: application/json; charset=ISO-8859-1'
GET /fdobi/reset_passcode/identify/{institutionId} HTTP/1.1
Accept: application/json; charset=ISO-8859-1
var headers = {
'Accept':'application/json; charset=ISO-8859-1'
};
$.ajax({
url: '/fdobi/reset_passcode/identify/{institutionId}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json; charset=ISO-8859-1'
};
fetch('/fdobi/reset_passcode/identify/{institutionId}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json; charset=ISO-8859-1'
}
result = RestClient.get '/fdobi/reset_passcode/identify/{institutionId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json; charset=ISO-8859-1'
}
r = requests.get('/fdobi/reset_passcode/identify/{institutionId}', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/reset_passcode/identify/{institutionId}");
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; charset=ISO-8859-1"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/fdobi/reset_passcode/identify/{institutionId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /reset_passcode/identify/{institutionId}
This operation returns the details required for reset passcode based on FIS configurations
Parameters
Parameter | Description |
---|---|
institutionId (path) |
string (required) This FDOBI Input Parameter/Output Label is the FDOBI Institution ID. |
Try It
Example responses
200 Response
{
"form": {
"attributes": {
"accessId": {
"helpText": "string",
"label": "string",
"maxLength": "string",
"minLength": "string",
"required": true,
"type": "string"
},
"emailAddress": {
"helpText": "string",
"label": "string",
"maxLength": "string",
"minLength": "string",
"required": true,
"type": "string"
},
"institutionId": {
"helpText": "string",
"label": "string",
"maxLength": "string",
"minLength": "string",
"required": true,
"type": "string"
},
"taxIdNum": {
"helpText": "string",
"label": "string",
"maxLength": "string",
"minLength": "string",
"required": true,
"type": "string"
},
"cust_type_id": {
"helpText": "string",
"label": "string",
"maxLength": "string",
"minLength": "string",
"required": true,
"type": "string"
},
"birthDate": {
"helpText": "string",
"label": "string",
"maxLength": "string",
"minLength": "string",
"required": true,
"type": "string"
},
"phone": {
"helpText": "string",
"label": "string",
"maxLength": "string",
"minLength": "string",
"required": true,
"type": "string"
},
"accNum": {
"helpText": "string",
"label": "string",
"maxLength": "string",
"minLength": "string",
"required": true,
"type": "string"
},
"postalCode": {
"helpText": "string",
"label": "string",
"maxLength": "string",
"minLength": "string",
"required": true,
"type": "string"
}
},
"attributeOrder": [
"access_id"
]
}
}
Responses
Status | Description |
---|---|
200 | OK |
Successful response | |
Schema: resetPasscodeIdentifyInstIdResponse |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
postResetPasscodeIdentify
Code samples
# You can also use wget
curl -X POST /fdobi/reset_passcode/identify \
-H 'Content-Type: application/json' \
-H 'Accept: application/json; charset=ISO-8859-1'
POST /fdobi/reset_passcode/identify HTTP/1.1
Content-Type: application/json
Accept: application/json; charset=ISO-8859-1
var headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1'
};
$.ajax({
url: '/fdobi/reset_passcode/identify',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const inputBody = '{
"appId": "string",
"emailAddress": "string",
"institutionId": "string",
"accessId": "string",
"taxIdNum": "string",
"accNum": "string",
"memNum": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1'
};
fetch('/fdobi/reset_passcode/identify',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json; charset=ISO-8859-1'
}
result = RestClient.post '/fdobi/reset_passcode/identify',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json; charset=ISO-8859-1'
}
r = requests.post('/fdobi/reset_passcode/identify', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/reset_passcode/identify");
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; charset=ISO-8859-1"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/fdobi/reset_passcode/identify", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /reset_passcode/identify
Gets an auth-token that resembles a session which can be used only for Reset Passcode operations.
Body parameter
{
"appId": "string",
"emailAddress": "string",
"institutionId": "string",
"accessId": "string",
"taxIdNum": "string",
"accNum": "string",
"memNum": "string"
}
appId: string
emailAddress: string
institutionId: string
accessId: string
taxIdNum: string
accNum: string
memNum: string
Parameters
Parameter | Description |
---|---|
body (body) |
resetPasscodeIdentifyPostRequest (required) Data necessary for post /reset_passcode/identify |
Try It
Example responses
200 Response
{
"authToken": "string"
}
Responses
Status | Description |
---|---|
200 | OK |
Successful response | |
Schema: authTokenResponse |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
getResetPasscodeChallenges
Code samples
# You can also use wget
curl -X GET /fdobi/reset_passcode/challenges \
-H 'Accept: application/json; charset=ISO-8859-1'
GET /fdobi/reset_passcode/challenges HTTP/1.1
Accept: application/json; charset=ISO-8859-1
var headers = {
'Accept':'application/json; charset=ISO-8859-1'
};
$.ajax({
url: '/fdobi/reset_passcode/challenges',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json; charset=ISO-8859-1'
};
fetch('/fdobi/reset_passcode/challenges',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json; charset=ISO-8859-1'
}
result = RestClient.get '/fdobi/reset_passcode/challenges',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json; charset=ISO-8859-1'
}
r = requests.get('/fdobi/reset_passcode/challenges', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/reset_passcode/challenges");
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; charset=ISO-8859-1"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/fdobi/reset_passcode/challenges", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /reset_passcode/challenges
This operation returns security questions and their ids. Number of questions depends on inst/cust configs
Try It
Example responses
500 Response
{
"error": {
"code": "string",
"id": "string",
"text": "string"
}
}
Responses
Status | Description |
---|---|
200 | OK |
Successful response |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
postResetPasscodeChallenges
Code samples
# You can also use wget
curl -X POST /fdobi/reset_passcode/challenges \
-H 'Content-Type: application/json' \
-H 'Accept: application/json; charset=ISO-8859-1'
POST /fdobi/reset_passcode/challenges HTTP/1.1
Content-Type: application/json
Accept: application/json; charset=ISO-8859-1
var headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1'
};
$.ajax({
url: '/fdobi/reset_passcode/challenges',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const inputBody = '{
"id1": "string",
"response1": "string",
"id2": "string",
"response2": "string",
"id3": "string",
"response3": "string",
"id4": "string",
"response4": "string",
"id5": "string",
"response5": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1'
};
fetch('/fdobi/reset_passcode/challenges',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json; charset=ISO-8859-1'
}
result = RestClient.post '/fdobi/reset_passcode/challenges',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json; charset=ISO-8859-1'
}
r = requests.post('/fdobi/reset_passcode/challenges', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/reset_passcode/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; charset=ISO-8859-1"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/fdobi/reset_passcode/challenges", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /reset_passcode/challenges
This operation returns {} on successful verification of security questions and their answers posted
Body parameter
{
"id1": "string",
"response1": "string",
"id2": "string",
"response2": "string",
"id3": "string",
"response3": "string",
"id4": "string",
"response4": "string",
"id5": "string",
"response5": "string"
}
id1: string
response1: string
id2: string
response2: string
id3: string
response3: string
id4: string
response4: string
id5: string
response5: string
Parameters
Parameter | Description |
---|---|
body (body) |
resetPasscodeChallengesPostRequest (required) Data necessary for post /reset_passcode/challenges |
Try It
Example responses
500 Response
{
"error": {
"code": "string",
"id": "string",
"text": "string"
}
}
Responses
Status | Description |
---|---|
200 | OK |
Successful response |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
getResetPasscodeSecureDelivery
Code samples
# You can also use wget
curl -X GET /fdobi/reset_passcode/secureDelivery \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
GET /fdobi/reset_passcode/secureDelivery HTTP/1.1
Accept: application/json; charset=ISO-8859-1
var headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/reset_passcode/secureDelivery',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/reset_passcode/secureDelivery',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.get '/fdobi/reset_passcode/secureDelivery',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.get('/fdobi/reset_passcode/secureDelivery', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/reset_passcode/secureDelivery");
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; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/fdobi/reset_passcode/secureDelivery", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /reset_passcode/secureDelivery
This operation returns the details of various Customer enrolled communication channels
Try It
Example responses
500 Response
{
"error": {
"code": "string",
"id": "string",
"text": "string"
}
}
Responses
Status | Description |
---|---|
200 | OK |
Successful response |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
postResetPasscodeSecureDelivery
Code samples
# You can also use wget
curl -X POST /fdobi/reset_passcode/secureDelivery \
-H 'Content-Type: application/json' \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
POST /fdobi/reset_passcode/secureDelivery HTTP/1.1
Content-Type: application/json
Accept: application/json; charset=ISO-8859-1
var headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/reset_passcode/secureDelivery',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const inputBody = '{
"emailAddress": "string",
"emailAddress2": "string",
"smsPhoneNumber": "string",
"phone": "string",
"phoneType": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/reset_passcode/secureDelivery',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.post '/fdobi/reset_passcode/secureDelivery',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.post('/fdobi/reset_passcode/secureDelivery', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/reset_passcode/secureDelivery");
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; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/fdobi/reset_passcode/secureDelivery", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /reset_passcode/secureDelivery
This operation actually delivers OTP on the choosen channel
Body parameter
{
"emailAddress": "string",
"emailAddress2": "string",
"smsPhoneNumber": "string",
"phone": "string",
"phoneType": "string"
}
emailAddress: string
emailAddress2: string
smsPhoneNumber: string
phone: string
phoneType: string
Parameters
Parameter | Description |
---|---|
body (body) |
resetPasscodeSecureDeliveryPostRequest (required) Data necessary for post /reset_passcode/secureDelivery |
Try It
Example responses
500 Response
{
"error": {
"code": "string",
"id": "string",
"text": "string"
}
}
Responses
Status | Description |
---|---|
200 | OK |
Successful response |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
getResetPasscodeConfirmLogin
Code samples
# You can also use wget
curl -X GET /fdobi/reset_passcode/confirmLogin \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
GET /fdobi/reset_passcode/confirmLogin HTTP/1.1
Accept: application/json; charset=ISO-8859-1
var headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/reset_passcode/confirmLogin',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/reset_passcode/confirmLogin',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.get '/fdobi/reset_passcode/confirmLogin',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.get('/fdobi/reset_passcode/confirmLogin', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/reset_passcode/confirmLogin");
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; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/fdobi/reset_passcode/confirmLogin", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /reset_passcode/confirmLogin
This operation returns the details for reseting customer password
Try It
Example responses
500 Response
{
"error": {
"code": "string",
"id": "string",
"text": "string"
}
}
Responses
Status | Description |
---|---|
200 | OK |
Successful response |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
postResetPasscodeConfirmLogin
Code samples
# You can also use wget
curl -X POST /fdobi/reset_passcode/confirmLogin \
-H 'Content-Type: application/json' \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
POST /fdobi/reset_passcode/confirmLogin HTTP/1.1
Content-Type: application/json
Accept: application/json; charset=ISO-8859-1
var headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/reset_passcode/confirmLogin',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const inputBody = '{
"passcodeCurrent": "string",
"passcodeNew": "string",
"passcodeNewConfirm": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/reset_passcode/confirmLogin',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.post '/fdobi/reset_passcode/confirmLogin',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.post('/fdobi/reset_passcode/confirmLogin', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/reset_passcode/confirmLogin");
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; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/fdobi/reset_passcode/confirmLogin", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /reset_passcode/confirmLogin
This operation actually resets customer password and the new password can be used to login OLB
Body parameter
{
"passcodeCurrent": "string",
"passcodeNew": "string",
"passcodeNewConfirm": "string"
}
passcodeCurrent: string
passcodeNew: string
passcodeNewConfirm: string
Parameters
Parameter | Description |
---|---|
body (body) |
resetPasscodeConfirmLoginPostRequest (required) Data necessary for post /reset_passcode/confirmLogin |
Try It
Example responses
500 Response
{
"error": {
"code": "string",
"id": "string",
"text": "string"
}
}
Responses
Status | Description |
---|---|
200 | OK |
Successful response |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
getResetPasscodeResendSecureDelivery
Code samples
# You can also use wget
curl -X GET /fdobi/reset_passcode/resendSecureDelivery \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
GET /fdobi/reset_passcode/resendSecureDelivery HTTP/1.1
Accept: application/json; charset=ISO-8859-1
var headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/reset_passcode/resendSecureDelivery',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/reset_passcode/resendSecureDelivery',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.get '/fdobi/reset_passcode/resendSecureDelivery',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.get('/fdobi/reset_passcode/resendSecureDelivery', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/reset_passcode/resendSecureDelivery");
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; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/fdobi/reset_passcode/resendSecureDelivery", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /reset_passcode/resendSecureDelivery
This operation returns the details of various Customer enrolled communication channels
Try It
Example responses
500 Response
{
"error": {
"code": "string",
"id": "string",
"text": "string"
}
}
Responses
Status | Description |
---|---|
200 | OK |
Successful response |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
getCustomerChangePass
Code samples
# You can also use wget
curl -X GET /fdobi/customer/change_pass \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
GET /fdobi/customer/change_pass HTTP/1.1
Accept: application/json; charset=ISO-8859-1
var headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/customer/change_pass',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/customer/change_pass',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.get '/fdobi/customer/change_pass',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.get('/fdobi/customer/change_pass', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/customer/change_pass");
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; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/fdobi/customer/change_pass", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /customer/change_pass
This operation returns the details for changing the customer password
Try It
Example responses
200 Response
{
"form": {
"attributeOrder": [
"string"
],
"attributes": {
"alert_text": "string",
"passcodeCurrent": {
"helpText": "string",
"label": "string",
"maxLength": "string",
"minLength": "string",
"required": true,
"type": "string"
},
"passcodeNew": {
"helpText": "string",
"label": "string",
"maxLength": "string",
"minLength": "string",
"required": true,
"type": "string"
},
"passcodeNewConfirm": {
"helpText": "string",
"label": "string",
"maxLength": "string",
"minLength": "string",
"required": true,
"type": "string"
}
}
},
"passcodeTips": [
"string"
],
"passcodeRequirements": {
"alpha_numeric_require": {
"text": "string",
"value": true
},
"boi_data": {
"text": "string",
"value": "string"
},
"case_sensitive": {
"text": "string",
"value": "string"
},
"minLength": {
"text": "string",
"value": 0
},
"passcode_history_age": {
"text": "string",
"value": "string"
},
"passcode_history_count": {
"text": "string",
"value": "string"
},
"same_accessId": {
"text": "string",
"value": "string"
},
"same_char_not_more_than_twice": {
"text": "string",
"value": true
},
"special_char_require": {
"text": "string",
"value": true
}
}
}
Responses
Status | Description |
---|---|
200 | OK |
A response containing a mixed-type form object, requirements, and tips. | |
Schema: customerChangePassGetResponse |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
putCustomerChangePass
Code samples
# You can also use wget
curl -X PUT /fdobi/customer/change_pass \
-H 'Content-Type: application/json' \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
PUT /fdobi/customer/change_pass HTTP/1.1
Content-Type: application/json
Accept: application/json; charset=ISO-8859-1
var headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/customer/change_pass',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const inputBody = '{
"passcodeCurrent": "string",
"passcodeNew": "string",
"passcodeNewConfirm": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/customer/change_pass',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.put '/fdobi/customer/change_pass',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.put('/fdobi/customer/change_pass', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/customer/change_pass");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "/fdobi/customer/change_pass", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /customer/change_pass
This operation actually updates customer password and the new password can be used to login OLB
Body parameter
{
"passcodeCurrent": "string",
"passcodeNew": "string",
"passcodeNewConfirm": "string"
}
passcodeCurrent: string
passcodeNew: string
passcodeNewConfirm: string
Parameters
Parameter | Description |
---|---|
body (body) |
customerChangePassPutRequest (required) Data necessary for put /customer/change_pass |
Try It
Example responses
500 Response
{
"error": {
"code": "string",
"id": "string",
"text": "string"
}
}
Responses
Status | Description |
---|---|
200 | OK |
Successful response |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
postCustomerChangePassVerifyCurrent
Code samples
# You can also use wget
curl -X POST /fdobi/customer/change_pass_verify_current \
-H 'Content-Type: application/json' \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
POST /fdobi/customer/change_pass_verify_current HTTP/1.1
Content-Type: application/json
Accept: application/json; charset=ISO-8859-1
var headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/customer/change_pass_verify_current',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const inputBody = '{
"passcodeCurrent": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/customer/change_pass_verify_current',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.post '/fdobi/customer/change_pass_verify_current',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.post('/fdobi/customer/change_pass_verify_current', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/customer/change_pass_verify_current");
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; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/fdobi/customer/change_pass_verify_current", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /customer/change_pass_verify_current
This operation validates the customer's current passcode without changing it.
Body parameter
{
"passcodeCurrent": "string"
}
passcodeCurrent: string
Parameters
Parameter | Description |
---|---|
body (body) |
customerChangePassVerifyCurrentPostRequest (required) Data necessary for post /customer/change_pass_verify_current |
Try It
Example responses
200 Response
{
"valid": true
}
Responses
Status | Description |
---|---|
200 | OK |
Successful response | |
Schema: Inline |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
Response Schema
Status Code 200
Property Name | Description |
---|---|
» valid | boolean If the passcode matched |
getDisclosureContextNameContextId
Code samples
# You can also use wget
curl -X GET /fdobi/disclosure/{contextName}/{contextId} \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
GET /fdobi/disclosure/{contextName}/{contextId} HTTP/1.1
Accept: application/json; charset=ISO-8859-1
var headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/disclosure/{contextName}/{contextId}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/disclosure/{contextName}/{contextId}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.get '/fdobi/disclosure/{contextName}/{contextId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.get('/fdobi/disclosure/{contextName}/{contextId}', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/disclosure/{contextName}/{contextId}");
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; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/fdobi/disclosure/{contextName}/{contextId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /disclosure/{contextName}/{contextId}
This operation returns the content of disclosure
Parameters
Parameter | Description |
---|---|
contextName (path) |
string (required) |
contextId (path) |
integer (required) |
Try It
Example responses
200 Response
{
"contentType": "string",
"content": "string",
"contentTransferEncoding": "string",
"contentTransferSize": 0,
"disclosureAcceptedDate": "string",
"disclosureRequired": 0
}
Responses
Status | Description |
---|---|
200 | OK |
Successful response | |
Schema: disclosureResponse |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
postDisclosureContextNameContextId
Code samples
# You can also use wget
curl -X POST /fdobi/disclosure/{contextName}/{contextId} \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
POST /fdobi/disclosure/{contextName}/{contextId} HTTP/1.1
Accept: application/json; charset=ISO-8859-1
var headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/disclosure/{contextName}/{contextId}',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/disclosure/{contextName}/{contextId}',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.post '/fdobi/disclosure/{contextName}/{contextId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.post('/fdobi/disclosure/{contextName}/{contextId}', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/disclosure/{contextName}/{contextId}");
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; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/fdobi/disclosure/{contextName}/{contextId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /disclosure/{contextName}/{contextId}
This operation actually sets read reciepient for particular disclosure based on contextName and contextId
Parameters
Parameter | Description |
---|---|
contextName (path) |
string (required) |
contextId (path) |
integer (required) |
Try It
Example responses
500 Response
{
"error": {
"code": "string",
"id": "string",
"text": "string"
}
}
Responses
Status | Description |
---|---|
200 | OK |
Successful response |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
getDisclosureContextName
Code samples
# You can also use wget
curl -X GET /fdobi/disclosure/{contextName} \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
GET /fdobi/disclosure/{contextName} HTTP/1.1
Accept: application/json; charset=ISO-8859-1
var headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/disclosure/{contextName}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/disclosure/{contextName}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.get '/fdobi/disclosure/{contextName}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.get('/fdobi/disclosure/{contextName}', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/disclosure/{contextName}");
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; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/fdobi/disclosure/{contextName}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /disclosure/{contextName}
This operation returns the content of disclosure
Parameters
Parameter | Description |
---|---|
contextName (path) |
string (required) |
Try It
Example responses
200 Response
{
"contentType": "string",
"content": "string",
"contentTransferEncoding": "string",
"contentTransferSize": 0,
"disclosureAcceptedDate": "string",
"disclosureRequired": 0
}
Responses
Status | Description |
---|---|
200 | OK |
Successful response | |
Schema: disclosureResponse |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
postDisclosureContextName
Code samples
# You can also use wget
curl -X POST /fdobi/disclosure/{contextName} \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
POST /fdobi/disclosure/{contextName} HTTP/1.1
Accept: application/json; charset=ISO-8859-1
var headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/disclosure/{contextName}',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/disclosure/{contextName}',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.post '/fdobi/disclosure/{contextName}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.post('/fdobi/disclosure/{contextName}', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/disclosure/{contextName}");
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; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/fdobi/disclosure/{contextName}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /disclosure/{contextName}
This operation actually sets read reciepient for particular disclosure based on contextName
Parameters
Parameter | Description |
---|---|
contextName (path) |
string (required) |
Try It
Example responses
500 Response
{
"error": {
"code": "string",
"id": "string",
"text": "string"
}
}
Responses
Status | Description |
---|---|
200 | OK |
Successful response |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
getFxwebPageDataOutsideAccounts
Code samples
# You can also use wget
curl -X GET /fdobi/fxweb/page_data/outsideAccounts \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
GET /fdobi/fxweb/page_data/outsideAccounts HTTP/1.1
Accept: application/json; charset=ISO-8859-1
var headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/fxweb/page_data/outsideAccounts',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/fxweb/page_data/outsideAccounts',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.get '/fdobi/fxweb/page_data/outsideAccounts',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.get('/fdobi/fxweb/page_data/outsideAccounts', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/fxweb/page_data/outsideAccounts");
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; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/fdobi/fxweb/page_data/outsideAccounts", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /fxweb/page_data/outsideAccounts
This Operation returns a list of outside accounts related custom texts based on FI configs
Try It
Example responses
200 Response
{
"oustsideAccountsCustomLinkTransferTxt": "string",
"oustsideAccountsCustomSeeTxt": "string",
"oustsideAccountsCustomSyncTxt": "string",
"oustsideAccountsCustomTransferTxt": "string",
"supportsOutsideAccounts": true
}
Responses
Status | Description |
---|---|
200 | OK |
Successful response | |
Schema: fxwebPageDataOutsideAccountsResponse |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
getFxwebPageDataDebitCardPreferences
Code samples
# You can also use wget
curl -X GET /fdobi/fxweb/page_data/debit_card_preferences \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
GET /fdobi/fxweb/page_data/debit_card_preferences HTTP/1.1
Accept: application/json; charset=ISO-8859-1
var headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/fxweb/page_data/debit_card_preferences',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/fxweb/page_data/debit_card_preferences',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.get '/fdobi/fxweb/page_data/debit_card_preferences',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.get('/fdobi/fxweb/page_data/debit_card_preferences', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/fxweb/page_data/debit_card_preferences");
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; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/fdobi/fxweb/page_data/debit_card_preferences", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /fxweb/page_data/debit_card_preferences
This Operation returns a list of debit card preferences related custom texts based on FI configs
Try It
Example responses
200 Response
{
"smsAddContent": "string",
"emailAddContent": "string",
"channelDeleteContent": "string",
"smsEditContent": "string",
"emailEditContent": "string",
"channelWarnAddContent": "string",
"channelWarnDeleteContent": "string",
"brokenAlertContent": "string",
"suspendedAlertContent": "string",
"suspendedControlContent": "string",
"vendorPlatform": "string",
"channelWarnEditContent": "string",
"smsDisclaimer": "string",
"stateCodes": [
{
"stateCode": "string",
"stateName": "string"
}
]
}
Responses
Status | Description |
---|---|
200 | OK |
Successful response | |
Schema: fxwebPageDataDebitCardPreferences |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
getFxwebPageDataTransfers
Code samples
# You can also use wget
curl -X GET /fdobi/fxweb/page_data/transfers \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
GET /fdobi/fxweb/page_data/transfers HTTP/1.1
Accept: application/json; charset=ISO-8859-1
var headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/fxweb/page_data/transfers',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/fxweb/page_data/transfers',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.get '/fdobi/fxweb/page_data/transfers',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.get('/fdobi/fxweb/page_data/transfers', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/fxweb/page_data/transfers");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/fdobi/fxweb/page_data/transfers", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /fxweb/page_data/transfers
This Operation returns a list of tansfers related custom texts based on FI configs
Try It
Example responses
200 Response
{
"principalInterestLinkContent": "string",
"loanPaymentContent": "string",
"principalInterestPageContent": "string",
"transferLoanHistoryContent": "string"
}
Responses
Status | Description |
---|---|
200 | OK |
Successful response | |
Schema: fxwebPageDataTransfers |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
postFxwebPageAudit
Code samples
# You can also use wget
curl -X POST /fdobi/fxweb/page_audit \
-H 'Content-Type: application/json' \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
POST /fdobi/fxweb/page_audit HTTP/1.1
Content-Type: application/json
Accept: application/json; charset=ISO-8859-1
var headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/fxweb/page_audit',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const inputBody = '{
"id": 0
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/fxweb/page_audit',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.post '/fdobi/fxweb/page_audit',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.post('/fdobi/fxweb/page_audit', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/fxweb/page_audit");
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; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/fdobi/fxweb/page_audit", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /fxweb/page_audit
Allows the caller to add a page audit that will show up in user activity reports, tracking customer page navigation/clicks
Body parameter
{
"id": 0
}
Parameters
Parameter | Description |
---|---|
body (body) |
pageAuditParams (required) The page audit post params |
Try It
Example responses
200 Response
{
"success": true
}
Responses
Status | Description |
---|---|
200 | OK |
Successful response | |
Schema: successfulResponse |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
getExternalAccountsDetails
Code samples
# You can also use wget
curl -X GET /fdobi/externalAccounts/details \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
GET /fdobi/externalAccounts/details HTTP/1.1
Accept: application/json; charset=ISO-8859-1
var headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/externalAccounts/details',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/externalAccounts/details',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.get '/fdobi/externalAccounts/details',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.get('/fdobi/externalAccounts/details', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/externalAccounts/details");
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; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/fdobi/externalAccounts/details", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /externalAccounts/details
This Operation returns a list of external accounts that the customer is authenticated to work with. If any of the can* parameters is specified, only external accounts that the customer has the specified privilege on will be returned.
Parameters
Parameter | Description |
---|---|
canBillpay (query) |
boolean This FDOBI Input Parameter/Output Label defines whether a customer has billpay privileges on a financial account. |
canTransferFrom (query) |
boolean This FDOBI Input Parameter/Output Label defines whether a customer has privileges to transfer from one financial account to other financial accounts for which that customer also has incoming transfer privileges. NOTE>> This FDOBI Input Parameter/Output Label is not the same as a wire transfer. |
canTransferTo (query) |
boolean This FDOBI Input Parameter/Output Label defines whether a customer has privileges to transfer funds to one financial account from other financial accounts for which that customer has outgoing transfer privileges. NOTE>> This FDOBI Input Parameter/Output Label is not the same as a wire transfer. |
canView (query) |
boolean This FDOBI Input Parameter/Output Label defines whether the customer has privileges to view a referenced financial account. |
numPerPage (query) |
integer This FDOBI Input Parameter/Output Label is the maximum number of response objects that can be returned in a single response; see the pageNum Input Parameter/Output Label for details about its associated functionality with this numPerPage Input Parameter/Output Label. |
pageNum (query) |
integer This FDOBI Input Parameter/Output Label specifies which page in a range of pages is desired. It defaults to 1; see the numPerPage Input Parameter/Output Label for details about its associated functionality with this pageNum Input Parameter/Output Label. |
Try It
Example responses
200 Response
{
"haveMore": true,
"accounts": [
{
"accDef": "string",
"accTypeDescription": "string",
"accId": 0,
"accNickname": "string",
"accNum": "string",
"accType": "string",
"accPrivs": {
"canBillpay": true,
"canMCD": true,
"canTransferFrom": true,
"canTransferTo": true,
"canView": true,
"canDebit": true,
"canCredit": true
},
"accDescription": "string",
"accOwner": "string",
"incomplete": true,
"isExternal": true,
"creditLimit": 0,
"debitLimit": 0,
"externalFiName": "string"
}
]
}
Responses
Status | Description |
---|---|
200 | OK |
Successful response | |
Schema: externalAccountsResponse |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
getAccountsAccIdStatements
Code samples
# You can also use wget
curl -X GET /fdobi/accounts/{accId}/statements \
-H 'Content-Type: application/json' \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
GET /fdobi/accounts/{accId}/statements HTTP/1.1
Content-Type: application/json
Accept: application/json; charset=ISO-8859-1
var headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/accounts/{accId}/statements',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const inputBody = '{
"accId": "string",
"dateStart": "2019-08-24",
"dateEnd": "2019-08-24"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/accounts/{accId}/statements',
{
method: 'GET',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.get '/fdobi/accounts/{accId}/statements',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.get('/fdobi/accounts/{accId}/statements', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/accounts/{accId}/statements");
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{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/fdobi/accounts/{accId}/statements", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /accounts/{accId}/statements
"This operation returns the list of the estatements for a given date range
- dateEnd=yyyy-mm-dd The end date (old date) from where estatement to be queried
- dateStart=yyyy-mm-dd The start date (new date) till where estatements to be queried."
Body parameter
{
"accId": "string",
"dateStart": "2019-08-24",
"dateEnd": "2019-08-24"
}
Parameters
Parameter | Description |
---|---|
accId (path) |
string (required) |
body (body) |
accountsAccIdStatementsGetRequest (required) Data necessary for get /accounts/{accId}/statements |
Try It
Example responses
200 Response
{
"docList": [
{
"docId": "string",
"accNum": "string",
"accId": "string",
"docType": "string",
"docLink": "string",
"docMethod": "string",
"docParams": [
{
"key": "string",
"value": "string"
}
],
"dateRcv": "string",
"accName": "string",
"label": "string"
}
]
}
Responses
Status | Description |
---|---|
200 | OK |
Successful response | |
Schema: estatementListResponse |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
getAccountsAch
Code samples
# You can also use wget
curl -X GET /fdobi/accounts/ach?transactionType=credit&secCode=arc \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
GET /fdobi/accounts/ach?transactionType=credit&secCode=arc HTTP/1.1
Accept: application/json; charset=ISO-8859-1
var headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/accounts/ach',
method: 'get',
data: '?transactionType=credit&secCode=arc',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/accounts/ach?transactionType=credit&secCode=arc',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.get '/fdobi/accounts/ach',
params: {
'transactionType' => 'string',
'secCode' => 'string'
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.get('/fdobi/accounts/ach', params={
'transactionType': 'credit', 'secCode': 'arc'
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/accounts/ach?transactionType=credit&secCode=arc");
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; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/fdobi/accounts/ach", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /accounts/ach
This Operation returns a list of ach accounts that the customer is authenticated to work based on that the customer has some ach priviliege on each account. A specific sec code and transaction type parameter should be specified and only ach accounts that the customer has those privs on will be returned. If the focusCustId is specified then we get only accounts the customer has authorization to do things on on behalf of that specific customer(focusCustId) You can also filter on the accounts based on the privs(view/create/approve/approveOther), if no filter is selected then no filtering is done If a batchId is passed in.. we will try and relate the ach account list with the account currently set on the passed in batch, This is usually done when a batch has an account set with a certain risk level.. then the FI changes the risk level on the account (from float to normal.. etc..) and now the batch has an inaccurate risk level for that account/batch. If a batchId is passed in and this is the case, then duplicate accounts will appear in the response with different risk levels and the account that is currently set on the batch will be marked as currrently selected account.
Parameters
Parameter | Description |
---|---|
focusCustId (query) |
integer |
batchId (query) |
integer |
transactionType (query) |
string (required) The type of transaction related to the ach privilege associated between the customer and this account(credit/debit/import/import_mixed) Enumerated values: credit debit import import_mixed |
secCode (query) |
string (required) The standard entry class code related to the ach privilege associated between the customer and this account(ppd/ccd/ctx/...) Enumerated values: arc boc ccd cie ctx pop ppd rck tel web |
canView (query) |
boolean Filter for only accounts that the customer has view privileges on. |
canApprove (query) |
boolean Filter for only accounts that the customer has approve privileges on. |
canApproveOther (query) |
boolean Filter for only accounts that the customer has approve other privileges on. |
canCreate (query) |
boolean Filter for only accounts that the customer has create privileges on. |
Try It
Example responses
200 Response
{
"accounts": [
{
"accDescription": "string",
"accId": 0,
"accountRiskLevel": 0,
"isCurrentlySelectedAccountOnTheBatch": true,
"accPrivs": {
"canApprove": true,
"canApproveOther": true,
"canCreate": true,
"canView": true,
"canViewBalance": true
}
}
]
}
Successful response, both with batchId passed in and without batchId, with different risk level and currently selected flag
unexpected error
Responses
Status | Description |
---|---|
200 | OK |
Successful response, both with batchId passed in and without batchId, with different risk level and currently selected flag | |
Schema: accountsAchResponse |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
getAccounts
Code samples
# You can also use wget
curl -X GET /fdobi/accounts \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
GET /fdobi/accounts HTTP/1.1
Accept: application/json; charset=ISO-8859-1
var headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/accounts',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/accounts',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.get '/fdobi/accounts',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.get('/fdobi/accounts', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/accounts");
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; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/fdobi/accounts", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /accounts
This Operation returns a list of accounts that the customer is authenticated to work with. If any of the can* parameters is specified, only accounts that the customer has the specified privilege on will be returned.
Parameters
Parameter | Description |
---|---|
canBillpay (query) |
boolean This FDOBI Input Parameter/Output Label defines whether a customer has billpay privileges on a financial account. |
canEstatements (query) |
boolean This lets the caller filter down accouts that hassupports estatemnts. |
canTransferFrom (query) |
boolean This FDOBI Input Parameter/Output Label defines whether a customer has privileges to transfer from one financial account to other financial accounts for which that customer also has incoming transfer privileges. NOTE>> This FDOBI Input Parameter/Output Label is not the same as a wire transfer. |
canTransferTo (query) |
boolean This FDOBI Input Parameter/Output Label defines whether a customer has privileges to transfer funds to one financial account from other financial accounts for which that customer has outgoing transfer privileges. NOTE>> This FDOBI Input Parameter/Output Label is not the same as a wire transfer. |
canView (query) |
boolean This FDOBI Input Parameter/Output Label defines whether the customer has privileges to view a referenced financial account. |
numPerPage (query) |
integer This FDOBI Input Parameter/Output Label is the maximum number of response objects that can be returned in a single response; see the pageNum Input Parameter/Output Label for details about its associated functionality with this numPerPage Input Parameter/Output Label. |
pageNum (query) |
integer This FDOBI Input Parameter/Output Label specifies which page in a range of pages is desired. It defaults to 1; see the numPerPage Input Parameter/Output Label for details about its associated functionality with this pageNum Input Parameter/Output Label. |
Try It
Example responses
200 Response
{
"haveMore": true,
"accounts": [
{
"accDef": "string",
"accTypeDescription": "string",
"accId": 0,
"accNickname": "string",
"accNum": "string",
"accType": "string",
"accPrivs": {
"canBillpay": true,
"canEstatements": true,
"canMCD": true,
"canTransferFrom": true,
"canTransferTo": true,
"canView": true
},
"accDescription": "string",
"accOwner": "string",
"incomplete": true,
"isExternal": true,
"primaryDisplayAccount": 0,
"productDescription": "string"
}
]
}
Responses
Status | Description |
---|---|
200 | OK |
Successful response | |
Schema: accountsResponse |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
getAccountsDetails
Code samples
# You can also use wget
curl -X GET /fdobi/accounts/details \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
GET /fdobi/accounts/details HTTP/1.1
Accept: application/json; charset=ISO-8859-1
var headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/accounts/details',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/accounts/details',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.get '/fdobi/accounts/details',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.get('/fdobi/accounts/details', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/accounts/details");
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; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/fdobi/accounts/details", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /accounts/details
This Operation returns a list of details about accounts.
Parameters
Parameter | Description |
---|---|
accIds (query) |
array[integer] This FDOBI Input Parameter/Output Label defines specific accounts to get details for |
canBillpay (query) |
boolean This FDOBI Input Parameter/Output Label defines whether a customer has billpay privileges on a financial account. |
canTransferFrom (query) |
boolean This FDOBI Input Parameter/Output Label defines whether a customer has privileges to transfer from one financial account to other financial accounts for which that customer also has incoming transfer privileges. NOTE>> This FDOBI Input Parameter/Output Label is not the same as a wire transfer. |
canTransferTo (query) |
boolean This FDOBI Input Parameter/Output Label defines whether a customer has privileges to transfer funds to one financial account from other financial accounts for which that customer has outgoing transfer privileges. NOTE>> This FDOBI Input Parameter/Output Label is not the same as a wire transfer. |
canView (query) |
boolean This FDOBI Input Parameter/Output Label defines whether the customer has privileges to view a referenced financial account. |
numPerPage (query) |
integer This FDOBI Input Parameter/Output Label is the maximum number of response objects that can be returned in a single response; see the pageNum Input Parameter/Output Label for details about its associated functionality with this numPerPage Input Parameter/Output Label. |
pageNum (query) |
integer This FDOBI Input Parameter/Output Label specifies which page in a range of pages is desired. It defaults to 1; see the numPerPage Input Parameter/Output Label for details about its associated functionality with this pageNum Input Parameter/Output Label. |
Try It
Example responses
200 Response
{
"incomplete": true,
"haveMore": true,
"accountsDetails": [
{
"accId": 0,
"accDef": "string",
"accDescription": "string",
"accNickname": "string",
"accNum": "string",
"accDisplayNum": "string",
"accOwner": "string",
"accType": "string",
"accTypeDescription": "string",
"amtNextPymt": 0,
"amtPastDue": 0,
"amtPayoff": 0,
"apr": 0,
"balAsOf": "2019-08-24",
"balAsOfDescription": "2019-08-24",
"balAdjustment": 0,
"balAvailable": 0,
"balCurrent": 0,
"cashAdvanceApr": 0,
"creditLimit": 0,
"dateMaturity": "2019-08-24",
"dateNextPymt": "2019-08-24",
"dateOpened": "2019-08-24",
"incomplete": true,
"isExternal": true,
"itrAccrued": 0,
"itrPriorYear": 0,
"itrRate": 0,
"itrYtd": 0,
"monthsPastDue": 0,
"origLoanAmt": "string",
"overdraftLimit": 0,
"productDescription": "string",
"termOfAcct": "string",
"primaryDisplayAccount": 0,
"balDetails": {
"balAsOf": "2019-08-24",
"balAsOfDescription": "2019-08-24",
"balAdjustment": 0,
"balAvailable": 0,
"balCurrent": 0
},
"accPrivs": {
"canBillpay": true,
"canEstatements": true,
"canMCD": true,
"canTransferFrom": true,
"canTransferTo": true,
"canView": true
},
"accDefNum": 0
}
]
}
Responses
Status | Description |
---|---|
200 | OK |
Successful response | |
Schema: accountsDetailsResponse |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
getAccountsAccIdDebitCards
Code samples
# You can also use wget
curl -X GET /fdobi/accounts/{accId}/debit_cards \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
GET /fdobi/accounts/{accId}/debit_cards HTTP/1.1
Accept: application/json; charset=ISO-8859-1
var headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/accounts/{accId}/debit_cards',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/accounts/{accId}/debit_cards',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.get '/fdobi/accounts/{accId}/debit_cards',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.get('/fdobi/accounts/{accId}/debit_cards', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/accounts/{accId}/debit_cards");
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; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/fdobi/accounts/{accId}/debit_cards", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /accounts/{accId}/debit_cards
This operation gets the list of debit cards associated with the specified account.
Parameters
Parameter | Description |
---|---|
accId (path) |
integer (required) The unique identifier (aka, the "thingy") associated with the account. |
Try It
Example responses
200 Response
{
"accessibleByMultipleUsers": true,
"accessibleByMultipleUsersToolTip": "string",
"accountSourceId": 0,
"cardDetails": [
{
"debitCardId": "string",
"maskCardNum": "string",
"name": "string",
"replacementRequested": true,
"status": "string",
"statusChangeTime": "string",
"statusChangeTimeDesc": "string",
"statusChangedBySessionCustomer": true,
"statusChangerName": "string",
"statusDescription": "string",
"bankIdentificationNum": "string",
"cardImageFilename": "string"
}
]
}
Responses
Status | Description |
---|---|
200 | OK |
Successful response | |
Schema: accountDebitCardsResponse |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
getAccountsAccIdDebitCardsCardId
Code samples
# You can also use wget
curl -X GET /fdobi/accounts/{accId}/debit_cards/{cardId} \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
GET /fdobi/accounts/{accId}/debit_cards/{cardId} HTTP/1.1
Accept: application/json; charset=ISO-8859-1
var headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/accounts/{accId}/debit_cards/{cardId}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/accounts/{accId}/debit_cards/{cardId}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.get '/fdobi/accounts/{accId}/debit_cards/{cardId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.get('/fdobi/accounts/{accId}/debit_cards/{cardId}', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/accounts/{accId}/debit_cards/{cardId}");
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; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/fdobi/accounts/{accId}/debit_cards/{cardId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /accounts/{accId}/debit_cards/{cardId}
This operation gets the details about a particular debit card.
Parameters
Parameter | Description |
---|---|
accId (path) |
integer (required) The unique identifier (aka, the "thingy") associated with the account. |
cardId (path) |
integer (required) The unique identifier (aka, the "card thingy") associated with the debit card. |
Try It
Example responses
200 Response
{
"cardDetails": {
"debitCardId": "string",
"maskCardNum": "string",
"name": "string",
"replacementRequested": true,
"status": "string",
"statusChangeTime": "string",
"statusChangeTimeDesc": "string",
"statusChangedBySessionCustomer": true,
"statusChangerName": "string",
"statusDescription": "string",
"bankIdentificationNum": "string",
"cardImageFilename": "string"
}
}
Responses
Status | Description |
---|---|
200 | OK |
Successful response | |
Schema: accountDebitCardResponse |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
putAccountsAccIdDebitCardsCardId
Code samples
# You can also use wget
curl -X PUT /fdobi/accounts/{accId}/debit_cards/{cardId} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'X-XSRF-TOKEN: API_KEY'
PUT /fdobi/accounts/{accId}/debit_cards/{cardId} HTTP/1.1
Content-Type: application/json
Accept: application/json; charset=ISO-8859-1
var headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN':'API_KEY'
};
$.ajax({
url: '/fdobi/accounts/{accId}/debit_cards/{cardId}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const inputBody = '{
"accId": 0,
"addressType": "permanent",
"address1": "string",
"address2": "string",
"cardId": 0,
"city": "string",
"postalCode": "string",
"replaceType": "expedite",
"stateProvince": "string",
"additionalAuthReplaceContent": "string",
"status": "active"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN':'API_KEY'
};
fetch('/fdobi/accounts/{accId}/debit_cards/{cardId}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN' => 'API_KEY'
}
result = RestClient.put '/fdobi/accounts/{accId}/debit_cards/{cardId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN': 'API_KEY'
}
r = requests.put('/fdobi/accounts/{accId}/debit_cards/{cardId}', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/accounts/{accId}/debit_cards/{cardId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json; charset=ISO-8859-1"},
"X-XSRF-TOKEN": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "/fdobi/accounts/{accId}/debit_cards/{cardId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /accounts/{accId}/debit_cards/{cardId}
This operation updates the status, and optionally the address, of a debit card associated with an account. (This should be used for REPLACE CARD ONLY).
Body parameter
{
"accId": 0,
"addressType": "permanent",
"address1": "string",
"address2": "string",
"cardId": 0,
"city": "string",
"postalCode": "string",
"replaceType": "expedite",
"stateProvince": "string",
"additionalAuthReplaceContent": "string",
"status": "active"
}
accId: 0
addressType: permanent
address1: string
address2: string
cardId: 0
city: string
postalCode: string
replaceType: expedite
stateProvince: string
additionalAuthReplaceContent: string
status: active
Parameters
Parameter | Description |
---|---|
accId (path) |
integer (required) The unique identifier (aka, the "thingy") associated with the account. |
addressType (query) |
string This indicates if the customer has requested an address change, and indicates the type of change. Allowed values for type are "permanent" (a permanent change of address should be registered for the card), "temporary" (a replacement card should be sent to a temporary (e.g., vacation) address), or "manual" (the customer will contact the FI directly to change the address on the card). If specified as "permanent" or "temporary", address parameters must be provided. Enumerated values: permanent temporary manual |
cardId (path) |
integer (required) The unique identifier (aka, the "card thingy") associated with the debit card. |
body (body) |
accountsAccIdDebitCardsCardIdPutRequest (required) Data necessary for put /accounts/{accId}/debit_cards/{cardId} |
Try It
Example responses
200 Response
{
"cardDetails": {
"debitCardId": "string",
"maskCardNum": "string",
"name": "string",
"replacementRequested": true,
"status": "string",
"statusChangeTime": "string",
"statusChangeTimeDesc": "string",
"statusChangedBySessionCustomer": true,
"statusChangerName": "string",
"statusDescription": "string",
"bankIdentificationNum": "string",
"cardImageFilename": "string"
}
}
Responses
Status | Description |
---|---|
200 | OK |
Successful response | |
Schema: accountDebitCardUpdateResponse |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
postAccountsAccIdDebitCardsCardId
Code samples
# You can also use wget
curl -X POST /fdobi/accounts/{accId}/debit_cards/{cardId} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'X-XSRF-TOKEN: API_KEY'
POST /fdobi/accounts/{accId}/debit_cards/{cardId} HTTP/1.1
Content-Type: application/json
Accept: application/json; charset=ISO-8859-1
var headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN':'API_KEY'
};
$.ajax({
url: '/fdobi/accounts/{accId}/debit_cards/{cardId}',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const inputBody = '{
"accId": 0,
"cardId": 0,
"status": "active"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN':'API_KEY'
};
fetch('/fdobi/accounts/{accId}/debit_cards/{cardId}',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN' => 'API_KEY'
}
result = RestClient.post '/fdobi/accounts/{accId}/debit_cards/{cardId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN': 'API_KEY'
}
r = requests.post('/fdobi/accounts/{accId}/debit_cards/{cardId}', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/accounts/{accId}/debit_cards/{cardId}");
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; charset=ISO-8859-1"},
"X-XSRF-TOKEN": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/fdobi/accounts/{accId}/debit_cards/{cardId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /accounts/{accId}/debit_cards/{cardId}
This operation updates the status of a debit card associated with an account. This is used for temporarily turn ON/OFF the CARD only.
Body parameter
{
"accId": 0,
"cardId": 0,
"status": "active"
}
accId: 0
cardId: 0
status: active
Parameters
Parameter | Description |
---|---|
accId (path) |
integer (required) The unique identifier (aka, the "thingy") associated with the account. |
cardId (path) |
integer (required) The unique identifier (aka, the "card thingy") associated with the debit card. |
body (body) |
accountsAccIdDebitCardsCardIdPostRequest (required) Data necessary for post /accounts/{accId}/debit_cards/{cardId} |
Try It
Example responses
200 Response
{
"cardDetails": {
"debitCardId": "string",
"maskCardNum": "string",
"name": "string",
"replacementRequested": true,
"status": "string",
"statusChangeTime": "string",
"statusChangeTimeDesc": "string",
"statusChangedBySessionCustomer": true,
"statusChangerName": "string",
"statusDescription": "string",
"bankIdentificationNum": "string",
"cardImageFilename": "string"
}
}
Responses
Status | Description |
---|---|
200 | OK |
Successful response | |
Schema: accountDebitCardUpdateResponse |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
getAccountsAccIdDebitCardsCardIdPreferences
Code samples
# You can also use wget
curl -X GET /fdobi/accounts/{accId}/debit_cards/{cardId}/preferences \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
GET /fdobi/accounts/{accId}/debit_cards/{cardId}/preferences HTTP/1.1
Accept: application/json; charset=ISO-8859-1
var headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/accounts/{accId}/debit_cards/{cardId}/preferences',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/accounts/{accId}/debit_cards/{cardId}/preferences',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.get '/fdobi/accounts/{accId}/debit_cards/{cardId}/preferences',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.get('/fdobi/accounts/{accId}/debit_cards/{cardId}/preferences', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/accounts/{accId}/debit_cards/{cardId}/preferences");
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; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/fdobi/accounts/{accId}/debit_cards/{cardId}/preferences", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /accounts/{accId}/debit_cards/{cardId}/preferences
This operation gets the details and preferences(alerts and controls) about a particular debit card.
Parameters
Parameter | Description |
---|---|
accId (path) |
integer (required) The unique identifier (aka, the "thingy") associated with the account. |
cardId (path) |
integer (required) The unique identifier (aka, the "card thingy") associated with the debit card. |
Try It
Example responses
200 Response
{
"cardDetails": {
"debitCardId": "string",
"maskCardNum": "string",
"name": "string",
"replacementRequested": true,
"status": "string",
"statusChangeTime": "string",
"statusChangeTimeDesc": "string",
"statusChangedBySessionCustomer": true,
"statusChangerName": "string",
"statusDescription": "string",
"bankIdentificationNum": "string",
"cardImageFilename": "string"
},
"cardPreferences": {
"preferences": [
{
"status": "ACTIVATED",
"preferenceId": "string",
"caption": "string",
"description": "string",
"preferenceType": "ALERT",
"thresholds": [
{
"thresholdId": "string",
"name": "string",
"value": "string",
"required": "REQUIRED",
"caption": "string",
"dataType": "string",
"regexp": "string",
"sequence": "string"
}
],
"channels": [
{
"sequence": "string",
"status": "ACTIVATED",
"mode": "EMAIL",
"address": "string",
"language": "EN",
"permission": "Y",
"description": "string"
}
]
}
],
"channels": [
{
"sequence": "string",
"recentlyActivated": "True",
"status": "ACTIVATED",
"mode": "EMAIL",
"address": "string",
"language": "EN",
"permission": "Y",
"description": "string"
}
]
},
"customerContactDetails": {
"emailAddress1": "string",
"emailAddress2": "string",
"smsPhoneNumber": "string"
},
"accessibleByMultipleUsers": true,
"accessibleByMultipleUsersToolTip": "string"
}
Responses
Status | Description |
---|---|
200 | OK |
Successful response | |
Schema: accountDebitCardPreferencesResponse |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
putAccountsAccIdDebitCardsCardIdPreferences
Code samples
# You can also use wget
curl -X PUT /fdobi/accounts/{accId}/debit_cards/{cardId}/preferences \
-H 'Content-Type: application/json' \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
PUT /fdobi/accounts/{accId}/debit_cards/{cardId}/preferences HTTP/1.1
Content-Type: application/json
Accept: application/json; charset=ISO-8859-1
var headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/accounts/{accId}/debit_cards/{cardId}/preferences',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const inputBody = '{
"accId": 0,
"cardId": 0,
"preferenceId": "string",
"status": "ACTIVATED",
"threshold1Id": "string",
"threshold1": "string",
"threshold2Id": "string",
"threshold2": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"address4": "string",
"address5": "string",
"mode1": "EMAIL",
"mode2": "EMAIL",
"mode3": "EMAIL",
"mode4": "EMAIL",
"mode5": "EMAIL",
"action1": "ADD",
"action2": "ADD",
"action3": "ADD",
"action4": "ADD",
"action5": "ADD",
"sequence1": 0,
"sequence2": 0,
"sequence3": 0,
"sequence4": 0,
"sequence5": 0
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/accounts/{accId}/debit_cards/{cardId}/preferences',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.put '/fdobi/accounts/{accId}/debit_cards/{cardId}/preferences',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.put('/fdobi/accounts/{accId}/debit_cards/{cardId}/preferences', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/accounts/{accId}/debit_cards/{cardId}/preferences");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "/fdobi/accounts/{accId}/debit_cards/{cardId}/preferences", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /accounts/{accId}/debit_cards/{cardId}/preferences
This operation sets the preferences(alerts and controls) of a particular debit card.
Body parameter
{
"accId": 0,
"cardId": 0,
"preferenceId": "string",
"status": "ACTIVATED",
"threshold1Id": "string",
"threshold1": "string",
"threshold2Id": "string",
"threshold2": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"address4": "string",
"address5": "string",
"mode1": "EMAIL",
"mode2": "EMAIL",
"mode3": "EMAIL",
"mode4": "EMAIL",
"mode5": "EMAIL",
"action1": "ADD",
"action2": "ADD",
"action3": "ADD",
"action4": "ADD",
"action5": "ADD",
"sequence1": 0,
"sequence2": 0,
"sequence3": 0,
"sequence4": 0,
"sequence5": 0
}
Parameters
Parameter | Description |
---|---|
accId (path) |
integer (required) The unique identifier (aka, the "thingy") associated with the account. |
cardId (path) |
integer (required) The unique identifier (aka, the "card thingy") associated with the debit card. |
body (body) |
accountsAccIdDebitCardsCardIdPreferencesPutRequest (required) Data necessary for put /accounts/{accId}/debit_cards/{cardId}/preferences |
Try It
Example responses
500 Response
{
"error": {
"code": "string",
"id": "string",
"text": "string"
}
}
Responses
Status | Description |
---|---|
200 | OK |
Successful response |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
postAccountsAccIdDebitCardsCardIdReenrollChannelPreferences
Code samples
# You can also use wget
curl -X POST /fdobi/accounts/{accId}/debit_cards/{cardId}/reenroll_channel_preferences \
-H 'Content-Type: application/json' \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
POST /fdobi/accounts/{accId}/debit_cards/{cardId}/reenroll_channel_preferences HTTP/1.1
Content-Type: application/json
Accept: application/json; charset=ISO-8859-1
var headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/accounts/{accId}/debit_cards/{cardId}/reenroll_channel_preferences',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const inputBody = '{
"accId": 0,
"cardId": 0,
"address": "string",
"sequence": 0,
"mode": "EMAIL"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/accounts/{accId}/debit_cards/{cardId}/reenroll_channel_preferences',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.post '/fdobi/accounts/{accId}/debit_cards/{cardId}/reenroll_channel_preferences',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.post('/fdobi/accounts/{accId}/debit_cards/{cardId}/reenroll_channel_preferences', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/accounts/{accId}/debit_cards/{cardId}/reenroll_channel_preferences");
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; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/fdobi/accounts/{accId}/debit_cards/{cardId}/reenroll_channel_preferences", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /accounts/{accId}/debit_cards/{cardId}/reenroll_channel_preferences
This operation reenrolls the channel of a particular debit card.
Body parameter
{
"accId": 0,
"cardId": 0,
"address": "string",
"sequence": 0,
"mode": "EMAIL"
}
Parameters
Parameter | Description |
---|---|
accId (path) |
integer (required) The unique identifier (aka, the "thingy") associated with the account. |
cardId (path) |
integer (required) The unique identifier (aka, the "card thingy") associated with the debit card. |
body (body) |
accountsAccIdDebitCardsCardIdReenrollChannelPreferencesPostRequest (required) Data necessary for post /accounts/{accId}/debit_cards/{cardId}/reenroll_channel_preferences |
Try It
Example responses
500 Response
{
"error": {
"code": "string",
"id": "string",
"text": "string"
}
}
Responses
Status | Description |
---|---|
200 | OK |
Successful response |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
putAccountsAccIdDebitCardsCardIdPreferencesChannel
Code samples
# You can also use wget
curl -X PUT /fdobi/accounts/{accId}/debit_cards/{cardId}/preferences_channel \
-H 'Content-Type: application/json' \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
PUT /fdobi/accounts/{accId}/debit_cards/{cardId}/preferences_channel HTTP/1.1
Content-Type: application/json
Accept: application/json; charset=ISO-8859-1
var headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/accounts/{accId}/debit_cards/{cardId}/preferences_channel',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const inputBody = '{
"accId": 0,
"cardId": 0,
"address": "string",
"sequence": 0,
"mode": "EMAIL"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/accounts/{accId}/debit_cards/{cardId}/preferences_channel',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.put '/fdobi/accounts/{accId}/debit_cards/{cardId}/preferences_channel',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.put('/fdobi/accounts/{accId}/debit_cards/{cardId}/preferences_channel', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/accounts/{accId}/debit_cards/{cardId}/preferences_channel");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "/fdobi/accounts/{accId}/debit_cards/{cardId}/preferences_channel", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /accounts/{accId}/debit_cards/{cardId}/preferences_channel
This operation adds the default channel of preferences(alerts and controls) of a particular debit card.
Body parameter
{
"accId": 0,
"cardId": 0,
"address": "string",
"sequence": 0,
"mode": "EMAIL"
}
Parameters
Parameter | Description |
---|---|
accId (path) |
integer (required) The unique identifier (aka, the "thingy") associated with the account. |
cardId (path) |
integer (required) The unique identifier (aka, the "card thingy") associated with the debit card. |
body (body) |
accountsAccIdDebitCardsCardIdPreferencesChannelPutRequest (required) Data necessary for put /accounts/{accId}/debit_cards/{cardId}/preferences_channel |
Try It
Example responses
500 Response
{
"error": {
"code": "string",
"id": "string",
"text": "string"
}
}
Responses
Status | Description |
---|---|
200 | OK |
Successful response |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
postAccountsAccIdDebitCardsCardIdPreferencesChannel
Code samples
# You can also use wget
curl -X POST /fdobi/accounts/{accId}/debit_cards/{cardId}/preferences_channel \
-H 'Content-Type: application/json' \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
POST /fdobi/accounts/{accId}/debit_cards/{cardId}/preferences_channel HTTP/1.1
Content-Type: application/json
Accept: application/json; charset=ISO-8859-1
var headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/accounts/{accId}/debit_cards/{cardId}/preferences_channel',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const inputBody = '{
"accId": 0,
"cardId": 0,
"sequence": "string",
"address": "string",
"mode": "EMAIL",
"newSequence": "string",
"newAddress": "string",
"newMode": "EMAIL"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/accounts/{accId}/debit_cards/{cardId}/preferences_channel',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.post '/fdobi/accounts/{accId}/debit_cards/{cardId}/preferences_channel',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.post('/fdobi/accounts/{accId}/debit_cards/{cardId}/preferences_channel', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/accounts/{accId}/debit_cards/{cardId}/preferences_channel");
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; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/fdobi/accounts/{accId}/debit_cards/{cardId}/preferences_channel", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /accounts/{accId}/debit_cards/{cardId}/preferences_channel
This operation sets the default channel of preferences(alerts and controls) of a particular debit card.
Body parameter
{
"accId": 0,
"cardId": 0,
"sequence": "string",
"address": "string",
"mode": "EMAIL",
"newSequence": "string",
"newAddress": "string",
"newMode": "EMAIL"
}
Parameters
Parameter | Description |
---|---|
accId (path) |
integer (required) The unique identifier (aka, the "thingy") associated with the account. |
cardId (path) |
integer (required) The unique identifier (aka, the "card thingy") associated with the debit card. |
body (body) |
accountsAccIdDebitCardsCardIdPreferencesChannelPostRequest (required) Data necessary for post /accounts/{accId}/debit_cards/{cardId}/preferences_channel |
Try It
Example responses
500 Response
{
"error": {
"code": "string",
"id": "string",
"text": "string"
}
}
Responses
Status | Description |
---|---|
200 | OK |
Successful response |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
postAccountsAccIdDebitCardsCardIdDeletePreferencesChannel
Code samples
# You can also use wget
curl -X POST /fdobi/accounts/{accId}/debit_cards/{cardId}/delete_preferences_channel \
-H 'Content-Type: application/json' \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
POST /fdobi/accounts/{accId}/debit_cards/{cardId}/delete_preferences_channel HTTP/1.1
Content-Type: application/json
Accept: application/json; charset=ISO-8859-1
var headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/accounts/{accId}/debit_cards/{cardId}/delete_preferences_channel',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const inputBody = '{
"accId": 0,
"cardId": 0,
"sequence": 0,
"address": "string",
"mode": "EMAIL"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/accounts/{accId}/debit_cards/{cardId}/delete_preferences_channel',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.post '/fdobi/accounts/{accId}/debit_cards/{cardId}/delete_preferences_channel',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.post('/fdobi/accounts/{accId}/debit_cards/{cardId}/delete_preferences_channel', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/accounts/{accId}/debit_cards/{cardId}/delete_preferences_channel");
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; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/fdobi/accounts/{accId}/debit_cards/{cardId}/delete_preferences_channel", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /accounts/{accId}/debit_cards/{cardId}/delete_preferences_channel
This operation deletes the default channel of preferences(alerts and controls) of a particular debit card.
Body parameter
{
"accId": 0,
"cardId": 0,
"sequence": 0,
"address": "string",
"mode": "EMAIL"
}
Parameters
Parameter | Description |
---|---|
accId (path) |
integer (required) The unique identifier (aka, the "thingy") associated with the account. |
cardId (path) |
integer (required) The unique identifier (aka, the "card thingy") associated with the debit card. |
body (body) |
accountsAccIdDebitCardsCardIdDeletePreferencesChannelPostRequest (required) Data necessary for post /accounts/{accId}/debit_cards/{cardId}/delete_preferences_channel |
Try It
Example responses
500 Response
{
"error": {
"code": "string",
"id": "string",
"text": "string"
}
}
Responses
Status | Description |
---|---|
200 | OK |
Successful response |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
postAccountsAccIdCardsVendorCardIdNotification
Code samples
# You can also use wget
curl -X POST /fdobi/accounts/{accId}/cards/{vendorCardId}/notification \
-H 'Content-Type: application/json' \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
POST /fdobi/accounts/{accId}/cards/{vendorCardId}/notification HTTP/1.1
Content-Type: application/json
Accept: application/json; charset=ISO-8859-1
var headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/accounts/{accId}/cards/{vendorCardId}/notification',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const inputBody = '{
"message": "string",
"sourceTransactionId": 0,
"subscriberReferenceId": 0,
"transactionStatus": 0,
"transactionStatusCode": "string",
"transactionType": "departmentStore",
"transactionTypeCode": 0,
"cardMask": "string",
"accountMask": "string",
"amount": 0,
"currencyCode": 0,
"currencySymbol": "string",
"merchantType": "inStore",
"merchantTypeCode": "string",
"merchantName": "string",
"merchantCity": "string",
"merchantStateCode": "string",
"merchantState": "string",
"merchantCountryCode": "string",
"merchantCountry": "string",
"merchantPostalCode": 0,
"transactionTime": 0,
"postedTime": 0,
"reversalTime": 0,
"transactionAlertBitmap": 0,
"isAgentRecommendationReason": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/accounts/{accId}/cards/{vendorCardId}/notification',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.post '/fdobi/accounts/{accId}/cards/{vendorCardId}/notification',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.post('/fdobi/accounts/{accId}/cards/{vendorCardId}/notification', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/accounts/{accId}/cards/{vendorCardId}/notification");
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; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/fdobi/accounts/{accId}/cards/{vendorCardId}/notification", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /accounts/{accId}/cards/{vendorCardId}/notification
This operation returns status of the notification
Body parameter
{
"message": "string",
"sourceTransactionId": 0,
"subscriberReferenceId": 0,
"transactionStatus": 0,
"transactionStatusCode": "string",
"transactionType": "departmentStore",
"transactionTypeCode": 0,
"cardMask": "string",
"accountMask": "string",
"amount": 0,
"currencyCode": 0,
"currencySymbol": "string",
"merchantType": "inStore",
"merchantTypeCode": "string",
"merchantName": "string",
"merchantCity": "string",
"merchantStateCode": "string",
"merchantState": "string",
"merchantCountryCode": "string",
"merchantCountry": "string",
"merchantPostalCode": 0,
"transactionTime": 0,
"postedTime": 0,
"reversalTime": 0,
"transactionAlertBitmap": 0,
"isAgentRecommendationReason": "string"
}
Parameters
Parameter | Description |
---|---|
accId (path) |
integer (required) The unique identifier (aka, the "thingy") associated with the account. |
vendorCardId (path) |
string (required) The unique identifier associated with the debit card on apitures side and the thirdparties side.(The shared unique value) |
body (body) |
cardNotificationParams (required) These are the json formated parameters needed to create a card notification. |
Try It
Example responses
200 Response
{
"responseCode": 0,
"responseMessage": "string"
}
Responses
Status | Description |
---|---|
200 | OK |
Successful response | |
Schema: cardNotification |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
postAccountsAccIdCardsCardIdAlertsAlertIdNotify
Code samples
# You can also use wget
curl -X POST /fdobi/accounts/{accId}/cards/{cardId}/alerts/{alertId}/notify \
-H 'Content-Type: application/json' \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
POST /fdobi/accounts/{accId}/cards/{cardId}/alerts/{alertId}/notify HTTP/1.1
Content-Type: application/json
Accept: application/json; charset=ISO-8859-1
var headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/accounts/{accId}/cards/{cardId}/alerts/{alertId}/notify',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const inputBody = '{
"state": "string",
"type": "string",
"settingType": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/accounts/{accId}/cards/{cardId}/alerts/{alertId}/notify',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.post '/fdobi/accounts/{accId}/cards/{cardId}/alerts/{alertId}/notify',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.post('/fdobi/accounts/{accId}/cards/{cardId}/alerts/{alertId}/notify', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/accounts/{accId}/cards/{cardId}/alerts/{alertId}/notify");
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; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/fdobi/accounts/{accId}/cards/{cardId}/alerts/{alertId}/notify", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /accounts/{accId}/cards/{cardId}/alerts/{alertId}/notify
This operation sends the alerts of a particular card to the primary email address and phone number (if enrolled) of each user who has privileges to control cards on that account when an alert enabled/disabled/edited by a user.
Body parameter
{
"state": "string",
"type": "string",
"settingType": "string"
}
Parameters
Parameter | Description |
---|---|
accId (path) |
integer (required) The unique identifier (aka, the "thingy") associated with the account. |
cardId (path) |
integer (required) The unique identifier (aka, the "thingy") associated with the debit card. |
alertId (path) |
string (required) The type of card alert. |
body (body) |
cardAlertNotifyParams (required) These are the json formated parameters needed to send card alerts notify. |
Try It
Example responses
500 Response
{
"error": {
"code": "string",
"id": "string",
"text": "string"
}
}
Responses
Status | Description |
---|---|
200 | OK |
Successful response |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
postAccountsAccIdCardsCardIdControlsControlIdNotify
Code samples
# You can also use wget
curl -X POST /fdobi/accounts/{accId}/cards/{cardId}/controls/{controlId}/notify \
-H 'Content-Type: application/json' \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
POST /fdobi/accounts/{accId}/cards/{cardId}/controls/{controlId}/notify HTTP/1.1
Content-Type: application/json
Accept: application/json; charset=ISO-8859-1
var headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/accounts/{accId}/cards/{cardId}/controls/{controlId}/notify',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const inputBody = '{
"state": "string",
"type": "string",
"settingType": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/accounts/{accId}/cards/{cardId}/controls/{controlId}/notify',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.post '/fdobi/accounts/{accId}/cards/{cardId}/controls/{controlId}/notify',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.post('/fdobi/accounts/{accId}/cards/{cardId}/controls/{controlId}/notify', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/accounts/{accId}/cards/{cardId}/controls/{controlId}/notify");
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; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/fdobi/accounts/{accId}/cards/{cardId}/controls/{controlId}/notify", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /accounts/{accId}/cards/{cardId}/controls/{controlId}/notify
This operation sends the alerts of a particular card to the primary email address and phone number (if enrolled) of each user who has privileges to control cards on that account when a control enabled/disabled/edited by a user.
Body parameter
{
"state": "string",
"type": "string",
"settingType": "string"
}
Parameters
Parameter | Description |
---|---|
accId (path) |
integer (required) The unique identifier (aka, the "thingy") associated with the account. |
cardId (path) |
integer (required) The unique identifier (aka, the "thingy") associated with the debit card. |
controlId (path) |
string (required) The type of card control. |
body (body) |
cardControlNotifyParams (required) These are the json formated parameters needed to set card alerts. |
Try It
Example responses
500 Response
{
"error": {
"code": "string",
"id": "string",
"text": "string"
}
}
Responses
Status | Description |
---|---|
200 | OK |
Successful response |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
getCardAlerts
Code samples
# You can also use wget
curl -X GET /fdobi/accounts/{accId}/cards/{cardId}/alerts \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
GET /fdobi/accounts/{accId}/cards/{cardId}/alerts HTTP/1.1
Accept: application/json; charset=ISO-8859-1
var headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/accounts/{accId}/cards/{cardId}/alerts',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/accounts/{accId}/cards/{cardId}/alerts',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.get '/fdobi/accounts/{accId}/cards/{cardId}/alerts',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.get('/fdobi/accounts/{accId}/cards/{cardId}/alerts', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/accounts/{accId}/cards/{cardId}/alerts");
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; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/fdobi/accounts/{accId}/cards/{cardId}/alerts", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /accounts/{accId}/cards/{cardId}/alerts
This operation returns a collection of alert notification settings for a specified card.
Parameters
Parameter | Description |
---|---|
accId (path) |
integer (required) The unique identifier (aka, the "thingy") associated with the account. |
cardId (path) |
integer (required) The unique identifier (aka, the "thingy") associated with the debit card. |
Try It
Example responses
200 Response
{
"name": "alerts",
"_embedded": {
"items": [
{
"constraints": {},
"description": "string",
"state": "inactive",
"type": "string"
}
]
}
}
Successful response
Responses
Status | Description |
---|---|
200 | OK |
Successful response | |
Schema: cardAlerts |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
putAccountsAccIdCardsCardIdAlertsAlertId
Code samples
# You can also use wget
curl -X PUT /fdobi/accounts/{accId}/cards/{cardId}/alerts/{alertId} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
PUT /fdobi/accounts/{accId}/cards/{cardId}/alerts/{alertId} HTTP/1.1
Content-Type: application/json
Accept: application/json; charset=ISO-8859-1
var headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/accounts/{accId}/cards/{cardId}/alerts/{alertId}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const inputBody = '{
"state": "inactive",
"constraints": {
"amount": 0,
"transactionTypes": [
{
"type": "inStore",
"state": "inactive"
},
{
"type": "online",
"state": "inactive"
},
{
"type": "mailOrPhoneOrder",
"state": "inactive"
},
{
"type": "atm",
"state": "inactive"
}
],
"merchantTypes": [
{
"type": "departmentStore",
"state": "inactive"
},
{
"type": "entertainment",
"state": "inactive"
},
{
"type": "gasStation",
"state": "inactive"
},
{
"type": "groceries",
"state": "inactive"
},
{
"type": "household",
"state": "inactive"
},
{
"type": "personalCare",
"state": "inactive"
},
{
"type": "restaurant",
"state": "inactive"
},
{
"type": "travel",
"state": "inactive"
},
{
"type": "others",
"state": "inactive"
}
],
"transactionLocations": [
{
"id": 0,
"state": "delete",
"name": "",
"type": "circle",
"circle": {
"radius": 0,
"center": {
"latitude": 0,
"longitude": 0
}
}
}
]
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/accounts/{accId}/cards/{cardId}/alerts/{alertId}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.put '/fdobi/accounts/{accId}/cards/{cardId}/alerts/{alertId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.put('/fdobi/accounts/{accId}/cards/{cardId}/alerts/{alertId}', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/accounts/{accId}/cards/{cardId}/alerts/{alertId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "/fdobi/accounts/{accId}/cards/{cardId}/alerts/{alertId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /accounts/{accId}/cards/{cardId}/alerts/{alertId}
This operation sets the alerts of a particular card.
Body parameter
{
"state": "inactive",
"constraints": {
"amount": 0,
"transactionTypes": [
{
"type": "inStore",
"state": "inactive"
},
{
"type": "online",
"state": "inactive"
},
{
"type": "mailOrPhoneOrder",
"state": "inactive"
},
{
"type": "atm",
"state": "inactive"
}
],
"merchantTypes": [
{
"type": "departmentStore",
"state": "inactive"
},
{
"type": "entertainment",
"state": "inactive"
},
{
"type": "gasStation",
"state": "inactive"
},
{
"type": "groceries",
"state": "inactive"
},
{
"type": "household",
"state": "inactive"
},
{
"type": "personalCare",
"state": "inactive"
},
{
"type": "restaurant",
"state": "inactive"
},
{
"type": "travel",
"state": "inactive"
},
{
"type": "others",
"state": "inactive"
}
],
"transactionLocations": [
{
"id": 0,
"state": "delete",
"name": "",
"type": "circle",
"circle": {
"radius": 0,
"center": {
"latitude": 0,
"longitude": 0
}
}
}
]
}
}
Parameters
Parameter | Description |
---|---|
accId (path) |
integer (required) The unique identifier (aka, the "thingy") associated with the account. |
cardId (path) |
integer (required) The unique identifier (aka, the "thingy") associated with the debit card. |
alertId (path) |
string (required) The type of card alert. |
body (body) |
cardAlertParams (required) These are the json formated parameters needed to set card alerts. |
NOTE>> From example below use only one constraints key respective to the alertId. When alertId is transactionAmount, constraints will have one key/value pair with key "amount". When alertId is merchantTypes or transactionTypes, constraints will have one key/value pair with key "merchantTypes" or "transactionTypes" and value of an array of key/value pairs. When alertId is transactionLocations, constraints will have one key/value pair with key "transactionLocations" and value of an array of location objects. Id is only used to edit or delete an existing location and state is only used to delete, otherwise they are ignored. |
Try It
Example responses
500 Response
{
"error": {
"code": "string",
"id": "string",
"text": "string"
}
}
Responses
Status | Description |
---|---|
200 | OK |
Successful response |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
getAccountsAccIdCardsCardIdAlertsDestinations
Code samples
# You can also use wget
curl -X GET /fdobi/accounts/{accId}/cards/{cardId}/alerts/destinations \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
GET /fdobi/accounts/{accId}/cards/{cardId}/alerts/destinations HTTP/1.1
Accept: application/json; charset=ISO-8859-1
var headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/accounts/{accId}/cards/{cardId}/alerts/destinations',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/accounts/{accId}/cards/{cardId}/alerts/destinations',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.get '/fdobi/accounts/{accId}/cards/{cardId}/alerts/destinations',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.get('/fdobi/accounts/{accId}/cards/{cardId}/alerts/destinations', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/accounts/{accId}/cards/{cardId}/alerts/destinations");
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; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/fdobi/accounts/{accId}/cards/{cardId}/alerts/destinations", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /accounts/{accId}/cards/{cardId}/alerts/destinations
This operation returns a list of destinations and their states for a specified card.
Parameters
Parameter | Description |
---|---|
accId (path) |
integer (required) The unique identifier (aka, the "thingy") associated with the account. |
cardId (path) |
integer (required) The unique identifier (aka, the "thingy") associated with the debit card. |
Try It
Example responses
200 Response
{
"cardAlertsDestinations": [
{
"alertId": "string",
"address1": "string",
"address2": "string",
"address3": "string"
}
],
"customerPossibleDestinations": {
"address1": "string",
"address2": "string",
"address3": "string",
"isSmsEnrolled": true
}
}
Responses
Status | Description |
---|---|
200 | OK |
Successful response | |
Schema: cardDestinations |
putAccountsAccIdCardsCardIdAlertsAlertIdDestinations
Code samples
# You can also use wget
curl -X PUT /fdobi/accounts/{accId}/cards/{cardId}/alerts/{alertId}/destinations \
-H 'Content-Type: application/json' \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
PUT /fdobi/accounts/{accId}/cards/{cardId}/alerts/{alertId}/destinations HTTP/1.1
Content-Type: application/json
Accept: application/json; charset=ISO-8859-1
var headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/accounts/{accId}/cards/{cardId}/alerts/{alertId}/destinations',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const inputBody = '{
"address1": true,
"address2": true,
"address3": true
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/accounts/{accId}/cards/{cardId}/alerts/{alertId}/destinations',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.put '/fdobi/accounts/{accId}/cards/{cardId}/alerts/{alertId}/destinations',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.put('/fdobi/accounts/{accId}/cards/{cardId}/alerts/{alertId}/destinations', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/accounts/{accId}/cards/{cardId}/alerts/{alertId}/destinations");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "/fdobi/accounts/{accId}/cards/{cardId}/alerts/{alertId}/destinations", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /accounts/{accId}/cards/{cardId}/alerts/{alertId}/destinations
This operation sets the state of each destination for a particular card alert.
Body parameter
{
"address1": true,
"address2": true,
"address3": true
}
Parameters
Parameter | Description |
---|---|
accId (path) |
integer (required) The unique identifier (aka, the "thingy") associated with the account. |
cardId (path) |
integer (required) The unique identifier (aka, the "thingy") associated with the debit card. |
alertId (path) |
string (required) The type of card alert. |
body (body) |
cardAlertsDestinationsParams (required) These are the json formated parameters needed to set the states of the destinations for a card alert. |
Try It
Example responses
500 Response
{
"error": {
"code": "string",
"id": "string",
"text": "string"
}
}
Responses
Status | Description |
---|---|
200 | OK |
Successful response |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
deleteAccountsAccIdCardsCardIdAlertsAlertIdDestinations
Code samples
# You can also use wget
curl -X DELETE /fdobi/accounts/{accId}/cards/{cardId}/alerts/{alertId}/destinations \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
DELETE /fdobi/accounts/{accId}/cards/{cardId}/alerts/{alertId}/destinations HTTP/1.1
Accept: application/json; charset=ISO-8859-1
var headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/accounts/{accId}/cards/{cardId}/alerts/{alertId}/destinations',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/accounts/{accId}/cards/{cardId}/alerts/{alertId}/destinations',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.delete '/fdobi/accounts/{accId}/cards/{cardId}/alerts/{alertId}/destinations',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.delete('/fdobi/accounts/{accId}/cards/{cardId}/alerts/{alertId}/destinations', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/accounts/{accId}/cards/{cardId}/alerts/{alertId}/destinations");
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/json; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "/fdobi/accounts/{accId}/cards/{cardId}/alerts/{alertId}/destinations", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /accounts/{accId}/cards/{cardId}/alerts/{alertId}/destinations
This operation deletes the destinations for a particular card alert.
Parameters
Parameter | Description |
---|---|
accId (path) |
integer (required) The unique identifier (aka, the "thingy") associated with the account. |
cardId (path) |
integer (required) The unique identifier (aka, the "thingy") associated with the debit card. |
alertId (path) |
string (required) The type of card alert. |
Try It
Example responses
500 Response
{
"error": {
"code": "string",
"id": "string",
"text": "string"
}
}
Responses
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
getCardControls
Code samples
# You can also use wget
curl -X GET /fdobi/accounts/{accId}/cards/{cardId}/controls \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
GET /fdobi/accounts/{accId}/cards/{cardId}/controls HTTP/1.1
Accept: application/json; charset=ISO-8859-1
var headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/accounts/{accId}/cards/{cardId}/controls',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/accounts/{accId}/cards/{cardId}/controls',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.get '/fdobi/accounts/{accId}/cards/{cardId}/controls',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.get('/fdobi/accounts/{accId}/cards/{cardId}/controls', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/accounts/{accId}/cards/{cardId}/controls");
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; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/fdobi/accounts/{accId}/cards/{cardId}/controls", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /accounts/{accId}/cards/{cardId}/controls
This operation returns a collection of card controls for a specified card.
Parameters
Parameter | Description |
---|---|
accId (path) |
integer (required) The unique identifier (aka, the "thingy") associated with the account. |
cardId (path) |
integer (required) The unique identifier (aka, the "thingy") associated with the debit card. |
Try It
Example responses
200 Response
{
"name": "controls",
"_embedded": {
"items": [
{
"constraints": {},
"description": "string",
"state": "inactive",
"type": "string"
}
]
}
}
Successful response
Responses
Status | Description |
---|---|
200 | OK |
Successful response | |
Schema: cardControls |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
putAccountsAccIdCardsCardIdControlsControlId
Code samples
# You can also use wget
curl -X PUT /fdobi/accounts/{accId}/cards/{cardId}/controls/{controlId} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
PUT /fdobi/accounts/{accId}/cards/{cardId}/controls/{controlId} HTTP/1.1
Content-Type: application/json
Accept: application/json; charset=ISO-8859-1
var headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/accounts/{accId}/cards/{cardId}/controls/{controlId}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const inputBody = '{
"state": "inactive",
"constraints": {
"amount": 0,
"transactionTypes": [
{
"type": "inStore",
"state": "inactive"
},
{
"type": "online",
"state": "inactive"
},
{
"type": "mailOrPhoneOrder",
"state": "inactive"
},
{
"type": "autoPayOrRecurring",
"state": "inactive"
},
{
"type": "atm",
"state": "inactive"
},
{
"type": "fundsTransfer",
"state": "inactive"
},
{
"type": "other",
"state": "inactive"
}
],
"merchantTypes": [
{
"type": "departmentStore",
"state": "inactive"
},
{
"type": "entertainment",
"state": "inactive"
},
{
"type": "gasStation",
"state": "inactive"
},
{
"type": "groceries",
"state": "inactive"
},
{
"type": "household",
"state": "inactive"
},
{
"type": "personalCare",
"state": "inactive"
},
{
"type": "restaurant",
"state": "inactive"
},
{
"type": "travel",
"state": "inactive"
},
{
"type": "others",
"state": "inactive"
}
],
"transactionLocations": [
{
"id": 0,
"state": "delete",
"name": "",
"type": "circle",
"circle": {
"radius": 0,
"center": {
"latitude": 0,
"longitude": 0
}
}
}
]
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/accounts/{accId}/cards/{cardId}/controls/{controlId}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.put '/fdobi/accounts/{accId}/cards/{cardId}/controls/{controlId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.put('/fdobi/accounts/{accId}/cards/{cardId}/controls/{controlId}', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/accounts/{accId}/cards/{cardId}/controls/{controlId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "/fdobi/accounts/{accId}/cards/{cardId}/controls/{controlId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /accounts/{accId}/cards/{cardId}/controls/{controlId}
This operation sets the controls of a particular card.
Body parameter
{
"state": "inactive",
"constraints": {
"amount": 0,
"transactionTypes": [
{
"type": "inStore",
"state": "inactive"
},
{
"type": "online",
"state": "inactive"
},
{
"type": "mailOrPhoneOrder",
"state": "inactive"
},
{
"type": "autoPayOrRecurring",
"state": "inactive"
},
{
"type": "atm",
"state": "inactive"
},
{
"type": "fundsTransfer",
"state": "inactive"
},
{
"type": "other",
"state": "inactive"
}
],
"merchantTypes": [
{
"type": "departmentStore",
"state": "inactive"
},
{
"type": "entertainment",
"state": "inactive"
},
{
"type": "gasStation",
"state": "inactive"
},
{
"type": "groceries",
"state": "inactive"
},
{
"type": "household",
"state": "inactive"
},
{
"type": "personalCare",
"state": "inactive"
},
{
"type": "restaurant",
"state": "inactive"
},
{
"type": "travel",
"state": "inactive"
},
{
"type": "others",
"state": "inactive"
}
],
"transactionLocations": [
{
"id": 0,
"state": "delete",
"name": "",
"type": "circle",
"circle": {
"radius": 0,
"center": {
"latitude": 0,
"longitude": 0
}
}
}
]
}
}
Parameters
Parameter | Description |
---|---|
accId (path) |
integer (required) The unique identifier (aka, the "thingy") associated with the account. |
cardId (path) |
integer (required) The unique identifier (aka, the "thingy") associated with the debit card. |
controlId (path) |
string (required) The type of card control. |
body (body) |
cardControlParams (required) These are the json formated parameters needed to set card alerts. |
NOTE>> From example below use only one constraints key respective to the controlId When controlId is transactionAmount, constraints will have one key/value pair with key "amount". When controlId is merchantTypes or transactionTypes, constraints will have one key/value pair with key "merchantTypes" or "transactionTypes" and value of an array of key/value pairs. When controlId is transactionLocations, constraints will have one key/value pair with key "transactionLocations" and value of an array of location objects. When setting a new location, id and state within constraints will be left blank. Id is only needed to delete or edit an existing location and state is only needed to delete. |
Try It
Example responses
500 Response
{
"error": {
"code": "string",
"id": "string",
"text": "string"
}
}
Responses
Status | Description |
---|---|
200 | OK |
Successful response |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
getAccountsAccIdCardsAlertsRegions
Code samples
# You can also use wget
curl -X GET /fdobi/accounts/{accId}/cards/alerts/regions \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
GET /fdobi/accounts/{accId}/cards/alerts/regions HTTP/1.1
Accept: application/json; charset=ISO-8859-1
var headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/accounts/{accId}/cards/alerts/regions',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/accounts/{accId}/cards/alerts/regions',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.get '/fdobi/accounts/{accId}/cards/alerts/regions',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.get('/fdobi/accounts/{accId}/cards/alerts/regions', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/accounts/{accId}/cards/alerts/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; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/fdobi/accounts/{accId}/cards/alerts/regions", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /accounts/{accId}/cards/alerts/regions
This operation returns a list of all the regions for a specified account.
Parameters
Parameter | Description |
---|---|
accId (path) |
integer (required) The unique identifier (aka, the "thingy") associated with the account. |
Try It
Example responses
200 Response
{
"regions": [
{
"cards": [
{
"cardId": 0,
"alertVendorRegionId": 0,
"controlVendorRegionId": 0
}
],
"circle": {
"radius": 0,
"center": {
"latitude": 0,
"longitude": 0
}
},
"id": 0,
"name": "string",
"type": "CIRCLE"
}
]
}
Responses
Status | Description |
---|---|
200 | OK |
Successful response | |
Schema: accountRegions |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
postAccountsAccIdCardsAlertsRegions
Code samples
# You can also use wget
curl -X POST /fdobi/accounts/{accId}/cards/alerts/regions \
-H 'Content-Type: application/json' \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
POST /fdobi/accounts/{accId}/cards/alerts/regions HTTP/1.1
Content-Type: application/json
Accept: application/json; charset=ISO-8859-1
var headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/accounts/{accId}/cards/alerts/regions',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const inputBody = '{
"cards": [
{
"cardId": 0,
"alertVendorRegionId": 0,
"controlVendorRegionId": 0
}
],
"name": "string",
"type": "CIRCLE",
"circle": {
"radius": 0,
"center": {
"latitude": 0,
"longitude": 0
}
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/accounts/{accId}/cards/alerts/regions',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.post '/fdobi/accounts/{accId}/cards/alerts/regions',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.post('/fdobi/accounts/{accId}/cards/alerts/regions', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/accounts/{accId}/cards/alerts/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; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/fdobi/accounts/{accId}/cards/alerts/regions", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /accounts/{accId}/cards/alerts/regions
This operation adds a new region to the specified account. (Only 10 regions currenlty allowed and shared by all users across an account.)
Body parameter
{
"cards": [
{
"cardId": 0,
"alertVendorRegionId": 0,
"controlVendorRegionId": 0
}
],
"name": "string",
"type": "CIRCLE",
"circle": {
"radius": 0,
"center": {
"latitude": 0,
"longitude": 0
}
}
}
Parameters
Parameter | Description |
---|---|
accId (path) |
integer (required) The unique identifier (aka, the "thingy") associated with the account. |
body (body) |
accountRegionParams (required) These are the json formated parameters needed to create a region. |
Try It
Example responses
200 Response
{
"regionId": 0
}
Responses
Status | Description |
---|---|
200 | OK |
Successful response | |
Schema: Inline |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
Response Schema
Status Code 200
regionId
Property Name | Description |
---|---|
» regionId | integer |
putAccountsAccIdCardsAlertsRegionsRegionId
Code samples
# You can also use wget
curl -X PUT /fdobi/accounts/{accId}/cards/alerts/regions/{regionId} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
PUT /fdobi/accounts/{accId}/cards/alerts/regions/{regionId} HTTP/1.1
Content-Type: application/json
Accept: application/json; charset=ISO-8859-1
var headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/accounts/{accId}/cards/alerts/regions/{regionId}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const inputBody = '{
"cards": [
{
"cardId": 0,
"alertVendorRegionId": 0,
"controlVendorRegionId": 0
}
],
"name": "string",
"type": "CIRCLE",
"circle": {
"radius": 0,
"center": {
"latitude": 0,
"longitude": 0
}
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/accounts/{accId}/cards/alerts/regions/{regionId}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.put '/fdobi/accounts/{accId}/cards/alerts/regions/{regionId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.put('/fdobi/accounts/{accId}/cards/alerts/regions/{regionId}', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/accounts/{accId}/cards/alerts/regions/{regionId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "/fdobi/accounts/{accId}/cards/alerts/regions/{regionId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /accounts/{accId}/cards/alerts/regions/{regionId}
This operation updates the specified region for a particular account.
Body parameter
{
"cards": [
{
"cardId": 0,
"alertVendorRegionId": 0,
"controlVendorRegionId": 0
}
],
"name": "string",
"type": "CIRCLE",
"circle": {
"radius": 0,
"center": {
"latitude": 0,
"longitude": 0
}
}
}
Parameters
Parameter | Description |
---|---|
accId (path) |
integer (required) The unique identifier (aka, the "thingy") associated with the account. |
regionId (path) |
string (required) The unique identifier associated with the region. |
body (body) |
accountRegionPutParams (required) These are the json formated parameters needed to update a region. |
Try It
Example responses
500 Response
{
"error": {
"code": "string",
"id": "string",
"text": "string"
}
}
Responses
Status | Description |
---|---|
200 | OK |
Successful response |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
deleteAccountsAccIdCardsAlertsRegionsRegionId
Code samples
# You can also use wget
curl -X DELETE /fdobi/accounts/{accId}/cards/alerts/regions/{regionId} \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
DELETE /fdobi/accounts/{accId}/cards/alerts/regions/{regionId} HTTP/1.1
Accept: application/json; charset=ISO-8859-1
var headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/accounts/{accId}/cards/alerts/regions/{regionId}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/accounts/{accId}/cards/alerts/regions/{regionId}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.delete '/fdobi/accounts/{accId}/cards/alerts/regions/{regionId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.delete('/fdobi/accounts/{accId}/cards/alerts/regions/{regionId}', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/accounts/{accId}/cards/alerts/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/json; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "/fdobi/accounts/{accId}/cards/alerts/regions/{regionId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /accounts/{accId}/cards/alerts/regions/{regionId}
This operation deletes the specified region for a particular account.
Parameters
Parameter | Description |
---|---|
accId (path) |
integer (required) The unique identifier (aka, the "thingy") associated with the account. |
regionId (path) |
string (required) The unique identifier associated with the region. |
Try It
Example responses
500 Response
{
"error": {
"code": "string",
"id": "string",
"text": "string"
}
}
Responses
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
getAccountsAccIdAccountNumber
Code samples
# You can also use wget
curl -X GET /fdobi/accounts/{accId}/account_number \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'X-XSRF-TOKEN: API_KEY'
GET /fdobi/accounts/{accId}/account_number HTTP/1.1
Accept: application/json; charset=ISO-8859-1
var headers = {
'Accept':'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN':'API_KEY'
};
$.ajax({
url: '/fdobi/accounts/{accId}/account_number',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN':'API_KEY'
};
fetch('/fdobi/accounts/{accId}/account_number',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN' => 'API_KEY'
}
result = RestClient.get '/fdobi/accounts/{accId}/account_number',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN': 'API_KEY'
}
r = requests.get('/fdobi/accounts/{accId}/account_number', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/accounts/{accId}/account_number");
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; charset=ISO-8859-1"},
"X-XSRF-TOKEN": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/fdobi/accounts/{accId}/account_number", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /accounts/{accId}/account_number
This Operation returns the full account number (unmasked) for the account requested via the account id parameter.
Parameters
Parameter | Description |
---|---|
accId (path) |
integer (required) This FDOBI Input Parameter/Output Label is an account identifier used to refer to the account in the FDOBI system. For example, in payee Operations, it is the payer's account number from which funds are used to make payment to a specified payee. |
Try It
Example responses
200 Response
{
"accNum": "string",
"ach": "string"
}
Responses
Status | Description |
---|---|
200 | OK |
Successful response | |
Schema: accountAccIdAccountNumberResponse |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
postAccountsAccIdHistory
Code samples
# You can also use wget
curl -X POST /fdobi/accounts/{accId}/history \
-H 'Content-Type: application/json' \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'X-XSRF-TOKEN: API_KEY'
POST /fdobi/accounts/{accId}/history HTTP/1.1
Content-Type: application/json
Accept: application/json; charset=ISO-8859-1
var headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN':'API_KEY'
};
$.ajax({
url: '/fdobi/accounts/{accId}/history',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const inputBody = '{
"dateStart": "2019-08-24",
"categories": [
"string"
],
"dateEnd": "2019-08-24",
"maxAmount": 0,
"maxCheckNum": 0,
"minCheckNum": 0,
"minAmount": 0,
"numPerPage": 0,
"pageNum": 0,
"sort": "DATE_ASC",
"txnType": "CHECK"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN':'API_KEY'
};
fetch('/fdobi/accounts/{accId}/history',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN' => 'API_KEY'
}
result = RestClient.post '/fdobi/accounts/{accId}/history',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN': 'API_KEY'
}
r = requests.post('/fdobi/accounts/{accId}/history', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/accounts/{accId}/history");
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; charset=ISO-8859-1"},
"X-XSRF-TOKEN": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/fdobi/accounts/{accId}/history", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /accounts/{accId}/history
This Operation returns a list of transactions and balances for the requested account, filtered by the query parameters passed.
Body parameter
{
"dateStart": "2019-08-24",
"categories": [
"string"
],
"dateEnd": "2019-08-24",
"maxAmount": 0,
"maxCheckNum": 0,
"minCheckNum": 0,
"minAmount": 0,
"numPerPage": 0,
"pageNum": 0,
"sort": "DATE_ASC",
"txnType": "CHECK"
}
Parameters
Parameter | Description |
---|---|
accId (path) |
integer (required) This FDOBI Input Parameter/Output Label is an account identifier used to refer to the account in the FDOBI system. For example, in payee Operations, it is the payer's account number from which funds are used to make payment to a specified payee. |
body (body) |
historyParams This FDOBI Input Parameter/Output Label is used to specify the history search filter params |
Try It
Example responses
200 Response
{
"haveMore": true,
"history": {
"historyType": "Balance",
"amount": 0,
"checkNum": "string",
"datePosted": "2019-08-24",
"description": "string",
"imgAvailable": true,
"memo": "string",
"merchantInfo": {
"merchantLogoUrl": "string",
"merchantName": "string",
"merchantWebsiteUrl": "string"
},
"refNum": "string",
"shortDescription": "string",
"txnId": "string",
"discrepency": 0,
"balRunning": 0,
"txnType": "CHECK"
},
"dateStart": "2019-08-24T14:15:22Z",
"dateEnd": "2019-08-24T14:15:22Z",
"numPerPage": 0
}
Responses
Status | Description |
---|---|
200 | OK |
Successful response | |
Schema: accountsAccIdHistoryResponse |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
postAccountsAccIdHistoryReport
Code samples
# You can also use wget
curl -X POST /fdobi/accounts/{accId}/history/report \
-H 'Content-Type: application/json' \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'X-XSRF-TOKEN: API_KEY'
POST /fdobi/accounts/{accId}/history/report HTTP/1.1
Content-Type: application/json
Accept: application/json; charset=ISO-8859-1
var headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN':'API_KEY'
};
$.ajax({
url: '/fdobi/accounts/{accId}/history/report',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const inputBody = '{
"dateStart": "2019-08-24",
"categories": "string",
"dateEnd": "2019-08-24",
"maxAmount": 0,
"maxCheckNum": 0,
"minCheckNum": 0,
"minAmount": 0,
"txnType": "all",
"type": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN':'API_KEY'
};
fetch('/fdobi/accounts/{accId}/history/report',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN' => 'API_KEY'
}
result = RestClient.post '/fdobi/accounts/{accId}/history/report',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN': 'API_KEY'
}
r = requests.post('/fdobi/accounts/{accId}/history/report', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/accounts/{accId}/history/report");
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; charset=ISO-8859-1"},
"X-XSRF-TOKEN": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/fdobi/accounts/{accId}/history/report", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /accounts/{accId}/history/report
FDOBI shall support the ability to retrieve Account History data for a specific account in a format that is useful for generating reports. Summary:
The output dataset will be of the same format as is used in the legacy OLB Account History / Report feature. Two options shall be supported: report summary and report details.
The legacy FXWeb Account History Report feature supports the following types of data filters:
- Date Range (starting date, ending date)
- Transaction Type (all, checks, credits only, debits only)
- Check Range (starting check number, ending check number)
- Amount Range (minimum amount, maximum amount). Note that this applies to the absolute value of transactions; so an amount range of 10 to 20 would apply to transaction amounts of -$20.00 to -$10.00 (inclusive) and $10.00 to $20.00 (inclusive).
- Categories
The legacy FXWeb Account History Report does not support customization using the following types of data filters:
- Sorted By/Sort Direction (defaults to Transaction Date/Ascending).
- Items Per Page.
FDOBI Interface
The following FDOBI call is used to dowload account history data:
GET /fdobi/accounts/:accId/history/report
where :accId is the unique identifier (aka, the "thingy") associated with the account.
Other query parameters may include:
- category=item... One or more categories, separated with commas, to be included in the report. If not supplied, the default is to report on all categories.
- dateEnd=yyyy-mm-dd The end date for the report. If not supplied, the report will be generated only for transactions matching the start date.
- dateStart=yyyy-mm-dd The start date for the report (required).
- maxAmount=value The maximum transaction value to be included.
- maxCheckNum=number The maximum check number to be included.
- minAmount=value The minimum transaction value to be included.
- minCheckNum=number The minimum check number to be included.
- txnType=all|check|credit|debit The type of transactions to include in the report (all, checks only, credits only, or debits only). If not supplied, the default is txnType=all.
- type=summary|details The type of report (summary or detailed) that is being requested (required).
Body parameter
{
"dateStart": "2019-08-24",
"categories": "string",
"dateEnd": "2019-08-24",
"maxAmount": 0,
"maxCheckNum": 0,
"minCheckNum": 0,
"minAmount": 0,
"txnType": "all",
"type": "string"
}
Parameters
Parameter | Description |
---|---|
accId (path) |
integer (required) The unique identifier (aka, the "thingy") associated with the account. |
body (body) |
historyReportParams This FDOBI Input Parameter/Output Label is used to specify the history search filter params |
Try It
Example responses
200 Response
{
"accDescription": "string",
"accDisplayNum": "string",
"accId": 0,
"dateStart": "2019-08-24",
"dateEnd": "2019-08-24",
"summary": {
"Income": {
"Income": 0,
"Expense": 0,
"UNASSIGNED": 0,
"total": 0
},
"Expense": {
"Income": 0,
"Expense": 0,
"UNASSIGNED": 0,
"total": 0
},
"UNASSIGNED": {
"Income": 0,
"Expense": 0,
"UNASSIGNED": 0,
"total": 0
}
},
"details": {
"Income": {
"total": 0,
"Income": {
"total": 0,
"Income": [
{
"amount": 0,
"check": 0,
"date": "2019-08-24",
"description": "string"
}
],
"Expense": [
{
"amount": 0,
"check": 0,
"date": "2019-08-24",
"description": "string"
}
],
"UNASSIGNED": [
{
"amount": 0,
"check": 0,
"date": "2019-08-24",
"description": "string"
}
]
},
"Expense": {
"total": 0,
"Income": [
{
"amount": 0,
"check": 0,
"date": "2019-08-24",
"description": "string"
}
],
"Expense": [
{
"amount": 0,
"check": 0,
"date": "2019-08-24",
"description": "string"
}
],
"UNASSIGNED": [
{
"amount": 0,
"check": 0,
"date": "2019-08-24",
"description": "string"
}
]
},
"UNASSIGNED": {
"total": 0,
"Income": [
{
"amount": 0,
"check": 0,
"date": "2019-08-24",
"description": "string"
}
],
"Expense": [
{
"amount": 0,
"check": 0,
"date": "2019-08-24",
"description": "string"
}
],
"UNASSIGNED": [
{
"amount": 0,
"check": 0,
"date": "2019-08-24",
"description": "string"
}
]
}
},
"Expense": {
"total": 0,
"Income": {
"total": 0,
"Income": [
{
"amount": 0,
"check": 0,
"date": "2019-08-24",
"description": "string"
}
],
"Expense": [
{
"amount": 0,
"check": 0,
"date": "2019-08-24",
"description": "string"
}
],
"UNASSIGNED": [
{
"amount": 0,
"check": 0,
"date": "2019-08-24",
"description": "string"
}
]
},
"Expense": {
"total": 0,
"Income": [
{
"amount": 0,
"check": 0,
"date": "2019-08-24",
"description": "string"
}
],
"Expense": [
{
"amount": 0,
"check": 0,
"date": "2019-08-24",
"description": "string"
}
],
"UNASSIGNED": [
{
"amount": 0,
"check": 0,
"date": "2019-08-24",
"description": "string"
}
]
},
"UNASSIGNED": {
"total": 0,
"Income": [
{
"amount": 0,
"check": 0,
"date": "2019-08-24",
"description": "string"
}
],
"Expense": [
{
"amount": 0,
"check": 0,
"date": "2019-08-24",
"description": "string"
}
],
"UNASSIGNED": [
{
"amount": 0,
"check": 0,
"date": "2019-08-24",
"description": "string"
}
]
}
},
"UNASSIGNED": {
"total": 0,
"Income": {
"total": 0,
"Income": [
{
"amount": 0,
"check": 0,
"date": "2019-08-24",
"description": "string"
}
],
"Expense": [
{
"amount": 0,
"check": 0,
"date": "2019-08-24",
"description": "string"
}
],
"UNASSIGNED": [
{
"amount": 0,
"check": 0,
"date": "2019-08-24",
"description": "string"
}
]
},
"Expense": {
"total": 0,
"Income": [
{
"amount": 0,
"check": 0,
"date": "2019-08-24",
"description": "string"
}
],
"Expense": [
{
"amount": 0,
"check": 0,
"date": "2019-08-24",
"description": "string"
}
],
"UNASSIGNED": [
{
"amount": 0,
"check": 0,
"date": "2019-08-24",
"description": "string"
}
]
},
"UNASSIGNED": {
"total": 0,
"Income": [
{
"amount": 0,
"check": 0,
"date": "2019-08-24",
"description": "string"
}
],
"Expense": [
{
"amount": 0,
"check": 0,
"date": "2019-08-24",
"description": "string"
}
],
"UNASSIGNED": [
{
"amount": 0,
"check": 0,
"date": "2019-08-24",
"description": "string"
}
]
}
}
},
"type": "string"
}
Responses
Status | Description |
---|---|
200 | OK |
Successful response | |
Schema: accountsAccIdHistoryReportResponse |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
postAccountsAccIdHistoryDownload
Code samples
# You can also use wget
curl -X POST /fdobi/accounts/{accId}/history/download \
-H 'Content-Type: application/json' \
-H 'Accept: text/x-csv' \
-H 'X-XSRF-TOKEN: API_KEY'
POST /fdobi/accounts/{accId}/history/download HTTP/1.1
Content-Type: application/json
Accept: text/x-csv
var headers = {
'Content-Type':'application/json',
'Accept':'text/x-csv',
'X-XSRF-TOKEN':'API_KEY'
};
$.ajax({
url: '/fdobi/accounts/{accId}/history/download',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const inputBody = '{
"dateStart": "2019-08-24",
"category": "string",
"dateEnd": "2019-08-24",
"maxAmount": 0,
"maxCheckNum": 0,
"minCheckNum": 0,
"minAmount": 0,
"sortDir": "asc",
"sort": "amount",
"format": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'text/x-csv',
'X-XSRF-TOKEN':'API_KEY'
};
fetch('/fdobi/accounts/{accId}/history/download',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'text/x-csv',
'X-XSRF-TOKEN' => 'API_KEY'
}
result = RestClient.post '/fdobi/accounts/{accId}/history/download',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'text/x-csv',
'X-XSRF-TOKEN': 'API_KEY'
}
r = requests.post('/fdobi/accounts/{accId}/history/download', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/accounts/{accId}/history/download");
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{"text/x-csv"},
"X-XSRF-TOKEN": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/fdobi/accounts/{accId}/history/download", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /accounts/{accId}/history/download
Summary
FDOBI shall support the ability to download Account History data for a specific account.
Supported download file formats include:
- CSV: comma-separated values;
- TSV: tab-separated values;
- BAI: the BAI2 (Bank Administration Institute) file format;
- QIF: Quicken Interchange Format (e.g. for Intuit Quicken);
- MON: Microsoft Money's OFX format;
- ASF: Microsoft Money Active Statement format;
- FLC: Fixed-length check format;
- QFX: Quicken99 format;
- QBO: QuickBooks format
For CSV, TSV and FLC, the following filter parameters are supported:
Sort parameters (date, check number, description, category or amount) and direction (ascending or descending) Date range (start and end dates) Amount range (minimum and maximum values) Check number range (start and end check numbers) Categories
For all other download formats, only the following filter parameters are supported:
Sort parameters (date, check number, description, category or amount) and direction (ascending or descending) Update: some sort parameters (e.g., date) are accepted and ignored, but some (e.g., amount) result in errors. Sort parameters should not be used with other download formats. Date range (start and end dates)
Note: Although the documentation indicates that the sort parameters are valid for file downloads, this has not been verified in the legacy FXWeb application. UPDATE: the sort= and sortDir= parameters work fine with this change to the API. FDOBI Interface
The following FDOBI call is used to download account history data:
POST /fdobi/accounts/:accId/download
where :accId is the unique identifier (aka, the "thingy") associated with the account.
Other query parameters may include:
- category=item... One or more categories, separated with commas, to be included in the report.
- dateEnd=yyyy-mm-dd The end date for the report. If not supplied, the report will be generated only for transactions matching the start date.
- dateStart=yyyy-mm-dd The start date for the report (required).
- format=type The type of report to be returned (required). - maxAmount=value The maximum transaction value to be included.
- maxCheckNum=number The maximum check number to be included.
- minAmount=value The minimum transaction value to be included.
- minCheckNum=number The minimum check number to be included.
- sort=amount|category|check|date|description The field on which the data is sorted.
- sortDir=asc|desc The order (ascending or descending) the report data is sorted.
- txnType=all|check|credit|debit The type of transactions to be returned. If not supplied, all transaction types will be included.
Three options are available to receive the downloaded data:
If the HTTP Accept header requests a JSON or XML response (or no Accept header is provided, which defaults to JSON output), a BASE64 encoded block with the report data will be returned as a "content" item in the output data. If the HTTP Accept header requests a specific content type, and if that type matches the report file type, the report data will be returned as binary data with the specified content type. Note that application/json; charset=ISO-8859-1 should be included as a lower priority option (q < 1.0) so any error condition will be returned as JSON data. If the HTTP Accept header requests "application/octet-stream", the report data will be returned as an untyped binary download.
The currently-defined output formats have these associated content types:
- CSV: "text/x-csv"
- TSV: "text/tab-separated-values"
- BAI: "text/x-bai2"
- QIF: "text/x-qif"
- MON: "text/x-ofx"
- ASF: "application/x-ofx"
- FLC: "text/x-flc"
- QFX: "application/vnd.intu.qfx"
- QBO: "application/vnd.intu.qbo"
Body parameter
{
"dateStart": "2019-08-24",
"category": "string",
"dateEnd": "2019-08-24",
"maxAmount": 0,
"maxCheckNum": 0,
"minCheckNum": 0,
"minAmount": 0,
"sortDir": "asc",
"sort": "amount",
"format": "string"
}
Parameters
Parameter | Description |
---|---|
accId (path) |
integer (required) The unique identifier (aka, the "thingy") associated with the account. |
body (body) |
historyDownloadParams This FDOBI Input Parameter/Output Label is used to specify the history search filter params |
Try It
Example responses
200 Response
{
"content": "string",
"contentTransferEncoding": "string",
"contentTransferSize": 0,
"contentType": "string",
"filename": "string",
"size": 0
}
Responses
Status | Description |
---|---|
200 | OK |
Successful response | |
Schema: accountsAccIdHistoryDownloadResponse |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
postAccountsAccIdTransactionMemoCategory
Code samples
# You can also use wget
curl -X POST /fdobi/accounts/{accId}/transaction/memoCategory \
-H 'Content-Type: application/json' \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'X-XSRF-TOKEN: API_KEY'
POST /fdobi/accounts/{accId}/transaction/memoCategory HTTP/1.1
Content-Type: application/json
Accept: application/json; charset=ISO-8859-1
var headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN':'API_KEY'
};
$.ajax({
url: '/fdobi/accounts/{accId}/transaction/memoCategory',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const inputBody = '{
"txnId": "string",
"category": 0,
"memo": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN':'API_KEY'
};
fetch('/fdobi/accounts/{accId}/transaction/memoCategory',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN' => 'API_KEY'
}
result = RestClient.post '/fdobi/accounts/{accId}/transaction/memoCategory',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN': 'API_KEY'
}
r = requests.post('/fdobi/accounts/{accId}/transaction/memoCategory', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/accounts/{accId}/transaction/memoCategory");
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; charset=ISO-8859-1"},
"X-XSRF-TOKEN": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/fdobi/accounts/{accId}/transaction/memoCategory", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /accounts/{accId}/transaction/memoCategory
Sets the custom information for the transaction if FI supports it. You can set Transaction memo and category id or either one of the memo or category id of the transaction. QueryParameters:
- txnId: format is (date,amount,description,check_num,ref_num,txn_type,counter.) Ex:(05172017,454.74,2YCrXmMVJDyFTe8fnYbanZW9XbU, , ,CREDIT,0)
- category: This will pick the category from list of predefined categories on the user account logged in.
- memo: simple memo string
Body parameter
{
"txnId": "string",
"category": 0,
"memo": "string"
}
Parameters
Parameter | Description |
---|---|
accId (path) |
integer (required) |
body (body) |
memoCategoryParams (required) |
Try It
Example responses
200 Response
{
"placeholder": true
}
Responses
Status | Description |
---|---|
200 | OK |
Successful response | |
Schema: accountsAccIdTransactionMemoCategoryResponse |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
getAccountsBalances
Code samples
# You can also use wget
curl -X GET /fdobi/accounts/balances \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'X-XSRF-TOKEN: API_KEY'
GET /fdobi/accounts/balances HTTP/1.1
Accept: application/json; charset=ISO-8859-1
var headers = {
'Accept':'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN':'API_KEY'
};
$.ajax({
url: '/fdobi/accounts/balances',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN':'API_KEY'
};
fetch('/fdobi/accounts/balances',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN' => 'API_KEY'
}
result = RestClient.get '/fdobi/accounts/balances',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN': 'API_KEY'
}
r = requests.get('/fdobi/accounts/balances', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/accounts/balances");
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; charset=ISO-8859-1"},
"X-XSRF-TOKEN": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/fdobi/accounts/balances", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /accounts/balances
This Operation returns a list of balance info for the requested account(s) or all accounts if none specified, filtered by any parameters passed.
Parameters
Parameter | Description |
---|---|
accIds (query) |
array[integer] This FDOBI Input Parameter/Output Label defines specific accounts to get balance infos for |
canBillpay (query) |
boolean This FDOBI Input Parameter/Output Label defines whether a customer has billpay privileges on a financial account. |
canTransferFrom (query) |
boolean This FDOBI Input Parameter/Output Label defines whether a customer has privileges to transfer from one financial account to other financial accounts for which that customer also has incoming transfer privileges. NOTE>> This FDOBI Input Parameter/Output Label is not the same as a wire transfer. |
canTransferTo (query) |
boolean This FDOBI Input Parameter/Output Label defines whether a customer has privileges to transfer funds to one financial account from other financial accounts for which that customer has outgoing transfer privileges. NOTE>> This FDOBI Input Parameter/Output Label is not the same as a wire transfer. |
canView (query) |
boolean This FDOBI Input Parameter/Output Label defines whether the customer has privileges to view a referenced financial account. |
numPerPage (query) |
integer This FDOBI Input Parameter/Output Label is the maximum number of response objects that can be returned in a single response; see the pageNum Input Parameter/Output Label for details about its associated functionality with this numPerPage Input Parameter/Output Label. |
pageNum (query) |
integer This FDOBI Input Parameter/Output Label specifies which page in a range of pages is desired. It defaults to 1; see the numPerPage Input Parameter/Output Label for details about its associated functionality with this pageNum Input Parameter/Output Label. |
Try It
Example responses
200 Response
{
"haveMore": true,
"incomplete": true,
"accountsBalanceInfoList": [
{
"accId": 0,
"balDetails": {
"balAsOf": "2019-08-24",
"balAsOfDescription": "2019-08-24",
"balAdjustment": 0,
"balAvailable": 0,
"balCurrent": 0
},
"incomplete": true
}
]
}
Responses
Status | Description |
---|---|
200 | OK |
Successful response | |
Schema: accountsBalanceInfoListResponse |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
postAccountsAccIdNickname
Code samples
# You can also use wget
curl -X POST /fdobi/accounts/{accId}/nickname \
-H 'Content-Type: application/json' \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'X-XSRF-TOKEN: API_KEY'
POST /fdobi/accounts/{accId}/nickname HTTP/1.1
Content-Type: application/json
Accept: application/json; charset=ISO-8859-1
var headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN':'API_KEY'
};
$.ajax({
url: '/fdobi/accounts/{accId}/nickname',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const inputBody = '{
"nickname": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN':'API_KEY'
};
fetch('/fdobi/accounts/{accId}/nickname',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN' => 'API_KEY'
}
result = RestClient.post '/fdobi/accounts/{accId}/nickname',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN': 'API_KEY'
}
r = requests.post('/fdobi/accounts/{accId}/nickname', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/accounts/{accId}/nickname");
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; charset=ISO-8859-1"},
"X-XSRF-TOKEN": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/fdobi/accounts/{accId}/nickname", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /accounts/{accId}/nickname
This Operation sets the nickname for the customer account using the accId passed in.
Body parameter
{
"nickname": "string"
}
Parameters
Parameter | Description |
---|---|
accId (path) |
integer (required) The unique identifier (aka, the "thingy") associated with the account. |
body (body) |
nicknameParams This FDOBI Input Parameter/Output Label is used to specify the nickname params (accId) |
Try It
Example responses
500 Response
{
"error": {
"code": "string",
"id": "string",
"text": "string"
}
}
Responses
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
postAccountsFavorites
Code samples
# You can also use wget
curl -X POST /fdobi/accounts/favorites \
-H 'Content-Type: application/json' \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'X-XSRF-TOKEN: API_KEY'
POST /fdobi/accounts/favorites HTTP/1.1
Content-Type: application/json
Accept: application/json; charset=ISO-8859-1
var headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN':'API_KEY'
};
$.ajax({
url: '/fdobi/accounts/favorites',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const inputBody = '{
"accIdsCsv": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN':'API_KEY'
};
fetch('/fdobi/accounts/favorites',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN' => 'API_KEY'
}
result = RestClient.post '/fdobi/accounts/favorites',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN': 'API_KEY'
}
r = requests.post('/fdobi/accounts/favorites', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/accounts/favorites");
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; charset=ISO-8859-1"},
"X-XSRF-TOKEN": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/fdobi/accounts/favorites", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /accounts/favorites
This Operation sets the current favorites list for the customer using the accIds passed in(as is).
Body parameter
{
"accIdsCsv": "string"
}
Parameters
Parameter | Description |
---|---|
body (body) |
favoritesParams This FDOBI Input Parameter/Output Label is used to specify the favorites params (accIds) |
Try It
Example responses
500 Response
{
"error": {
"code": "string",
"id": "string",
"text": "string"
}
}
Responses
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
getAccountsAccIdPledgeCusipId
Code samples
# You can also use wget
curl -X GET /fdobi/accounts/{accId}/pledge/{cusipId} \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'X-XSRF-TOKEN: API_KEY'
GET /fdobi/accounts/{accId}/pledge/{cusipId} HTTP/1.1
Accept: application/json; charset=ISO-8859-1
var headers = {
'Accept':'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN':'API_KEY'
};
$.ajax({
url: '/fdobi/accounts/{accId}/pledge/{cusipId}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN':'API_KEY'
};
fetch('/fdobi/accounts/{accId}/pledge/{cusipId}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN' => 'API_KEY'
}
result = RestClient.get '/fdobi/accounts/{accId}/pledge/{cusipId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN': 'API_KEY'
}
r = requests.get('/fdobi/accounts/{accId}/pledge/{cusipId}', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/accounts/{accId}/pledge/{cusipId}");
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; charset=ISO-8859-1"},
"X-XSRF-TOKEN": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/fdobi/accounts/{accId}/pledge/{cusipId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /accounts/{accId}/pledge/{cusipId}
This Operation returns the pledge information for the given account
Parameters
Parameter | Description |
---|---|
accId (path) |
integer (required) The account thingy used to refer to the account in the FDOBI system. |
cusipId (path) |
integer (required) The unique 9 character identification number assigned to all securities by the Committee on Uniform Security Identification Procedures |
Try It
Example responses
200 Response
{
"repurchase": "string",
"totalCollateral": 0,
"targetCollateralization": 0,
"actualCollateralization": 0,
"pledges": [
{
"cusipId": "string",
"amount": 0
}
]
}
Responses
Status | Description |
---|---|
200 | OK |
Successful response | |
Schema: accountAccIdPledgeCuspidIdResponse |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
getFxwebGetSessionData
Code samples
# You can also use wget
curl -X GET /fdobi/fxweb/get_session_data \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'X-XSRF-TOKEN: API_KEY'
GET /fdobi/fxweb/get_session_data HTTP/1.1
Accept: application/json; charset=ISO-8859-1
var headers = {
'Accept':'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN':'API_KEY'
};
$.ajax({
url: '/fdobi/fxweb/get_session_data',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN':'API_KEY'
};
fetch('/fdobi/fxweb/get_session_data',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN' => 'API_KEY'
}
result = RestClient.get '/fdobi/fxweb/get_session_data',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN': 'API_KEY'
}
r = requests.get('/fdobi/fxweb/get_session_data', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/fxweb/get_session_data");
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; charset=ISO-8859-1"},
"X-XSRF-TOKEN": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/fdobi/fxweb/get_session_data", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /fxweb/get_session_data
Returns the primary navigation and layout information for FXWEB.
Try It
Example responses
200 Response
{
"customerData": {
"custNickname": "string",
"customerId": 0,
"hasNotifyMe": true,
"billpay": "string",
"fontSize": "string",
"language": "string",
"priorAccess": "2019-08-24",
"accSort": "string",
"accountMenuHasFavories": true,
"accountMenuAccountsTotalCount": 0,
"accountMenuAccountsShowTransfers": true,
"accountMenuAccounts": {
"accId": 0,
"accDefNum": "string",
"accUrl": "string",
"accTarget": "string",
"accDescription": "string",
"accDisplayNum": 0,
"accDisplayName": "string",
"accDef": "string",
"favorite": 0
}
},
"institutionData": {
"iid": "string",
"name": "string",
"logoutURL": "string",
"logoutText": "string",
"privacyURL": "string",
"serviceAgreementURL": "string",
"customFooter": "string",
"topLivePersonBody": "string",
"customLivePersonBody": 0,
"changeAccessIdAllowed": "string",
"billpayEnabled": true,
"publicPhone": "string",
"showSpendableBalance": true,
"supportsComplexSpendableBalance": true,
"supportsCardPreferences": true,
"supportsEstatementsSSO": true,
"estatementsSSOLabel": "string",
"billpayWidgetEnabled": true,
"trusteerValidationId": 0,
"trusteerSplashId": 0,
"accTypesNoDetails": {
"type": "string",
"label": "string",
"target": "string"
},
"smartBanner": {
"bannerDaysHidden": "string",
"bannerDaysReminder": "string",
"bannerLogoFile": "string",
"bannerAppName": "string",
"bannerAppAuthor": "string"
}
},
"layout": [
{
"label": "string",
"id": "string",
"class": "string",
"link": "string",
"submenu": [
{
"label": "string",
"link": "string"
}
]
}
]
}
Responses
Status | Description |
---|---|
200 | OK |
Successful response | |
Schema: getLayoutInfoResponse |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
getFxwebPageDataHome
Code samples
# You can also use wget
curl -X GET /fdobi/fxweb/page_data/home \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'X-XSRF-TOKEN: API_KEY'
GET /fdobi/fxweb/page_data/home HTTP/1.1
Accept: application/json; charset=ISO-8859-1
var headers = {
'Accept':'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN':'API_KEY'
};
$.ajax({
url: '/fdobi/fxweb/page_data/home',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN':'API_KEY'
};
fetch('/fdobi/fxweb/page_data/home',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN' => 'API_KEY'
}
result = RestClient.get '/fdobi/fxweb/page_data/home',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN': 'API_KEY'
}
r = requests.get('/fdobi/fxweb/page_data/home', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/fxweb/page_data/home");
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; charset=ISO-8859-1"},
"X-XSRF-TOKEN": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/fdobi/fxweb/page_data/home", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /fxweb/page_data/home
This Operation returns some of the page data necessary to help create the Home page in fxweb
Try It
Example responses
200 Response
{
"showAvailableBal": true,
"supportsOutsideAccounts": true
}
Responses
Status | Description |
---|---|
200 | OK |
Successful response | |
Schema: fxwebPageDataHomeResponse |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
getFxwebPageDataAccountDetailAccId
Code samples
# You can also use wget
curl -X GET /fdobi/fxweb/page_data/account_detail/{accId} \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
GET /fdobi/fxweb/page_data/account_detail/{accId} HTTP/1.1
Accept: application/json; charset=ISO-8859-1
var headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/fxweb/page_data/account_detail/{accId}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/fxweb/page_data/account_detail/{accId}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.get '/fdobi/fxweb/page_data/account_detail/{accId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.get('/fdobi/fxweb/page_data/account_detail/{accId}', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/fxweb/page_data/account_detail/{accId}");
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; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/fdobi/fxweb/page_data/account_detail/{accId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /fxweb/page_data/account_detail/{accId}
This Operation returns some of the page data necessary to help create the Home page in fxweb
Parameters
Parameter | Description |
---|---|
accId (path) |
integer (required) This FDOBI Input Parameter/Output Label is an account identifier used to refer to the account in the FDOBI system. |
Try It
Example responses
200 Response
{
"accountDetailContent": {
"balanceText": "string",
"checkRegisterItems": "string",
"history": "string",
"historySearch": "string"
},
"accountDetailLabels": {
"apr": "string",
"balAdjustment": "string",
"balAvailable": "string",
"balCurrent": "string",
"insurerText": "string",
"itrAccrued": "string",
"itrPriorYear": "string",
"itrRate": "string",
"itrYtd": "string"
},
"custProps": {
"accQuickHistReportingPeriod": "string"
},
"displayLedgerBalanceColumn": true,
"displayXpressBalanceColumn": true,
"downloadFormats": {},
"instData": {
"displayAddAccount": true,
"primaryRT": "string",
"supportsChkReg": true
},
"instProps": {
"accQuickHistReportingPeriod": "string",
"accQuickHistReportingPeriodList": [
0
],
"accountBalanceUpdate": true,
"accountBalanceUpdateIgnoreCache": 0,
"accountsDetailHideBalanceAdjustment": "string",
"cardControlsEnabled": true,
"checkImageSupportsMultiple": 0,
"checkImageUrlAlgorithm": 0,
"detailRedirectClass": "string",
"dispPlusMinusAtTxnLevel": 0,
"hideAchAccountNumber": 0,
"pageTimeoutAccountDetail": 0,
"rtproxyDisableAccountHistory": "string",
"servicesAlternateContactUsLinkLabel": "string",
"showEnquiryLink": true,
"tabPaymentLabel": "string"
},
"links": [
{
"type": "string",
"label": "string",
"target": "string"
}
]
}
Responses
Status | Description |
---|---|
200 | OK |
Successful response | |
Schema: fxwebPageDataAccountDetailAccIdResponse |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
postFxwebHistReportPeriod
Code samples
# You can also use wget
curl -X POST /fdobi/fxweb/hist_report_period \
-H 'Content-Type: application/json' \
-H 'Accept: application/json; charset=ISO-8859-1'
POST /fdobi/fxweb/hist_report_period HTTP/1.1
Content-Type: application/json
Accept: application/json; charset=ISO-8859-1
var headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1'
};
$.ajax({
url: '/fdobi/fxweb/hist_report_period',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const inputBody = '{
"accQuickHistReportingPeriod": 0
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1'
};
fetch('/fdobi/fxweb/hist_report_period',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json; charset=ISO-8859-1'
}
result = RestClient.post '/fdobi/fxweb/hist_report_period',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json; charset=ISO-8859-1'
}
r = requests.post('/fdobi/fxweb/hist_report_period', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/fxweb/hist_report_period");
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; charset=ISO-8859-1"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/fdobi/fxweb/hist_report_period", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /fxweb/hist_report_period
This Operation checks its input agains the reporting period list and if found sets the customers quick history reporting period.
Body parameter
{
"accQuickHistReportingPeriod": 0
}
accQuickHistReportingPeriod: 0
Parameters
Parameter | Description |
---|---|
body (body) |
fxwebHistReportPeriodPostRequest (required) Data necessary for post /fxweb/hist_report_period |
Try It
Example responses
500 Response
{
"error": {
"code": "string",
"id": "string",
"text": "string"
}
}
Responses
Status | Description |
---|---|
200 | OK |
Successful response |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
getNotifyme
Code samples
# You can also use wget
curl -X GET /fdobi/notifyme \
-H 'Accept: application/json; charset=ISO-8859-1'
GET /fdobi/notifyme HTTP/1.1
Accept: application/json; charset=ISO-8859-1
var headers = {
'Accept':'application/json; charset=ISO-8859-1'
};
$.ajax({
url: '/fdobi/notifyme',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json; charset=ISO-8859-1'
};
fetch('/fdobi/notifyme',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json; charset=ISO-8859-1'
}
result = RestClient.get '/fdobi/notifyme',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json; charset=ISO-8859-1'
}
r = requests.get('/fdobi/notifyme', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/notifyme");
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; charset=ISO-8859-1"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/fdobi/notifyme", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /notifyme
An OLB customer's notifications can be retrieved using the GET /fdobi/notifyme operation. Several query parameters may be used to customize the retrieval, and (as with all FDOBI operations), the output may be returned in JSON or XML format. In case of conflicting date-related options, the priority is sinceLastLogin=, then days=, then dateStart=/dateEnd=.
Parameters
Parameter | Description |
---|---|
accId (query) |
integer This is only used when retrieving account-level alerts; thingy is the internal account identifier for the account in question. |
category (query) |
string This defines the category of notifications to return. The value of type may be one of the defined Notify Me categories ('account', 'activationMarketing', 'externalAccountValidation', 'messaging', 'pin', 'security', 'twoAWaySms', 'system'), 'all' (all categories) or 'allButMessaging' (all notifications except messages). The default, if the "category=" parameter is not provided, is 'messaging'. |
dateEnd (query) |
string(date) This defines the last date for which alerts are retrieved. It is only applicable if a dateStart parameter is supplied. If the dateStart parameter is provided but dateEnd is not, the end date defaults to the current date. |
dateStart (query) |
string(date) This defines the first date for which alerts are retrieved. If none of the starting date parameters (dateStart, days, or sinceLastLogin) are defined, the default is to retrieve all applicable alerts from the last 30 days. |
days (query) |
integer If defined, this indicates that alerts should be retrieved from the last N days. |
includePin (query) |
boolean This defines whether PIN-related notifications will be returned. The default value is false (do not return PIN-related alerts). |
sinceLastLogin (query) |
boolean This defines whether the only notifications returned were those since the last time the user logged in. The default value is false. |
Try It
Example responses
200 Response
{
"alertsAvailable": 0,
"alertsReturned": 0,
"alerts": [
{
"accId": 0,
"alertId": 0,
"category": "string",
"categoryLabel": "string",
"emailAddress": "string",
"emailAddress2": "string",
"entity": 0,
"eventId": 0,
"otherModes": "string",
"smsPhoneNumber": "string",
"subcategory": "string",
"subcategoryLabel": "string",
"threadId": 0,
"timeStamp": "2019-08-24T14:15:22Z",
"timeStampDesc": "string"
}
]
}
Responses
Status | Description |
---|---|
200 | OK |
Successful response | |
Schema: notifyMeGetResponse |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
getNotifymeAccountAccId
Code samples
# You can also use wget
curl -X GET /fdobi/notifyme/account/{accId} \
-H 'Accept: application/json; charset=ISO-8859-1'
GET /fdobi/notifyme/account/{accId} HTTP/1.1
Accept: application/json; charset=ISO-8859-1
var headers = {
'Accept':'application/json; charset=ISO-8859-1'
};
$.ajax({
url: '/fdobi/notifyme/account/{accId}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json; charset=ISO-8859-1'
};
fetch('/fdobi/notifyme/account/{accId}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json; charset=ISO-8859-1'
}
result = RestClient.get '/fdobi/notifyme/account/{accId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json; charset=ISO-8859-1'
}
r = requests.get('/fdobi/notifyme/account/{accId}', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/notifyme/account/{accId}");
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; charset=ISO-8859-1"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/fdobi/notifyme/account/{accId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /notifyme/account/{accId}
An OLB customer's notification settings for a particular account can be retrieved using the GET /fdobi/notifyme/account/:accId operation. Several query parameters may be used to customize the retrieval, and (as with all FDOBI operations), the output may be returned in JSON or XML format. The operation is GET /fdobi/notifyme/account/:accId , where ":accId" is the internal account ID of the account in question.
Parameters
Parameter | Description |
---|---|
accId (path) |
integer (required) This is the internal account identifier (the "thingy") for the account. This must be specified as the :accId component of the URL. |
Try It
Example responses
200 Response
{
"accId": 0,
"accNum": 0,
"accType": "string",
"deliveryModes": [
{
"primaryEmail": "string",
"secondaryEmail": "string",
"smsEnrolled": true,
"smsPhoneNumber": "string"
}
],
"notifications": [
{
"active": true,
"primaryEmail": true,
"secondaryEmail": true,
"smsPhoneNumber": "string",
"type": "string",
"typeDesc": "string",
"value": "string"
}
]
}
Responses
Status | Description |
---|---|
200 | OK |
Successful response | |
Schema: notifyMeAccountAccIdResponse |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
postNotifymeAccount
Code samples
# You can also use wget
curl -X POST /fdobi/notifyme/account \
-H 'Content-Type: application/json' \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'X-XSRF-TOKEN: API_KEY'
POST /fdobi/notifyme/account HTTP/1.1
Content-Type: application/json
Accept: application/json; charset=ISO-8859-1
var headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN':'API_KEY'
};
$.ajax({
url: '/fdobi/notifyme/account',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const inputBody = '{
"accId": 0,
"delivery": "string",
"frequency": 0,
"type": "string",
"value": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN':'API_KEY'
};
fetch('/fdobi/notifyme/account',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN' => 'API_KEY'
}
result = RestClient.post '/fdobi/notifyme/account',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN': 'API_KEY'
}
r = requests.post('/fdobi/notifyme/account', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/notifyme/account");
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; charset=ISO-8859-1"},
"X-XSRF-TOKEN": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/fdobi/notifyme/account", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /notifyme/account
An OLB customer's account notifications can be retrieved using the POST /fdobi/notifyme operation. These notifications are the customer-configurable alerts that may be set to trigger alerts for that account. Several parameters may be used to customize the operation, and (as with all FDOBI operations), the output may be returned in JSON or XML format.
Body parameter
{
"accId": 0,
"delivery": "string",
"frequency": 0,
"type": "string",
"value": "string"
}
Parameters
Parameter | Description |
---|---|
body (body) |
notifymeAccountParams (required) Query parameters may not be included as part of the URL, and must be in the body of the HTTP request. |
Try It
Example responses
500 Response
{
"error": {
"code": "string",
"id": "string",
"text": "string"
}
}
Responses
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
deleteNotifymeAccountAccIdType
Code samples
# You can also use wget
curl -X DELETE /fdobi/notifyme/account/{accId}/{type} \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'X-XSRF-TOKEN: API_KEY'
DELETE /fdobi/notifyme/account/{accId}/{type} HTTP/1.1
Accept: application/json; charset=ISO-8859-1
var headers = {
'Accept':'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN':'API_KEY'
};
$.ajax({
url: '/fdobi/notifyme/account/{accId}/{type}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN':'API_KEY'
};
fetch('/fdobi/notifyme/account/{accId}/{type}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN' => 'API_KEY'
}
result = RestClient.delete '/fdobi/notifyme/account/{accId}/{type}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN': 'API_KEY'
}
r = requests.delete('/fdobi/notifyme/account/{accId}/{type}', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/notifyme/account/{accId}/{type}");
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/json; charset=ISO-8859-1"},
"X-XSRF-TOKEN": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "/fdobi/notifyme/account/{accId}/{type}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /notifyme/account/{accId}/{type}
An OLB customer's account notification can be deleted using the DELETE /fdobi/notifyme/:accId/:type operation. These notifications are the customer-configurable alerts that may be set to trigger alerts for that account. As with all FDOBI operations, the output may be returned in JSON or XML format.
Parameters
Parameter | Description |
---|---|
accId (path) |
integer (required) The internal account identifier (the "thingy") for the account in question. |
type (path) |
string (required) This defines the type of notification to be removed. Valid types currently include balance> the current balance of the specified account. balanceAbove> a notification if the balance in the account exceeds a specified amount. balaceBelow> a notification if the balance in the account falls below a specified amount. checkCleared> a notification if a check (from the specified list) is paid from the account. depositAbove> a notification if a deposit is received that has a value above a specified amount. eDocumentAvailable> a notification that an electronic document is available for this account. eStatementAvailable> a notification that an electronic statement is available for this account. incomingWire> a notification that an incoming wire has been processed for this account. loanPastDue> a notification that a loan payment on this account (loan accounts only) is due or past due. maturity> a notification that the account (CD or IRA accounts only) is maturing. overdrawn> a notification if the balance in the account falls below $0. transactionAbove> a notification if a transaction worth more than a specified amount is processed. wireAck> a notification that an outgoing wire from this account has been accepted for delivery. |
Try It
Example responses
500 Response
{
"error": {
"code": "string",
"id": "string",
"text": "string"
}
}
Responses
Status | Description |
---|---|
200 | OK |
Successful response |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
deleteMessagethreadThreadId
Code samples
# You can also use wget
curl -X DELETE /fdobi/messagethread/{threadId} \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
DELETE /fdobi/messagethread/{threadId} HTTP/1.1
Accept: application/json; charset=ISO-8859-1
var headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/messagethread/{threadId}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/messagethread/{threadId}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.delete '/fdobi/messagethread/{threadId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.delete('/fdobi/messagethread/{threadId}', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/messagethread/{threadId}");
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/json; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "/fdobi/messagethread/{threadId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /messagethread/{threadId}
This operation deletes the message thread.
Parameters
Parameter | Description |
---|---|
threadId (path) |
integer (required) the id of the thread of interest |
Try It
Example responses
500 Response
{
"error": {
"code": "string",
"id": "string",
"text": "string"
}
}
Responses
Status | Description |
---|---|
200 | OK |
Thread was successfully deleted. |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
getModulesAch
Code samples
# You can also use wget
curl -X GET /fdobi/modules/ach \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
GET /fdobi/modules/ach HTTP/1.1
Accept: application/json; charset=ISO-8859-1
var headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/modules/ach',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/modules/ach',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.get '/fdobi/modules/ach',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.get('/fdobi/modules/ach', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/modules/ach");
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; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/fdobi/modules/ach", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /modules/ach
This Operation returns information about the ACH module/service for use in building links/navigation to ACH services
Parameters
Parameter | Description |
---|---|
focusCustId (query) |
integer |
Try It
Example responses
200 Response
{
"label": "string",
"type": "string",
"uris": [
{
"label": "string",
"uri": "string",
"href": "<a href=\"https://pospay.somebank.com/ExactTMS/page1/Login.aspx\" target=\"_blank\">Positive Pay Login</a>",
"suburis": [
{}
]
}
],
"learnMore": {
"content": "string",
"button": {
"uri": {
"label": "string",
"uri": "string",
"href": "<a href=\"https://pospay.somebank.com/ExactTMS/page1/Login.aspx\" target=\"_blank\">Positive Pay Login</a>",
"suburis": [
{}
]
},
"isVisible": true
}
}
}
Successful response
Responses
Status | Description |
---|---|
200 | OK |
Successful response | |
Schema: modulesResponse |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
getModulesTaxPayments
Code samples
# You can also use wget
curl -X GET /fdobi/modules/taxPayments \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
GET /fdobi/modules/taxPayments HTTP/1.1
Accept: application/json; charset=ISO-8859-1
var headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/modules/taxPayments',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/modules/taxPayments',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.get '/fdobi/modules/taxPayments',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.get('/fdobi/modules/taxPayments', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/modules/taxPayments");
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; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/fdobi/modules/taxPayments", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /modules/taxPayments
This Operation returns information about the Tax Payments module/service for use in building links/navigation to EFTPS services
Parameters
Parameter | Description |
---|---|
focusCustId (query) |
integer |
Try It
Example responses
200 Response
{
"label": "string",
"type": "string",
"uris": [
{
"label": "string",
"uri": "string",
"href": "<a href=\"https://pospay.somebank.com/ExactTMS/page1/Login.aspx\" target=\"_blank\">Positive Pay Login</a>",
"suburis": [
{}
]
}
],
"learnMore": {
"content": "string",
"button": {
"uri": {
"label": "string",
"uri": "string",
"href": "<a href=\"https://pospay.somebank.com/ExactTMS/page1/Login.aspx\" target=\"_blank\">Positive Pay Login</a>",
"suburis": [
{}
]
},
"isVisible": true
}
}
}
Successful response
Responses
Status | Description |
---|---|
200 | OK |
Successful response | |
Schema: modulesResponse |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
getModulesAdministration
Code samples
# You can also use wget
curl -X GET /fdobi/modules/administration \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
GET /fdobi/modules/administration HTTP/1.1
Accept: application/json; charset=ISO-8859-1
var headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/modules/administration',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/modules/administration',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.get '/fdobi/modules/administration',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.get('/fdobi/modules/administration', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/modules/administration");
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; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/fdobi/modules/administration", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /modules/administration
This Operation returns information about the Sub-User Administration module/service for use in building links/navigation to Sub-User Administration services
Try It
Example responses
200 Response
{
"label": "string",
"type": "string",
"uris": [
{
"label": "string",
"uri": "string",
"href": "<a href=\"https://pospay.somebank.com/ExactTMS/page1/Login.aspx\" target=\"_blank\">Positive Pay Login</a>",
"suburis": [
{}
]
}
],
"learnMore": {
"content": "string",
"button": {
"uri": {
"label": "string",
"uri": "string",
"href": "<a href=\"https://pospay.somebank.com/ExactTMS/page1/Login.aspx\" target=\"_blank\">Positive Pay Login</a>",
"suburis": [
{}
]
},
"isVisible": true
}
}
}
Successful response
Responses
Status | Description |
---|---|
200 | OK |
Successful response | |
Schema: modulesResponse |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
getModulesWireTransfers
Code samples
# You can also use wget
curl -X GET /fdobi/modules/wireTransfers \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
GET /fdobi/modules/wireTransfers HTTP/1.1
Accept: application/json; charset=ISO-8859-1
var headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/modules/wireTransfers',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/modules/wireTransfers',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.get '/fdobi/modules/wireTransfers',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.get('/fdobi/modules/wireTransfers', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/modules/wireTransfers");
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; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/fdobi/modules/wireTransfers", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /modules/wireTransfers
This Operation returns information about the Wire Transfers module/service for use in building links/navigation to Wire services
Parameters
Parameter | Description |
---|---|
focusCustId (query) |
integer |
Try It
Example responses
200 Response
{
"label": "string",
"type": "string",
"uris": [
{
"label": "string",
"uri": "string",
"href": "<a href=\"https://pospay.somebank.com/ExactTMS/page1/Login.aspx\" target=\"_blank\">Positive Pay Login</a>",
"suburis": [
{}
]
}
],
"learnMore": {
"content": "string",
"button": {
"uri": {
"label": "string",
"uri": "string",
"href": "<a href=\"https://pospay.somebank.com/ExactTMS/page1/Login.aspx\" target=\"_blank\">Positive Pay Login</a>",
"suburis": [
{}
]
},
"isVisible": true
}
}
}
Successful response
Responses
Status | Description |
---|---|
200 | OK |
Successful response | |
Schema: modulesResponse |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
getModulesBalanceReporting
Code samples
# You can also use wget
curl -X GET /fdobi/modules/balanceReporting \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
GET /fdobi/modules/balanceReporting HTTP/1.1
Accept: application/json; charset=ISO-8859-1
var headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/modules/balanceReporting',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/modules/balanceReporting',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.get '/fdobi/modules/balanceReporting',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.get('/fdobi/modules/balanceReporting', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/modules/balanceReporting");
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; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/fdobi/modules/balanceReporting", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /modules/balanceReporting
This Operation returns information about the Balance Reporting module/service for use in building links/navigation to Balance Reporting services
Parameters
Parameter | Description |
---|---|
focusCustId (query) |
integer |
Try It
Example responses
200 Response
{
"label": "string",
"type": "string",
"uris": [
{
"label": "string",
"uri": "string",
"href": "<a href=\"https://pospay.somebank.com/ExactTMS/page1/Login.aspx\" target=\"_blank\">Positive Pay Login</a>",
"suburis": [
{}
]
}
],
"learnMore": {
"content": "string",
"button": {
"uri": {
"label": "string",
"uri": "string",
"href": "<a href=\"https://pospay.somebank.com/ExactTMS/page1/Login.aspx\" target=\"_blank\">Positive Pay Login</a>",
"suburis": [
{}
]
},
"isVisible": true
}
}
}
Successful response
Responses
Status | Description |
---|---|
200 | OK |
Successful response | |
Schema: modulesResponse |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
getModulesBookTransfers
Code samples
# You can also use wget
curl -X GET /fdobi/modules/bookTransfers \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
GET /fdobi/modules/bookTransfers HTTP/1.1
Accept: application/json; charset=ISO-8859-1
var headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/modules/bookTransfers',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/modules/bookTransfers',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.get '/fdobi/modules/bookTransfers',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.get('/fdobi/modules/bookTransfers', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/modules/bookTransfers");
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; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/fdobi/modules/bookTransfers", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /modules/bookTransfers
This Operation returns information about the Book Transfers module/service for use in building links/navigation to Book Transfers services
Parameters
Parameter | Description |
---|---|
focusCustId (query) |
integer |
Try It
Example responses
200 Response
{
"label": "string",
"type": "string",
"uris": [
{
"label": "string",
"uri": "string",
"href": "<a href=\"https://pospay.somebank.com/ExactTMS/page1/Login.aspx\" target=\"_blank\">Positive Pay Login</a>",
"suburis": [
{}
]
}
],
"learnMore": {
"content": "string",
"button": {
"uri": {
"label": "string",
"uri": "string",
"href": "<a href=\"https://pospay.somebank.com/ExactTMS/page1/Login.aspx\" target=\"_blank\">Positive Pay Login</a>",
"suburis": [
{}
]
},
"isVisible": true
}
}
}
Successful response
Responses
Status | Description |
---|---|
200 | OK |
Successful response | |
Schema: modulesResponse |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
getModulesOtherServices
Code samples
# You can also use wget
curl -X GET /fdobi/modules/otherServices \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
GET /fdobi/modules/otherServices HTTP/1.1
Accept: application/json; charset=ISO-8859-1
var headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/modules/otherServices',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/modules/otherServices',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.get '/fdobi/modules/otherServices',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.get('/fdobi/modules/otherServices', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/modules/otherServices");
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; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/fdobi/modules/otherServices", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /modules/otherServices
This Operation returns information about the Other Services module/service for use in building links/navigation to Other services
Parameters
Parameter | Description |
---|---|
focusCustId (query) |
integer |
Try It
Example responses
200 Response
{
"label": "string",
"type": "string",
"uris": [
{
"label": "string",
"uri": "string",
"href": "<a href=\"https://pospay.somebank.com/ExactTMS/page1/Login.aspx\" target=\"_blank\">Positive Pay Login</a>",
"suburis": [
{}
]
}
],
"learnMore": {
"content": "string",
"button": {
"uri": {
"label": "string",
"uri": "string",
"href": "<a href=\"https://pospay.somebank.com/ExactTMS/page1/Login.aspx\" target=\"_blank\">Positive Pay Login</a>",
"suburis": [
{}
]
},
"isVisible": true
}
}
}
Successful response
Responses
Status | Description |
---|---|
200 | OK |
Successful response | |
Schema: modulesResponse |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
getModulesCheckReconciliation
Code samples
# You can also use wget
curl -X GET /fdobi/modules/checkReconciliation \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
GET /fdobi/modules/checkReconciliation HTTP/1.1
Accept: application/json; charset=ISO-8859-1
var headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/modules/checkReconciliation',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/modules/checkReconciliation',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.get '/fdobi/modules/checkReconciliation',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.get('/fdobi/modules/checkReconciliation', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/modules/checkReconciliation");
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; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/fdobi/modules/checkReconciliation", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /modules/checkReconciliation
This Operation returns information about the Check Reconciliation module/service for use in building links/navigation to Check Reconciliation
Parameters
Parameter | Description |
---|---|
focusCustId (query) |
integer |
Try It
Example responses
200 Response
{
"label": "string",
"type": "string",
"uris": [
{
"label": "string",
"uri": "string",
"href": "<a href=\"https://pospay.somebank.com/ExactTMS/page1/Login.aspx\" target=\"_blank\">Positive Pay Login</a>",
"suburis": [
{}
]
}
],
"learnMore": {
"content": "string",
"button": {
"uri": {
"label": "string",
"uri": "string",
"href": "<a href=\"https://pospay.somebank.com/ExactTMS/page1/Login.aspx\" target=\"_blank\">Positive Pay Login</a>",
"suburis": [
{}
]
},
"isVisible": true
}
}
}
Successful response
Responses
Status | Description |
---|---|
200 | OK |
Successful response | |
Schema: modulesResponse |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
putAchBatchesBatchIdRequestApprove
Code samples
# You can also use wget
curl -X PUT /fdobi/achBatches/{batchId}/requestApprove \
-H 'Content-Type: application/json' \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
PUT /fdobi/achBatches/{batchId}/requestApprove HTTP/1.1
Content-Type: application/json
Accept: application/json; charset=ISO-8859-1
var headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/achBatches/{batchId}/requestApprove',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const inputBody = '{
"batchId": 0,
"approverCustId": 0,
"focusCustId": 0
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/achBatches/{batchId}/requestApprove',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.put '/fdobi/achBatches/{batchId}/requestApprove',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.put('/fdobi/achBatches/{batchId}/requestApprove', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/achBatches/{batchId}/requestApprove");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "/fdobi/achBatches/{batchId}/requestApprove", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /achBatches/{batchId}/requestApprove
This Operation request approval of a specified ACH batch identified by its batchId number.
Body parameter
{
"batchId": 0,
"approverCustId": 0,
"focusCustId": 0
}
Parameters
Parameter | Description |
---|---|
batchId (path) |
integer (required) |
body (body) |
achBatchesBatchIdRequestApprovePutRequest (required) Data necessary for put /achBatches/{batchId}/requestApprove |
Try It
Example responses
200 Response
0
Responses
Status | Description |
---|---|
200 | OK |
Successful response | |
Schema: integer |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
putAchBatchesBatchIdUnapprove
Code samples
# You can also use wget
curl -X PUT /fdobi/achBatches/{batchId}/unapprove \
-H 'Content-Type: application/json' \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
PUT /fdobi/achBatches/{batchId}/unapprove HTTP/1.1
Content-Type: application/json
Accept: application/json; charset=ISO-8859-1
var headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/achBatches/{batchId}/unapprove',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const inputBody = '{
"batchId": 0,
"focusCustId": 0
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/achBatches/{batchId}/unapprove',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.put '/fdobi/achBatches/{batchId}/unapprove',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.put('/fdobi/achBatches/{batchId}/unapprove', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/achBatches/{batchId}/unapprove");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "/fdobi/achBatches/{batchId}/unapprove", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /achBatches/{batchId}/unapprove
This Operation unapprove of a specified ACH batch identified by its batchId number.
Body parameter
{
"batchId": 0,
"focusCustId": 0
}
Parameters
Parameter | Description |
---|---|
batchId (path) |
integer (required) |
body (body) |
achBatchesBatchIdUnapprovePutRequest (required) Data necessary for put /achBatches/{batchId}/unapprove |
Try It
Example responses
200 Response
0
Responses
Status | Description |
---|---|
200 | OK |
Successful response | |
Schema: integer |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
postAchBatches
Code samples
# You can also use wget
curl -X POST /fdobi/achBatches \
-H 'Content-Type: application/json' \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'X-XSRF-TOKEN: API_KEY'
POST /fdobi/achBatches HTTP/1.1
Content-Type: application/json
Accept: application/json; charset=ISO-8859-1
var headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN':'API_KEY'
};
$.ajax({
url: '/fdobi/achBatches',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const inputBody = '{
"batchId": 0,
"secCode": "ARC",
"compId": "string",
"recurType": "variable recurring payment",
"period": "once",
"batchType": "credit",
"settlementType": "Summary",
"companyName": "string",
"discretionaryData": "string",
"batchName": "string",
"compIdType": "string",
"settlementAccount": "string",
"newBatchP": true,
"oneTimeP": true,
"sameDayP": true,
"effectiveDate": "2019-08-24"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN':'API_KEY'
};
fetch('/fdobi/achBatches',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN' => 'API_KEY'
}
result = RestClient.post '/fdobi/achBatches',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN': 'API_KEY'
}
r = requests.post('/fdobi/achBatches', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/achBatches");
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; charset=ISO-8859-1"},
"X-XSRF-TOKEN": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/fdobi/achBatches", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /achBatches
This operation creates a new ach batch
Body parameter
{
"batchId": 0,
"secCode": "ARC",
"compId": "string",
"recurType": "variable recurring payment",
"period": "once",
"batchType": "credit",
"settlementType": "Summary",
"companyName": "string",
"discretionaryData": "string",
"batchName": "string",
"compIdType": "string",
"settlementAccount": "string",
"newBatchP": true,
"oneTimeP": true,
"sameDayP": true,
"effectiveDate": "2019-08-24"
}
Parameters
Parameter | Description |
---|---|
body (body) |
achBatchesParams (required) These are the json formated parameters that create needs to create a new batch |
Try It
Example responses
200 Response
{
"batchId": 0
}
Responses
Status | Description |
---|---|
200 | OK |
Successful response | |
Schema: achBatchesCreatePostResponse |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
getAchBatchesBatchIdItemsExport
Code samples
# You can also use wget
curl -X GET /fdobi/achBatches/{batchId}/items/export \
-H 'Accept: text/tab-separated-values' \
-H 'X-XSRF-TOKEN: API_KEY'
GET /fdobi/achBatches/{batchId}/items/export HTTP/1.1
Accept: text/tab-separated-values
var headers = {
'Accept':'text/tab-separated-values',
'X-XSRF-TOKEN':'API_KEY'
};
$.ajax({
url: '/fdobi/achBatches/{batchId}/items/export',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'text/tab-separated-values',
'X-XSRF-TOKEN':'API_KEY'
};
fetch('/fdobi/achBatches/{batchId}/items/export',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'text/tab-separated-values',
'X-XSRF-TOKEN' => 'API_KEY'
}
result = RestClient.get '/fdobi/achBatches/{batchId}/items/export',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'text/tab-separated-values',
'X-XSRF-TOKEN': 'API_KEY'
}
r = requests.get('/fdobi/achBatches/{batchId}/items/export', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/achBatches/{batchId}/items/export");
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{"text/tab-separated-values"},
"X-XSRF-TOKEN": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/fdobi/achBatches/{batchId}/items/export", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /achBatches/{batchId}/items/export
Get all the items for a batch in either tsv or nacha format
Parameters
Parameter | Description |
---|---|
batchId (path) |
integer (required) The specific batch to export items for |
fileType (query) |
string What type of file does the caller want returned? Enumerated values: tsv nacha |
includeFrozenItems (query) |
boolean Wether or not to include items that may be on hold/frozen, default is true |
includeHeaderForTsvFormat (query) |
boolean Wether or not to include the header columns when exporting tsv format, default is true |
Try It
Example responses
500 Response
{
"error": {
"error": {
"code": "string",
"id": "string",
"text": "string"
}
},
"batchHeaderMissingFields": [
"string"
],
"batchItemsMissingFields": [
"string"
],
"batchName": "string",
"trackingNumber": 0
}
General or batch field-specific errors.
Responses
Status | Description |
---|---|
200 | OK |
Successful response may be text/tab-separated-values or text/nacha file. |
Status | Description |
---|---|
500 | Internal Server Error |
General or batch field-specific errors. | |
Schema: achBatchesBatchIdItemsExportGetResponseFieldErrors |
Response Schema
getAchBatchesBatchIdItemsValidToApprove
Code samples
# You can also use wget
curl -X GET /fdobi/achBatches/{batchId}/items/validToApprove \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'X-XSRF-TOKEN: API_KEY'
GET /fdobi/achBatches/{batchId}/items/validToApprove HTTP/1.1
Accept: application/json; charset=ISO-8859-1
var headers = {
'Accept':'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN':'API_KEY'
};
$.ajax({
url: '/fdobi/achBatches/{batchId}/items/validToApprove',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN':'API_KEY'
};
fetch('/fdobi/achBatches/{batchId}/items/validToApprove',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN' => 'API_KEY'
}
result = RestClient.get '/fdobi/achBatches/{batchId}/items/validToApprove',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN': 'API_KEY'
}
r = requests.get('/fdobi/achBatches/{batchId}/items/validToApprove', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/achBatches/{batchId}/items/validToApprove");
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; charset=ISO-8859-1"},
"X-XSRF-TOKEN": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/fdobi/achBatches/{batchId}/items/validToApprove", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /achBatches/{batchId}/items/validToApprove
Check all the items of the batch (and some batch level checks(no date checks)) for errors that would prevent the items/batch from being approved.
Parameters
Parameter | Description |
---|---|
batchId (path) |
integer (required) The specific batch to validate items against |
focusCustId (query) |
integer The id of the focus customer for subuser or agent calls |
Try It
Example responses
200 Response
{
"error": {
"error": {
"code": "string",
"id": "string",
"text": "string"
}
},
"haveErrorsAtBatchLevel": true,
"haveErrorsAtBatchItemLevel": true,
"items": [
{
"index": 0,
"traceNumber": 0,
"parameterWarnings": {
"amount": "string"
},
"parameterErrors": {
"amount": "string",
"routingNumber": "string"
}
}
],
"errorsAtBatchLevel": {
"hold": "string",
"limits": "string"
}
}
Multiple errors are returned. Error at batch level when the batch has no items.
A single error
Responses
Status | Description |
---|---|
200 | OK |
Multiple errors are returned. Error at batch level when the batch has no items. | |
Schema: achBatchesBatchIdItemsResponseMultipleErrors |
Status | Description |
---|---|
500 | Internal Server Error |
A single error | |
Schema: errorType |
getAchBatchesBatchIdValidToApprove
Code samples
# You can also use wget
curl -X GET /fdobi/achBatches/{batchId}/validToApprove \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'X-XSRF-TOKEN: API_KEY'
GET /fdobi/achBatches/{batchId}/validToApprove HTTP/1.1
Accept: application/json; charset=ISO-8859-1
var headers = {
'Accept':'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN':'API_KEY'
};
$.ajax({
url: '/fdobi/achBatches/{batchId}/validToApprove',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN':'API_KEY'
};
fetch('/fdobi/achBatches/{batchId}/validToApprove',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN' => 'API_KEY'
}
result = RestClient.get '/fdobi/achBatches/{batchId}/validToApprove',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN': 'API_KEY'
}
r = requests.get('/fdobi/achBatches/{batchId}/validToApprove', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/achBatches/{batchId}/validToApprove");
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; charset=ISO-8859-1"},
"X-XSRF-TOKEN": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/fdobi/achBatches/{batchId}/validToApprove", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /achBatches/{batchId}/validToApprove
Check the batch(date checks, priv checks, limit checks, field validation) for errors that would prevent the items/batch from being approved.
Parameters
Parameter | Description |
---|---|
batchId (path) |
integer (required) The specific batch to validate items against |
focusCustId (query) |
integer The id of the focus customer for subuser or agent calls |
Try It
Example responses
200 Response
{
"error": {
"error": {
"code": "string",
"id": "string",
"text": "string"
}
},
"errorFields": {
"settlementAccount": "string",
"compId": "string",
"companyName": "string",
"batchName": "string",
"sameDay": "string"
}
}
Multiple errors are returned
A single error
Responses
Status | Description |
---|---|
200 | OK |
Multiple errors are returned | |
Schema: achBatchesBatchIdValidToApproveResponseMultipleErrors |
Status | Description |
---|---|
500 | Internal Server Error |
A single error | |
Schema: errorType |
getAchBatchesBatchIdAuthorizedApprovers
Code samples
# You can also use wget
curl -X GET /fdobi/achBatches/{batchId}/authorizedApprovers \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'X-XSRF-TOKEN: API_KEY'
GET /fdobi/achBatches/{batchId}/authorizedApprovers HTTP/1.1
Accept: application/json; charset=ISO-8859-1
var headers = {
'Accept':'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN':'API_KEY'
};
$.ajax({
url: '/fdobi/achBatches/{batchId}/authorizedApprovers',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN':'API_KEY'
};
fetch('/fdobi/achBatches/{batchId}/authorizedApprovers',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN' => 'API_KEY'
}
result = RestClient.get '/fdobi/achBatches/{batchId}/authorizedApprovers',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN': 'API_KEY'
}
r = requests.get('/fdobi/achBatches/{batchId}/authorizedApprovers', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/achBatches/{batchId}/authorizedApprovers");
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; charset=ISO-8859-1"},
"X-XSRF-TOKEN": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/fdobi/achBatches/{batchId}/authorizedApprovers", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /achBatches/{batchId}/authorizedApprovers
Get all the authorized approvers for a batch
Parameters
Parameter | Description |
---|---|
batchId (path) |
integer (required) The specific batch to export items for |
focusCustId (query) |
integer The id of the focus customer for subuser or agent calls |
Try It
Example responses
200 Response
{
"approvers": [
{
"name": "string",
"accessId": "string",
"displayAccessId": "string",
"authMethod": "string",
"entity": 0
}
]
}
Successful response, or There were no authorized approvers available.
A general error
Responses
Status | Description |
---|---|
200 | OK |
Successful response, or There were no authorized approvers available. | |
Schema: achBatchesBatchIdAuthorizedApproversGetResponseSuccess |
postAchBatchesBatchIdItemsImport
Code samples
# You can also use wget
curl -X POST /fdobi/achBatches/{batchId}/items/import \
-H 'Content-Type: application/json' \
-H 'Accept: success' \
-H 'X-XSRF-TOKEN: API_KEY'
POST /fdobi/achBatches/{batchId}/items/import HTTP/1.1
Content-Type: application/json
Accept: success
var headers = {
'Content-Type':'application/json',
'Accept':'success',
'X-XSRF-TOKEN':'API_KEY'
};
$.ajax({
url: '/fdobi/achBatches/{batchId}/items/import',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const inputBody = '{
"batchId": 0,
"attachment1": "string",
"focusCustId": 0,
"deleteItems": true
}';
const headers = {
'Content-Type':'application/json',
'Accept':'success',
'X-XSRF-TOKEN':'API_KEY'
};
fetch('/fdobi/achBatches/{batchId}/items/import',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'success',
'X-XSRF-TOKEN' => 'API_KEY'
}
result = RestClient.post '/fdobi/achBatches/{batchId}/items/import',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'success',
'X-XSRF-TOKEN': 'API_KEY'
}
r = requests.post('/fdobi/achBatches/{batchId}/items/import', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/achBatches/{batchId}/items/import");
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{"success"},
"X-XSRF-TOKEN": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/fdobi/achBatches/{batchId}/items/import", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /achBatches/{batchId}/items/import
DO NOT USE THIS SWAGGER OPERATION WHICH DOES NOT SUPPORT FILE UPLOAD. This operation imports items from a file to the specific batch
Body parameter
{
"batchId": 0,
"attachment1": "string",
"focusCustId": 0,
"deleteItems": true
}
batchId: 0
attachment1: string
focusCustId: 0
deleteItems: true
Parameters
Parameter | Description |
---|---|
batchId (path) |
integer (required) |
body (body) |
achBatchesBatchIdItemsImportPostRequest (required) Data necessary for post /achBatches/{batchId}/items/import |
Try It
Example responses
Items where added to the batch
500 Response
{
"error": {
"error": {
"code": "string",
"id": "string",
"text": "string"
}
},
"lineErrors": [
"string"
]
}
A single error, or errors in specific line in import file
Responses
Status | Description |
---|---|
200 | OK |
Items where added to the batch |
Status | Description |
---|---|
500 | Internal Server Error |
A single error, or errors in specific line in import file | |
Schema: achBatchesImportLineErrors |
Response Schema
prenoteBatch
Code samples
# You can also use wget
curl -X POST /fdobi/achBatches/{batchId}/prenote \
-H 'Content-Type: application/json' \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'X-XSRF-TOKEN: API_KEY'
POST /fdobi/achBatches/{batchId}/prenote HTTP/1.1
Content-Type: application/json
Accept: application/json; charset=ISO-8859-1
var headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN':'API_KEY'
};
$.ajax({
url: '/fdobi/achBatches/{batchId}/prenote',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const inputBody = '{
"focusCustId": 0
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN':'API_KEY'
};
fetch('/fdobi/achBatches/{batchId}/prenote',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN' => 'API_KEY'
}
result = RestClient.post '/fdobi/achBatches/{batchId}/prenote',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN': 'API_KEY'
}
r = requests.post('/fdobi/achBatches/{batchId}/prenote', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/achBatches/{batchId}/prenote");
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; charset=ISO-8859-1"},
"X-XSRF-TOKEN": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/fdobi/achBatches/{batchId}/prenote", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /achBatches/{batchId}/prenote
This operation creates a prenote for a specific batch
Body parameter
{
"focusCustId": 0
}
Parameters
Parameter | Description |
---|---|
batchId (path) |
integer (required) |
body (body) |
achBatchesBatchIdPrenoteParams (required) These are the json formated parameters that create a prenote needs |
Try It
Example responses
500 Response
{
"error": {
"code": "string",
"id": "string",
"text": "string"
}
}
This is a single error that represents when all the items for the batch have already been prenoted When this happens a new prenoted batch is not created and this error is returned
Or This is a single error that represents when there are no items in the batch that can be prenoted because all the items have insufficient/bad data When this happens a new prenoted batch is not created and this error is returned
Responses
Status | Description |
---|---|
200 | OK |
Successful response If a success is returned, then at least some of the items have been prenoted. Sometimes when this call returns success, all items have not actually been prenoted and only some of the items have been prenoted. A call to (Update batch items)PUT /achBatches/{batchId}/items for all the current items will show you any warnings/errors with items, any items that have warnings/errors would be the items that would not be prenoted. Or a call to (Get items)GET /achBatches/{batchId}/items would return all the batch items and each item would say wether it was prenoted or not |
Status | Description |
---|---|
500 | Internal Server Error |
This is a single error that represents when all the items for the batch have already been prenoted When this happens a new prenoted batch is not created and this error is returned Or This is a single error that represents when there are no items in the batch that can be prenoted because all the items have insufficient/bad data When this happens a new prenoted batch is not created and this error is returned | |
Schema: errorType |
addBatchItems
Code samples
# You can also use wget
curl -X POST /fdobi/achBatches/{batchId}/items \
-H 'Content-Type: application/json' \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'X-XSRF-TOKEN: API_KEY'
POST /fdobi/achBatches/{batchId}/items HTTP/1.1
Content-Type: application/json
Accept: application/json; charset=ISO-8859-1
var headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN':'API_KEY'
};
$.ajax({
url: '/fdobi/achBatches/{batchId}/items',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const inputBody = '{
"batchType": "vendorPaymentCreditCTX",
"items": [
{
"traceNumber": 0,
"index": 0,
"invoiceDate": "2019-08-24",
"refIdCode": 0,
"adjustmentCode": 0,
"invoiceNumber": 0,
"refIdNumber": 0,
"adjDescription": "string",
"invoiceAmount": 0,
"discountAmount": 0,
"adjustmentAmount": 0,
"remittanceAmount": 0,
"description": "string",
"routingNumber": 0,
"accountNumber": 0,
"accountType": "string",
"companyName": "string",
"name": "string",
"hold": true,
"id": 0,
"amount": 0
}
]
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN':'API_KEY'
};
fetch('/fdobi/achBatches/{batchId}/items',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN' => 'API_KEY'
}
result = RestClient.post '/fdobi/achBatches/{batchId}/items',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN': 'API_KEY'
}
r = requests.post('/fdobi/achBatches/{batchId}/items', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/achBatches/{batchId}/items");
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; charset=ISO-8859-1"},
"X-XSRF-TOKEN": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/fdobi/achBatches/{batchId}/items", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /achBatches/{batchId}/items
This operation creates items for a specific batch
Body parameter
{
"batchType": "vendorPaymentCreditCTX",
"items": [
{
"traceNumber": 0,
"index": 0,
"invoiceDate": "2019-08-24",
"refIdCode": 0,
"adjustmentCode": 0,
"invoiceNumber": 0,
"refIdNumber": 0,
"adjDescription": "string",
"invoiceAmount": 0,
"discountAmount": 0,
"adjustmentAmount": 0,
"remittanceAmount": 0,
"description": "string",
"routingNumber": 0,
"accountNumber": 0,
"accountType": "string",
"companyName": "string",
"name": "string",
"hold": true,
"id": 0,
"amount": 0
}
]
}
Parameters
Parameter | Description |
---|---|
batchId (path) |
integer (required) |
body (body) |
achBatchesBatchIdItemsParams (required) These are the json formated parameters that create needs to add items to the batch |
Try It
Example responses
200 Response
{
"items": [
{
"index": 0,
"traceNumber": 0,
"parameterWarnings": {
"amount": "string"
},
"parameterErrors": {
"amount": "string",
"routingNumber": "string"
}
}
],
"warning": {
"code": "string",
"text": "string"
},
"haveWarningsAtBatchLevel": true,
"haveWarningsAtBatchItemLevel": true,
"warningsAtBatchLevel": {
"hold": "string",
"limits": "string",
"privs": "string"
}
}
Success with no warnings or errors and all items added. or Multiple warnings, all items are added and warnings are returned. or Warnings at batch level when the batch has no items. or Warnings at batch level when the batch has items but they are all on hold/frozen(not active).
A single error
Responses
Status | Description |
---|---|
200 | OK |
Success with no warnings or errors and all items added. or Multiple warnings, all items are added and warnings are returned. or Warnings at batch level when the batch has no items. or Warnings at batch level when the batch has items but they are all on hold/frozen(not active). | |
Schema: achBatchesBatchIdItemsPostResponse |
Status | Description |
---|---|
500 | Internal Server Error |
A single error | |
Schema: achBatchesBatchIdItemsResponseMultipleErrors |
getAchBatchesBatchIdItems
Code samples
# You can also use wget
curl -X GET /fdobi/achBatches/{batchId}/items \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
GET /fdobi/achBatches/{batchId}/items HTTP/1.1
Accept: application/json; charset=ISO-8859-1
var headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/achBatches/{batchId}/items',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/achBatches/{batchId}/items',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.get '/fdobi/achBatches/{batchId}/items',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.get('/fdobi/achBatches/{batchId}/items', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/achBatches/{batchId}/items");
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; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/fdobi/achBatches/{batchId}/items", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /achBatches/{batchId}/items
This Operation returns all the items for a specific batch
Parameters
Parameter | Description |
---|---|
batchId (path) |
integer (required) |
focusCustId (query) |
integer |
Try It
Example responses
200 Response
{
"items": [
{
"accountNumber": 0,
"accountType": "string",
"amount": 0,
"hold": true,
"id": 0,
"itemType": "string",
"name": "string",
"prenote": true,
"routingNumber": 0,
"traceNumber": 0,
"addendas": [
{
"adjDescription": "string",
"adjustmentAmount": "string",
"adjustmentCode": "string",
"description": "string",
"discountAmount": "string",
"index": 0,
"invoiceAmount": "string",
"invoiceDate": "string",
"invoiceNumber": "string",
"refIdCode": "string",
"refIdNumber": "string",
"remittanceAmount": 0
}
]
}
]
}
Responses
Status | Description |
---|---|
200 | OK |
Successful response | |
Schema: achBatchesBatchIdItemsGetResponse |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
updateBatchItems
Code samples
# You can also use wget
curl -X PUT /fdobi/achBatches/{batchId}/items \
-H 'Content-Type: application/json' \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'X-XSRF-TOKEN: API_KEY'
PUT /fdobi/achBatches/{batchId}/items HTTP/1.1
Content-Type: application/json
Accept: application/json; charset=ISO-8859-1
var headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN':'API_KEY'
};
$.ajax({
url: '/fdobi/achBatches/{batchId}/items',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const inputBody = '{
"batchType": "vendorPaymentCreditCTX",
"items": [
{
"traceNumber": 0,
"index": 0,
"invoiceDate": "2019-08-24",
"refIdCode": 0,
"adjustmentCode": 0,
"invoiceNumber": 0,
"refIdNumber": 0,
"adjDescription": "string",
"invoiceAmount": 0,
"discountAmount": 0,
"adjustmentAmount": 0,
"remittanceAmount": 0,
"description": "string",
"routingNumber": 0,
"accountNumber": 0,
"accountType": "string",
"companyName": "string",
"name": "string",
"hold": true,
"id": 0,
"amount": 0
}
]
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN':'API_KEY'
};
fetch('/fdobi/achBatches/{batchId}/items',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN' => 'API_KEY'
}
result = RestClient.put '/fdobi/achBatches/{batchId}/items',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN': 'API_KEY'
}
r = requests.put('/fdobi/achBatches/{batchId}/items', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/achBatches/{batchId}/items");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json; charset=ISO-8859-1"},
"X-XSRF-TOKEN": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "/fdobi/achBatches/{batchId}/items", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /achBatches/{batchId}/items
This operation updates items for a specific batch
Body parameter
{
"batchType": "vendorPaymentCreditCTX",
"items": [
{
"traceNumber": 0,
"index": 0,
"invoiceDate": "2019-08-24",
"refIdCode": 0,
"adjustmentCode": 0,
"invoiceNumber": 0,
"refIdNumber": 0,
"adjDescription": "string",
"invoiceAmount": 0,
"discountAmount": 0,
"adjustmentAmount": 0,
"remittanceAmount": 0,
"description": "string",
"routingNumber": 0,
"accountNumber": 0,
"accountType": "string",
"companyName": "string",
"name": "string",
"hold": true,
"id": 0,
"amount": 0
}
]
}
Parameters
Parameter | Description |
---|---|
batchId (path) |
integer (required) |
body (body) |
achBatchesBatchIdItemsParams (required) These are the json formated parameters that update needs to update items to the batch |
Try It
Example responses
200 Response
{
"items": [
{
"index": 0,
"traceNumber": 0,
"parameterWarnings": {
"amount": "string"
},
"parameterErrors": {
"amount": "string",
"routingNumber": "string"
}
}
],
"warning": {
"code": "string",
"text": "string"
},
"haveWarningsAtBatchLevel": true,
"haveWarningsAtBatchItemLevel": true,
"warningsAtBatchLevel": {
"hold": "string",
"limits": "string",
"privs": "string"
}
}
Success with no warnings or errors and all items added. or Multiple warnings, all items are added and warnings are returned or High Level warnings, all items are added and warnings are returned, these warnings are not "per-item" but are more high level(related to all items) or Warnings at batch level when the batch has no items. or Warnings at batch level when the batch has items but they are all on hold/frozen(not active).
A single error or Multiple errors, no items are added and errors are returned.
Responses
Status | Description |
---|---|
200 | OK |
Success with no warnings or errors and all items added. or Multiple warnings, all items are added and warnings are returned or High Level warnings, all items are added and warnings are returned, these warnings are not "per-item" but are more high level(related to all items) or Warnings at batch level when the batch has no items. or Warnings at batch level when the batch has items but they are all on hold/frozen(not active). | |
Schema: achBatchesBatchIdItemsPostResponse |
Status | Description |
---|---|
500 | Internal Server Error |
A single error or Multiple errors, no items are added and errors are returned. | |
Schema: achBatchesBatchIdItemsResponseMultipleErrors |
deleteBatchItems
Code samples
# You can also use wget
curl -X DELETE /fdobi/achBatches/{batchId}/items/{itemId}/focusCustomer/{focusCustId} \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'X-XSRF-TOKEN: API_KEY'
DELETE /fdobi/achBatches/{batchId}/items/{itemId}/focusCustomer/{focusCustId} HTTP/1.1
Accept: application/json; charset=ISO-8859-1
var headers = {
'Accept':'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN':'API_KEY'
};
$.ajax({
url: '/fdobi/achBatches/{batchId}/items/{itemId}/focusCustomer/{focusCustId}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN':'API_KEY'
};
fetch('/fdobi/achBatches/{batchId}/items/{itemId}/focusCustomer/{focusCustId}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN' => 'API_KEY'
}
result = RestClient.delete '/fdobi/achBatches/{batchId}/items/{itemId}/focusCustomer/{focusCustId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json; charset=ISO-8859-1',
'X-XSRF-TOKEN': 'API_KEY'
}
r = requests.delete('/fdobi/achBatches/{batchId}/items/{itemId}/focusCustomer/{focusCustId}', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/achBatches/{batchId}/items/{itemId}/focusCustomer/{focusCustId}");
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/json; charset=ISO-8859-1"},
"X-XSRF-TOKEN": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "/fdobi/achBatches/{batchId}/items/{itemId}/focusCustomer/{focusCustId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /achBatches/{batchId}/items/{itemId}/focusCustomer/{focusCustId}
This operation deletes a specific item for a specific batch on a specific focus customer(Agents and subusers are acting on behalf of a focus customer)
Parameters
Parameter | Description |
---|---|
batchId (path) |
integer (required) |
itemId (path) |
integer (required) |
focusCustId (path) |
integer (required) |
Try It
Example responses
200 Response
{
"deletedItemCount": 0
}
Success with no errors and all items deleted
A single error, in this case an error that you cant delete items when the batch is past the "scheduled" state A single error, in this case an error that the item could not be found to delete it(bad batch itemId) A single error, in this case an error that the batch could not be found to delete items for(bad batchId)
Responses
Status | Description |
---|---|
200 | OK |
Success with no errors and all items deleted | |
Schema: achBatchesBatchIdItemsDeleteResponseSuccess |
Status | Description |
---|---|
500 | Internal Server Error |
A single error, in this case an error that you cant delete items when the batch is past the "scheduled" state A single error, in this case an error that the item could not be found to delete it(bad batch itemId) A single error, in this case an error that the batch could not be found to delete items for(bad batchId) | |
Schema: errorType |
getAchCustomerDetails
Code samples
# You can also use wget
curl -X GET /fdobi/ach/customer/details \
-H 'Content-Type: application/json' \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
GET /fdobi/ach/customer/details HTTP/1.1
Content-Type: application/json
Accept: application/json; charset=ISO-8859-1
var headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/ach/customer/details',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const inputBody = '{
"focusCustId": 0
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/ach/customer/details',
{
method: 'GET',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.get '/fdobi/ach/customer/details',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.get('/fdobi/ach/customer/details', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/ach/customer/details");
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{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/fdobi/ach/customer/details", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /ach/customer/details
This Operation returns customer details required for ach batch creation.
Body parameter
{
"focusCustId": 0
}
Parameters
Parameter | Description |
---|---|
body (body) |
achCustomerDetailsGetRequest (required) Data necessary for get /ach/customer/details |
Try It
Example responses
200 Response
{
"companyName": "string",
"taxIdNum": 0,
"compIdType": [
0
]
}
Successful response
Responses
Status | Description |
---|---|
200 | OK |
Successful response | |
Schema: achCustomerDetailsResponse |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
getCustomerCapabilities
Code samples
# You can also use wget
curl -X GET /fdobi/customer/capabilities \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
GET /fdobi/customer/capabilities HTTP/1.1
Accept: application/json; charset=ISO-8859-1
var headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/customer/capabilities',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/customer/capabilities',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.get '/fdobi/customer/capabilities',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.get('/fdobi/customer/capabilities', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/customer/capabilities");
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; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/fdobi/customer/capabilities", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /customer/capabilities
This operation returns a high level(general) listing of the capabilities this customer has. It is not concerned with what capabilities the customer has per account,but only that the customer has some sort of capabilities and what specifically those are. Specific capabilities can be queried for by using the appropriate customer/capabilities/* operation
Try It
Example responses
200 Response
{
"hasSomething": true,
"hasAch": true,
"hasWires": true,
"requestCapabilities": {
"label": "string",
"uri": "string",
"href": "<a href=\"https://pospay.somebank.com/ExactTMS/page1/Login.aspx\" target=\"_blank\">Positive Pay Login</a>",
"suburis": [
{}
]
}
}
Responses
Status | Description |
---|---|
200 | OK |
Successful response | |
Schema: customerCapabilitiesResponse |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
getCustomerCapabilitiesAch
Code samples
# You can also use wget
curl -X GET /fdobi/customer/capabilities/ach \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
GET /fdobi/customer/capabilities/ach HTTP/1.1
Accept: application/json; charset=ISO-8859-1
var headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/customer/capabilities/ach',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/customer/capabilities/ach',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.get '/fdobi/customer/capabilities/ach',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.get('/fdobi/customer/capabilities/ach', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/customer/capabilities/ach");
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; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/fdobi/customer/capabilities/ach", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /customer/capabilities/ach
This operation returns a high level listing of the capabilities this customer has relating to ACH. It is not concerned with what capabilities the customer has per account,but only that the customer has some sort of ACH capabilities and what specifically those are. For a higher level(general) listing of customer capabilities use the customer/capabilities operation
Try It
Example responses
200 Response
{
"credit": {
"canApprove": true,
"canApproveOther": true,
"canCreate": true,
"canDoSameDay": true,
"canDoSomething": true,
"canView": true
},
"debit": {
"canApprove": true,
"canApproveOther": true,
"canCreate": true,
"canDoSameDay": true,
"canDoSomething": true,
"canView": true
},
"import": {
"canApprove": true,
"canApproveOther": true,
"canCreate": true,
"canDoSameDay": true,
"canDoSomething": true,
"canView": true
},
"creditCCD": {
"canApprove": true,
"canApproveOther": true,
"canCreate": true,
"canDoSameDay": true,
"canDoSomething": true,
"canView": true
},
"creditCTX": {
"canApprove": true,
"canApproveOther": true,
"canCreate": true,
"canDoSameDay": true,
"canDoSomething": true,
"canView": true
},
"creditPPD": {
"canApprove": true,
"canApproveOther": true,
"canCreate": true,
"canDoSameDay": true,
"canDoSomething": true,
"canView": true
},
"debitARC": {
"canApprove": true,
"canApproveOther": true,
"canCreate": true,
"canDoSameDay": true,
"canDoSomething": true,
"canView": true
},
"debitBOC": {
"canApprove": true,
"canApproveOther": true,
"canCreate": true,
"canDoSameDay": true,
"canDoSomething": true,
"canView": true
},
"debitCCD": {
"canApprove": true,
"canApproveOther": true,
"canCreate": true,
"canDoSameDay": true,
"canDoSomething": true,
"canView": true
},
"debitCTX": {
"canApprove": true,
"canApproveOther": true,
"canCreate": true,
"canDoSameDay": true,
"canDoSomething": true,
"canView": true
},
"debitPPD": {
"canApprove": true,
"canApproveOther": true,
"canCreate": true,
"canDoSameDay": true,
"canDoSomething": true,
"canView": true
},
"debitRCK": {
"canApprove": true,
"canApproveOther": true,
"canCreate": true,
"canDoSameDay": true,
"canDoSomething": true,
"canView": true
},
"debitTEL": {
"canApprove": true,
"canApproveOther": true,
"canCreate": true,
"canDoSameDay": true,
"canDoSomething": true,
"canView": true
},
"debitWEB": {
"canApprove": true,
"canApproveOther": true,
"canCreate": true,
"canDoSameDay": true,
"canDoSomething": true,
"canView": true
}
}
Successful response
Responses
Status | Description |
---|---|
200 | OK |
Successful response | |
Schema: customerCapabilitiesAchResponse |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
getCustomerCapabilitiesWires
Code samples
# You can also use wget
curl -X GET /fdobi/customer/capabilities/wires \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
GET /fdobi/customer/capabilities/wires HTTP/1.1
Accept: application/json; charset=ISO-8859-1
var headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/customer/capabilities/wires',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/customer/capabilities/wires',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.get '/fdobi/customer/capabilities/wires',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.get('/fdobi/customer/capabilities/wires', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/customer/capabilities/wires");
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; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/fdobi/customer/capabilities/wires", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /customer/capabilities/wires
This operation returns a high level listing of the capabilities this customer has relating to wires. It is not concerned with what capabilities the customer has per account,but only that the customer has some sort of wire capabilities and what specifically those are. For a higher level(general) listing of customer capabilities use the customer/capabilities operation
Try It
Example responses
200 Response
{
"hasSomething": true,
"hasIncoming": true,
"hasTransfer": true
}
Responses
Status | Description |
---|---|
200 | OK |
Successful response | |
Schema: customerCapabilitiesWiresResponse |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
getCustomerCutoffTimesAch
Code samples
# You can also use wget
curl -X GET /fdobi/customer/cutoff_times/ach \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
GET /fdobi/customer/cutoff_times/ach HTTP/1.1
Accept: application/json; charset=ISO-8859-1
var headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/customer/cutoff_times/ach',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/customer/cutoff_times/ach',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.get '/fdobi/customer/cutoff_times/ach',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.get('/fdobi/customer/cutoff_times/ach', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/customer/cutoff_times/ach");
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; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/fdobi/customer/cutoff_times/ach", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /customer/cutoff_times/ach
This operation returns a listing of the ACH(and Same Day ACH)cut off times relevant for this customer.
Parameters
Parameter | Description |
---|---|
focusCustId (query) |
integer |
Try It
Example responses
200 Response
{
"achCutoffTimes": [
{
"label": "string",
"time": "string"
}
]
}
Responses
Status | Description |
---|---|
200 | OK |
Successful response | |
Schema: customerCutoffTimeAchResponse |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
getCustomerCutoffTimesTransfer
Code samples
# You can also use wget
curl -X GET /fdobi/customer/cutoff_times/transfer \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
GET /fdobi/customer/cutoff_times/transfer HTTP/1.1
Accept: application/json; charset=ISO-8859-1
var headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/customer/cutoff_times/transfer',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/customer/cutoff_times/transfer',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.get '/fdobi/customer/cutoff_times/transfer',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.get('/fdobi/customer/cutoff_times/transfer', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/customer/cutoff_times/transfer");
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; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/fdobi/customer/cutoff_times/transfer", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /customer/cutoff_times/transfer
This operation returns a listing of the transfer cut off times relevant for this customer.
Parameters
Parameter | Description |
---|---|
focusCustId (query) |
integer |
Try It
Example responses
200 Response
{
"transferCutoffTimes": [
{
"label": "string",
"time": "string"
}
]
}
Responses
Status | Description |
---|---|
200 | OK |
Successful response | |
Schema: customerCutoffTimeTransferResponse |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
postCustomerFocusCustomer
Code samples
# You can also use wget
curl -X POST /fdobi/customer/focusCustomer \
-H 'Content-Type: application/json' \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
POST /fdobi/customer/focusCustomer HTTP/1.1
Content-Type: application/json
Accept: application/json; charset=ISO-8859-1
var headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/customer/focusCustomer',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const inputBody = '{
"focusCustId": 0
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/customer/focusCustomer',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.post '/fdobi/customer/focusCustomer',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.post('/fdobi/customer/focusCustomer', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/customer/focusCustomer");
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; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/fdobi/customer/focusCustomer", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /customer/focusCustomer
This operation actually updates the session data for the customer to save the currently selected focus customer (This normally is only used when the caller knows they are working with an agent)
Body parameter
{
"focusCustId": 0
}
focusCustId: 0
Parameters
Parameter | Description |
---|---|
body (body) |
customerFocusCustomerPostRequest (required) Data necessary for post /customer/focusCustomer |
Try It
Example responses
500 Response
{
"error": {
"code": "string",
"id": "string",
"text": "string"
}
}
Responses
Status | Description |
---|---|
200 | OK |
Successful response |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
getCustomerFocusCustomer
Code samples
# You can also use wget
curl -X GET /fdobi/customer/focusCustomer \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
GET /fdobi/customer/focusCustomer HTTP/1.1
Accept: application/json; charset=ISO-8859-1
var headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/customer/focusCustomer',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/customer/focusCustomer',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.get '/fdobi/customer/focusCustomer',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.get('/fdobi/customer/focusCustomer', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/customer/focusCustomer");
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; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/fdobi/customer/focusCustomer", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /customer/focusCustomer
This operation returns a list of unique focus customers for the currently loged in customer (This normally is only used when the caller knows they are working with an agent)
Try It
Example responses
200 Response
{
"focusCustomers": [
{
"accessId": "string",
"displayAccessId": "string",
"entity": 0,
"displayName": "string",
"isSelectedFocusCust": true
}
]
}
Successful response
Responses
Status | Description |
---|---|
200 | OK |
Successful response | |
Schema: customerFocusCustomerGetResponse |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
getInstitutionCapabilities
Code samples
# You can also use wget
curl -X GET /fdobi/institution/capabilities \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
GET /fdobi/institution/capabilities HTTP/1.1
Accept: application/json; charset=ISO-8859-1
var headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/institution/capabilities',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/institution/capabilities',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.get '/fdobi/institution/capabilities',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.get('/fdobi/institution/capabilities', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/institution/capabilities");
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; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/fdobi/institution/capabilities", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /institution/capabilities
This operation returns a high level(general) listing of the capabilities this institution has. It is not concerned with what capabilities a customer has.
Try It
Example responses
200 Response
{
"hasAch": true,
"hasAdministration": true,
"hasBalanceReporting": true,
"hasBookTransfers": true,
"hasCheckReconciliation": true,
"hasOtherServices": true,
"hasTaxPayments": true,
"hasWireTransfers": true,
"settings": {
"displayAdminSection": true
}
}
Responses
Status | Description |
---|---|
200 | OK |
Successful response | |
Schema: institutionCapabilitiesResponse |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
getInstitutionConfigs
Code samples
# You can also use wget
curl -X GET /fdobi/institution/configs \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
GET /fdobi/institution/configs HTTP/1.1
Accept: application/json; charset=ISO-8859-1
var headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/institution/configs',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/institution/configs',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.get '/fdobi/institution/configs',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.get('/fdobi/institution/configs', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/institution/configs");
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; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/fdobi/institution/configs", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /institution/configs
This operation returns a high level(general) listing of the configs this institution has.
Try It
Example responses
200 Response
{
"canDisplayPrincipal": true,
"canDisplayInterest": true,
"displayMxLogosAndHistory": true,
"displayOutsideAccountLogos": true,
"displayTransactionLogos": true,
"extXferText": "string",
"sessionTimeoutMinutes": "string"
}
Responses
Status | Description |
---|---|
200 | OK |
Successful response | |
Schema: institutionConfigResponse |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
getSmsBankingDevices
Code samples
# You can also use wget
curl -X GET /fdobi/smsBanking/devices \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
GET /fdobi/smsBanking/devices HTTP/1.1
Accept: application/json; charset=ISO-8859-1
var headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/smsBanking/devices',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/smsBanking/devices',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.get '/fdobi/smsBanking/devices',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.get('/fdobi/smsBanking/devices', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/smsBanking/devices");
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; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/fdobi/smsBanking/devices", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /smsBanking/devices
This operation returns the sms banking devices of the customer
Try It
Example responses
200 Response
{
"list": [
{
"id": 0,
"phoneNumber": "string",
"state": "active"
}
]
}
Responses
Status | Description |
---|---|
200 | OK |
Successful response | |
Schema: getSmsBankingDevicesResponse |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
postSmsBankingDevice
Code samples
# You can also use wget
curl -X POST /fdobi/smsBanking/devices \
-H 'Content-Type: application/json' \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
POST /fdobi/smsBanking/devices HTTP/1.1
Content-Type: application/json
Accept: application/json; charset=ISO-8859-1
var headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/smsBanking/devices',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const inputBody = '{
"phoneNumber": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/smsBanking/devices',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.post '/fdobi/smsBanking/devices',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.post('/fdobi/smsBanking/devices', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/smsBanking/devices");
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; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/fdobi/smsBanking/devices", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /smsBanking/devices
This operation creates an sms banking device.
Body parameter
{
"phoneNumber": "string"
}
phoneNumber: string
Parameters
Parameter | Description |
---|---|
body (body) |
smsBankingDevicePostRequest (required) Data necessary for post /smsBanking/devices |
Try It
Example responses
500 Response
{
"error": {
"code": "string",
"id": "string",
"text": "string"
}
}
Responses
Status | Description |
---|---|
200 | OK |
Successful response |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
mb
Show all FIS mobile operations
postAuthToken
Code samples
# You can also use wget
curl -X POST /fdobi/auth-token \
-H 'Content-Type: application/json' \
-H 'Accept: application/json; charset=ISO-8859-1'
POST /fdobi/auth-token HTTP/1.1
Content-Type: application/json
Accept: application/json; charset=ISO-8859-1
var headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1'
};
$.ajax({
url: '/fdobi/auth-token',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const inputBody = '{
"appId": "string",
"biometricLogin": true,
"customerId": 0,
"deviceDetails": {},
"deviceScore": 0,
"deviceSummary": {},
"institutionId": "string",
"password": "string",
"username": "string",
"authType": "string",
"authLevel": "string",
"PIN": "string",
"accDef": 1,
"accNum": "string",
"taxIdNumber4": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1'
};
fetch('/fdobi/auth-token',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json; charset=ISO-8859-1'
}
result = RestClient.post '/fdobi/auth-token',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json; charset=ISO-8859-1'
}
r = requests.post('/fdobi/auth-token', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/auth-token");
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; charset=ISO-8859-1"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/fdobi/auth-token", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /auth-token
Gets an auth-token that resembles a session.
Body parameter
{
"appId": "string",
"biometricLogin": true,
"customerId": 0,
"deviceDetails": {},
"deviceScore": 0,
"deviceSummary": {},
"institutionId": "string",
"password": "string",
"username": "string",
"authType": "string",
"authLevel": "string",
"PIN": "string",
"accDef": 1,
"accNum": "string",
"taxIdNumber4": "string"
}
appId: string
biometricLogin: true
customerId: 0
deviceDetails: {}
deviceScore: 0
deviceSummary: {}
institutionId: string
password: string
username: string
authType: string
authLevel: string
PIN: string
accDef: 1
accNum: string
taxIdNumber4: string
Parameters
Parameter | Description |
---|---|
body (body) |
authTokenParams (required) The auth token post params |
Try It
Example responses
200 Response
{
"authToken": "string"
}
Responses
Status | Description |
---|---|
200 | OK |
Successful response | |
Schema: authTokenResponse |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
deleteAuthToken
Code samples
# You can also use wget
curl -X DELETE /fdobi/auth-token \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
DELETE /fdobi/auth-token HTTP/1.1
Accept: application/json; charset=ISO-8859-1
var headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/auth-token',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/auth-token',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.delete '/fdobi/auth-token',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.delete('/fdobi/auth-token', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/auth-token");
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/json; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "/fdobi/auth-token", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /auth-token
This Operation invalidates the authToken presented through an HTTP header.
Try It
Example responses
500 Response
{
"error": {
"code": "string",
"id": "string",
"text": "string"
}
}
Responses
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
putAuthTokenKeepalive
Code samples
# You can also use wget
curl -X PUT /fdobi/auth-token/keepalive \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
PUT /fdobi/auth-token/keepalive HTTP/1.1
Accept: application/json; charset=ISO-8859-1
var headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/auth-token/keepalive',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/auth-token/keepalive',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.put '/fdobi/auth-token/keepalive',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.put('/fdobi/auth-token/keepalive', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/auth-token/keepalive");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "/fdobi/auth-token/keepalive", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /auth-token/keepalive
This Operation pings the /fdobi server during sessions which involve calls to other servers, keeping the application's connection to the /fdobi server from timing out after 10 minutes of inactivity. This Operation must be event-driven, rather than just set to continuously run throughout the /fdobi server session, which would inappropriately defeat the /fdobi server's business rules timeout. An appropriate example of this would be while communicating with the Mobile Deposit Capture (MDC) server during the same /fdobi server session which the user logged into using the POST /fdobi/auth-token Operation.
Try It
Example responses
500 Response
{
"error": {
"code": "string",
"id": "string",
"text": "string"
}
}
Responses
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
getAccountsAccId
Code samples
# You can also use wget
curl -X GET /fdobi/accounts/{accId} \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
GET /fdobi/accounts/{accId} HTTP/1.1
Accept: application/json; charset=ISO-8859-1
var headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/accounts/{accId}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/accounts/{accId}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.get '/fdobi/accounts/{accId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.get('/fdobi/accounts/{accId}', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/accounts/{accId}");
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; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/fdobi/accounts/{accId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /accounts/{accId}
This Operation returns detailed information about a specified account using that account's ID as defined by its accId. NOTE>> This value is the FDOBI internal account ID and not the FI account number.
Parameters
Parameter | Description |
---|---|
accId (path) |
integer (required) This FDOBI Input Parameter/Output Label is an account identifier used to refer to the account in the FDOBI system. For example, in payee Operations, it is the payer's account number from which funds are used to make payment to a specified payee. |
Try It
Example responses
200 Response
{
"accId": 0,
"accDef": "string",
"accDescription": "string",
"accNickname": "string",
"accNum": "string",
"accDisplayNum": "string",
"accOwner": "string",
"accType": "string",
"accTypeDescription": "string",
"amtNextPymt": 0,
"amtPastDue": 0,
"amtPayoff": 0,
"apr": 0,
"balAsOf": "2019-08-24",
"balAsOfDescription": "2019-08-24",
"balAdjustment": 0,
"balAvailable": 0,
"balCurrent": 0,
"cashAdvanceApr": 0,
"creditLimit": 0,
"dateMaturity": "2019-08-24",
"dateNextPymt": "2019-08-24",
"dateOpened": "2019-08-24",
"incomplete": true,
"isExternal": true,
"itrAccrued": 0,
"itrPriorYear": 0,
"itrRate": 0,
"itrYtd": 0,
"monthsPastDue": 0,
"origLoanAmt": "string",
"overdraftLimit": 0,
"productDescription": "string",
"termOfAcct": "string",
"primaryDisplayAccount": 0,
"balDetails": {
"balAsOf": "2019-08-24",
"balAsOfDescription": "2019-08-24",
"balAdjustment": 0,
"balAvailable": 0,
"balCurrent": 0
},
"accPrivs": {
"canBillpay": true,
"canEstatements": true,
"canMCD": true,
"canTransferFrom": true,
"canTransferTo": true,
"canView": true
},
"accDefNum": 0
}
Responses
Status | Description |
---|---|
200 | OK |
Successful response | |
Schema: accountDetail |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
postAccountsAccIdSpendableBalance
Code samples
# You can also use wget
curl -X POST /fdobi/accounts/{accId}/spendableBalance \
-H 'Content-Type: application/json' \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
POST /fdobi/accounts/{accId}/spendableBalance HTTP/1.1
Content-Type: application/json
Accept: application/json; charset=ISO-8859-1
var headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/accounts/{accId}/spendableBalance',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const inputBody = '{
"balHoldAmount": 0,
"accId": 0,
"dateRange": 0,
"showTransfersPayments": true,
"toolTipSeen": true
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/accounts/{accId}/spendableBalance',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.post '/fdobi/accounts/{accId}/spendableBalance',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.post('/fdobi/accounts/{accId}/spendableBalance', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/accounts/{accId}/spendableBalance");
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; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/fdobi/accounts/{accId}/spendableBalance", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /accounts/{accId}/spendableBalance
This Operation sets hold amount for the accId. Also sets customer's primary display account to accId, if accId and customer's current primary display account do not match. This is enhanced to have complext spendable balance response too.. Also sets dateRange , showTransfersPayments and toolTipSeen
Body parameter
{
"balHoldAmount": 0,
"accId": 0,
"dateRange": 0,
"showTransfersPayments": true,
"toolTipSeen": true
}
Parameters
Parameter | Description |
---|---|
accId (path) |
integer (required) This FDOBI Input Parameter/Output Label defines specific account to set spendable balance infos for |
body (body) |
accountsAccIdSpendableBalancePostRequest Data necessary for post /accounts/{accId}/spendableBalance |
Try It
Example responses
200 Response
{}
Responses
Status | Description |
---|---|
200 | OK |
Successful response | |
Schema: accountsSpendableBalancePostResponse |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
getAccountsAccIdSpendableBalance
Code samples
# You can also use wget
curl -X GET /fdobi/accounts/{accId}/spendableBalance \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
GET /fdobi/accounts/{accId}/spendableBalance HTTP/1.1
Accept: application/json; charset=ISO-8859-1
var headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/accounts/{accId}/spendableBalance',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/accounts/{accId}/spendableBalance',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.get '/fdobi/accounts/{accId}/spendableBalance',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.get('/fdobi/accounts/{accId}/spendableBalance', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/accounts/{accId}/spendableBalance");
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; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/fdobi/accounts/{accId}/spendableBalance", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /accounts/{accId}/spendableBalance
This Operation returns the spendablebalance for the requested account. This is enhanced to have complext spendable balance response too.. pendingTransfersPayments were added
Parameters
Parameter | Description |
---|---|
accId (path) |
integer (required) This FDOBI Input Parameter/Output Label defines specific account to get spendable balance infos for |
Try It
Example responses
200 Response
{
"spendableBalDetails": {
"incomplete": true,
"incompleteBalance": true,
"incompleteTransactions": true,
"balAvailable": 0,
"balHoldAmount": 0,
"balToolTip": "string",
"dateRange": 0,
"showTransfersPayments": true,
"toolTipSeen": true,
"pendingTransfersPayments": [
{
"amount": 0,
"date": "2019-08-24",
"description": "string"
}
]
}
}
Responses
Status | Description |
---|---|
200 | OK |
Successful response | |
Schema: accountsSpendableBalanceResponse |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
postAccountsAccIdTransactions
Code samples
# You can also use wget
curl -X POST /fdobi/accounts/{accId}/transactions \
-H 'Content-Type: application/json' \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
POST /fdobi/accounts/{accId}/transactions HTTP/1.1
Content-Type: application/json
Accept: application/json; charset=ISO-8859-1
var headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/accounts/{accId}/transactions',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const inputBody = '{
"accId": 0,
"categories": [
"string"
],
"dateEnd": "2019-08-24",
"maxAmount": 0,
"maxCheckNum": 0,
"minCheckNum": 0,
"minAmount": 0,
"numPerPage": 0,
"pageNum": 0,
"dateStart": "2019-08-24",
"sort": "DATE_ASC",
"txnType": "CHECK"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/accounts/{accId}/transactions',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.post '/fdobi/accounts/{accId}/transactions',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.post('/fdobi/accounts/{accId}/transactions', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/accounts/{accId}/transactions");
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; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/fdobi/accounts/{accId}/transactions", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /accounts/{accId}/transactions
This Operation returns a list of transaction information for the requested account, filtered by the query parameters passed.
Some of the response elements/behavior is briefly described below.
(a) isPosted element will be there for all type of transactions
(b) if the response element isPosted value is yes then the transaction can be treated as POSTED
(c) if the response element isPosted value is false then the transaction can be treated as PENDING
(d) The cancelled txns will not be in the response
(e) 'Running Balance' / 'balRunning' can exists for the posted txns. And Running balance may be empty for pending transactions.
Additional notes: If the txn has a memo, then the memo response element will have a value. Sample is given below. "memo" : "hi memo", If the txn has a category, then the category response element will have a value. Sample is given below. "categoryId" : 29307318, "category" : "Cable TV",
Body parameter
{
"accId": 0,
"categories": [
"string"
],
"dateEnd": "2019-08-24",
"maxAmount": 0,
"maxCheckNum": 0,
"minCheckNum": 0,
"minAmount": 0,
"numPerPage": 0,
"pageNum": 0,
"dateStart": "2019-08-24",
"sort": "DATE_ASC",
"txnType": "CHECK"
}
accId: 0
categories:
- string
dateEnd: '2019-08-24'
maxAmount: 0
maxCheckNum: 0
minCheckNum: 0
minAmount: 0
numPerPage: 0
pageNum: 0
dateStart: '2019-08-24'
sort: DATE_ASC
txnType: CHECK
Parameters
Parameter | Description |
---|---|
accId (path) |
integer (required) This FDOBI Input Parameter/Output Label is an account identifier used to refer to the account in the FDOBI system. For example, in payee Operations, it is the payer's account number from which funds are used to make payment to a specified payee. |
body (body) |
accountsAccIdTransactionsPostRequest (required) Data necessary for post /accounts/{accId}/transactions |
Try It
Example responses
200 Response
{
"haveMore": true,
"txns": [
{
"amount": 0,
"balRunning": 0,
"category": "string",
"categoryId": 0,
"checkNum": "string",
"datePosted": "2019-08-24",
"description": "string",
"shortDescription": "string",
"imgAvailable": true,
"isPosted": true,
"memo": "string",
"refNum": "string",
"txnId": "string",
"txnType": "CHECK"
}
]
}
Responses
Status | Description |
---|---|
200 | OK |
Successful response | |
Schema: accountsAccIdTransactionsResponse |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
postAccountsAccIdTransactionsImages
Code samples
# You can also use wget
curl -X POST /fdobi/accounts/{accId}/transactions/images \
-H 'Content-Type: application/json' \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
POST /fdobi/accounts/{accId}/transactions/images HTTP/1.1
Content-Type: application/json
Accept: application/json; charset=ISO-8859-1
var headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/accounts/{accId}/transactions/images',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const inputBody = '{
"accId": 0,
"txnId": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/accounts/{accId}/transactions/images',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.post '/fdobi/accounts/{accId}/transactions/images',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.post('/fdobi/accounts/{accId}/transactions/images', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/accounts/{accId}/transactions/images");
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; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/fdobi/accounts/{accId}/transactions/images", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /accounts/{accId}/transactions/images
This Operation returns images associated with a customer's transaction for a specified account.
Body parameter
{
"accId": 0,
"txnId": "string"
}
accId: 0
txnId: string
Parameters
Parameter | Description |
---|---|
accId (path) |
integer (required) |
body (body) |
accountsAccIdTransactionsImagesPostRequest (required) Data necessary for post /accounts/{accId}/transactions/images |
Try It
Example responses
200 Response
[
{
"contentType": "string",
"data": "string",
"description": "string"
}
]
Responses
Status | Description |
---|---|
200 | OK |
Successful response | |
Schema: Inline |
Status | Description |
---|---|
500 | Internal Server Error |
unexpected error | |
Schema: errorType |
Response Schema
Status Code 200
images
Property Name | Description |
---|---|
images | [image] |
» contentType | string (required) |
» data | string(base64) (required) Base64 encoded image data |
» description | string (required) |
postSsoP2pRedirect
Code samples
# You can also use wget
curl -X POST /fdobi/sso/p2p/redirect \
-H 'Accept: application/json; charset=ISO-8859-1' \
-H 'Authorization: API_KEY'
POST /fdobi/sso/p2p/redirect HTTP/1.1
Accept: application/json; charset=ISO-8859-1
var headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
$.ajax({
url: '/fdobi/sso/p2p/redirect',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json; charset=ISO-8859-1',
'Authorization':'API_KEY'
};
fetch('/fdobi/sso/p2p/redirect',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json; charset=ISO-8859-1',
'Authorization' => 'API_KEY'
}
result = RestClient.post '/fdobi/sso/p2p/redirect',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json; charset=ISO-8859-1',
'Authorization': 'API_KEY'
}
r = requests.post('/fdobi/sso/p2p/redirect', params={
}, headers = headers)
print r.json()
URL obj = new URL("/fdobi/sso/p2p/redirect");
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; charset=ISO-8859-1"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/fdobi/sso/p2p/redirect", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /sso/p2p/redirect
This Operation returns the redirect action data needed to redirect to a Pay to Person (P2P) vendor via FDOBI.