### Transfer Object Example

Source: https://api.hellocash.net/docs

This is an example of the Transfer object, showing the structure and typical values for initiating a transfer.

```json
{
  "amount": 245.34,
  "description": "Fintubo tubing order X627438",
  "settlementamount": "USD 46.24",
  "to": "+251997289566"
}
```

--------------------------------

### Example API Parameters

Source: https://api.hellocash.net/docs

This snippet shows an example of parameters used for API requests, including batch information and transfer details.

```json
{
  "batch": "Batch 24-04-2017/2",
  "transfers": [
    {
      "amount": 245.34,
      "description": "Fintubo tubing order X627438",
      "settlementamount": "USD 46.24",
      "to": "+251997289566",
      "currency": "ETB",
      "tracenumber": "49d968b9-58ae-49d7-848b-94e4dc1f6456",
      "referenceid": "string",
      "notifyfrom": true,
      "notifyto": true,
      "tofullname": {},
      "toaddress": {},
      "tobankcode": {},
      "tobankbranch": {},
      "tobankaccount": {},
      "from": {}
    }
  ]
}
```

--------------------------------

### RepaymentBase Model Example

Source: https://api.hellocash.net/docs

This JSON object represents an example of the RepaymentBase model, used for loan repayment transfer details. It includes amount, description, and notification settings.

```json
{
  "amount": 245.34,
  "description": "Fintubo tubing order X627438",
  "notifyfrom": true,
  "notifyto": true
}
```

--------------------------------

### UserCredentialsChange Request Body Example

Source: https://api.hellocash.net/docs

Example of a JSON object representing user credentials change request. Use this to understand the required fields and their data types.

```json
{
  "principal": "2427384",
  "credentials0": "string",
  "credentials1": "string",
  "credentials2": "string",
  "system": "lucy"
}
```

--------------------------------

### API Parameters Example

Source: https://api.hellocash.net/docs

This JSON object represents the parameters for an API call, specifying currency, trace number, reference ID, notification preferences, and recipient/sender information.

```json
{
  "currency": "ETB",
  "tracenumber": "49d968b9-58ae-49d7-848b-94e4dc1f6456",
  "referenceid": "string",
  "notifyfrom": true,
  "notifyto": true,
  "tofullname": {},
  "toaddress": {},
  "tobankcode": {},
  "tobankaccount": {},
  "tobankbranch": {},
  "from": {}
}
```

--------------------------------

### Batch Processing Parameters

Source: https://api.hellocash.net/docs

Example of parameters for batch operations, specifying batch IDs with line numbers, transfer IDs, invoice IDs, and an optional comment.

```json
{
  "batchids": [
    {
      "batchid": "string",
      "linenumbers": [
        0
      ]
    }
  ],
  "transferids": [
    "string"
  ],
  "invoiceids": [
    "string"
  ],
  "comment": "string"
}
```

--------------------------------

### Response Class (Status 200)

Source: https://api.hellocash.net/docs

Example JSON structure for a successful API response (Status 200).

```json
{
  "197.156.71.98/29"
  ],
  "webhook": "https://callback.example.com/mycallbackhandler",
  "webhookmethod": "POST",
  "fromstatus": [
    "INITIALIZING",
    "PROCESSED"
  ],
  "tostatus": [
    "INITIALIZING",
    "PROCESSED"
  ],
  "certificatecheck": false,
  "retrytime": 60000,
  "timeout": 86400000,
  "timeoutmode": "DENIED",
  "eventdate": "2016-12-01T08:55:32Z"
}
```

--------------------------------

### Example Error Response

Source: https://api.hellocash.net/docs

Illustrates a typical error response from the API, showing the message code and a descriptive text for the error. This format is used for various account and transfer-related errors.

```json
{
  "message": "NOT_ENOUGH_CREDITS",
  "details": "The transfer is already processed and cannot be replaced."
}
```

--------------------------------

### Loan Response Example (Status 200)

