> ## Documentation Index
> Fetch the complete documentation index at: https://grandcentral.backbase.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Reference

> Configuration properties, operations, events, and error mapping for the Alacriti Batch connectors.

The Alacriti Batch integration handles high-volume ACH (Automated Clearing House) processing with the Alacriti batch platform. The batch payment connector is outbound: it submits, validates, and cancels bulk payment instructions across the supported SEC codes. The batch payment inbound connector receives asynchronous batch and payment status webhooks from Alacriti and publishes events to the Sync Hub ASB producer. For setup steps, see [Get started](/connectors/payments/alacriti-batch/get-started).

For single (non-batch) Alacriti payments, see the [Alacriti Connector reference](/connectors/payments/alacriti/reference).

| Connector                                     | Property file                           | Purpose                                                         |
| :-------------------------------------------- | :-------------------------------------- | :-------------------------------------------------------------- |
| `gc-alacriti-batch-payment-connector`         | `batch-payments-v0.values.yaml`         | Outbound ACH batch submission, validation, and cancellation     |
| `gc-alacriti-batch-payment-inbound-connector` | `inbound-batch-payments-v0.values.yaml` | Inbound batch and payment status updates from Alacriti webhooks |

## Configuration properties

### Values to obtain from Alacriti

Obtain the following values from Alacriti and set them in `values.yaml`. These values are environment-specific, so they have no default.

| Property              | Description                                            |
| :-------------------- | :----------------------------------------------------- |
| `alacriti.baseUrl`    | Target API endpoint for the Alacriti gateway.          |
| `alacriti.client_key` | Unique organizational identifier assigned by Alacriti. |

### Common properties

Set these properties in `values.yaml`. They apply to both batch connectors.

| Property                              | Description                                                                                               | Default                                 |
| :------------------------------------ | :-------------------------------------------------------------------------------------------------------- | :-------------------------------------- |
| `alacriti.client_requestor_reference` | Mandatory. Internal identifier used for audit logging.                                                    | N/A (environment-specific)              |
| `alacriti.product`                    | Product that indicates the supported transfer type, for example `business_transfers`.                     | N/A (environment-specific)              |
| `alacriti.payment_channel`            | Payment channel, for example `business_banking` or `retail_banking`.                                      | N/A (environment-specific)              |
| `alacriti.requestor_type`             | Who requests the payment, for example `party`.                                                            | N/A (environment-specific)              |
| `alacriti.access_channel`             | Access channel used to split a main organization into sub-organizations, for example `backbase_business`. | N/A (environment-specific)              |
| `routing.number`                      | Routing number used for Alacriti requests.                                                                | N/A (environment-specific)              |
| `errorTemplate`                       | Error mapping template file used to translate Alacriti errors.                                            | `transform-alacriti-error-details.json` |
| `connectionsPerRoute`                 | Maximum HTTP connections per route.                                                                       | `200`                                   |
| `http.client.connect.timeout`         | HTTP connect timeout, in milliseconds.                                                                    | `5000`                                  |
| `http.client.request.timeout`         | HTTP request timeout, in milliseconds.                                                                    | `10000`                                 |
| `http.client.response.timeout`        | HTTP response timeout, in milliseconds.                                                                   | `15000`                                 |
| `retryFlag`                           | Enable automatic request retries on connection failure.                                                   | `true`                                  |
| `redelivery.maximumRetries`           | Maximum number of redelivery attempts.                                                                    | `3`                                     |
| `redelivery.delay`                    | Initial delay between redelivery attempts, in milliseconds.                                               | `200`                                   |
| `redelivery.backOffMultiplier`        | Backoff multiplier for redelivery attempts.                                                               | `2`                                     |

### gc-alacriti-batch-payment-connector

Set these properties in `batch-payments-v0.values.yaml`. This connector submits outbound ACH batches.

