Transactions
Download SpecOkra API endpoints for Transactions
Get transaction by id
This endpoint allows you retrieve a paginated list of a specific transaction of a customer.
id
string
bearer
Request
{
"id": "// id"
}Response
OK
{
"status": "success",
"message": "Transactions retrieved succesfully",
"data": {
"pagination": {
"totalDocs": 1,
"limit": 20,
"hasPrevPage": false,
"hasNextPage": false,
"page": 1,
"totalPages": 1,
"pagingCounter": 1
},
"transaction": [
{
"_id": "",
"notes": {
"desc": "",
"topics": [],
"places": [],
"people": [],
"actions": [
""
],
"subjects": [
""
],
"prepositions": [
""
]
},
"manual": false,
"reconciled": false,
"fetched": [
""
],
"record": [
""
],
"actions": [],
"trans_date": "",
"cleared_date": "",
"unformatted_trans_date": "",
"unformatted_cleared_date": "",
"debit": 0.01,
"ref": " ",
"bank": {
"icon": "",
"logo": "",
"name": "",
"status": ""
},
"customer": {
"_id": "",
"name": ""
},
"account": {
"_id": "",
"name": ""
},
"env": "",
"checked": [],
"created_at": "",
"last_updated": "",
"__v": 0,
"id": ""
}
]
}
}Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
status
string
message
string
data
object (data)
- Example
- { "pagination": { "totalDocs": 591, "limit": 1, "hasPrevPage": false, "hasNextPage": true, "page": 1, "totalPages": 591, "pagingCounter": 1, "nextPage": 2 }, "transaction": [ { "_id": "", "notes": { "desc": "", "topics": [], "places": [], "people": [], "actions": [ "" ], "subjects": [ "" ], "prepositions": [] }, "manual": false, "reconciled": false, "fetched": [ "" ], "record": [ "" ], "actions": [], "trans_date": "", "cleared_date": "", "unformatted_trans_date": "", "unformatted_cleared_date": "", "debit": 52.5, "ref": " ", "bank": { "icon": "", "logo": "", "name": "", "status": "" }, "customer": { "_id": "", "name": "" }, "account": { "_id": "", "name": "" }, "env": "", "checked": [], "created_at": "", "last_updated": "", "__v": 0, "id": "" } ] }
pagination
object (pagination)
totalDocs
int
i32
The total number of results that match the request.
limit
int
i32
Returns the value of the limit parameter. Limit sets the number of results that the API returns in a single page. If you do not specify a value for limit, the API will limit the response to 10 results per page.
hasPrevPage
boolean
Shows when a previous page of results is available. This field always returns true when the value of page is greater than 1.
hasNextPage
boolean
Shows when a next page of results is available. When true, Okra recommends that you make subsequent requests to retrieve the following pages of results.
page
int
i32
Returns the number of the current page. For example, if you set page to 1 in your request, the API will return the first page of results in the response.
totalPages
int
i32
The total number of pages that the API returns.
pagingCounter
int
i32
The index number of the first result on the current page. For example, if the value of page is 2 and limit is set to 10, then pagingCounter returns 11.
prevPage
string or null
The number of previous result pages. If the value of page is 1 and there is no previous page, the value of prevPage is null.
nextPage
string or null
The number of following result pages. Each page consists of up to 100 items. If there are not enough results for an additional page, the value is null.
transaction
array[object (Transaction)]
Transaction
object (Transaction)
- Example
- { "_id": "", "notes": { "desc": "", "topics": [], "places": [], "people": [], "actions": [ "" ], "subjects": [ "" ], "prepositions": [ "" ] }, "manual": false, "reconciled": false, "fetched": [ "" ], "record": [ "" ], "actions": [], "trans_date": "", "cleared_date": "", "unformatted_trans_date": "", "unformatted_cleared_date": "", "debit": 0.01, "ref": " ", "bank": { "icon": "", "logo": "", "name": "", "status": "" }, "customer": { "_id": "", "name": "" }, "account": { "_id": "", "name": "" }, "env": "", "checked": [], "created_at": "", "last_updated": "", "__v": 0, "id": "" }
_id
string
The unique transaction identifier.
notes
object (notes)
- Example
- { "actions": [ "" ], "desc": "", "people": [], "places": [], "prepositions": [], "subjects": [ "", "" ], "topics": [] }
actions
array[string]
string
desc
string
people
array[string]
string
places
array[string]
string
prepositions
array[string]
string
subjects
array[string]
string
topics
array[string]
string
manual
boolean
A boolean that describes if it was fetched directly from user statement, we return TRUE or FALSE.
reconciled
boolean
A boolean that describes if transaction has been reconciled, we return TRUE or FALSE.
fetched
array[string]
The client id, that fetched the transaction.
string
record
array[string]
The record id, unique Okra app process identifier.
string
actions
array[string]
The webhook id used during reconciliation.
string
trans_date
string
Timestamp in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ) indicating the date when the transaction was carried out.
cleared_date
string
Timestamp in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ) indicating the date when the transaction was effected.
unformatted_trans_date
string
Timestamp in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ) indicating the transaction date format returned from bank.
unformatted_cleared_date
string
Timestamp in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ) indicating the cleared date format returned from bank.
debit
number
The Amount debited from the bank.
ref
string
The transaction bank reference number.
customer
object (customer)
_id
string
The unique identifier that references the user.
name
string
The user’s full name.
account
object (account)
- Example
- { "_id": "", "name": "" }
_id
string
The unique identifier created by Okra used to reference the balance.
name
string
The account name of the account holder as returned from the bank
env
string
The application environment where the process was carried out.
checked
array[string]
The companies that have viewed this transaction.
string
created_at
string
Timestamp in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ) indicating the first time that the transaction for the given account was created.
last_updated
string
Timestamp in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ) indicating the last time that the transaction for the given account has been updated
__v
int
i32
The document version
id
string
The transaction unique id
Content-Security-Policy
string
- Content Type
- text/plain
- Example
- "default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"
X-DNS-Prefetch-Control
string
- Content Type
- text/plain
- Example
- "off"
Expect-CT
string
- Content Type
- text/plain
- Example
- "max-age=0"
X-Frame-Options
string
- Content Type
- text/plain
- Example
- "SAMEORIGIN"
Strict-Transport-Security
string
- Content Type
- text/plain
- Example
- "max-age=15552000; includeSubDomains"
X-Download-Options
string
- Content Type
- text/plain
- Example
- "noopen"
X-Content-Type-Options
string
- Content Type
- text/plain
- Example
- "nosniff"
X-Permitted-Cross-Domain-Policies
string
- Content Type
- text/plain
- Example
- "none"
Referrer-Policy
string
- Content Type
- text/plain
- Example
- "no-referrer"
X-XSS-Protection
string
- Content Type
- text/plain
- Example
- "0"
Access-Control-Allow-Methods
string
- Content Type
- text/plain
- Example
- "GET, POST, OPTIONS, PUT, PATCH, DELETE"
Access-Control-Allow-Headers
string
- Content Type
- text/plain
- Example
- "X-Requested-With,content-type,authorization"
Access-Control-Allow-Credentials
string
- Content Type
- text/plain
- Example
- "true"
Content-Length
string
- Content Type
- text/plain
- Example
- "2103"
ETag
string
- Content Type
- text/plain
- Example
- "W/\"837-EXPcmkJqrWBnDyQiFvg30ctfgD4\""
Date
string
- Content Type
- text/plain
- Example
- "Tue, 01 Dec 2020 13:01:49 GMT"
Connection
string
- Content Type
- text/plain
- Example
- "keep-alive"
Keep-Alive
string
- Content Type
- text/plain
- Example
- "timeout=5"
Get transaction by account
This endpoint allows you retrieve a paginated list of a specific transaction of a customer using the accountId
account
string
page
string
limit
string
bearer
Request
{
"account": "// account id",
"page": "1",
"limit": "1"
}Response
OK
{
"status": "success",
"message": "Transactions retrieved succesfully",
"data": {
"pagination": {
"totalDocs": 38,
"limit": 1,
"hasPrevPage": false,
"hasNextPage": true,
"page": 1,
"totalPages": 38,
"pagingCounter": 1,
"nextPage": 2
},
"transaction": [
{
"_id": "",
"notes": {
"desc": "",
"topics": [],
"places": [],
"people": [],
"actions": [
""
],
"subjects": [
"",
""
],
"prepositions": []
},
"manual": false,
"reconciled": false,
"fetched": [
""
],
"record": [
""
],
"actions": [],
"trans_date": "",
"cleared_date": "",
"unformatted_trans_date": "",
"unformatted_cleared_date": "",
"debit": 0.03,
"bank": {
"icon": "",
"logo": "",
"name": "",
"status": ""
},
"customer": {
"_id": "",
"name": ""
},
"account": {
"_id": "",
"name": ""
},
"env": "",
"checked": [],
"created_at": "",
"last_updated": "",
"__v": 0,
"id": ""
}
]
}
}Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
status
string
message
string
data
object (data)
- Example
- { "pagination": { "totalDocs": 38, "limit": 1, "hasPrevPage": false, "hasNextPage": true, "page": 1, "totalPages": 38, "pagingCounter": 1, "nextPage": 2 }, "transaction": [ { "_id": "", "notes": { "desc": "", "topics": [], "places": [], "people": [], "actions": [ "" ], "subjects": [ "", "" ], "prepositions": [] }, "manual": false, "reconciled": false, "fetched": [ "" ], "record": [ "" ], "actions": [], "trans_date": "", "cleared_date": "", "unformatted_trans_date": "", "unformatted_cleared_date": "", "debit": 0.03, "bank": { "icon": "", "logo": "", "name": "", "status": "" }, "customer": { "_id": "", "name": "" }, "account": { "_id": "", "name": "" }, "env": "", "checked": [], "created_at": "", "last_updated": "", "__v": 0, "id": "" } ] }
pagination
object (pagination)
totalDocs
int
i32
The total number of results that match the request.
limit
int
i32
Returns the value of the limit parameter. Limit sets the number of results that the API returns in a single page. If you do not specify a value for limit, the API will limit the response to 10 results per page.
hasPrevPage
boolean
Shows when a previous page of results is available. This field always returns true when the value of page is greater than 1.
hasNextPage
boolean
Shows when a next page of results is available. When true, Okra recommends that you make subsequent requests to retrieve the following pages of results.
page
int
i32
Returns the number of the current page. For example, if you set page to 1 in your request, the API will return the first page of results in the response.
totalPages
int
i32
The total number of pages that the API returns.
pagingCounter
int
i32
The index number of the first result on the current page. For example, if the value of page is 2 and limit is set to 10, then pagingCounter returns 11.
prevPage
string or null
The number of previous result pages. If the value of page is 1 and there is no previous page, the value of prevPage is null.
nextPage
string or null
The number of following result pages. Each page consists of up to 100 items. If there are not enough results for an additional page, the value is null.
transaction
array[object (TransactionByAccountData)]
TransactionByAccountData
object (TransactionByAccountData)
- Example
- { "_id": "", "notes": { "desc": "", "topics": [], "places": [], "people": [], "actions": [ "" ], "subjects": [ "", "" ], "prepositions": [] }, "manual": false, "reconciled": false, "fetched": [ "" ], "record": [ "" ], "actions": [], "trans_date": "", "cleared_date": "", "unformatted_trans_date": "", "unformatted_cleared_date": "", "debit": 0.03, "bank": { "icon": "", "logo": "", "name": "", "status": "" }, "customer": { "_id": "", "name": "" }, "account": { "_id": "", "name": "" }, "env": "", "checked": [], "created_at": "", "last_updated": "", "__v": 0, "id": "" }
_id
string
The unique transaction identifier.
notes
object (notes)
- Example
- { "actions": [ "" ], "desc": "", "people": [], "places": [], "prepositions": [], "subjects": [ "", "" ], "topics": [] }
actions
array[string]
string
desc
string
people
array[string]
string
places
array[string]
string
prepositions
array[string]
string
subjects
array[string]
string
topics
array[string]
string
manual
boolean
A boolean that describes if it was fetched directly from user statement, we return TRUE or FALSE.
reconciled
boolean
A boolean that describes if transaction has been reconciled, we return TRUE or FALSE.
fetched
array[string]
The client id, that fetched the transaction.
string
record
array[string]
The record id, unique Okra app process identifier.
string
actions
array[string]
The webhook id used during reconciliation.
string
trans_date
string
Timestamp in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ) indicating the date when the transaction was carried out.
cleared_date
string
Timestamp in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ) indicating the date when the transaction was effected.
unformatted_trans_date
string
Timestamp in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ) indicating the transaction date format returned from bank.
unformatted_cleared_date
string
Timestamp in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ) indicating the cleared date format returned from bank.
debit
number
The Amount debited from the bank.
ref
string
The transaction bank reference number.
customer
object (customer)
_id
string
The unique identifier that references the user.
name
string
The user’s full name.
account
object (account)
- Example
- { "_id": "", "name": "" }
_id
string
The unique identifier created by Okra used to reference the balance.
name
string
The account name of the account holder as returned from the bank
env
string
The application environment where the process was carried out.
checked
array[string]
The companies that have viewed this transaction.
string
created_at
string
Timestamp in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ) indicating the first time that the transaction for the given account was created.
last_updated
string
Timestamp in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ) indicating the last time that the transaction for the given account has been updated
__v
int
i32
The document version
id
string
The transaction unique id
Content-Security-Policy
string
- Content Type
- text/plain
- Example
- "default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"
X-DNS-Prefetch-Control
string
- Content Type
- text/plain
- Example
- "off"
Expect-CT
string
- Content Type
- text/plain
- Example
- "max-age=0"
X-Frame-Options
string
- Content Type
- text/plain
- Example
- "SAMEORIGIN"
Strict-Transport-Security
string
- Content Type
- text/plain
- Example
- "max-age=15552000; includeSubDomains"
X-Download-Options
string
- Content Type
- text/plain
- Example
- "noopen"
X-Content-Type-Options
string
- Content Type
- text/plain
- Example
- "nosniff"
X-Permitted-Cross-Domain-Policies
string
- Content Type
- text/plain
- Example
- "none"
Referrer-Policy
string
- Content Type
- text/plain
- Example
- "no-referrer"
X-XSS-Protection
string
- Content Type
- text/plain
- Example
- "0"
Access-Control-Allow-Methods
string
- Content Type
- text/plain
- Example
- "GET, POST, OPTIONS, PUT, PATCH, DELETE"
Access-Control-Allow-Headers
string
- Content Type
- text/plain
- Example
- "X-Requested-With,content-type,authorization"
Access-Control-Allow-Credentials
string
- Content Type
- text/plain
- Example
- "true"
Content-Length
string
- Content Type
- text/plain
- Example
- "2059"
ETag
string
- Content Type
- text/plain
- Example
- "W/\"80b-NeTS8crMcWktjDYc9jSIGSpnGoA\""
Date
string
- Content Type
- text/plain
- Example
- "Tue, 01 Dec 2020 13:15:20 GMT"
Connection
string
- Content Type
- text/plain
- Example
- "keep-alive"
Keep-Alive
string
- Content Type
- text/plain
- Example
- "timeout=5"
Get transaction by date
This endpoint allows you retrieve a paginated list of a specific transaction of a customer within a specific date range.
from
string
to
string
page
int
i32
limit
int
i32
bearer
Request
{
"from": "2020-04-25",
"to": "2020-06-29",
"page": 1,
"limit": 1
}Response
OK
{
"status": "success",
"message": "Transactions retrieved succesfully",
"data": {
"pagination": {
"totalDocs": 2339,
"limit": 1,
"hasPrevPage": false,
"hasNextPage": true,
"page": 1,
"totalPages": 2339,
"pagingCounter": 1,
"nextPage": 2
},
"transaction": [
{
"_id": "",
"notes": {
"desc": "",
"topics": [],
"places": [],
"people": [],
"actions": [
"",
""
],
"subjects": [
"",
""
],
"prepositions": []
},
"manual": false,
"reconciled": false,
"fetched": [
""
],
"record": [
""
],
"actions": [],
"analyzed": [
""
],
"ner": {
"TRANS_TYPE": ""
},
"ner_v": 1,
"trans_date": "",
"cleared_date": "",
"unformatted_trans_date": "",
"unformatted_cleared_date": "",
"debit": 52.5,
"ref": " ",
"bank": {
"icon": "",
"logo": "",
"name": "",
"status": ""
},
"customer": {
"_id": "",
"name": ""
},
"account": {
"_id": "",
"name": ""
},
"env": "",
"checked": [],
"created_at": "",
"last_updated": "",
"__v": 0,
"id": ""
}
]
}
}Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
status
string
message
string
data
object (data)
- Example
- { "pagination": { "totalDocs": 2339, "limit": 1, "hasPrevPage": false, "hasNextPage": true, "page": 1, "totalPages": 2339, "pagingCounter": 1, "nextPage": 2 }, "transaction": [ { "_id": "", "notes": { "desc": "", "topics": [], "places": [], "people": [], "actions": [ "", "" ], "subjects": [ "", "" ], "prepositions": [] }, "manual": false, "reconciled": false, "fetched": [ "" ], "record": [ "" ], "actions": [], "analyzed": [ "" ], "ner": { "TRANS_TYPE": "" }, "ner_v": 1, "trans_date": "", "cleared_date": "", "unformatted_trans_date": "", "unformatted_cleared_date": "", "debit": 52.5, "ref": " ", "bank": { "icon": "", "logo": "", "name": "", "status": "" }, "customer": { "_id": "", "name": "" }, "account": { "_id": "", "name": "" }, "env": "", "checked": [], "created_at": "", "last_updated": "", "__v": 0, "id": "" } ] }
pagination
object (pagination)
totalDocs
int
i32
The total number of results that match the request.
limit
int
i32
Returns the value of the limit parameter. Limit sets the number of results that the API returns in a single page. If you do not specify a value for limit, the API will limit the response to 10 results per page.
hasPrevPage
boolean
Shows when a previous page of results is available. This field always returns true when the value of page is greater than 1.
hasNextPage
boolean
Shows when a next page of results is available. When true, Okra recommends that you make subsequent requests to retrieve the following pages of results.
page
int
i32
Returns the number of the current page. For example, if you set page to 1 in your request, the API will return the first page of results in the response.
totalPages
int
i32
The total number of pages that the API returns.
pagingCounter
int
i32
The index number of the first result on the current page. For example, if the value of page is 2 and limit is set to 10, then pagingCounter returns 11.
prevPage
string or null
The number of previous result pages. If the value of page is 1 and there is no previous page, the value of prevPage is null.
nextPage
string or null
The number of following result pages. Each page consists of up to 100 items. If there are not enough results for an additional page, the value is null.
transaction
array[object (TransactionByDateObject)]
TransactionByDateObject
object (TransactionByDateObject)
_id
string
The unique transaction identifier.
notes
object (notes)
- Example
- { "actions": [ "" ], "desc": "", "people": [], "places": [], "prepositions": [], "subjects": [ "", "" ], "topics": [] }
actions
array[string]
string
desc
string
people
array[string]
string
places
array[string]
string
prepositions
array[string]
string
subjects
array[string]
string
topics
array[string]
string
manual
boolean
A boolean that describes if it was fetched directly from user statement, we return TRUE or FALSE.
reconciled
boolean
A boolean that describes if transaction has been reconciled, we return TRUE or FALSE.
fetched
array[string]
The client id, that fetched the transaction.
string
record
array[string]
The record id, unique Okra app process identifier.
string
actions
array[string]
The webhook id used during reconciliation.
string
Content-Security-Policy
string
- Content Type
- text/plain
- Example
- "default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"
X-DNS-Prefetch-Control
string
- Content Type
- text/plain
- Example
- "off"
Expect-CT
string
- Content Type
- text/plain
- Example
- "max-age=0"
X-Frame-Options
string
- Content Type
- text/plain
- Example
- "SAMEORIGIN"
Strict-Transport-Security
string
- Content Type
- text/plain
- Example
- "max-age=15552000; includeSubDomains"
X-Download-Options
string
- Content Type
- text/plain
- Example
- "noopen"
X-Content-Type-Options
string
- Content Type
- text/plain
- Example
- "nosniff"
X-Permitted-Cross-Domain-Policies
string
- Content Type
- text/plain
- Example
- "none"
Referrer-Policy
string
- Content Type
- text/plain
- Example
- "no-referrer"
X-XSS-Protection
string
- Content Type
- text/plain
- Example
- "0"
Access-Control-Allow-Methods
string
- Content Type
- text/plain
- Example
- "GET, POST, OPTIONS, PUT, PATCH, DELETE"
Access-Control-Allow-Headers
string
- Content Type
- text/plain
- Example
- "X-Requested-With,content-type,authorization"
Access-Control-Allow-Credentials
string
- Content Type
- text/plain
- Example
- "true"
Content-Length
string
- Content Type
- text/plain
- Example
- "2233"
ETag
string
- Content Type
- text/plain
- Example
- "W/\"8b9-tcgvO7oLVf5NS7vpOkSx5NDsioc\""
Date
string
- Content Type
- text/plain
- Example
- "Tue, 01 Dec 2020 13:30:39 GMT"
Connection
string
- Content Type
- text/plain
- Example
- "keep-alive"
Keep-Alive
string
- Content Type
- text/plain
- Example
- "timeout=5"
Get transaction by customer date
This endpoint allows you retrieve a paginated list of a specific transaction of a customer within a specific customer date range.
from
string
to
string
page
int
i32
limit
int
i32
customer_id
string
bearer
Request
{
"from": "2020-04-25",
"to": "2020-06-29",
"page": 1,
"limit": 1,
"customer_id": "// 6768uhashd9878shga987db8"
}Response
OK
{
"status": "success",
"message": "Transactions retrieved succesfully",
"data": {
"pagination": {
"totalDocs": 350,
"limit": 1,
"hasPrevPage": false,
"hasNextPage": true,
"page": 1,
"totalPages": 350,
"pagingCounter": 1,
"nextPage": 2
},
"transaction": [
{
"_id": "",
"notes": {
"desc": "",
"topics": [],
"places": [],
"people": [],
"actions": [
"",
""
],
"subjects": [
"",
""
],
"prepositions": []
},
"manual": false,
"reconciled": false,
"fetched": [
""
],
"record": [
""
],
"actions": [],
"analyzed": [
""
],
"ner": {
"TRANS_TYPE": ""
},
"ner_v": 1,
"trans_date": "",
"cleared_date": "",
"unformatted_trans_date": "",
"unformatted_cleared_date": "",
"debit": 52.5,
"ref": " ",
"bank": {
"icon": "",
"logo": "",
"name": "",
"status": ""
},
"customer": {
"_id": "",
"name": ""
},
"account": {
"_id": "",
"name": ""
},
"env": "",
"checked": [],
"created_at": "",
"last_updated": "",
"__v": 0,
"id": ""
}
]
}
}Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
status
string
message
string
data
object (data)
- Example
- { "pagination": { "totalDocs": 2339, "limit": 1, "hasPrevPage": false, "hasNextPage": true, "page": 1, "totalPages": 2339, "pagingCounter": 1, "nextPage": 2 }, "transaction": [ { "_id": "", "notes": { "desc": "", "topics": [], "places": [], "people": [], "actions": [ "", "" ], "subjects": [ "", "" ], "prepositions": [] }, "manual": false, "reconciled": false, "fetched": [ "" ], "record": [ "" ], "actions": [], "analyzed": [ "" ], "ner": { "TRANS_TYPE": "" }, "ner_v": 1, "trans_date": "", "cleared_date": "", "unformatted_trans_date": "", "unformatted_cleared_date": "", "debit": 52.5, "ref": " ", "bank": { "icon": "", "logo": "", "name": "", "status": "" }, "customer": { "_id": "", "name": "" }, "account": { "_id": "", "name": "" }, "env": "", "checked": [], "created_at": "", "last_updated": "", "__v": 0, "id": "" } ] }
pagination
object (pagination)
totalDocs
int
i32
The total number of results that match the request.
limit
int
i32
Returns the value of the limit parameter. Limit sets the number of results that the API returns in a single page. If you do not specify a value for limit, the API will limit the response to 10 results per page.
hasPrevPage
boolean
Shows when a previous page of results is available. This field always returns true when the value of page is greater than 1.
hasNextPage
boolean
Shows when a next page of results is available. When true, Okra recommends that you make subsequent requests to retrieve the following pages of results.
page
int
i32
Returns the number of the current page. For example, if you set page to 1 in your request, the API will return the first page of results in the response.
totalPages
int
i32
The total number of pages that the API returns.
pagingCounter
int
i32
The index number of the first result on the current page. For example, if the value of page is 2 and limit is set to 10, then pagingCounter returns 11.
prevPage
string or null
The number of previous result pages. If the value of page is 1 and there is no previous page, the value of prevPage is null.
nextPage
string or null
The number of following result pages. Each page consists of up to 100 items. If there are not enough results for an additional page, the value is null.
transaction
array[object (TransactionByDateObject)]
TransactionByDateObject
object (TransactionByDateObject)
_id
string
The unique transaction identifier.
notes
object (notes)
- Example
- { "actions": [ "" ], "desc": "", "people": [], "places": [], "prepositions": [], "subjects": [ "", "" ], "topics": [] }
actions
array[string]
string
desc
string
people
array[string]
string
places
array[string]
string
prepositions
array[string]
string
subjects
array[string]
string
topics
array[string]
string
manual
boolean
A boolean that describes if it was fetched directly from user statement, we return TRUE or FALSE.
reconciled
boolean
A boolean that describes if transaction has been reconciled, we return TRUE or FALSE.
fetched
array[string]
The client id, that fetched the transaction.
string
record
array[string]
The record id, unique Okra app process identifier.
string
actions
array[string]
The webhook id used during reconciliation.
string
Content-Security-Policy
string
- Content Type
- text/plain
- Example
- "default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"
X-DNS-Prefetch-Control
string
- Content Type
- text/plain
- Example
- "off"
Expect-CT
string
- Content Type
- text/plain
- Example
- "max-age=0"
X-Frame-Options
string
- Content Type
- text/plain
- Example
- "SAMEORIGIN"
Strict-Transport-Security
string
- Content Type
- text/plain
- Example
- "max-age=15552000; includeSubDomains"
X-Download-Options
string
- Content Type
- text/plain
- Example
- "noopen"
X-Content-Type-Options
string
- Content Type
- text/plain
- Example
- "nosniff"
X-Permitted-Cross-Domain-Policies
string
- Content Type
- text/plain
- Example
- "none"
Referrer-Policy
string
- Content Type
- text/plain
- Example
- "no-referrer"
X-XSS-Protection
string
- Content Type
- text/plain
- Example
- "0"
Access-Control-Allow-Methods
string
- Content Type
- text/plain
- Example
- "GET, POST, OPTIONS, PUT, PATCH, DELETE"
Access-Control-Allow-Headers
string
- Content Type
- text/plain
- Example
- "X-Requested-With,content-type,authorization"
Access-Control-Allow-Credentials
string
- Content Type
- text/plain
- Example
- "true"
Content-Length
string
- Content Type
- text/plain
- Example
- "2272"
ETag
string
- Content Type
- text/plain
- Example
- "W/\"8e0-l+ZpANGuNClnQ2rx24x6ij7oZ0c\""
Date
string
- Content Type
- text/plain
- Example
- "Tue, 01 Dec 2020 14:48:06 GMT"
Connection
string
- Content Type
- text/plain
- Example
- "keep-alive"
Keep-Alive
string
- Content Type
- text/plain
- Example
- "timeout=5"
Get transaction by nuban
This endpoint allows you retrieve a paginated list of a specific transaction of a customer by passing the nuban account of that customer
nuban
string
page
int
i32
limit
int
i32
bearer
Request
{
"nuban": "// nuban number",
"page": 1,
"limit": 1
}Response
OK
{
"status": "success",
"message": "Transactions retrieved successfully",
"data": {
"pagination": {
"totalDocs": 465,
"limit": 1,
"hasPrevPage": false,
"hasNextPage": true,
"page": 1,
"totalPages": 465,
"pagingCounter": 1,
"nextPage": 2
},
"transaction": [
{
"_id": "",
"notes": {
"desc": "",
"topics": [],
"places": [],
"people": [],
"actions": [],
"subjects": [
""
],
"prepositions": []
},
"manual": false,
"reconciled": false,
"fetched": [
""
],
"record": [
""
],
"actions": [],
"trans_date": "",
"cleared_date": "",
"unformatted_trans_date": "",
"unformatted_cleared_date": "",
"credit": 3.21,
"ref": "0",
"branch": "",
"bank": {
"icon": "",
"logo": "",
"name": "",
"status": ""
},
"customer": {
"_id": "",
"name": ""
},
"account": {
"_id": "",
"name": ""
},
"env": "",
"checked": [],
"created_at": "",
"last_updated": "",
"__v": 0,
"id": ""
}
]
}
}Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
status
string
message
string
data
object (data)
- Example
- { "pagination": { "totalDocs": 465, "limit": 1, "hasPrevPage": false, "hasNextPage": true, "page": 1, "totalPages": 465, "pagingCounter": 1, "nextPage": 2 }, "transaction": [ { "_id": "", "notes": { "desc": "", "topics": [], "places": [], "people": [], "actions": [], "subjects": [ "" ], "prepositions": [] }, "manual": false, "reconciled": false, "fetched": [ "" ], "record": [ "" ], "actions": [], "trans_date": "", "cleared_date": "", "unformatted_trans_date": "", "unformatted_cleared_date": "", "credit": 3.21, "ref": "0", "branch": "", "bank": { "icon": "", "logo": "", "name": "", "status": "" }, "customer": { "_id": "", "name": "" }, "account": { "_id": "", "name": "" }, "env": "", "checked": [], "created_at": "", "last_updated": "", "__v": 0, "id": "" } ] }
pagination
object (pagination)
totalDocs
int
i32
The total number of results that match the request.
limit
int
i32
Returns the value of the limit parameter. Limit sets the number of results that the API returns in a single page. If you do not specify a value for limit, the API will limit the response to 10 results per page.
hasPrevPage
boolean
Shows when a previous page of results is available. This field always returns true when the value of page is greater than 1.
hasNextPage
boolean
Shows when a next page of results is available. When true, Okra recommends that you make subsequent requests to retrieve the following pages of results.
page
int
i32
Returns the number of the current page. For example, if you set page to 1 in your request, the API will return the first page of results in the response.
totalPages
int
i32
The total number of pages that the API returns.
pagingCounter
int
i32
The index number of the first result on the current page. For example, if the value of page is 2 and limit is set to 10, then pagingCounter returns 11.
prevPage
string or null
The number of previous result pages. If the value of page is 1 and there is no previous page, the value of prevPage is null.
nextPage
string or null
The number of following result pages. Each page consists of up to 100 items. If there are not enough results for an additional page, the value is null.
transaction
array[object (NubanTransaction)]
NubanTransaction
object (NubanTransaction)
- Example
- { "_id": "", "notes": { "desc": "", "topics": [], "places": [], "people": [], "actions": [], "subjects": [ "" ], "prepositions": [] }, "manual": false, "reconciled": false, "fetched": [ "" ], "record": [ "" ], "actions": [], "trans_date": "", "cleared_date": "", "unformatted_trans_date": "", "unformatted_cleared_date": "", "credit": 3.21, "ref": "0", "branch": "", "bank": { "icon": "", "logo": "", "name": "", "status": "" }, "customer": { "_id": "", "name": "" }, "account": { "_id": "", "name": "" }, "env": "", "checked": [], "created_at": "", "last_updated": "", "__v": 0, "id": "" }
_id
string
The unique transaction identifier.
notes
object (notes)
- Example
- { "actions": [ "" ], "desc": "", "people": [], "places": [], "prepositions": [], "subjects": [ "", "" ], "topics": [] }
actions
array[string]
string
desc
string
people
array[string]
string
places
array[string]
string
prepositions
array[string]
string
subjects
array[string]
string
topics
array[string]
string
manual
boolean
A boolean that describes if it was fetched directly from user statement, we return TRUE or FALSE.
reconciled
boolean
A boolean that describes if transaction has been reconciled, we return TRUE or FALSE.
fetched
array[string]
Additional items retreived from with the transaction.
string
record
array[string]
The record id, unique Okra app process identifier.
string
actions
array[string]
The webhook id used during reconciliation
string
trans_date
string
The Timestamp in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ) indicating the date when the transaction was carried out.
cleared_date
string
The date when the transaction was effected.
unformatted_trans_date
string
The transaction date format returned from bank.
unformatted_cleared_date
string
The cleared date format returned from bank.
debit
string or null
The Amount debited from the bank.
credit
number
The Amount credited into the bank.
ref
string
The transaction bank reference number.
branch
string
The name of the authorized bank branch as returned from in the transaction fetch.
customer
object (customer)
_id
string
The unique identifier that references the user.
name
string
The user’s full name.
account
object (account)
- Example
- { "_id": "", "name": "" }
_id
string
The unique identifier created by Okra used to reference the balance.
name
string
The account name of the account holder as returned from the bank
env
string
The application environment where the process was carried out.
checked
array[string]
companies that have viewed this transaction
string
created_at
string
Timestamp in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ) indicating the first time that the transaction for the given account was created.
last_updated
string
Timestamp in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ) indicating the last time that the transaction for the given account has been updated
__v
int
i32
The document version
id
string
The transaction unique id
Content-Security-Policy
string
- Content Type
- text/plain
- Example
- "default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"
X-DNS-Prefetch-Control
string
- Content Type
- text/plain
- Example
- "off"
Expect-CT
string
- Content Type
- text/plain
- Example
- "max-age=0"
X-Frame-Options
string
- Content Type
- text/plain
- Example
- "SAMEORIGIN"
Strict-Transport-Security
string
- Content Type
- text/plain
- Example
- "max-age=15552000; includeSubDomains"
X-Download-Options
string
- Content Type
- text/plain
- Example
- "noopen"
X-Content-Type-Options
string
- Content Type
- text/plain
- Example
- "nosniff"
X-Permitted-Cross-Domain-Policies
string
- Content Type
- text/plain
- Example
- "none"
Referrer-Policy
string
- Content Type
- text/plain
- Example
- "no-referrer"
X-XSS-Protection
string
- Content Type
- text/plain
- Example
- "0"
Access-Control-Allow-Methods
string
- Content Type
- text/plain
- Example
- "GET, POST, OPTIONS, PUT, PATCH, DELETE"
Access-Control-Allow-Headers
string
- Content Type
- text/plain
- Example
- "X-Requested-With,content-type,authorization"
Access-Control-Allow-Credentials
string
- Content Type
- text/plain
- Example
- "true"
Content-Length
string
- Content Type
- text/plain
- Example
- "1700"
ETag
string
- Content Type
- text/plain
- Example
- "W/\"6a4-0qd0y2o3oWBP/MFZpePrFiJrOic\""
Date
string
- Content Type
- text/plain
- Example
- "Tue, 01 Dec 2020 13:46:19 GMT"
Connection
string
- Content Type
- text/plain
- Example
- "keep-alive"
Keep-Alive
string
- Content Type
- text/plain
- Example
- "timeout=5"
Was this page helpful?