Source: https://api.hellocash.net/docs

This JSON object represents a successful response for a loan request. It includes details about the loan, its repayments, and status. Use this as a reference for expected data structure.

```json
[
  {
    "id": "LUC0002347782ETH",
    "repayments": [
      {
        "id": "",
        "date": "",
        "expires": "",
        "amount": {},
        "repaidamount": {},
        "transfers": [
          {
            "id": "string",
            "status": "string",
            "amount": {}
          }
        ]
      }
    ],
    "status": "OPEN",
    "statusdetail": "string"
  }
]
```

--------------------------------

### Manage Connections

Source: https://api.hellocash.net/docs

Configure remote access tokens, IP whitelisting, and webhook settings.

```APIDOC
## GET /connections

### Description
Retrieve current connection settings, including remote access tokens, IP whitelist, and webhook configurations.

### Method
GET

### Endpoint
/connections

### Response
#### Success Response (200)
- **remote_tokens** (array) - List of remote access tokens.
- **ip_whitelist** (array) - List of allowed IP addresses.
- **webhooks** (object) - Webhook configuration details.
  - **url** (string) - The URL for receiving webhooks.
  - **events** (array) - The events to subscribe to.

#### Response Example
{
  "remote_tokens": [{"token": "your_connection_token", "authoritative": true}],
  "ip_whitelist": ["192.168.1.1"],
  "webhooks": {
    "url": "https://your-service.com/webhook",
    "events": ["AUTHENTICATING", "RECEIVED", "PROCESSED"]
  }
}

## POST /connections

### Description
Configure or update connection settings, such as remote access tokens, IP whitelisting, and webhook settings.

### Method
POST

### Endpoint
/connections

### Parameters
#### Request Body
- **remote_tokens** (array) - Optional - Array of remote access tokens to set.
- **ip_whitelist** (array) - Optional - Array of IP addresses to whitelist.
- **webhooks** (object) - Optional - Webhook configuration.
  - **url** (string) - The URL for receiving webhooks.
  - **events** (array) - The events to subscribe to.

### Request Example
{
  "ip_whitelist": ["192.168.1.100"],
  "webhooks": {
    "url": "https://your-service.com/new-webhook",
    "events": ["PREPARED"]
  }
}

### Response
#### Success Response (200)
- **message** (string) - Confirmation message of the update.

#### Response Example
{
  "message": "Connection settings updated successfully."
}
```

--------------------------------

### get /loans/{id} - Error Responses

Source: https://api.hellocash.net/docs

This section describes the potential error responses for the GET /loans/{id} endpoint, including not found scenarios and general transfer errors.

```APIDOC
## GET /loans/{id}

### Description
Retrieves the details of an individual loan.

### Method
GET

### Endpoint
/loans/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the loan.

### Response
#### Error Responses
- **404 Not Found**: Loan not found.
- **Default**: An error response with a message and optional details.

### Response Example (Error)
```json
{
  "message": "NOT_ENOUGH_CREDITS",
  "details": "The transfer is already processed and cannot be replaced."
}
```

### Error Codes
- **AMOUNT_NOT_AVAILABLE**: For airtime transfers, indicates an amount is out of stock.
- **AMOUNT_INVALID**: Only Ethiopian Birr amounts with '.' as decimal separator and 2 digit cent amounts are allowed.
- **BALANCE_TOO_LOW**: The current available balance on the from account is insufficient to allow the transfer.
- **DAILY_LIMIT_REACHED**: The maximum daily amount of funds transferred for the from account has been reached.
- **RECEIVER_UPPER_CREDIT_LIMIT_REACHED**: The maximum allowed balance on the to account has been reached.
- **FROM_NOT_FOUND**: The specified from member does not exist on the system or is not a correct phone number.
- **TO_NOT_FOUND**: The specified to member does not exist on the system or is not a correct phone number.
- **EXPIRES_TOO_EARLY**: Expiration date is too early, must be at least 5 minutes in the future.
- **EXPIRES_TOO_LATE**: Expiration date is too late, must be 90 days or less in the future.
- **NO_FROM_SELF_TRANSFER**: It is not allowed to send an invoice from your own account.
- **NO_TO_SELF_TRANSFER**: It is not allowed to send a transfer to your own account.
- **TRACENUMBER_NOT_UNIQUE**: When creating a new transfer, tracenumber must not have been used in the past.
- **TRANSFER_ALREADY_PROCESSED**: When trying to amend a transfer, if the transfer was already processed.
- **TRANSFER_NOT_MATCHED**: When trying to amend a transfer, if the referenceid and id did not match an existing transfer.
- **REFERENCEID_NOT_UNIQUE**: When creating a new transfer, referenceid is only allowed once. For batches, there may be multiple errors. For batches this field may contain a generic error code or the first error code of the batch.
```

