Class GirasolCardClearingBatchAdminService

Index

Constructors

Properties

db dbHelper girasolClient

Methods

create get getGirasolClearingBatch search

Constructors

constructor

new GirasolCardClearingBatchAdminService(
args: { girasolClient: GirasolClient; sqlClient: Sql },
): GirasolCardClearingBatchAdminService
Parameters
- args: { girasolClient: GirasolClient; sqlClient: Sql }
Returns GirasolCardClearingBatchAdminService
- Defined in packages/girasol-card-services/src/GirasolCardClearingBatchAdminService.ts:33

Properties

`Protected` `Readonly`db

db: B2bDatabase

`Protected` `Readonly`dbHelper

dbHelper: DbHelper

`Protected` `Readonly`girasolClient

girasolClient: GirasolClient

Methods

create

create(
input: Omit<GirasolCardClearingBatch, "id" | "createdAt">,
): Promise<{ ok: true; value: GirasolCardClearingBatch }>
Creates a new clearing batch
Parameters
- input: Omit<GirasolCardClearingBatch, "id" | "createdAt">
  The clearing batch data to create
Returns Promise<{ ok: true; value: GirasolCardClearingBatch }>
Result containing the created clearing batch or an error
- Defined in packages/girasol-card-services/src/GirasolCardClearingBatchAdminService.ts:44

get

get(
id: { clearingDate: string },
): Promise<{ ok: true; value: GirasolCardClearingBatch | null }>
Retrieves a single clearing record by its external ID
Parameters
- id: { clearingDate: string }
  The external ID of the clearing record
Returns Promise<{ ok: true; value: GirasolCardClearingBatch | null }>
Result containing the clearing record or an error
- Defined in packages/girasol-card-services/src/GirasolCardClearingBatchAdminService.ts:68

getGirasolClearingBatch

getGirasolClearingBatch(
    date: { date: string },
): Promise<
    | { ok: true; value: GirasolClearingTransaction[] }
    | { error: ServiceError; ok: false },
>
Retrieves clearing data from Girasol for a specific date
Parameters
- date: { date: string }
  Date in YYYY-MM-DD format (e.g., "2025-08-15")
Returns Promise<
| { ok: true; value: GirasolClearingTransaction[] }
| { error: ServiceError; ok: false },
>
Result containing the clearing transactions
- Defined in packages/girasol-card-services/src/GirasolCardClearingBatchAdminService.ts:148

search

search(
    fromDate: {
        clearingDates?: string[];
        fromClearingDate?: string;
        status?: "PENDING" | "PROCESSING" | "COMPLETED" | "FAILED";
        toClearingDate?: string;
    },
): Promise<{ ok: true; value: GirasolCardClearingBatch[] }>
Searches clearing batches between specified dates
Parameters
- fromDate: {
      clearingDates?: string[];
      fromClearingDate?: string;
      status?: "PENDING" | "PROCESSING" | "COMPLETED" | "FAILED";
      toClearingDate?: string;
  }
  Start date in YYYY-MM-DD format (mandatory)
Returns Promise<{ ok: true; value: GirasolCardClearingBatch[] }>
Result containing the clearing records
- Defined in packages/girasol-card-services/src/GirasolCardClearingBatchAdminService.ts:93