| Property                                | Description                                                            | Default                                            |
| :-------------------------------------- | :--------------------------------------------------------------------- | :------------------------------------------------- |
| `alacriti.api_path.submit_credit_batch` | API path to submit a credit batch.                                     | `/fasterpayments/v1/masspayment/submitcreditbatch` |
| `alacriti.api_path.submit_debit_batch`  | API path to submit a debit batch.                                      | `/fasterpayments/v1/masspayment/submitdebitbatch`  |
| `alacriti.api_path.batch_cancel`        | API path to cancel a batch.                                            | `/fasterpayments/v1/masspayment/cancelbatch`       |
| `sec.code.ded.prefix`                   | Addenda prefix for the deduction (DED) SEC code segment.               | `DED`                                              |
| `sec.code.txp.prefix`                   | Addenda prefix for the tax payment (TXP) SEC code segment.             | `TXP`                                              |
| `sec.code.ded.semicolon.count`          | Expected number of semicolon-delimited fields in a DED addenda record. | `7`                                                |
| `sec.code.txp.semicolon.count`          | Expected number of semicolon-delimited fields in a TXP addenda record. | `8`                                                |
| `http.client.socket.timeout`            | HTTP socket timeout, in milliseconds.                                  | `10000`                                            |

### gc-alacriti-batch-payment-inbound-connector

Set these properties in `inbound-batch-payments-v0.values.yaml`. This connector receives Alacriti batch and payment status webhooks and publishes events to the Sync Hub ASB producer.

| Property                                      | Description                                           | Default                                      |
| :-------------------------------------------- | :---------------------------------------------------- | :------------------------------------------- |
| `asb.producer.apiUri`                         | Callback URI of the Sync Hub ASB producer.            | N/A (environment-specific)                   |
| `asb.batch.status.update.event.topic`         | ASB topic for batch status update events.             | N/A (environment-specific)                   |
| `asb.batch.status.update.event.type`          | ASB event type for batch status updates.              | N/A (environment-specific)                   |
| `asb.batch.payment.status.update.event.topic` | ASB topic for payment-level status update events.     | N/A (environment-specific)                   |
| `asb.batch.payment.status.update.event.type`  | ASB event type for payment-level status updates.      | N/A (environment-specific)                   |
| `asb.event.source`                            | ASB source for batch and payment status events.       | `com.backbase.payments`                      |
| `asb.event.version`                           | ASB schema version for status events.                 | N/A (environment-specific)                   |
| `alacriti.api_path.batch_cancel`              | API path to cancel a batch.                           | `/fasterpayments/v1/masspayment/cancelbatch` |
| `backbase.gc.enable.batch.rejection`          | Feature toggle that enables batch rejection handling. | N/A (environment-specific)                   |
| `http.client.socket.timeout`                  | HTTP socket timeout, in milliseconds.                 | `5000`                                       |
| `retry.statuses`                              | HTTP status codes that trigger a retry.               | `429,500,502,503,504`                        |

## Supported operations

The Alacriti Batch Connector exposes the Grand Central Unified API for ACH batch submission, validation, and cancellation. For the operation-to-endpoint tables, see [Overview](/connectors/payments/alacriti-batch/overview). For the full contract, see the [unified API specifications](/connectors/reference/unified-api-specifications).

## Events

The batch payment inbound connector publishes the following events to the Sync Hub ASB producer.

| Event                                            | Type property                                | Source property    | Version property    | Topic property                                |
| :----------------------------------------------- | :------------------------------------------- | :----------------- | :------------------ | :-------------------------------------------- |
| Batch status update                              | `asb.batch.status.update.event.type`         | `asb.event.source` | `asb.event.version` | `asb.batch.status.update.event.topic`         |
| Payment status update (per payment in the batch) | `asb.batch.payment.status.update.event.type` | `asb.event.source` | `asb.event.version` | `asb.batch.payment.status.update.event.topic` |

The batch payment inbound connector consumes status notifications from the following sources.

| Source                          | Configuration                                                                |
| :------------------------------ | :--------------------------------------------------------------------------- |
| Alacriti batch status webhook   | Registered callback URL, delivered to `POST /webhooks/batch/statusupdate`    |
| Alacriti payment status webhook | Registered callback URL, delivered to `POST /webhooks/payment/paymentupdate` |

The batch payment connector is synchronous and doesn't publish or consume events.

## Error mapping

The connector maps Alacriti error codes to Grand Central status codes using the shared `transform-alacriti-error-details.json` template. For the full list, see [Error codes](/connectors/reference/error-codes).

## Dependencies

* Alacriti batch payment platform API (outbound), reachable at `alacriti.baseUrl`.
* Alacriti batch and payment status webhooks (inbound), delivered to the registered callback URLs.
* Sync Hub ASB producer, which receives the published batch status and payment status events.