--------------------------------

### Account Model Example

Source: https://api.hellocash.net/docs

This JSON object represents a successful response for an account. It includes details such as account ID, balance, currency, credit and daily limits, owner's name and group, and account type. The 'id' field combines the user ID and account type, while 'balance' and 'reservedamount' are crucial for calculating available funds for transfers.

```json
[
  {
    "id": "252464:CUS",
    "balance": 1432.63,
    "reservedamount": 10.34,
    "currency": "ETB",
    "creditlimit": 0,
    "dailylimit": 0,
    "name": "Fitsum Abebe Tizane",
    "group": "regcusts",
    "type": "REGULAR"
  }
]
```

--------------------------------

### Invoice Object Example

Source: https://api.hellocash.net/docs

This JSON object represents an example of an invoice that can be created via the HelloCash API. It includes fields for amount, description, payer information, currency, trace number, and notification preferences.

```json
{
  "amount": 23.6,
  "description": "string",
  "from": "2489566",
  "currency": "ETB",
  "tracenumber": "cff1b106-028d-4433-8c4f-70423487a238",
  "notifyfrom": true,
  "notifyto": true,
  "expires": "2017-01-15T15:34:23Z"
}
```

--------------------------------

### get /accounts/{id}

Source: https://api.hellocash.net/docs

Finds one account.

```APIDOC
## GET /accounts/{id}

### Description
Finds one account.

### Method
GET

### Endpoint
/accounts/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the account to retrieve.

### Response
#### Success Response (200)
- **message** (string) - The message code of the error.
- **details** (string) - A descriptive text message for the code, if available.

#### Response Example
```json
{
  "message": "ACCOUNT_NOT_FOUND",
  "details": "The specified account does not exist."
}
```

#### Error Response (default)
- **message** (string) - The message code of the error.
- **details** (string) - A descriptive text message for the code, if available.

**Error Codes:**
- AMOUNT_NOT_AVAILABLE: For airtime transfers, indicates an amount is out of stock.
- AMOUNT_INVALID: Only Ethiopian Birr amounts with '.' as decimal separator and 2 digit cent amounts are allowed.
- BALANCE_TOO_LOW: The current available balance on the from account is insufficient to allow the transfer. The accounts endpoint shows current available balance.
- DAILY_LIMIT_REACHED: The maximum daily amount of funds transferred for the from account has been reached. The accounts endpoint shows current daily limit.
- RECEIVER_UPPER_CREDIT_LIMIT_REACHED: The maximum allowed balance on the to account has been reached.
- FROM_NOT_FOUND: The specified from member does not exist on the system or is not a correct phone number.
- TO_NOT_FOUND: The specified to member does not exist on the system or is not a correct phone number.
- EXPIRES_TOO_EARLY: Expiration date is too early, must be at least 5 minutes in the future.
- EXPIRES_TOO_LATE: Expiration date is too late, must be 90 days or less in the future.
- NO_FROM_SELF_TRANSFER: It is not allowed to send an invoice from your own account.
- NO_TO_SELF_TRANSFER: It is not allowed to send a transfer to your own account.
- TRACENUMBER_NOT_UNIQUE: When creating a new transfer, tracenumber must not have been used in the past.
- TRANSFER_ALREADY_PROCESSED: When trying to amend a transfer, if the transfer was already processed.
- TRANSFER_NOT_MATCHED: When trying to amend a transfer, if the referenceid and id did not match an existing transfer.
- REFERENCEID_NOT_UNIQUE: When creating a new transfer, referenceid is only allowed once For batches, there may be multiple errors. For batches this field may contain a generic error code or the first error code of the batch.
```

