Open Banking Sandbox v1.0.0
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
Open Banking Sandbox
Base URLs:
Email: Support License: UNLICENCED
Corporate APIs
Get Accounts
Code samples
# You can also use wget
curl -X GET https://sandbox.equals.co/api/corporate/v3.1/accounts \
-H 'Accept: application/json'
GET https://sandbox.equals.co/api/corporate/v3.1/accounts HTTP/1.1
Host: sandbox.equals.co
Accept: application/json
var headers = {
'Accept':'application/json'
};
$.ajax({
url: 'https://sandbox.equals.co/api/corporate/v3.1/accounts',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://sandbox.equals.co/api/corporate/v3.1/accounts',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET /corporate/v3.1/accounts
Get accounts
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
page | query | integer | false | The page of the results to return |
Example responses
200 Response
{
"Meta": {
"TotalPages": 1,
"FirstAvailableDateTime": "2020-07-17T10:52:16Z",
"LastAvailableDateTime": "2020-07-17T10:52:16Z"
},
"Data": {
"Account": [
{
"AccountId": "123",
"Currency": "EUR",
"AccountType": "Business",
"AccountSubType": "PrePaidCard",
"Description": "Euro card",
"Account": {
"SchemeName": [
"UK.OBIE.BBAN",
"UK.OBIE.IBAN",
"UK.OBIE.PAN",
"UK.OBIE.Paym",
"UK.OBIE.SortCodeAccountNumber"
],
"Identification": "1222333344441113",
"Name": "John Johnson",
"SecondaryIdentification": "1234"
}
}
]
}
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Successful response | Inline |
400 | Bad Request | Invalid data passed to the endpoint | Error |
500 | Internal Server Error | Internal server error | Error |
Response Schema
Status Code 200
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
» Meta | Meta | false | none | Meta Data relevant to the payload |
»» TotalPages | integer(int32) | false | none | none |
»» FirstAvailableDateTime | ISODateTime(date-time) | false | none | All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 |
»» LastAvailableDateTime | ISODateTime(date-time) | false | none | All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 |
» Data | object | false | none | none |
»» Account | [AccountsResponse] | false | none | none |
»»» AccountId | string | true | none | none |
»»» Currency | string | true | none | none |
»»» AccountType | string | true | none | none |
»»» AccountSubType | string | true | none | none |
»»» Description | string | true | none | none |
»»» Account | object | true | none | none |
»»»» SchemeName | string | true | none | none |
»»»» Identification | string | true | none | none |
»»»» Name | string | false | none | none |
»»»» SecondaryIdentification | string | false | none | none |
Get Single Account
Code samples
# You can also use wget
curl -X GET https://sandbox.equals.co/api/corporate/v3.1/accounts/{accountId} \
-H 'Accept: application/json'
GET https://sandbox.equals.co/api/corporate/v3.1/accounts/{accountId} HTTP/1.1
Host: sandbox.equals.co
Accept: application/json
var headers = {
'Accept':'application/json'
};
$.ajax({
url: 'https://sandbox.equals.co/api/corporate/v3.1/accounts/{accountId}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://sandbox.equals.co/api/corporate/v3.1/accounts/{accountId}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET /corporate/v3.1/accounts/{accountId}
Get Single Account
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
accountId | path | string | true | Account ID |
Example responses
200 Response
{
"Meta": {
"TotalPages": 1,
"FirstAvailableDateTime": "2020-07-17T10:52:16Z",
"LastAvailableDateTime": "2020-07-17T10:52:16Z"
},
"Data": {
"Account": [
{
"AccountId": "123",
"Currency": "EUR",
"AccountType": "Business",
"AccountSubType": "PrePaidCard",
"Description": "Euro card",
"Account": {
"SchemeName": [
"UK.OBIE.BBAN",
"UK.OBIE.IBAN",
"UK.OBIE.PAN",
"UK.OBIE.Paym",
"UK.OBIE.SortCodeAccountNumber"
],
"Identification": "1222333344441113",
"Name": "John Johnson",
"SecondaryIdentification": "1234"
}
}
]
}
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Successful response | Inline |
400 | Bad Request | Invalid data passed to the endpoint | Error |
500 | Internal Server Error | Internal server error | Error |
Response Schema
Status Code 200
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
» Meta | Meta | false | none | Meta Data relevant to the payload |
»» TotalPages | integer(int32) | false | none | none |
»» FirstAvailableDateTime | ISODateTime(date-time) | false | none | All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 |
»» LastAvailableDateTime | ISODateTime(date-time) | false | none | All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 |
» Data | object | false | none | none |
»» Account | [AccountsResponse] | false | none | none |
»»» AccountId | string | true | none | none |
»»» Currency | string | true | none | none |
»»» AccountType | string | true | none | none |
»»» AccountSubType | string | true | none | none |
»»» Description | string | true | none | none |
»»» Account | object | true | none | none |
»»»» SchemeName | string | true | none | none |
»»»» Identification | string | true | none | none |
»»»» Name | string | false | none | none |
»»»» SecondaryIdentification | string | false | none | none |
Get All Balances
Code samples
# You can also use wget
curl -X GET https://sandbox.equals.co/api/corporate/v3.1/balances \
-H 'Accept: application/json'
GET https://sandbox.equals.co/api/corporate/v3.1/balances HTTP/1.1
Host: sandbox.equals.co
Accept: application/json
var headers = {
'Accept':'application/json'
};
$.ajax({
url: 'https://sandbox.equals.co/api/corporate/v3.1/balances',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://sandbox.equals.co/api/corporate/v3.1/balances',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET /corporate/v3.1/balances
Get all balances
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
page | query | integer | false | The page of the results to return |
Example responses
200 Response
{
"Meta": {
"TotalPages": 1,
"FirstAvailableDateTime": "2020-07-17T10:52:16Z",
"LastAvailableDateTime": "2020-07-17T10:52:16Z"
},
"Data": {
"Balance": [
{
"AccountId": "123",
"Amount": {
"Amount": "1230.00",
"Currency": "GBP"
},
"CreditDebitIndicator": "Credit",
"Type": "ClosingAvailable",
"DateTime": "2020-07-17T10:52:16Z"
}
]
}
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Successful response | Inline |
400 | Bad Request | Invalid data passed to the endpoint | Error |
500 | Internal Server Error | Internal server error | Error |
Response Schema
Status Code 200
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
» Meta | Meta | false | none | Meta Data relevant to the payload |
»» TotalPages | integer(int32) | false | none | none |
»» FirstAvailableDateTime | ISODateTime(date-time) | false | none | All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 |
»» LastAvailableDateTime | ISODateTime(date-time) | false | none | All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 |
» Data | object | false | none | none |
»» Balance | [BalancesResponse] | false | none | none |
»»» AccountId | string | true | none | none |
»»» Amount | object | true | none | none |
»»»» Amount | string | true | none | none |
»»»» Currency | string | true | none | none |
»»» CreditDebitIndicator | string | true | none | Indicates whether the balance is a credit or a debit balance. Usage: A zero balance is considered to be a credit balance. |
»»» Type | string | true | none | none |
»»» DateTime | ISODateTime(date-time) | true | none | All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 |
Enumerated Values
Property | Value |
---|---|
CreditDebitIndicator | Credit |
CreditDebitIndicator | Debit |
Type | ClosingAvailable |
Type | ClosingBooked |
Type | ClosingCleared |
Type | Expected |
Type | ForwardAvailable |
Type | Information |
Type | InterimAvailable |
Type | InterimBooked |
Type | InterimCleared |
Type | OpeningAvailable |
Type | OpeningBooked |
Type | OpeningCleared |
Type | PreviouslyClosedBooked |
Get Balances
Code samples
# You can also use wget
curl -X GET https://sandbox.equals.co/api/corporate/v3.1/accounts/{accountId}/balances \
-H 'Accept: application/json'
GET https://sandbox.equals.co/api/corporate/v3.1/accounts/{accountId}/balances HTTP/1.1
Host: sandbox.equals.co
Accept: application/json
var headers = {
'Accept':'application/json'
};
$.ajax({
url: 'https://sandbox.equals.co/api/corporate/v3.1/accounts/{accountId}/balances',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://sandbox.equals.co/api/corporate/v3.1/accounts/{accountId}/balances',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET /corporate/v3.1/accounts/{accountId}/balances
Get account balances
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
accountId | path | string | true | Account ID |
page | query | integer | false | The page of the results to return |
Example responses
200 Response
{
"Meta": {
"TotalPages": 1,
"FirstAvailableDateTime": "2020-07-17T10:52:16Z",
"LastAvailableDateTime": "2020-07-17T10:52:16Z"
},
"Data": {
"Balance": [
{
"AccountId": "123",
"Amount": {
"Amount": "1230.00",
"Currency": "GBP"
},
"CreditDebitIndicator": "Credit",
"Type": "ClosingAvailable",
"DateTime": "2020-07-17T10:52:16Z"
}
]
}
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Successful response | Inline |
400 | Bad Request | Invalid data passed to the endpoint | Error |
500 | Internal Server Error | Internal server error | Error |
Response Schema
Status Code 200
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
» Meta | Meta | false | none | Meta Data relevant to the payload |
»» TotalPages | integer(int32) | false | none | none |
»» FirstAvailableDateTime | ISODateTime(date-time) | false | none | All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 |
»» LastAvailableDateTime | ISODateTime(date-time) | false | none | All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 |
» Data | object | false | none | none |
»» Balance | [BalancesResponse] | false | none | none |
»»» AccountId | string | true | none | none |
»»» Amount | object | true | none | none |
»»»» Amount | string | true | none | none |
»»»» Currency | string | true | none | none |
»»» CreditDebitIndicator | string | true | none | Indicates whether the balance is a credit or a debit balance. Usage: A zero balance is considered to be a credit balance. |
»»» Type | string | true | none | none |
»»» DateTime | ISODateTime(date-time) | true | none | All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 |
Enumerated Values
Property | Value |
---|---|
CreditDebitIndicator | Credit |
CreditDebitIndicator | Debit |
Type | ClosingAvailable |
Type | ClosingBooked |
Type | ClosingCleared |
Type | Expected |
Type | ForwardAvailable |
Type | Information |
Type | InterimAvailable |
Type | InterimBooked |
Type | InterimCleared |
Type | OpeningAvailable |
Type | OpeningBooked |
Type | OpeningCleared |
Type | PreviouslyClosedBooked |
Get All Transactions
Code samples
# You can also use wget
curl -X GET https://sandbox.equals.co/api/corporate/v3.1/transactions \
-H 'Accept: application/json'
GET https://sandbox.equals.co/api/corporate/v3.1/transactions HTTP/1.1
Host: sandbox.equals.co
Accept: application/json
var headers = {
'Accept':'application/json'
};
$.ajax({
url: 'https://sandbox.equals.co/api/corporate/v3.1/transactions',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://sandbox.equals.co/api/corporate/v3.1/transactions',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET /corporate/v3.1/transactions
Get all transactions
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
accountId | path | string | true | Account ID |
page | query | integer | false | The page of the results to return |
fromBookingDateTime | query | string | false | Show transactions on or after this date |
toBookingDateTime | query | string | false | Show transactions on or before this date |
Example responses
200 Response
{
"Meta": {
"TotalPages": 1,
"FirstAvailableDateTime": "2020-07-17T10:52:16Z",
"LastAvailableDateTime": "2020-07-17T10:52:16Z"
},
"Data": {
"Transaction": [
{
"TransactionId": "784527",
"AccountId": "123",
"CreditDebitIndicator": "Credit",
"Status": "Booked",
"BookingDateTime": "2020-07-17T10:52:16Z",
"Amount": {
"Amount": "1230.00",
"Currency": "GBP"
},
"MerchantDetails": {
"MerchantName": "Paypal",
"MerchantCategoryCode": "5932"
},
"TransactionInformation": "UNQD497"
}
]
}
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Successful response | Inline |
400 | Bad Request | Invalid data passed to the endpoint | Error |
500 | Internal Server Error | Internal server error | Error |
Response Schema
Status Code 200
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
» Meta | Meta | false | none | Meta Data relevant to the payload |
»» TotalPages | integer(int32) | false | none | none |
»» FirstAvailableDateTime | ISODateTime(date-time) | false | none | All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 |
»» LastAvailableDateTime | ISODateTime(date-time) | false | none | All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 |
» Data | object | false | none | none |
»» Transaction | [TransactionsResponse] | false | none | none |
»»» TransactionId | string | true | none | none |
»»» AccountId | string | true | none | none |
»»» CreditDebitIndicator | string | true | none | Indicates whether the transaction is a credit or a debit entry. |
»»» Status | string | true | none | Status of a transaction entry on the books of the account servicer. |
»»» BookingDateTime | string(date-time) | true | none | Date and time when a transaction entry is posted to an account on the account servicer's books. Usage: Booking date is the expected booking date, unless the status is booked, in which case it is the actual booking date.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 |
»»» Amount | object | true | none | none |
»»»» Amount | string | true | none | none |
»»»» Currency | string | true | none | none |
»»» MerchantDetails | object | false | none | none |
»»»» MerchantName | string | true | none | none |
»»»» MerchantCategoryCode | string | true | none | none |
»»» TransactionInformation | string | false | none | none |
Enumerated Values
Property | Value |
---|---|
CreditDebitIndicator | Credit |
CreditDebitIndicator | Debit |
Status | Booked |
Status | Pending |
Get Transactions
Code samples
# You can also use wget
curl -X GET https://sandbox.equals.co/api/corporate/v3.1/accounts/{accountId}/transactions \
-H 'Accept: application/json'
GET https://sandbox.equals.co/api/corporate/v3.1/accounts/{accountId}/transactions HTTP/1.1
Host: sandbox.equals.co
Accept: application/json
var headers = {
'Accept':'application/json'
};
$.ajax({
url: 'https://sandbox.equals.co/api/corporate/v3.1/accounts/{accountId}/transactions',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://sandbox.equals.co/api/corporate/v3.1/accounts/{accountId}/transactions',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET /corporate/v3.1/accounts/{accountId}/transactions
Get account transactions
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
accountId | path | string | true | Account ID |
page | query | integer | false | The page of the results to return |
fromBookingDateTime | query | string | false | Show transactions on or after this date |
toBookingDateTime | query | string | false | Show transactions on or before this date |
Example responses
200 Response
{
"Meta": {
"TotalPages": 1,
"FirstAvailableDateTime": "2020-07-17T10:52:16Z",
"LastAvailableDateTime": "2020-07-17T10:52:16Z"
},
"Data": {
"Transaction": [
{
"TransactionId": "784527",
"AccountId": "123",
"CreditDebitIndicator": "Credit",
"Status": "Booked",
"BookingDateTime": "2020-07-17T10:52:16Z",
"Amount": {
"Amount": "1230.00",
"Currency": "GBP"
},
"MerchantDetails": {
"MerchantName": "Paypal",
"MerchantCategoryCode": "5932"
},
"TransactionInformation": "UNQD497"
}
]
}
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Successful response | Inline |
400 | Bad Request | Invalid data passed to the endpoint | Error |
500 | Internal Server Error | Internal server error | Error |
Response Schema
Status Code 200
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
» Meta | Meta | false | none | Meta Data relevant to the payload |
»» TotalPages | integer(int32) | false | none | none |
»» FirstAvailableDateTime | ISODateTime(date-time) | false | none | All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 |
»» LastAvailableDateTime | ISODateTime(date-time) | false | none | All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 |
» Data | object | false | none | none |
»» Transaction | [TransactionsResponse] | false | none | none |
»»» TransactionId | string | true | none | none |
»»» AccountId | string | true | none | none |
»»» CreditDebitIndicator | string | true | none | Indicates whether the transaction is a credit or a debit entry. |
»»» Status | string | true | none | Status of a transaction entry on the books of the account servicer. |
»»» BookingDateTime | string(date-time) | true | none | Date and time when a transaction entry is posted to an account on the account servicer's books. Usage: Booking date is the expected booking date, unless the status is booked, in which case it is the actual booking date.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 |
»»» Amount | object | true | none | none |
»»»» Amount | string | true | none | none |
»»»» Currency | string | true | none | none |
»»» MerchantDetails | object | false | none | none |
»»»» MerchantName | string | true | none | none |
»»»» MerchantCategoryCode | string | true | none | none |
»»» TransactionInformation | string | false | none | none |
Enumerated Values
Property | Value |
---|---|
CreditDebitIndicator | Credit |
CreditDebitIndicator | Debit |
Status | Booked |
Status | Pending |
Schemas
Error
{
"error": {
"title": "string"
}
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
error | object | false | none | none |
» title | string | false | none | none |
Errors
{
"errors": [
{
"error": {
"title": "string"
}
}
]
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
errors | [Error] | false | none | none |
ISODateTime
"2020-07-17T10:52:16Z"
All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | string(date-time) | false | none | All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 |
Meta
{
"TotalPages": 1,
"FirstAvailableDateTime": "2020-07-17T10:52:16Z",
"LastAvailableDateTime": "2020-07-17T10:52:16Z"
}
MetaData
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
TotalPages | integer(int32) | false | none | none |
FirstAvailableDateTime | ISODateTime | false | none | All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 |
LastAvailableDateTime | ISODateTime | false | none | All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 |
AccountsResponse
{
"AccountId": "123",
"Currency": "EUR",
"AccountType": "Business",
"AccountSubType": "PrePaidCard",
"Description": "Euro card",
"Account": {
"SchemeName": [
"UK.OBIE.BBAN",
"UK.OBIE.IBAN",
"UK.OBIE.PAN",
"UK.OBIE.Paym",
"UK.OBIE.SortCodeAccountNumber"
],
"Identification": "1222333344441113",
"Name": "John Johnson",
"SecondaryIdentification": "1234"
}
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
AccountId | string | true | none | none |
Currency | string | true | none | none |
AccountType | string | true | none | none |
AccountSubType | string | true | none | none |
Description | string | true | none | none |
Account | object | true | none | none |
» SchemeName | string | true | none | none |
» Identification | string | true | none | none |
» Name | string | false | none | none |
» SecondaryIdentification | string | false | none | none |
TransactionsResponse
{
"TransactionId": "784527",
"AccountId": "123",
"CreditDebitIndicator": "Credit",
"Status": "Booked",
"BookingDateTime": "2020-07-17T10:52:16Z",
"Amount": {
"Amount": "1230.00",
"Currency": "GBP"
},
"MerchantDetails": {
"MerchantName": "Paypal",
"MerchantCategoryCode": "5932"
},
"TransactionInformation": "UNQD497"
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
TransactionId | string | true | none | none |
AccountId | string | true | none | none |
CreditDebitIndicator | string | true | none | Indicates whether the transaction is a credit or a debit entry. |
Status | string | true | none | Status of a transaction entry on the books of the account servicer. |
BookingDateTime | string(date-time) | true | none | Date and time when a transaction entry is posted to an account on the account servicer's books. Usage: Booking date is the expected booking date, unless the status is booked, in which case it is the actual booking date.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 |
Amount | object | true | none | none |
» Amount | string | true | none | none |
» Currency | string | true | none | none |
MerchantDetails | object | false | none | none |
» MerchantName | string | true | none | none |
» MerchantCategoryCode | string | true | none | none |
TransactionInformation | string | false | none | none |
Enumerated Values
Property | Value |
---|---|
CreditDebitIndicator | Credit |
CreditDebitIndicator | Debit |
Status | Booked |
Status | Pending |
BalancesResponse
{
"AccountId": "123",
"Amount": {
"Amount": "1230.00",
"Currency": "GBP"
},
"CreditDebitIndicator": "Credit",
"Type": "ClosingAvailable",
"DateTime": "2020-07-17T10:52:16Z"
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
AccountId | string | true | none | none |
Amount | object | true | none | none |
» Amount | string | true | none | none |
» Currency | string | true | none | none |
CreditDebitIndicator | string | true | none | Indicates whether the balance is a credit or a debit balance. Usage: A zero balance is considered to be a credit balance. |
Type | string | true | none | none |
DateTime | ISODateTime | true | none | All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 |
Enumerated Values
Property | Value |
---|---|
CreditDebitIndicator | Credit |
CreditDebitIndicator | Debit |
Type | ClosingAvailable |
Type | ClosingBooked |
Type | ClosingCleared |
Type | Expected |
Type | ForwardAvailable |
Type | Information |
Type | InterimAvailable |
Type | InterimBooked |
Type | InterimCleared |
Type | OpeningAvailable |
Type | OpeningBooked |
Type | OpeningCleared |
Type | PreviouslyClosedBooked |