Transaction
A transaction represents any transferral of funds via CorePro. This includes requests via the /transfer/create
route, or interest paid, or manual adjustments, or incoming ACH requests, among others.
The transaction resource is used for retrieving a list of transactions. Transactions that are initiated via the /transfer/create
route with external bank accounts (or via a recurring contribution) can be voided as long as the ACH request has not yet been delivered to NACHA.
transaction Object
Represents a single transaction in CorePro.
details
Property | Data Type (length) |
Description |
---|---|---|
transactionCount |
integer | The total transactions that meet your query criteria. Note only a single page is returned in one call. See /transaction/list route definition for more information. |
transactionId |
long integer (64-bit integer) | The unique identifier created by CorePro for a particular transaction. |
masterId |
long integer (64-bit integer) | The unique identifier created by CorePro used to group related transactions together. Examples: an ACH withdrawal and a subsequent return. A debit card authorization and its corresponding completion(s). A mobile check deposit return and its corresponding original mobile check deposit. |
customerId |
integer | Customer who owns the Bank Account |
type |
string (50) | A human-readable description of the type of transaction.
Example values include (but are not limited to):
|
typeCode |
string (6) | A programmatic code for the type of transaction. For full detail, see Transaction Types |
tag |
string (50) | The program-wide unique identifier provided by the caller at /transfer/create time. CorePro does not generate this value. |
friendlyDescription |
string (255) | A human-readable description of the transaction. This is automatically generated by CorePro driven by the typeCode of the transaction. |
nachaDescription |
string (255) | Deprecated; equivalent to |
description |
string (255) | A synonym for nachaDescription . Represents a client-specified description of the transaction.
|
status |
string (50) |
The status of the transaction. Possible values include:
|
createdDate |
datetime | The exact date and time the transaction was created. Returned in time zone local to the bank. |
amount |
decimal | The amount of funds the transaction represents. |
depositAvailability |
Optional depositAvailability object related to deposit transaction types. |
|
isCredit |
boolean | true if the amount is crediting the given accountId , false if it is debiting it. |
settledDate |
datetime | The exact date and time the transaction was settled. Returned in time zone local to the bank. |
availableDate |
datetime | The exact date and time the funds associated with the transaction became available. Returned in time zone local to the bank. |
voidedDate |
datetime | The exact date and time the transaction was voided. Returned in time zone local to the bank. |
returnCode |
string (10) | The NACHA return code representing why the transaction was returned. |
feeCode |
string (3) | The code of the fee this transaction represents. Possible values are:
|
feeDescription |
string (50) | The description of the fee this transaction represents. See above for possible values. |
cardId |
integer | The CorePro-generated identifier for the card that created the transaction. Will be empty or 0 if this transaction is not tied to a card. |
subTypeCode |
string (6) |
The code of the subtype for this transaction. Possible values are TBD Currently applicable only to ISO-8583 based transactions (card). |
subType |
string (50) | The description of the subtype for this transaction. See above for possible values. Currently applicable only to ISO-8583 based transactions (card). |
institutionName |
string (50) | The name of the financial institution that originated the transaction. Will be populated when possible, but is not always available for all transaction types. |
check |
Optional check object related to check deposit transaction types. |
get
Retrieve a list of transactions related to the given transactionId
Note: When you provide an invalid identifier (id,tag, or emailAddress), all routes ending with /get
returns 400 (Bad Request).
GET /transaction/get/{customerId}/{transactionId}
Request Parameters
customerId |
Required | Customer ID (returned when customer originally created) |
transactionId |
Required | Transaction ID (returned when transaction was created) |
Response Data
A list of transaction Objects |
The list is ordered by transaction settledDate desc. |
All transactions, regardless of any flags or status, will be returned. |
This output is a list because multiple transaction objects may be tied to the given transactionId
. This is because a single call to /transfer/create
can result in multiple transactions. e.g. In the situation where a fee is applied (such as an NSF during NACHA file processing). A fee is considered a separate, but instrinsically related, transaction.
Error Codes
Code | Message (en-US) | Notes |
1-60000 | Any "Common Error Code" may occur. | See Common Error Codes |
63201 | TransactionId is a required field. | |
63202 | Invalid TransactionId specified. |
Example
Request
GET /transaction/get/2734/36863 Authorization: Basic PutBase64TokenHere
Response
200
{ "data": [ { "amount": 3.0, "availableDate": "2014-12-16T13:25:23.611-06:00", "createdDate": "2014-12-16T13:25:23.611-06:00", "customerId": 2734, "friendlyDescription": "Transfer from lyonstest123 *9873 to test 1", "isCredit": true, "nachaDescription": "", "settledDate": "2014-12-16T13:25:23.611-06:00", "status": "Settled", "tag": "fdasfdsa", "transactionCount": 1, "transactionId": 36863, "type": "CorePro Deposit", "typeCode": "CPDEP" } ], "errors": [], "requestId": "f7ef3b1e-184e-4c1f-98ba-ec95a6085de8", "status": 200 }
getByTag
Retrieve a list of transactions related to the given transaction tag
Note: When you provide an invalid identifier (id,tag, or emailAddress), all routes ending with /getByTag
returns 400 (Bad Request).
GET /transaction/getByTag/{customerId}/{tag}
Request Parameters
customerId |
Required | Customer ID (returned when customer originally created) |
tag |
Required | The value of the transaction tag property supplied when the transaction was created via /transfer/create |
Response Data
A list of transaction Objects |
The list is ordered by transaction settledDate desc. |
All transactions, regardless of any flags or status, will be returned. |
This output is a list because multiple transaction objects may be tied to the given tag
. This is because a single call to /transfer/create
may result in multiple transactions. e.g. In the situation where a fee is applied (such as an NSF during NACHA file processing). A fee is considered a separate, but instrinsically related, transaction.
Error Codes
Code | Message (en-US) | Notes | |
1-60000 | Any "Common Error Code" may occur. | See Common Error Codes | |
65601 | Tag ''{0}'' is invalid. | ||
65602 | Tag must be specified. |
Example
Request
GET /transaction/getByTag/2734/E6C8A2F8-2269-4D73-82AA-269DD990CDB0 Authorization: Basic PutBase64TokenHere
Response
200
{ "data": [ { "amount": 3.0, "availableDate": "2014-12-16T13:25:53.611-06:00", "createdDate": "2014-12-16T13:25:53.611-06:00", "customerId": 2734, "friendlyDescription": "Transfer from lyonstest123 *9873 to test 1", "isCredit": true, "nachaDescription": "", "settledDate": "2014-12-16T13:25:53.611-06:00", "status": "Settled", "tag": "E6C8A2F8-2269-4D73-82AA-269DD990CDB0", "transactionCount": 1, "transactionId": 36865, "type": "CorePro Deposit", "typeCode": "CPDEP" } ], "errors": [], "requestId": "dfd1dbd3-73e8-4db0-97f6-d03ef2eb7683", "status": 200 }
list
Retrieve a list of transactions restricted by the given parameters
GET /transaction/list/{customerId}/{accountId}/{beginDate}/{endDate}?pageNumber={0}&pageSize={200}
Request Parameters
customerId |
Required | Customer ID (returned when customer was originally created) |
accountId |
Required | Account ID (returned when bank account was originally created) |
beginDate |
Optional | Date of earliest transaction to return. Formatted as "YYYY-MM-DD". E.g.: 2014-03-01 |
endDate |
Optional | Date of latest transaction to return. Formatted as "YYYY-MM-DD". E.g.: 2014-04-01 |
pageNumber |
Optional (supplied via the query string) | Which page of the transaction list to return. Default is 0 |
pageSize |
Optional (supplied via the query string) | Size of one page of the transactions to return. Default is 200. Max is 200 |
Response Data
A list of transaction Objects |
The list is ordered by transaction settledDate desc. |
All transactions, regardless of any flags or status, will be returned. |
Error Codes
Code | Message (en-US) | Notes |
1-60000 | Any "Common Error Code" may occur. | See Common Error Codes |
63501 | Begin Date must be a date prior to End Date. | |
63502 | Customer does not have read access to the specified account. |
Example
Request
GET /transaction/list/333/336/2014-03-01/2014-04-01?pageNumber=0&pageSize=200 Authorization: Basic PutBase64TokenHere
Response
200
{ "data": [ { "amount": 500.0000, "createdDate": "2014-03-23T09:07:19.716-05:00", "customerId": 333, "friendlyDescription": "Card to MoneyDrawer", "nachaDescription": "", "settledDate": "2014-03-23T09:07:19.716-05:00", "status": "Settled", "tag": "", "transactionCount": 2, "transactionId": 1878, "type": "CorePro Deposit", "typeCode": "CPDEP" }, { "amount": 2.0000, "createdDate": "2014-03-23T09:08:08.719-05:00", "customerId": 333, "friendlyDescription": "MoneyDrawer to Card", "nachaDescription": "", "settledDate": "2014-03-23T09:08:08.719-05:00", "status": "Settled", "tag": "ItoE1", "transactionCount": 2, "transactionId": 1883, "type": "CorePro Withdrawal", "typeCode": "CPWTH" } ], "errors": [], "requestId": "2dd82a44-02b0-49cb-94e3-ca454bcdd276", "status": 200 }