--------------------------------

### get /transfers

Source: https://api.hellocash.net/docs

Search for transfers to and from this account. This endpoint will return a list of transfers meeting the search parameters sent. To get a list of most recent transfers, use descending set to true and limit the results. Using the status field, it is possible to return only transfers in certain states.

```APIDOC
## GET /transfers

### Description
Search for transfers to and from this account. This endpoint will return a list of transfers meeting the search parameters sent. To get a list of most recent transfers, use descending set to true and limit the results. Using the status field, it is possible to return only transfers in certain states.

### Method
GET

### Endpoint
/transfers

### Parameters
#### Query Parameters
- **descending** (boolean) - Optional - Set to true to get a list of most recent transfers.
- **limit** (integer) - Optional - Limits the number of results returned.
- **status** (string) - Optional - Filters transfers by their status (e.g., 'PENDING', 'COMPLETED', 'FAILED').

### Response
#### Success Response (200)
- **transfers** (array) - A list of transfer objects.
  - **transfer_id** (string) - The unique identifier for the transfer.
  - **from_account** (string) - The account from which the transfer was made.
  - **to_account** (string) - The account to which the transfer was made.
  - **amount** (number) - The amount of the transfer.
  - **currency** (string) - The currency of the transfer.
  - **status** (string) - The status of the transfer.
  - **timestamp** (string) - The date and time the transfer was initiated.

#### Response Example
```json
{
  "transfers": [
    {
      "transfer_id": "tx_12345",
      "from_account": "acc_abcde",
      "to_account": "acc_fghij",
      "amount": 100.50,
      "currency": "USD",
      "status": "COMPLETED",
      "timestamp": "2023-10-27T10:00:00Z"
    }
  ]
}
```

#### Error Response (404)
- **message** (string) - Loan not found.

#### Error Response (default)
- **message** (string) - The parameters are incorrect, or the transfer could not be made.
- **details** (string) - A descriptive text message for the code, if available. For batch errors, the item number and item error code are shown in the text.

#### Error Response Example
```json
{
  "message": "AMOUNT_INVALID",
  "details": "Only Ethiopian Birr amounts with '.' as decimal separator and 2 digit cent amounts are allowed."
}
```
```

--------------------------------

### Authentication Token Response

Source: https://api.hellocash.net/docs

This example demonstrates a successful authentication response, returning a Bearer API token. The token is valid for a maximum of 24 hours and must be included in subsequent API requests.

```json
{
  "token": "string"
}
```

--------------------------------

### get /airtime/{id}

Source: https://api.hellocash.net/docs

Find an airtime topup transfer by id.

