Overview
Q LINK Alchemy – SA bank collections (EFT, Debicheck, RM) – recurring + non-recurring batches
Available operations
36 operations available. Click any row to jump to its detail.
| Operation | Category | What it does |
|---|---|---|
| Get Batch Action History | General | Retrieve the state-transition history for a batch |
| Create Non-Recurring Batch | General | Create a non-recurring batch header. Body fields: collectionType (required), description, reference, actionDate, totalValue, transactionCount, source, debitType, userCode |
| Get Batch Audit | General | Retrieve the full audit log for a batch |
| Authorise Batch | General | Authorise a non-recurring batch for submission |
| Delete Non-Recurring Batch | General | Delete a non-recurring batch by headerId |
| Strip CDV-Error Transactions | General | Delete transactions in a batch that failed CDV validation |
| Strip Duplicate Transactions | General | Delete duplicate transactions within a batch |
| Edit Non-Recurring Batch | General | Edit a non-recurring batch header by headerId |
| Get Batch | General | Get batch header details by headerId |
| Recall Batch | General | Recall a submitted batch (before processing) |
| Submit Batch | General | Submit an authorised batch for bank processing |
| Unauthorise Batch | General | Revoke authorisation on a non-recurring batch |
| Login | General | Re-authenticate and refresh the JWT bearer token |
| Login (Mandate) | General | Re-authenticate against the mandate-scoped login (requires usercode) |
| Ping | General | Health-check the Auth service |
| Create Recurring Debicheck Instruction | General | Create a recurring Debicheck instruction (mandate handled inline) |
| Edit Recurring Debicheck Instruction | General | Edit an existing recurring Debicheck instruction by ID |
| Get Recurring Debicheck Instruction | General | Get a recurring Debicheck instruction by ID |
| Stop Recurring Debicheck Instruction | General | Stop an active recurring Debicheck instruction (comment is required) |
| Create Recurring EFT Instruction | General | Create a recurring EFT debit instruction. Body fields: usercode, logoCode, shortName, customer, payer, instruction (recurrence rule) |
| Edit Recurring EFT Instruction | General | Edit an existing recurring EFT instruction by ID |
| Get Recurring EFT Instruction | General | Get a recurring EFT instruction by ID |
| Stop Recurring EFT Instruction | General | Stop an active recurring EFT instruction (comment is required, max 200 chars) |
| Create Recurring RM Instruction | General | Create a recurring Registered Mandate instruction |
| Edit Recurring RM Instruction | General | Edit an existing recurring RM instruction by ID |
| Get Recurring RM Instruction | General | Get a recurring RM instruction by ID |
| Stop Recurring RM Instruction | General | Stop an active recurring RM instruction (comment is required) |
| Get Invalid Dates | General | Retrieve banned/blocked processing dates |
| Validate Date | General | Validate a proposed action date for a usercode + collectionType |
| Add Transaction | General | Add a transaction to a batch. Body fields: reference, accountName, accountNumber, branchCode, accountType, amount, trackingDays, shortname, mandateRegistrationNumber, debiCheckSequenceType, cardCustomerToken, cardToken, headerId |
| Get Transaction Audit | General | Retrieve the audit log for a single transaction |
| Validate Account (CDV) | General | Pre-validate account number/branch/type via CDV (array body) |
| Check Mandates | General | Verify mandate status for an array of transactions |
| Delete Transaction | General | Remove a transaction from a batch by transactionId |
| Edit Transaction | General | Edit a transaction within a batch by transactionId |
| Get Transaction | General | Get transaction details by transactionId |
Operations
Get Batch Action History
Retrieve the state-transition history for a batch
| Parameter | Required | Type | Description |
|---|---|---|---|
Headerid headerId | Yes | text |
Create Non-Recurring Batch
Create a non-recurring batch header. Body fields: collectionType (required), description, reference, actionDate, totalValue, transactionCount, source, debitType, userCode
No input parameters.
Get Batch Audit
Retrieve the full audit log for a batch
| Parameter | Required | Type | Description |
|---|---|---|---|
Headerid headerId | Yes | text |
Authorise Batch
Authorise a non-recurring batch for submission
No input parameters.
Delete Non-Recurring Batch
Delete a non-recurring batch by headerId
No input parameters.
Strip CDV-Error Transactions
Delete transactions in a batch that failed CDV validation
No input parameters.
Strip Duplicate Transactions
Delete duplicate transactions within a batch
No input parameters.
Edit Non-Recurring Batch
Edit a non-recurring batch header by headerId
No input parameters.
Get Batch
Get batch header details by headerId
| Parameter | Required | Type | Description |
|---|---|---|---|
Headerid headerId | Yes | text |
Recall Batch
Recall a submitted batch (before processing)
No input parameters.
Submit Batch
Submit an authorised batch for bank processing
No input parameters.
Unauthorise Batch
Revoke authorisation on a non-recurring batch
No input parameters.
Login
Re-authenticate and refresh the JWT bearer token
No input parameters.
Login (Mandate)
Re-authenticate against the mandate-scoped login (requires usercode)
No input parameters.
Ping
Health-check the Auth service
No input parameters.
Create Recurring Debicheck Instruction
Create a recurring Debicheck instruction (mandate handled inline)
No input parameters.
Edit Recurring Debicheck Instruction
Edit an existing recurring Debicheck instruction by ID
| Parameter | Required | Type | Description |
|---|---|---|---|
Id id | Yes | text |
Get Recurring Debicheck Instruction
Get a recurring Debicheck instruction by ID
| Parameter | Required | Type | Description |
|---|---|---|---|
Id id | Yes | text |
Stop Recurring Debicheck Instruction
Stop an active recurring Debicheck instruction (comment is required)
| Parameter | Required | Type | Description |
|---|---|---|---|
Id id | Yes | text |
Create Recurring EFT Instruction
Create a recurring EFT debit instruction. Body fields: usercode, logoCode, shortName, customer, payer, instruction (recurrence rule)
No input parameters.
Edit Recurring EFT Instruction
Edit an existing recurring EFT instruction by ID
| Parameter | Required | Type | Description |
|---|---|---|---|
Id id | Yes | text |
Get Recurring EFT Instruction
Get a recurring EFT instruction by ID
| Parameter | Required | Type | Description |
|---|---|---|---|
Id id | Yes | text |
Stop Recurring EFT Instruction
Stop an active recurring EFT instruction (comment is required, max 200 chars)
| Parameter | Required | Type | Description |
|---|---|---|---|
Id id | Yes | text |
Create Recurring RM Instruction
Create a recurring Registered Mandate instruction
No input parameters.
Edit Recurring RM Instruction
Edit an existing recurring RM instruction by ID
| Parameter | Required | Type | Description |
|---|---|---|---|
Id id | Yes | text |
Get Recurring RM Instruction
Get a recurring RM instruction by ID
| Parameter | Required | Type | Description |
|---|---|---|---|
Id id | Yes | text |
Stop Recurring RM Instruction
Stop an active recurring RM instruction (comment is required)
| Parameter | Required | Type | Description |
|---|---|---|---|
Id id | Yes | text |
Get Invalid Dates
Retrieve banned/blocked processing dates
No input parameters.
Validate Date
Validate a proposed action date for a usercode + collectionType
No input parameters.
Add Transaction
Add a transaction to a batch. Body fields: reference, accountName, accountNumber, branchCode, accountType, amount, trackingDays, shortname, mandateRegistrationNumber, debiCheckSequenceType, cardCustomerToken, cardToken, headerId
No input parameters.
Get Transaction Audit
Retrieve the audit log for a single transaction
| Parameter | Required | Type | Description |
|---|---|---|---|
Transactionid transactionId | Yes | text |
Validate Account (CDV)
Pre-validate account number/branch/type via CDV (array body)
No input parameters.
Check Mandates
Verify mandate status for an array of transactions
No input parameters.
Delete Transaction
Remove a transaction from a batch by transactionId
No input parameters.
Edit Transaction
Edit a transaction within a batch by transactionId
No input parameters.
Get Transaction
Get transaction details by transactionId
| Parameter | Required | Type | Description |
|---|---|---|---|
Transactionid transactionId | Yes | text |