Transaction History
Request URL
POST /condor/transaction/history (deprecated)
Description
This endpoint is deprecated. Instead of using /condor endpoints, it is recommended to use /ibis endpoints. Ibis endpoints support credit-card issuing, debit-card issuing, and vAccount issuing.
This endpoint will return a list of transactions associated with the given cardId. The system will return any transactions located that meet the filter criteria specified. The "cardId" is a required property of the request body object. If no other properties are present in the request body, only the 20 most recent transactions associated with the requested cardId will be returned. Optional request body properties are "dateFrom", "dateTo", "offset", "numberOfTransactions", and "status". Transactions will be listed in order starting with the most recent transaction at index 0.
| Required Properties | Description | Schema | Example Values |
|---|---|---|---|
| cardId | The card ID in connectFi for which you are requesting the transaction history | String | "crda_5Mx3p6lSIQevd0qwfFhhSs" |
| Optional Properties | Description | Schema | Example Values |
|---|---|---|---|
| "dateFrom" | The beginning of the requested transaction period in "YYYY-MM-DD" format | String | "2021-01-01" |
| "dateTo" | The end of the requested transaction period in "YYYY-MM-DD" format | String | "2022-10-14" |
| "offset" | A value representing the desired number of transaction groups by which to offset the result (the number of transactions in each group is defined by the "numberOfTransactions" property and defaults to 20). For example, "offset" : 1 will return the most recent 20 transactions, "offset" : 2 will return the next set of 20 transactions, and so on. |
Integer > 0 | 2 |
| "numberOfTransactions" | Represents the number of desired transactions to return. The default is 20 transactions. If the number of transactions meeting all other criteria is less than the requested "numberOfTransactions", it is fine. All transactions located that meet remaining criteria will be returned. If a value of 0 is used, this filter will be ignored | Integer >= 0 | 15 |
| "status" | If present, will filter the results to return only the transactions matching the requested status | String | "ALL", "PENDING", "COMPLETE", or "DECLINED" |
Request Body
HEADERS
{
"Content-Type": "application/json",
"x-connectfi-token": "a long random string" //Authorization token received from /auth/get-token request
}
REQUEST BODY
This request has no optional properties and will return the 20 most recent transactions associated with the requested cardId
This request includes a date filter and will only return transactions between the dates of "2021-01-01" and "2022-10-13".
{
"cardId" : "crda_1EnrcK7QgBU2030pNCaygA", //card ID in connectFi
"dateFrom" : "2021-01-01",
"dateTo" : "2022-10-13"
}
This request will only return the 2 most recent transactions.
{
"cardId" : "crda_1EnrcK7QgBU2030pNCaygA", //card ID in connectFi
"numberOfTransactions" : 2 //non-negative integer representing the number of transactions to return, will be ignored if 0 is requested
}
This request sets the number of transactions to be returned as 15. It will skip the first set of transactions (15 most recent transactions) and return the second set of transactions because the offset value is 2.
{
"cardId" : "crda_1EnrcK7QgBU2030pNCaygA", //card ID in connectFi
"numberOfTransactions" : 15, //non-negative integer representing the number of transactions to return, will be ignored if 0 is requested
"offset" : 2 //skip the most recent group of 15 (value defined by "numberOfTransactions") transactions and return the 2nd set of 15 transactions.
}
This request will only return the 20 most recent transactions with a "PENDING" status. If less than 20 "PENDING" transactions exist, then any "PENDING" transactions located for this card will be returned.
{
"cardId" : "crda_1EnrcK7QgBU2030pNCaygA", //card ID in connectFi
"status" : "PENDING" //or "ALL", "COMPLETE", "DECLINED"
}
Successful Response Examples
200 (HTTP response status code) -- Success, requested transactions were returned
{
"code": "0", //Success
"data": {
"transactions": [
{
"transaction_type": "DEBIT", //Possible types include: "DEBIT_ADJUSTMENT", "PROVISIONAL_DEBIT", "CREDIT_ADJUSTMENT", "PROVISIONAL_CREDIT ", "CREDIT", "DEBIT", "DD_ACH_DEBIT", "DD_CREDIT", "BANK_TRANSFER_DEBIT", "BANK_TRANSFER_CREDIT", "ACH_RETURN", "FEE", "FEE_REVERSAL", "RETAIL_CREDIT", "AGENT_LOC_CREDIT", "RETAIL_DEBIT", "WITHDRAWAL", "PRE_AUTH", "PRE_AUTH_COMPLETE", "DIRECT_LOADS"
"amount": -250, //transaction amount
"currency_code": "USD", //currency code
"state": "COMPLETE", //internal status of transaction
"running_balance": 1459.72, //Current account balance as of this transaction
"iso_message_type": "0200",
"device_type": "API",
"international": false,
"transaction_datetime": "2022-10-14T12:52:59.000Z",
"additional_data": {
"memo": "Manual Signature Based Cash Withdrawal",
"fee_amount": 0,
"transaction_details": "Cash Withdrawal"
},
"id": "cс_jGyBv9loClJxnl2MSnKRy", //transaction ID in connectFi
"cardId": "crda_1EnrcK7QgBU2030pNCaygA" //card ID in connectFi
},
{
"transaction_type": "CREDIT",
"amount": 700, //transaction amount
"currency_code": "USD", //currency code
"state": "COMPLETE", //internal status of transaction
"running_balance": 1709.72, //current account balance as of this transaction
"iso_message_type": "0200",
"device_type": "API",
"international": false,
"transaction_datetime": "2022-10-14T12:52:47.000Z",
"additional_data": {
"memo": "MoneyGram POS Money Load",
"fee_amount": 0,
"transaction_details": "Load Money Onto Card"
},
"id": "cс_6lWzQEEbHILWAuG6MppkA", //transaction ID in connectFi
"cardId": "crda_1EnrcK7QgBU2030pNCaygA" //card ID in connectFi
},
{
"transaction_type": "DEBIT",
"amount": -18.21, //transaction amount
"currency_code": "USD", //currency code
"state": "COMPLETE", //internal status of transaction
"running_balance": 1009.72, //current account balance as of this transaction
"iso_message_type": "0200",
"device_type": "API",
"international": false,
"transaction_datetime": "2022-10-14T12:52:37.000Z",
"additional_data": {
"memo": "Manual Signature Based Cash Withdrawal",
"fee_amount": 0,
"transaction_details": "Cash Withdrawal"
},
"id": "cс_7HqlEFvWUiMnkMNQW8BPcc", //transaction ID in connectFi
"cardId": "crda_1EnrcK7QgBU2030pNCaygA" //card ID in connectFi
},
// ... remaining transaction objects ...
]
}
}
200 (HTTP response status code) -- Success, no transactions were returned
In this example, the request was successful, but no transactions matched the search criteria.
{
"code": "0", //Success
"data": {
"transactions": [] //no transactions were found for the requested card ID and filters
}
}
Errors
400 (HTTP response status code) -- Date must match pattern
In this example, an incorrect date format was requested as a filter. The optional "dateFrom" and "dateTo" properties must be a string in the format "YYYY-MM-DD" if present in the request body.
{
"code": "requestValidateError",
"context": [
{
"instancePath": "/dateFrom",
"schemaPath": "request#/definitions/dateOnly/pattern",
"keyword": "pattern",
"params": {
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"message": "must match pattern \"^\\d{4}-\\d{2}-\\d{2}$\""
}
]
}
400 (HTTP response status code) -- FromDate is greater than ToDate in request
In this example, the "dateFrom" requested is after the "dateTo", which is invalid. The "dateTo" must be a later date than the "dateFrom".
{
"code": "extCondor",
"subCode": "T0004",
"context": {
"title": "cardsGetTransactionsByToken"
},
"message": "Get Transaction History Decline (FromDate is greater than ToDate in request)"
}
400 (HTTP response status code) -- Must be > 0
In this example, an offset of 0 was used. If an offset is not desired, remove the "offset" property from the request body.
{
"code": "requestValidateError",
"context": [
{
"instancePath": "/offset",
"schemaPath": "#/properties/offset/exclusiveMinimum",
"keyword": "exclusiveMinimum",
"params": {
"comparison": ">",
"limit": 0
},
"message": "must be > 0"
}
]
}
400 (HTTP response status code) -- Must NOT have additional properties
In this example, a request was made with an additional property that is not an allowed option: "amount".
{
"code": "requestValidateError",
"context": [
{
"instancePath": "",
"schemaPath": "#/additionalProperties",
"keyword": "additionalProperties",
"params": {
"additionalProperty": "amount"
},
"message": "must NOT have additional properties"
}
]
}
400 (HTTP response status code) -- Request error
In this example, the "numberOfTransactions" filter was used with a decimal value instead of an integer value. If you receive this error, check to make sure all filter property values match the required schema. If the error persists, contact support with the given error code and request ID.