# TransfersCredit

A transfer using the CREDIT mechanism. Funds are moved from a firm account to a customer's brokerage account

## Example Usage

```typescript
import { TransfersCredit } from "@apexfintechsolutions/ascend-sdk/models/components";

let value: TransfersCredit = {};
```

## Fields

| Field                                                                                                                                                                                                                                                                                                                                                         | Type                                                                                                                                                                                                                                                                                                                                                          | Required                                                                                                                                                                                                                                                                                                                                                      | Description                                                                                                                                                                                                                                                                                                                                                   | Example                                                                                                                                                                                                                                                                                                                                                       |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `amount`                                                                                                                                                                                                                                                                                                                                                      | [components.TransfersCreditAmount](../../models/components/transferscreditamount.md)                                                                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                            | The amount of the credit being issued to the investor                                                                                                                                                                                                                                                                                                         | {<br/>"value": "10.00"<br/>}                                                                                                                                                                                                                                                                                                                                  |
| `bulkUploadId`                                                                                                                                                                                                                                                                                                                                                | *string*                                                                                                                                                                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                            | Bulk upload identifier to group related credit transfers                                                                                                                                                                                                                                                                                                      | 01H8FB90ZRRFWXB4XC2JPJ1D4Y                                                                                                                                                                                                                                                                                                                                    |
| `clientTransferId`                                                                                                                                                                                                                                                                                                                                            | *string*                                                                                                                                                                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                            | External identifier supplied by the API caller. Each request must have a unique pairing of client_transfer_id and account                                                                                                                                                                                                                                     | 179dcd33-49f8-4615-989c-560fb387c4fd                                                                                                                                                                                                                                                                                                                          |
| `description`                                                                                                                                                                                                                                                                                                                                                 | *string*                                                                                                                                                                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                            | Optional description information that will attach to this transaction                                                                                                                                                                                                                                                                                         | Credit given as promotion                                                                                                                                                                                                                                                                                                                                     |
| `feeOperatingAccount`                                                                                                                                                                                                                                                                                                                                         | *string*                                                                                                                                                                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                            | Optional account field to denote where the credit amount should be withdrawn from. If provided, the account must be a fee operating account. In the case of multiple fee operating accounts under the same correspondent, this field must be provided. If not provided, this will be looked up asynchronously (therefore will not be in the initial response) | accounts/01H8FM6EXVH77SAW3TC8KAWMES                                                                                                                                                                                                                                                                                                                           |
| `name`                                                                                                                                                                                                                                                                                                                                                        | *string*                                                                                                                                                                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                            | Full name of the credit resource, which contains account id and credit transaction id                                                                                                                                                                                                                                                                         | accounts/01H8FB90ZRRFWXB4XC2JPJ1D4Y/credits/20230823123456                                                                                                                                                                                                                                                                                                    |
| `state`                                                                                                                                                                                                                                                                                                                                                       | [components.TransfersCreditState](../../models/components/transferscreditstate.md)                                                                                                                                                                                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                            | The current state of the credit                                                                                                                                                                                                                                                                                                                               |                                                                                                                                                                                                                                                                                                                                                               |
| `type`                                                                                                                                                                                                                                                                                                                                                        | [components.TransfersCreditType](../../models/components/transferscredittype.md)                                                                                                                                                                                                                                                                              | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                            | The type of the credit being issued                                                                                                                                                                                                                                                                                                                           | PROMOTIONAL                                                                                                                                                                                                                                                                                                                                                   |