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

> Supported operations and error mappings for the Open Banking connector

The Open Banking connector supports the following operations from the Grand Central Unified API.

## Supported operations

| Grand Central Unified API domain | Grand Central Unified API method and endpoint                  | Operation                                                                                                                                                                                                                                                                                                                                                                                       | Market               |
| :------------------------------- | :------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------- |
| Servicing Consent                | `POST {consentBaseUrl}/consents`                               | Initiates the consent process by validating an authorization URL received from an AISP, triggered by redirection from the AISP. In response, the endpoint retrieves the consent information from the consent's source of truth. The digital banking app of the ASPSP calls this endpoint (for example, Backbase Identity) before the end user logs in and consents to the data sharing request. | UK OBL, Berlin Group |
| Servicing Consent                | `PATCH {consentBaseUrl}/consents/{consentId}`                  | Updates an existing consent by attaching account and consent approval information. The digital banking layer calls this operation after Strong Customer Authentication (SCA), when the user logs in, associates accounts with the consent, and grants or denies the consent.                                                                                                                    | UK OBL, Berlin Group |
| Servicing Consent                | `DELETE {consentBaseUrl}/{scheme}/{type}/consents/{consentId}` | Revokes an existing consent. The `scheme` path parameter identifies the standard (`ob` for UK Open Banking, `bg` for Berlin Group). The `type` path parameter identifies the consent type (`ais` for account information, `pis` for payment initiation, `cof` for confirmation of funds).                                                                                                       | UK OBL, Berlin Group |
| Deposit                          | `GET {depositBaseUrl}/deposits/{depositId}`                    | Returns the details of the deposit account and balances by ID.                                                                                                                                                                                                                                                                                                                                  | UK OBL, Berlin Group |
| Deposit                          | `GET {depositBaseUrl}/deposits/{depositId}/transactions`       | Returns the transactions for the deposit account by the given parameters.                                                                                                                                                                                                                                                                                                                       | UK OBL, Berlin Group |
| Payment Order                    | `POST {paymentOrderBaseUrl}/payments/accounts/{accountId}`     | Retrieves the list of standing orders and future scheduled payments associated with the requested account.                                                                                                                                                                                                                                                                                      | UK OBL only          |
| Payment Order                    | `PATCH {paymentOrderBaseUrl}/payments/{externalReferenceNo}`   | Updates the status of, or cancels, an authorized payment initiated from the Open Banking channel.                                                                                                                                                                                                                                                                                               | UK OBL, Berlin Group |

## Request headers

The following table describes the request headers that the Open Banking connector accepts on top of the standard Grand Central headers.