```APIDOC
## GET /airtime/{id}

### Description
Find an airtime topup transfer by id.

### Method
GET

### Endpoint
/airtime/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the airtime topup transfer.

### Response
#### Success Response (200)
- **message** (string, optional) - The message code of the error.
- **details** (string, optional) - A descriptive text message for the code, if available.

#### Response Example
```json
{
  "message": "NOT_ENOUGH_CREDITS",
  "details": "The transfer is already processed and cannot be replaced."
}
```

#### Error Response (default)
- **message** (string, optional) - The message code of the error. For transfers, there are error codes that reflect certain reasons. On INVALID, DENIED or CANCELED status, this contains further details on the reason. More information about some individual errors:
    * AMOUNT_NOT_AVAILABLE: For airtime transfers, indicates an amount is out of stock.
    * AMOUNT_INVALID: Only Ethiopian Birr amounts with '.' as decimal separator and 2 digit cent amounts are allowed.
    * BALANCE_TOO_LOW: The current avaiable balance on the from account is insufficient to allow the transfer. The accounts endpoint shows current available balance.
    * DAILY_LIMIT_REACHED: The maximum daily amount of funds transferred for the from account has been reached. The accounts endpoint shows current daily limit.
    * RECEIVER_UPPER_CREDIT_LIMIT_REACHED: The maximum allowed balance on the to account has been reached.
    * FROM_NOT_FOUND: The specified from member does not exist on the system or is not a correct phone number
    * TO_NOT_FOUND: The specified to member does not exist on the system or is not a correct phone number
    * EXPIRES_TOO_EARLY: Expiration date is too early, must be at least 5 minutes in the future
    * EXPIRES_TOO_LATE: Expiration date is too late, must be 90 days or less in the future
    * NO_FROM_SELF_TRANSFER: It is not allowed to send an invoice from your own account
    * NO_TO_SELF_TRANSFER: It is not allowed to send a transfer to your own account
    * TRACENUMBER_NOT_UNIQUE: When creating a new transfer, tracenumber must not have been used in the past
    * TRANSFER_ALREADY_PROCESSED: When trying to amend a transfer, if the transfer was already processed
    * TRANSFER_NOT_MATCHED: When trying to amend a transfer, if the referenceid and id did not match an existing transfer
    * REFERENCEID_NOT_UNIQUE: When creating a new transfer, referenceid is only allowed once For batches, there may be multiple errors. For batches this field may contain a generic error code or the first error code of the batch.
= ['BALANCE_TOO_LOW', 'DAILY_LIMIT_REACHED', 'MAX_CREDIT_LIMIT_REACHED', 'ACCOUNT_SUSPENDED', 'ACCOUNT_NOT_FOUND', 'AMOUNT_TOO_LOW', 'AMOUNT_TOO_HIGH', 'AMOUNT_NOT_AVAILABLE', 'AMOUNT_INVALID', 'NOT_ENOUGH_CREDITS', 'RECIPIENT_REJECTED', 'RECEIVER_UPPER_CREDIT_LIMIT_REACHED', 'TRACENUMBER_NOT_UNIQUE', 'NO_POSSIBLE_TRANSFER_TYPES', 'FROM_NOT_FOUND', 'TO_NOT_FOUND', 'EXPIRES_TOO_EARLY', 'EXPIRES_TOO_LATE', 'NO_FROM_SELF_TRANSFER', 'NO_TO_SELF_TRANSFER', 'TRANSFER_ALREADY_PROCESSED', 'TRANSFER_NOT_MATCHED', 'REFERENCEID_NOT_UNIQUE']
- **details** (string, optional) - A descriptive text message for the code, if available. For batch errors, the item number and item error code are shown in the text.
```

--------------------------------

### Get Transfer History

Source: https://api.hellocash.net/docs

Retrieves the transfer history for the authenticated member.

```APIDOC
## GET /transfers

### Description
Retrieve the transfer history for the authenticated member.

### Method
GET

### Endpoint
/transfers

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - The maximum number of transfers to return.
- **offset** (integer) - Optional - The number of transfers to skip before starting to collect the result set.

### Response
#### Success Response (200)
- **transfers** (array) - A list of transfer objects.
  - **transfer_id** (string) - The unique identifier for the transfer.
  - **from_account** (string) - The sender's account number.
  - **to_account** (string) - The recipient's account number.
  - **amount** (number) - The transfer amount.
  - **currency** (string) - The currency of the transfer.
  - **timestamp** (string) - The date and time the transfer was made.
  - **status** (string) - The status of the transfer.

#### Response Example
{
  "transfers": [
    {
      "transfer_id": "txn_12345abcde",
      "from_account": "+251987654321",
      "to_account": "+251912345678",
      "amount": 100.50,
      "currency": "USD",
      "timestamp": "2023-10-27T10:00:00Z",
      "status": "COMPLETED"
    }
  ]
}
```

