Creating 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 theirItemStatusas'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
IorB.
Single RCC Transaction
Section titled “Single RCC Transaction”To add a single, RCC transaction to the system, use the following endpoint:
POST /api/v3/RccTransactions/companycode/{companyCode}Single Model
Section titled “Single Model”Model required for adding the transaction (filled wiht random values):
Model Example:
{ "firstSignerFirstName": "WA9MtsoBrYaCoTN RuouA4Do", "firstSignerLastName": "wAYKfyzw&OC2lLhplm", "secondSignerFirstName": "Chx&MP`hI93?CAiCCXQhQu", "secondSignerLastName": "ITw75Bl0z05w0mH51UZs", "address1": "B jvSy8-o/kNm", "address2": "'/dnj(1 1dYEPCFIGk", "city": "je8feR6tPchAD", "state": "uD", "zip": "65218 7156", "yourReferenceNumber": "string", "bankRoutingNumber": "247090010", "bankAccountNumber": "29155-", "amount": 0}Bulk RCC Transactions
Section titled “Bulk RCC Transactions”To add multiple, RCC transactions to the system, use the following endpoint:
POST /apiv3/RccTransactions/companycode/{companyCode}/manyBulk Model
Section titled “Bulk Model”Model required for adding the transaction (filled with random values):
Model Example:
{ "alwaysCommitValid": true, "items": [ { "firstSignerFirstName": "oPbavjEnEV&aKR7m'q", "firstSignerLastName": "7W5E.sBw0", "secondSignerFirstName": "&wHPKa", "secondSignerLastName": "P-`g?cyWo.Y-smO", "address1": "0d1tArkeKRHS(4", "address2": "FcgAPb(vR", "city": "X0D9t", "state": "HE", "zip": "68327 8705", "yourReferenceNumber": "string", "bankRoutingNumber": "411281220", "bankAccountNumber": "048-444-366", "amount": 0 } ]}Submitting items that will automatically return (Dev Only)
Section titled “Submitting items that will automatically return (Dev Only)”To test return scenarios, Flex has created a mechanism that allows you to submit an account number that will automatically return an item. The pattern includes a variable for delaying the response as well as defining the particular reason code that will be returned.
Account Number Pattern: XXXXXXXXX99990001XXXXXXXXX: Optional prefix digits9999: Signals to flex that this transaction should respond with a Return response00: How many days to wait till Return response is triggered01: Return code that should be triggered