| Header             | Value                  | Required | Purpose                                                                                                                                                                                                                                                     |
| :----------------- | :--------------------- | :------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Open-Banking-Lob` | `RETAIL` or `BUSINESS` | No       | Routes the request to the connector instance for the retail or business line of business. Required only when `openBankingLobEnabled` is set to `true` on the connector. For configuration details, see [Get started](/connectors/open-banking/get-started). |

## Events

This connector is synchronous and doesn't publish or consume events.

## Error mapping

The Open Banking connector integrates with two third-party systems: Salt Edge for consent management and the Backbase Engagement Banking Platform (EBP) for account information retrieval. The following tables map each third-party error code to its Grand Central counterpart.

### Salt Edge error mapping

The following table maps each Salt Edge error code to its Grand Central error code:

| Salt Edge code             | Grand Central code |
| :------------------------- | :----------------- |
| `RouteNotFound`            | `GC054`            |
| `TokenNotFound`            | `GC054`            |
| `AccountNotFound`          | `GC054`            |
| `ConsentNotFound`          | `GC054`            |
| `PaymentNotFound`          | `GC054`            |
| `ProviderNotFound`         | `GC054`            |
| `SessionNotFound`          | `GC054`            |
| `CustomerNotFound`         | `GC054`            |
| `ConsentExpired`           | `GC002`            |
| `ConsentFinalised`         | `GC702`            |
| `TokenExpired`             | `GC002`            |
| `InvalidCredentials`       | `GC002`            |
| `AccessDenied`             | `GC002`            |
| `PaymentFinalised`         | `GC434`            |
| `BasketFinalised`          | `GC002`            |
| `SessionExpired`           | `GC002`            |
| `InvalidEncoding`          | `GC067`            |
| `ValueOutOfRange`          | `GC025`            |
| `WrongRequestFormat`       | `GC024`            |
| `AuthorizationMissing`     | `GC007`            |
| `InvalidAuthorizationType` | `GC001`            |
| `JWTDecodeError`           | `GC008`            |
| `JWTExpiredSignature`      | `GC008`            |
| `JWTVerificationError`     | `GC008`            |
| `JWTIncorrectAlgorithm`    | `GC008`            |
| `AccessTokenMissing`       | `GC008`            |
| `AccountsRefreshFailed`    | `GC103`            |
| `HttpRequestFailed`        | `GC025`            |
| `AuthorisationDenied`      | `GC004`            |
| `InternalServerError`      | `GC027`            |

### Backbase EBP error mapping

The following table maps each Backbase Engagement Banking Platform error code to its Grand Central error code:

| Backbase EBP code                                                | Grand Central code |
| :--------------------------------------------------------------- | :----------------- |
| `arrangements.api.notFound.arrangement`                          | `GC201`            |
| `arrangements.api.parentNotFound.arrangement`                    | `GC201`            |
| `arrangements.api.blank.`                                        | `GC025`            |
| `arrangements.api.notFound.balanceHistory`                       | `GC201`            |
| `arrangements.api.notFound.product`                              | `GC201`            |
| `arrangements.api.notNull.atLeastOne`                            | `GC025`            |
| `arrangements.api.badFormat.arrangementsIdentifiersPairs`        | `GC024`            |
| `arrangements.api.legalEntities.notRelated`                      | `GC201`            |
| `arrangements.api.legalEntities.atLeastOne`                      | `GC201`            |
| `Arrangement.api`                                                | `GC025`            |
| `account.arrangement.api`                                        | `GC024`            |
| `arrangements.api.batch.maxSizeExceeded`                         | `GC052`            |
| `Arrangement.balanceHistory.api`                                 | `GC201`            |
| `getArrangementById.arrangementId.Size`                          | `GC025`            |
| `account.product.api`                                            | `GC201`            |
| `arrangement.view.mapping.attribute`                             | `GC025`            |
| `account.api.notFound.user`                                      | `GC201`            |
| `account.api.arrangement.legalEntityNotExist`                    | `GC201`            |
| `account.api.arrangement.invalid.legalEntitiesPair`              | `GC025`            |
| `account.api.arrangement.duplicated.internalLegalEntityIds`      | `GC025`            |
| `account.api.arrangement.duplicated.externalLegalEntityIds`      | `GC025`            |
| `account.api.arrangements.getLinked`                             | `GC004`            |
| `arrangements.api.notFound.state`                                | `GC201`            |
| `account.api.invalidBody.user`                                   | `GC024`            |
| `account.api.invalidBody.accessGroup`                            | `GC024`            |
| `account.api.arrangement.notEntitledToSee`                       | `GC004`            |
| `account.api.arrangementNoPrivilege`                             | `GC004`            |
| `account.api.noPrivilege.user`                                   | `GC004`            |
| `arrangements.api.notFound.userPreferences`                      | `GC201`            |
| `account.api.arrangement.remove`                                 | `GC201`            |
| `account.api.arrangement.getRecipientArrangementsList`           | `GC201`            |
| `account.api.arrangement.getBalances`                            | `GC201`            |
| `account.api.arrangement.getArrangementsByLegalEntity`           | `GC201`            |
| `account.api.arrangement.invalidComboOfPeriodRange`              | `GC025`            |
| `account.api.arrangement.fromToDateBadCombo`                     | `GC025`            |
| `account.api.arrangement.invalidFromDate`                        | `GC025`            |
| `account.api.arrangement.emptyArrangementIds`                    | `GC025`            |
| `account.api.exportBalance.invalidFormat`                        | `GC025`            |
| `account.api.exportBalance.exceededLimit`                        | `GC052`            |
| `account.balanceHistory.api.invalidTimePeriod`                   | `GC025`            |
| `account.api.arrangement.unlink`                                 | `GC004`            |
| `account.api.arrangement.withLiveBalance.invalidIdentifiersJson` | `GC024`            |
| `product.summary.api.arrangement.noPrivilege`                    | `GC004`            |
| `product.summary.api.legalEntity.notAllowed`                     | `GC004`            |
| `arrangements.api.batch.minSizeNotReached`                       | `GC025`            |
| `arrangements.api.no.parent.child.mapping`                       | `GC201`            |
| `attribute.not.found`                                            | `GC025`            |
| `attribute.not.unmaskable`                                       | `GC025`            |
| `arrangements.api.notExist.subscription`                         | `GC201`            |
| `arrangements.api.externalLegalEntity.externalId.Size`           | `GC025`            |
| `arrangements.api.internalLegalEntity.id.Size`                   | `GC025`            |
| `arrangements.api.legalEntity.relation.Size`                     | `GC025`            |
| `KEY_API_PARSE`                                                  | `GC024`            |
| `arrangement-manager.api.Invalid.alias`                          | `GC201`            |
| `transactions.api.invalidId.arrangement`                         | `GC201`            |
| `transactions.api.invalidIds.arrangement`                        | `GC201`            |
| `transactions.api.notFound.arrangement`                          | `GC201`            |
| `transactions.api.invalidParameters.transaction`                 | `GC203`            |
| `transactions.api.invalid.bookingDateGreaterThan`                | `GC203`            |
| `transactions.api.invalid.bookingDateLessThan`                   | `GC203`            |
| `transactions.api.notFound.transaction`                          | `GC203`            |
| `transactions.api.noPrivilege.transaction`                       | `GC203`            |
| `transactions.api.noPrivilege.arrangement`                       | `GC002`            |
| `transactions.api.invalidBody.accessGroup`                       | `GC002`            |
| `transactions.api.notFound.user`                                 | `GC203`            |
| `transactions.api.noPrivilege.user`                              | `GC002`            |
| `api.Size.arrangementIds`                                        | `GC025`            |
| `transactions.api.size.transaction`                              | `GC203`            |
| `transactions.api.request.attribute.bad.value`                   | `GC203`            |
| `transactions.api.invalid`                                       | `GC203`            |
| `transactions.api.get.defaultValues.bad.param`                   | `GC203`            |
| `pfm.api.invalid.date`                                           | `GC203`            |
| `pfm.api.invalid.range.date`                                     | `GC203`            |
| `pfm.api.invalid.creditDebitIndicator`                           | `GC203`            |
| `pfm.api.invalid.intervalDuration`                               | `GC203`            |
| `pfm.api.invalid.forecast`                                       | `GC203`            |
| `transactions.api.io.error.writing.file`                         | `GC203`            |
| `pfm.api.invalid.arrangementIds`                                 | `GC201`            |
| `transactions.api.invalid.exportType`                            | `GC203`            |
| `transactions.api.state.definition.error`                        | `GC203`            |
| `transaction.api.export.ofx.booked.balance`                      | `GC203`            |
| `transactions.api.checkImageUnavailable.transaction`             | `GC203`            |
| `transaction.api.export.general.error`                           | `GC203`            |
| `transaction.api.notFound.state`                                 | `GC203`            |
| `transactions.api.invalid.amount`                                | `GC203`            |
| `transactions.api.invalid.description`                           | `GC203`            |
| `transactions.api.invalid.bookingDate`                           | `GC203`            |
| `transactions.api.notSupported.bookingDate`                      | `GC203`            |
| `REQUEST_ERROR`                                                  | `GC025`            |
| `common.api.consent.INVALID_CONSENT`                             | `GC704`            |
| `common.api.consent.INTERNAL_ERROR`                              | `GC027`            |
| `common.api.consent.FORBIDDEN`                                   | `GC004`            |
| `common.api.consent.INVALID_PARAMETER_VALUE`                     | `GC007`            |
| `common.api.consent.TOKEN_MISMATCH_ERROR`                        | `GC705`            |
| `common.api.consent.INVALID_CONSENT_STATUS`                      | `GC704`            |
| `common.api.consent.CONSENT_PAYMENT_NOT_FOUND`                   | `GC706`            |
| `common.api.consent.CONSENT_PAYMENT_ID_MISMATCH`                 | `GC707`            |
| `common.api.consent.CONSENT_SCHEME_MISMATCH`                     | `GC708`            |

<Note>
  For a complete list of Grand Central error codes and their descriptions, see [Status codes, errors, and responses](/connectors/reference/error-codes).
</Note>