--------------------------------

### List available airtime topup amounts

Source: https://api.hellocash.net/docs

Returns a list of amounts that are currently available for airtime top-ups in the system. This endpoint helps determine the operational mode of the HelloCash airtime system (normal or fallback).

```APIDOC
## GET /airtime/available

### Description
Lists available airtime topup amounts. This endpoint indicates whether the airtime system is in normal or fallback mode.

### Method
GET

### Endpoint
/airtime/available

### Response
#### Success Response (200)
Returns a list of available top-up amounts.

* Model: string[]

#### Response Example
```json
[
  100
]
```
```

--------------------------------

### Get Loans

Source: https://api.hellocash.net/docs

Retrieves a list of loans with optional filtering by status, date range, and sorting.

```APIDOC
## GET /loans

### Description
Retrieves a list of loans. The results can be filtered by status, date range, and sorted in ascending or descending order.

### Method
GET

### Endpoint
/loans

### Parameters
#### Query Parameters
- **offset** (double) - Optional - offset, must be multiple of limit
- **limit** (double) - Optional - limit number of returned results
- **status** (Array[string]) - Optional - Limit results to one or more comma separated of the possible transfer states. NOTE: if not specified, transfers in all states are shown. Enum: ['PREPARED', 'PENDING', 'CANCELED', 'DENIED', 'EXPIRED', 'PROCESSED', 'FAILED']
- **startdate** (string) - Optional - Limit returned results from and including RFC3339 start date. Results with the second of the startdate are included. Fractional seconds are ignored.
- **enddate** (string) - Optional - Limit returned results upto and including RFC3339 end date. Results within the second of the enddate are included. Fractional seconds are ignored.
- **descending** (boolean) - Optional - Order results ascending or descending by date. Default: false

### Response
#### Success Response (200)
- **Model**: Loan
- **Example Value**: Inline Model [
Loan
]

Loan {
id (string, optional): 
A unique identifier for this loan. It is the original credit loan transfer to your account.
,
repayments (Array[Inline Model 1], optional): 
An array of future and past repayments for this loan. Each repayment has its own status, expiration date and amount.
,
status (string, optional): 
The overall status of this loan. This may be OPEN when the full amount has not been repaid, or CLOSED after all repayments are done.
= ['OPEN', 'CLOSED']string  
---
Enum:| "OPEN", "CLOSED"  
,
statusdetail (string, optional): 
For certain types of loan codes more detailed status is available
}

Inline Model 1 {
id (string, optional): 
The unique id for this repayment
,
date (string, optional): 
The rfc3339 due date for this repayment
,
expires (string, optional): 
The rfc3339 expiration date for this repayment
,
amount (object, optional): 
Repayment amount
,
repaidamount (object, optional): 
Total repaid amount for this repayment
,
transfers (Array[Inline Model 2], optional)
}

Inline Model 2 {
id (string, optional): 
Unique transfer id
,
status (string, optional): 
Transfer status
,
amount (object, optional): 
Transfer amount
}

#### Response Example
```json
[
  {
    "id": "LUC0002347782ETH",
    "repayments": [
      {
        "id": "",
        "date": "",
        "expires": "",
        "amount": {},
        "repaidamount": {},
        "transfers": [
          {
            "id": "string",
            "status": "string",
            "amount": {}
          }
        ]
      }
    ],
    "status": "OPEN",
    "statusdetail": "string"
  }
]
```
```

--------------------------------

### post /authorize

Source: https://api.hellocash.net/docs

