> ## 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.

# Get started

> Quick start guide for Alacriti Batch payment connector integration

Before initiating the configuration, ensure you have the following credentials and connectivity in place:

* Make sure that you have followed [Get started with connectors](/connectors/getting-started).
* **Alacriti access:** An active account in the Alacriti environment.
* **Network connectivity:** Confirmed routing between the Alacriti environment and the Grand Central (GC) iPaaS.
* **Environment details:** The following environment variables are needed from Alacriti to configure the connector:

| Environmental Key     | Description                                                  |
| :-------------------- | :----------------------------------------------------------- |
| `alacriti-url`        | The base URL to access the Alacriti environment              |
| `alacriti-client-key` | The **unique identifier** assigned to the client by Alacriti |

***

## Configuration guide

Follow these steps to initialize and authorize your Alacriti Batch Connector.

### 1. Establishing connectivity

Share the following details with Grand Central team to establish secure connectivity between **Grand Central and Alacriti**

* **Environment details:** `baseUrl` and `ipaddress` of Alacriti application.

  <Info>
    **Istio configuration:** To add Alacriti IPs and DNS to the allowlist, see this page which describes how to configure Istio and how to add IPs and certificates to the allowlist.
  </Info>

### 2. Environment configuration

To initialize the Alacriti Batch Connector, you must define specific environment variables within your `gc-applications-live` repository.

These variables are stored in the `values.yaml` for common parameters and `batch-payments-v0.values.yaml` file for outbound request  and `batch-inbound-payments-v0.values.yaml` for inbound webhook events.

For the full property list for each connector, including defaults and descriptions, see [Reference](/connectors/payments/alacriti-batch/reference).

### Define common parameters

These variables are used across both outbound and inbound connectors connecting **Grand Central to Alacriti** and **Alacriti to Grand Central**.

| values.yaml                           | Description                                                                                                                    | Environmental Key     |
| :------------------------------------ | :----------------------------------------------------------------------------------------------------------------------------- | :-------------------- |
| `alacriti.baseUrl`                    | Target API endpoint for the Alacriti gateway.                                                                                  | `alacriti-url`        |
| `alacriti.client_key`                 | Unique organizational identifier assigned by Alacriti.                                                                         | `alacriti-client-key` |
| `alacriti.client_requestor_reference` | **Mandatory:** Internal identifier for audit logging.                                                                          |                       |
| `alacriti.product`                    | Products to indicate what type of transfers are supported (eg: business\_transfer)                                             |                       |
| `alacriti.payment_channel`            | Payment channel to identify its business banking or retail baning or any other channel (eg: business\_banking)                 |                       |
| `alacriti.requestor_type`             | Who is requesting the payment as its a party or company or any mode (eg: party)                                                |                       |
| `alacriti.access_channel`             | If mutiple organisation or banks inside main organisation we can split it into various access channel (eg: backbase\_business) |                       |

Below is a sample `values.yaml`:

```yaml theme={"system"}
# Sample Alacriti Environment Configuration
connector:
  properties:
    alacriti.baseUrl: https://demoapi.orbipay.com
    alacriti.client_key: AB1CDE23FG
    alacriti.client_requestor_reference: Test
    alacriti.product: business_transfers
    alacriti.payment_channel: business_banking
    alacriti.requestor_type: party
    alacriti.client_requestor_reference: Test
    alacriti.access_channel: backbase_business
```

Below is the path where the `values.yaml` needs to be placed:

```
├── iPaaS
└── azure/runtimes
    ├── dev
    └── test
        └── values
            ├── gc-alacriti
                └── values.yaml
```

### Define outbound parameters

These variables along with common parameters in `values.yaml`are to authorize and route requests sent from **Grand Central to Alacriti**.

| batch-payments-v0.values.yaml | Description                                        | Environmental Key |
| ----------------------------- | :------------------------------------------------- | ----------------- |
| `retryFlag`                   | Set to `true` to enable automatic request retries. |                   |

Below is a sample `batch-payments-v0.values.yaml`:

```yaml theme={"system"}
# Sample Alacriti Batch Outbound Environment Configuration
connector:
  properties:
    retryFlag: true

  traits:
    knativeservice:
      # IMPORTANT: Cost-related. Keeping minScale >0 causes continuous cost even when idle.
      # With minScale: 0, each request grants 30 min uptime (extended if new requests arrive).
      # Use >0 only if hot start is required, and reset to 0 afterward to avoid unnecessary cost.
      minScale: 0
    logging:
      # DEBUG adds significant log output during startup and runtime.
      # This can noticeably slow down starts due to extra logging work and I/O.
      # Use only for troubleshooting and disable when not needed.
      level: INFO
```

Below is the path where the `batch-payments-v0.values.yaml` needs to be placed:

```
├── iPaaS
└── azure/runtimes
    ├── dev
    └── test
        └── values
            ├── gc-alacriti
                └── batch-payments-v0.values.yaml
```

### Define inbound/webhook parameters

Configure along with common parameters in `values.yaml `on how Grand Central receives asynchronous updates from **Alacriti to GC**.

<Info>
  Set up the sync-hub component as described in [Sync Hub](/platform/sync-hub/overview). The following ASB variables are available after configuring Sync Hub. This is a mandatory component for inbound connectivity.
</Info>

<Info>
  **Webhook registration:** To process asynchronous updates (for example, successful settlements or network rejections), you must register your environment's callback URL in the Alacriti Portal.
</Info>

