Getting Transactions
Submitting Single vs Multi Transactions
Section titled “Submitting Single vs Multi Transactions”When submitting RCC transactions, there are important differences between single and bulk (multi) submission modes, as well as how item statuses are reported in responses.
Single Transaction Submission
Section titled “Single Transaction Submission”- If you submit a single transaction and the data is not formatted correctly, the API will return a 400 Bad Request error.
- In some cases, even if the data is valid, the item may later be marked with
ItemStatus='I'
(Invalid) orItemStatus='B'
(Blocked) due to business processing rules. For example, this can happen if a state is restricted or an account number is blocked after initial validation. - If everything is successful, the response will include
ItemStatus='W'
, which means all checks have passed and the item is waiting for further processing.
Bulk (Multi) Transaction Submission
Section titled “Bulk (Multi) Transaction Submission”When submitting multiple transactions in bulk, there is a flag that controls how the API handles validation for the entire set:
- If the all-or-nothing flag is enabled (the whole set must be valid), and even a single item in the set is invalid (e.g., an account number contains an apostrophe), the entire set will be rejected and a 400 Bad Request will be returned.
- If the flag is disabled (partial commit allowed), the API will process all valid items and return the invalid items with
ItemStatus='I'
. - If
alwaysCommitValid == true
, the API will process all valid items, and for invalid items, it will create entries and mark theirItemStatus
as'I'
.
ItemStatus Codes
Section titled “ItemStatus Codes”W
: Waiting – All checks passed, item is ready for processing.I
: Invalid – The item failed validation or was later found to be invalid due to business rules.B
: Blocked – The item is blocked, possibly due to restrictions or account issues.
Tip: Even if data is initially valid, business rules may later change the status to
I
orB
.
Open List of RCC Transactions in System
Section titled “Open List of RCC Transactions in System”If you want to recieve a paged list of all RCC type transactions that are currently in the system, you can use the following endpoint:
GET /api/v3/RccTransactions/companycode/{companyCode}
Get a Single RCC Transaction
Section titled “Get a Single RCC Transaction”If you want to retrieve a single RCC transaction by its itemId
, you can use the following endpoint:
GET /api/v3/RccTransactions/companycode/{companyCode}/{itemId}
Export Document List of RCC Transactions in System
Section titled “Export Document List of RCC Transactions in System”If you want to export a list of RCC transactions in the system, you can use the following endpoint:
GET /api/v3/RccTransactions/companycode/{companyCode}/export/filetype/{fileType}