### Amount

- **integer**  
  *required*  
  ≥ 1  
  Amount to be transferred in the currency's smallest unit (e.g., cents for USD). This should always be a positive value.

### Category

- **string**  
  *enum*  
  *required*  
  `ADJUSTMENT`, `BALANCE_OR_FUNDING`, `DERECOGNITION`, `DISPUTE`, `FEE`, `INTERNAL`, `REWARD`, `PROGRAM_FUNDING`, `TRANSFER`

### From Financial Account Token

- **uuid**  
  *required*  
  Globally unique identifier for the financial account or card that will send the funds. Accepted type dependent on the program's use case.

### Memo

- **string**  
  *length ≤ 512*  
  Optional descriptor for the transfer.

### Subtype

- **string**  
  *required*  
  The program specific subtype code for the specified category/type.

### To Financial Account Token

- **uuid**  
  *required*  
  Globally unique identifier for the financial account or card that will receive the funds. Accepted type dependent on the program's use case.

### Token

- **uuid**  
  Customer-provided token that will serve as an idempotency token. This token will become the transaction token.

### Type

- **string**  
  *enum*  
  *required*  
  `ATM_BALANCE_INQUIRY`, `ATM_WITHDRAWAL`, `ATM_DECLINE`, `INTERNATIONAL_ATM_WITHDRAWAL`, `INACTIVITY`, `STATEMENT`, `MONTHLY`, `QUARTERLY`, `ANNUAL`, `CUSTOMER_SERVICE`, `ACCOUNT_MAINTENANCE`, `ACCOUNT_ACTIVATION`, `ACCOUNT_CLOSURE`, `CARD_REPLACEMENT`, `CARD_DELIVERY`, `CARD_CREATE`, `CURRENCY_CONVERSION`, `INTEREST`, `LATE_PAYMENT`, `BILL_PAYMENT`, `PAYMENT_FEE`, `CASH_BACK`, `ACCOUNT_TO_ACCOUNT`, `CARD_TO_CARD`, `DISBURSE`, `BILLING_ERROR`, `LOSS_WRITE_OFF`, `EXPIRED_CARD`, `EARLY_DERECOGNITION`, `ESCHEATMENT`, `INACTIVITY_FEE_DOWN`, `PROVISIONAL_CREDIT`, `DISPUTE_WON`, `SERVICE`, `TRANSFER`, `COLLECTION`

### External ID

- **string**  
  External ID defined by the customer

### On Closed Account

- **string**  
  *enum*  
  Defaults to FAIL  
  What to do if the financial account is closed when posting an operation  
  `FAIL`, `USE_SUSPENSE`

### Hold Token

- **uuid**  
  Token of an existing hold to settle when this transfer is initiated.

### 200 OK

- **object**  
  Base class for all transaction types in the ledger service

### Status

- **string**  
  *enum*  
  *required*  
  `PENDING`, `SETTLED`, `DECLINED`, `REVERSED`, `CANCELED`, `RETURNED`

### Token

- **uuid**  
  *required*  
  Unique identifier for the transaction

### Created

- **date-time**  
  *required*  
  ISO 8601 timestamp of when the transaction was created

### Updated

- **date-time**  
  *required*  
  ISO 8601 timestamp of when the transaction was last updated

### Family

- **const**  
  *enum*  
  *required*  
  `TRANSFER` - Book Transfer Transaction  
  `TRANSFER`

### Result

- **string**  
  *enum*  
  *required*  
  `APPROVED`, `DECLINED`

### Currency

- **string**  
  *required*  
  3-character alphabetic ISO 4217 code for the settling currency of the transaction

### Settled Amount

- **integer**  
  *required*  
  Amount of the transaction that has been settled in the currency's smallest unit (e.g., cents)

### Pending Amount

- **integer**  
  *required*  
  Pending amount of the transaction in the currency's smallest unit (e.g., cents), including any acquirer fees.  
  The value of this field will go to zero over time once the financial transaction is settled.

### Events

- **array of objects**  
  *required*  
  A list of all financial events that have modified this transfer

#### Events Object

- **amount**  
  - **integer**  
    *required*  
    Amount of the financial event that has been settled in the currency's smallest unit (e.g., cents).
  - **type**  
  - **string**  
    *enum*  
    *required*  
    `ATM_BALANCE_INQUIRY`, `ATM_WITHDRAWAL`, `ATM_DECLINE`, `INTERNATIONAL_ATM_WITHDRAWAL`, `INACTIVITY`, `STATEMENT`, `MONTHLY`, `QUARTERLY`, `ANNUAL`, `CUSTOMER_SERVICE`, `ACCOUNT_MAINTENANCE`, `ACCOUNT_ACTIVATION`, `ACCOUNT_CLOSURE`, `CARD_REPLACEMENT`, `CARD_DELIVERY`, `CARD_CREATE`, `CURRENCY_CONVERSION`, `INTEREST`, `LATE_PAYMENT`, `BILL_PAYMENT`, `PAYMENT_FEE`, `CASH_BACK`, `ACCOUNT_TO_ACCOUNT`, `CARD_TO_CARD`, `DISBURSE`, `BILLING_ERROR`, `LOSS_WRITE_OFF`, `EXPIRED_CARD`, `EARLY_DERECOGNITION`, `ESCHEATMENT`, `INACTIVITY_FEE_DOWN`, `PROVISIONAL_CREDIT`, `DISPUTE_WON`, `SERVICE`, `TRANSFER`, `COLLECTION`
  - **result**  
  - **string**  
    *enum*  
    *required*  
    `APPROVED`, `DECLINED`
  - **created**  
  - **date-time**  
    *required*  
    Date and time when the financial event occurred. UTC time zone.
  - **token**  
  - **uuid**  
    *required*  
    Globally unique identifier.
  - **subtype**  
  - **string**  
    *required*  
    The program specific subtype code for the specified category/type.
  - **memo**  
  - **string**  
    *required*  
    Memo for the transfer.
  - **detailed_results**  
    - **array of objects**  
      *required*  
      `APPROVED`, `FUNDS_INSUFFICIENT`

### From Financial Account Token

- **uuid**  
  *required*  
  Globally unique identifier for the financial account or card that will send the funds. Accepted type dependent on the program's use case.

### To Financial Account Token

### External ID

- **string**
  External ID defined by the customer

### Transaction Series

- **object**
  A series of transactions that are grouped together

### External Resource

- **object**  
  An external resource associated with the transfer.