| inbound-batch-payments-v0.values.yaml         | Description                                               |   |
| :-------------------------------------------- | :-------------------------------------------------------- | - |
| `asb.producer.apiUri`                         | The callback URI for receiving incoming events.           |   |
| `asb.batch.status.update.event.topic`         | The ASB topic to send messages for batch status updates   |   |
| `asb.batch.payment.status.update.event.topic` | The ASB topic to send messages for payment status updates |   |
| `asb.batch.status.update.event.type`          | The ASB event type to send messages for batch status      |   |
| `asb.batch.payment.status.update.event.type`  | The ASB event type to send messages for payment status    |   |
| `asb.event.source`                            | The ASB source to send messages.                          |   |
| `asb.event.version`                           | Version of the Async Service Bridge (ASB) schema.         |   |
| `asb.event.type`                              | Event type of the Async Service Bridge (ASB) schema.      |   |
| `retryFlag`                                   | Set to `true` to enable automatic request retries.        |   |

***

Below is a sample `inbound-batch-payments-v0.values.yaml`:

```yaml theme={"system"}
# Sample Alacriti Inbound Environment Configuration
connector:
  customLabels:
    app.gcservices.io/synchub-enabled: "true"
    app.gcservices.io/synchub-type: "producer"
  properties:
    retryFlag: true
    asb.batch.status.update.event.type: com.backbase.paymentbatchintegration.event.spec.v1.BatchStatusUpdateEvent
    asb.batch.payment.status.update.event.type: com.backbase.paymentbatchintegration.event.spec.v1.BatchPaymentStatusUpdateEvent
    asb.batch.status.update.event.topic: batch-orders
    asb.batch.payment.status.update.event.topic: batch-payments
    asb.producer.apiUri: http://wiremock-obpm-payments.gc-obpm.svc.cluster.local:9021
	asb.event.type: com.backbase.paymentbatchintegration.event.spec.v1.BatchStatusUpdateV1Event
    asb.event.source: com.backbase.payments
    asb.event.version: 1.0.0  
traits:
    knativeservice:
      # IMPORTANT: Cost-related. Keeping minScale >0 causes continuous cost even when idle.
      # With minScale: 0, each request grants 30 min uptime (extended if new requests arrive).
      # Use >0 only if hot start is required, and reset to 0 afterward to avoid unnecessary cost.
      minScale: 0
    logging:
      # DEBUG adds significant log output during startup and runtime.
      # This can noticeably slow down starts due to extra logging work and I/O.
      # Use only for troubleshooting and disable when not needed.
      level: INFO
```

<Info>
  **CustomLabels:** CustomLabels are part of the Sync Hub setup. Once Sync Hub is enabled, adding the customLabels to the connector automatically invokes the Sync Hub URLs.
</Info>

Below is the path where the inbound-batch-payments-v0.values.yaml needs to be placed:

```
├── iPaaS
└── azure/runtimes
    ├── dev
    └── test
        └── values
            ├── gc-obpm
                └── inbound-batch-payments-v0.values.yaml
```

## Testing your integration

To access the Payments Unified API, you must include your Grand Central subscription key in the request header. If you do not have a key, please contact the Grand Central Support Team to have one provisioned.

| Key       | Value                     |
| :-------- | :------------------------ |
| `api-key` | `<your_subscription_key>` |

<Info>
  **Webhook integration:** Share the API Key through 1Password or any standard tool with Alacriti to call the inbound APIs.
</Info>

Test the API using the [Postman collection](.).

## Troubleshooting

If your connector isn't responding as expected, check these common scenarios.

<AccordionGroup>
  <Accordion title="5XX : Internal server error / Core system is down" icon="lock">
    **Cause:** The Grand Central (GC) gateway cannot establish a handshake with the Alacriti endpoint. This typically indicates an upstream service outage at Alacriti or a network routing failure.

    **Solution:** Verify the operational status of the Alacriti environment with Alacriti. If the service is operational, contact the [GC Support](mailto:gc_support@backbase.com) team.
  </Accordion>

  <Accordion title="5XX : Timeout from Core / Read timeout / SocketTimeoutException" icon="wifi-slash">
    **Cause:** The Grand Central (GC) gateway cannot establish a handshake with the Alacriti endpoint. This typically indicates an upstream service outage at Alacriti or a network routing failure.

    **Solution:** Verify the operational status of the Alacriti environment with Alacriti. If the service is operational, contact the [GC Support](mailto:gc_support@backbase.com) team.
  </Accordion>

  <Accordion title="Invalid OAuth Token" icon="key">
    **Cause:** The `client_id` or `client_secret` provided during setup is incorrect.

    **Solution:** Re-verify your credentials with the Alacriti portal and contact the GC team to update the connection.
  </Accordion>

  <Accordion title="429 : Rate limit Exceeded" icon="gauge-high">
    **Cause:** The number of incoming requests has exceeded the defined threshold for your subscription tier. This "429 Too Many Requests" response is a protective measure to ensure the stability of the Grand Central and Core Banking infrastructure.

    **Solution:** Review your application's request patterns to identify unexpected spikes. If your business requirements have evolved and you require a higher throughput, contact the Grand Central Team to request an adjustment to your APIM rate limit policy.
  </Accordion>
</AccordionGroup>

***

## Need more help?

<Card title="Contact Support" icon="envelope" href="mailto:support@grandcentral.io">
  Reach out to the Grand Central team for assistance with environment setup or rate limit increases.
</Card>