Select a collection of items for two-factor authorization. Use this endpoint to select batch line items, transfers and/or invoices for manual two-factor authorization in one go. The next time the user checks their HelloCash menu on IVR or USSD, they are shown a prompt to review the transfers and enter their pincode to authorize the transfers. Returns a unique reference code for the selection, valid for 15 minutes. See PATCH /transfers/{id} for a fully automated alternative to manual authorization of transfers.

```APIDOC
## post /authorize

### Description
Select a collection of items for two-factor authorization. Use this endpoint to select batch line items, transfers and/or invoices for manual two-factor authorization in one go. The next time the user checks their HelloCash menu on IVR or USSD, they are shown a prompt to review the transfers and enter their pincode to authorize the transfers. Returns a unique reference code for the selection, valid for 15 minutes. See PATCH /transfers/{id} for a fully automated alternative to manual authorization of transfers.

### Method
POST

### Endpoint
/authorize

### Response
#### Success Response (200)
Request was successful
- **authorized** (number, optional): Number of authorized transfers

### Response Example
```json
{
  "authorized": 0
}
```
```

--------------------------------

### Successful Authorization Response

Source: https://api.hellocash.net/docs

Example response for a successful authorization request, indicating the number of authorized transfers.

```json
{
  "authorized": 0
}
```

--------------------------------

### post /authorize

Source: https://api.hellocash.net/docs

Select a collection of items for two-factor authorization. Use this endpoint to select batch line items, transfers and/or invoices for manual two-factor authorization in one go. The next time the user checks their HelloCash menu on IVR or USSD, they are shown a prompt to review the transfers and enter their pincode to authorize the transfers. Returns a unique reference code for the selection, valid for 15 minutes. See PATCH /transfers/{id} for a fully automated alternative to manual authorization of transfers.

```APIDOC
## POST /authorize

### Description
Select a collection of items for two-factor authorization. Use this endpoint to select batch line items, transfers and/or invoices for manual two-factor authorization in one go. The next time the user checks their HelloCash menu on IVR or USSD, they are shown a prompt to review the transfers and enter their pincode to authorize the transfers. Returns a unique reference code for the selection, valid for 15 minutes. See PATCH /transfers/{id} for a fully automated alternative to manual authorization of transfers.

### Method
POST

### Endpoint
/authorize

### Response
#### Success Response (200)
Request was successful
- **authorized** (number, optional): Number of authorized transfers

### Response Example
```json
{
  "authorized": 0
}
```
```

--------------------------------

### User Credentials Model

Source: https://api.hellocash.net/docs

Defines the structure for user credentials, including principal, optional credentials, optional token, and system ID. Use token instead of credentials when available.

```json
{
  "principal": "2427384",
  "credentials": "string",
  "token": "string",
  "system": "lucy"
}
```

--------------------------------

### Get Loan Details

Source: https://api.hellocash.net/docs

Retrieves detailed information about a specific loan, including its repayment schedule and status.

```APIDOC
## GET /loans/{id}

### Description
Retrieves detailed information about a specific loan using its unique identifier.

### Method
GET

### Endpoint
/loans/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier for the loan.

### Response
#### Success Response (200)
- **id** (string, optional) - A unique identifier for this loan. It is the original credit loan transfer to your account.
- **repayments** (Array[object], optional) - An array of future and past repayments for this loan. Each repayment has its own status, expiration date and amount.
- **status** (string, optional) - The overall status of this loan. This may be OPEN when the full amount has not been repaid, or CLOSED after all repayments are done.
- **statusdetail** (string, optional) - For certain types of loan codes more detailed status is available.

### Response Example
```json
{
  "id": "LUC0002347782ETH",
  "repayments": [
    {
      "id": "string",
      "date": "string",
      "expires": "string",
      "amount": {},
      "repaidamount": {},
      "transfers": [
        {
          "id": "string",
          "status": "string",
          "amount": {}
        }
      ]
    }
  ],
  "status": "OPEN",
  "statusdetail": "string"
}
```
```