### Execute Remote Commands via Get

Source: https://developer.huntington.com/enterprisepayments/docs/commands

Demonstrates how to retrieve files or execute commands by fetching specific paths from the command directory. This includes examples of using parameters and handling command responses.

```SFTP
sftp> get /command/filenamemode=sender_only
sftp> cd /receive
sftp> ls
sftp> mget *

sftp> get "/command/parm=SA=AA:COMPANY;RA=AA:COMPANY2;CN=999999999" response.txt
sftp> !cat response.txt
```

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

### Configure API Environment Variables

Source: https://developer.huntington.com/enterprisepayments/docs/accounts-api

Defines essential configuration variables including client credentials and API endpoints. This setup ensures modularity and ease of maintenance when switching between development and production environments.

```bash
# ---- EDIT THESE VALUES AS NEEDED ----
CLIENT_ID="[client_id]"
CLIENT_SECRET="[client_secret]"
GROUP_ID="XXXXXXX"

# ---- ENDPOINTS ----
AUTH_URL="https://localhost:8080/1.0/oauth2/token"
ACCOUNTS_URL="https://localhost:8080/commercial/1.0/accounts"
```

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

### RSA Public Key Format

Source: https://developer.huntington.com/enterprisepayments/docs/setting-up-sftp-connection

Example of a valid RSA public key format required for non-interactive authentication. The key must be a single line starting with 'ssh-rsa'.

```Shell
ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDA3ew5lseakKU1oSarrnRWkvBLhiLYP
g8yi+bW9M3XngcHhABQPvvYi/OhpxTI4hjM2rAdMxp6xToXXXJYUoYtYiGRL7Mc6lv1FN
DmBVQK0AW6+qMgwS1853/tojNX34QWKLAYVEq0N/G4srvwgJdT+K2LaebH6chFB9mHsKu
VskFLyD+ioPhXivy6djbUywr56M0HBuG/LlN+Ozo8bTPwTnO9zYpzwiOCDJ4y+KzQubRx
4laLXWTnvsAk0YeCOdPGmmpBTErYTXNubI/Nl/zqIfodXrpOofh1U51fsp/kQ7IOU6+TC
hLO5FMJRCdW7nCkG0NdC68QKFjmzCAleMnF user@host
```

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

### Handle Initial Host Authentication

Source: https://developer.huntington.com/enterprisepayments/docs/setting-up-sftp-connection

Example of the terminal output when connecting to a new host for the first time, requiring the user to verify the RSA key fingerprint.

```Shell
The authenticity of host sftp.xxxxx.gxs.com (216.9.132.134) can't be established.
RSA key fingerprint is 53:b4:ad:c8:51:17:99:4b:c9:08:ac:c1:b6:05:71:9b.
Are you sure you want to continue connecting (yes/no)? yes
Warning: Permanently added 'sftp.xxxxx.gxs.com' (RSA) to the list of known hosts.
```

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

### Change Account Status using Node.js

Source: https://developer.huntington.com/enterprisepayments/reference/statusaccount

This Node.js example shows how to update an account's status using the 'axios' library. It sends a POST request to the API endpoint with the account GUID and version, including the account status in the request body. Ensure you have 'axios' installed (`npm install axios`).

```JavaScript
const axios = require('axios');

const accountGuid = 'your_account_guid';
const version = 'your_version';
const accountStatus = 'SYSTEM';

axios.post(`https://agw-ext.huntington.com/connected-deposits/${version}/accounts/${accountGuid}/status`, {
    account_status: accountStatus
}, {
    headers: {
        'accept': 'application/json',
        'content-type': 'application/json'
    }
})
.then(response => {
    console.log('Account status updated:', response.data);
})
.catch(error => {
    console.error('Error updating account status:', error.response ? error.response.data : error.message);
});
```

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

### Authenticate with Password

Source: https://developer.huntington.com/enterprisepayments/docs/setting-up-sftp-connection

Example of the terminal prompt and successful connection message after providing the Trading Grid password.

```Shell
$ sftp party1@sftp.xxxxx.opentext.com
party1@ sftp's password:
Connected to sftp.xxxxx.opentext.com.
```

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

### Retrieve Transactions (Node.js)

Source: https://developer.huntington.com/enterprisepayments/reference/get_transactions

Example Node.js code to retrieve transactional data using the 'axios' library. This snippet demonstrates making a GET request to the Huntington API and handling the response. It requires the 'axios' package to be installed.

```javascript
const axios = require('axios');

const options = {
  method: 'GET',
  url: 'https://api.huntington.com/commercial/1.0/transactions',
  headers: {
    'accept': 'application/json'
  }
};

axios.request(options).then(function (response) {
  console.log(response.data);
}).catch(function (error) {
  console.error(error);
});
```

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

### Retrieve Transactions (Python)

Source: https://developer.huntington.com/enterprisepayments/reference/get_transactions

Example Python code to retrieve transactional data using the 'requests' library. This snippet demonstrates making a GET request to the Huntington API and printing the JSON response. The 'requests' library needs to be installed.

```python
import requests

url = "https://api.huntington.com/commercial/1.0/transactions"
headers = {
    'accept': 'application/json'
}

response = requests.get(url, headers=headers)

print(response.json())
```

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

### MT940 Optional Field and Trailer Examples

Source: https://developer.huntington.com/enterprisepayments/docs/swift-mt-940

Examples demonstrating the syntax for optional balance fields like :65: and the security trailer block 5 containing MAC and checksum values.

```text
:65:C260210USD55000,00
{5:{MAC:12345678}{CHK:ABCD1234EF56}}
```

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

### Retrieve Transactions (Ruby)

Source: https://developer.huntington.com/enterprisepayments/reference/get_transactions

Example Ruby code to retrieve transactional data using the 'httparty' gem. This snippet shows how to send a GET request to the Huntington API and process the JSON response. The 'httparty' gem must be installed.

```ruby
require 'httparty'

response = HTTParty.get('https://api.huntington.com/commercial/1.0/transactions', headers: { 'accept' => 'application/json' })

puts response.body
```

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

### Full BAI2 Sample File

Source: https://developer.huntington.com/enterprisepayments/docs/file-format-guides

A comprehensive example of a BAI2 file containing multiple record types including headers, account summaries, transaction details, and trailer records.

```text
01,053200983,053200983,241210,1228,1,,,2/
02,,063114030,1,241209,,USD,2/
03,9999999999991,USD,015,69627820,0,,045,69627820,0,,100,0,0,,400,8949876,0,/
16,506,8949876,,,,TRANSFER TO COMMERCIAL ANALYSIS ACCOUNT 9999999999992/
49,157155392,3/
03, 9999999999994,USD,010,1433010,0,,015,11093072,0,,040,0,0,,045,0,0,,060,0,0,/
88,100,20042948,0,,400,10382886,0,/
16,100,20042948,,886883152,,REMOTE CAPTURE DEPOSIT/
16,206,8949876,,,,TRANSFER FROM BUSINESS SWEEP ACCOUNT 9999999999993/
16,451,121739,,20568396,,DSTRS INVESTMENT 5555555555/
16,475,7665230,,282387919,7294,Check Paid/
16,475,1892550,,910520012,7272,Check Paid/
16,475,300000,,910456769,7238,Check Paid/
16,475,267500,,910540579,7218,Check Paid/
16,475,50000,,910528585,7281,Check Paid/
16,475,41538,,910481026,7264,Check Paid/
16,475,24449,,910931882,7299,Check Paid/
16,475,19880,,910481025,7263,Check Paid/
49,73377750,14/
03, 9999999999995,USD,010,2989754,0,,015,2989754,0,,040,2989754,0,/
88,045,2989754,0,,060,2989754,0,,100,0,0,,400,0,0,/
49,14948770,3/
03, 9999999999996,USD,010,7724,0,,015,7724,0,,040,7724,0,,045,7724,0,/
88,060,7724,0,,100,0,0,,400,0,0,/
49,38620,3/
98,245520532,4,25/
99,245520532,1,27/
```

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

### Retrieve Usage Help Information

Source: https://developer.huntington.com/enterprisepayments/docs/commands

Explains how to fetch the help documentation for available commands by requesting a specific help file from the server.

```SFTP
sftp> get /command/help=help response.txt
sftp> !cat response.txt
```

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

### GET /connected-deposits/{version}/persons/retrieve?person_guid={person_guid}

Source: https://developer.huntington.com/enterprisepayments/openapi/CD-PERSONS.yaml

Retrieves a specific person's information using their unique GUID. Requires the API version and the person's GUID.

```APIDOC
## GET /connected-deposits/{version}/persons/retrieve?person_guid={person_guid}

### Description
Use this endpoint to retrieve or find a specific person using their unique identifier (person_guid).

### Method
GET

### Endpoint
`/connected-deposits/{version}/persons/retrieve`

### Parameters
#### Path Parameters
- **version** (string) - Required - The API version.
- **person_guid** (string) - Required - The unique identifier (GUID) of the person to retrieve. Format: uuid.

### Request Example
```
GET /connected-deposits/v1/persons/retrieve?person_guid=f1e2d3c4-b5a6-0987-6543-210fedcba987
```

### Response
#### Success Response (200)
- **person** (object) - The requested Person object. See `PersonResponseDTO` schema.

#### Response Example
```json
{
  "person": {
    "guid": "f1e2d3c4-b5a6-0987-6543-210fedcba987",
    "first_name": "John",
    "last_name": "Doe",
    "email": "john.doe@example.com",
    "birth_date": "1991-06-20",
    "created_at": "2023-10-27T10:00:00Z",
    "updated_at": "2023-10-27T11:30:00Z"
  }
}
```

#### Error Responses
- **400**: Bad Request.
- **401**: Unauthorized.
- **404**: Not Found.
- **500**: Internal Server Error.
```

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

### Retrieve SFTP /info/commands list

Source: https://developer.huntington.com/enterprisepayments/docs/commands

This example shows how to download the 'commands' file from the `/info` directory. This file lists all commands that can be issued in the `/command/` directory, along with their descriptions.

```shell
sftp> get commands
Fetching /info/commands to commands
sftp> !cat commands
- help - Returns help text for a command
- parm - Sets parameters used to send messages and filter received messages.
- receivemode - Sets 'ReceiveMode' for this session.
- standard - Sets 'STANDARD' for this session.
```

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

### GET /connected-deposits/{version}/account-instruments/retrieve

Source: https://developer.huntington.com/enterprisepayments/openapi/CD-ACCOUNT_INSTRUMENTS-renamed-url.yaml

Retrieves a specific account instrument by its unique GUID.

```APIDOC
## GET /connected-deposits/{version}/account-instruments/retrieve

### Description
Use this end point to retrieve or find a specific account instrument by guid.

### Method
GET

### Endpoint
/connected-deposits/{version}/account-instruments/retrieve?account_instrument_guid={account_instrument_guid}

### Parameters
#### Path Parameters
- **version** (string) - Required - The API version.
- **account_instrument_guid** (string) - Required - The unique identifier of the account instrument.

### Response
#### Success Response (200)
- **account_instrument_guid** (string) - Unique id of instrument associated with account
- **account_guid** (string) - Unique identifier of the account
- **mask_account_number** (string) - Last four digits of account number

#### Response Example
{
  "account_instrument_guid": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "account_guid": "550e8400-e29b-41d4-a716-446655440000",
  "mask_account_number": "1234"
}
```

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

### GET /connected-deposits/{version}/outside-instruments/retrieve

Source: https://developer.huntington.com/enterprisepayments/openapi/CD-OUTSIDE_INSTRUMENTS-renamed-url.yaml

Retrieve an external instrument using Instrument GUID.

```APIDOC
## GET /connected-deposits/{version}/outside-instruments/retrieve

### Description
Retrieve an external instrument using Instrument GUID.

### Method
GET

### Endpoint
/connected-deposits/{version}/outside-instruments/retrieve?outside_instrument_guid={outside_instrument_guid}

### Parameters
#### Path Parameters
- **version** (string) - Required - API version

#### Query Parameters
- **outside_instrument_guid** (string) - Required - GUID of the outside instrument to retrieve.

### Response
#### Success Response (200)
- **OutsideInstrumentDTO** - The retrieved outside instrument

#### Response Example
```json
{
  "instrument_guid": "d5e4f3c2-b1a0-9876-5432-10fedcba9876",
  "instrument_type": "BANK",
  "instrument_category": "CHECKING",
  "person_guid": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "instrument_country": "USA",
  "financial_inst_name": "Example Bank",
  "account_details": {
    "bank_account": {
      "account_type": "CHECKING",
      "account_number": "1234567890",
      "routing_number": "012345678"
    }
  },
  "created_at": "2023-10-27T10:00:00Z",
  "updated_at": "2023-10-27T10:00:00Z"
}
```

#### Error Responses
- **400** - Bad request
- **401** - Unauthorized
- **404** - Instrument not found
- **500** - Server Error
```

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

### Retrieve SFTP /info/version information

Source: https://developer.huntington.com/enterprisepayments/docs/commands

This example shows how to retrieve the server version information by downloading the 'version' file from the `/info` directory. This data is primarily for OpenText support.

```shell
sftp> get version
Fetching /info/version to version
sftp> !cat version
Version: 20120507-12
```

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

### GET /connected-deposits/{version}/wallets/retrieve

Source: https://developer.huntington.com/enterprisepayments/reference/getwalletbyid

Retrieves a specific wallet using its unique Wallet GUID.

```APIDOC
## GET /connected-deposits/{version}/wallets/retrieve

### Description
Use this endpoint to retrieve or find a specific wallet using Wallet GUID.

### Method
GET

### Endpoint
https://agw-ext.huntington.com/connected-deposits/{version}/wallets/retrieve

### Parameters
#### Query Parameters
- **wallet_guid** (string) - Required - The unique identifier for the wallet to retrieve.

### Request Example
```
GET https://agw-ext.huntington.com/connected-deposits/v1/wallets/retrieve?wallet_guid=YOUR_WALLET_GUID
```

### Response
#### Success Response (200)
- **wallet_details** (object) - Contains the details of the retrieved wallet.
  - **guid** (string) - The unique identifier of the wallet.
  - **name** (string) - The name of the wallet.
  - **balance** (number) - The current balance of the wallet.
  - **currency** (string) - The currency of the wallet balance.

#### Response Example
```json
{
  "wallet_details": {
    "guid": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
    "name": "Primary Wallet",
    "balance": 1500.75,
    "currency": "USD"
  }
}
```
```

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

### POST /connected-deposits/{version}/wallets/create

Source: https://developer.huntington.com/enterprisepayments/openapi/CD-WALLETS.yaml

Creates a new wallet for a person on the Qolo platform. Requires a person GUID and program GUID.

```APIDOC
## POST /connected-deposits/{version}/wallets/create

### Description
Create a wallet for a person on the Qolo platform. If the person is already created, send an existing Person GUID.

### Method
POST

### Endpoint
/connected-deposits/{version}/wallets/create

### Parameters
#### Path Parameters
- **version** (string) - Required - The API version.

#### Request Body
- **person_guid** (string) - Required - Person Guid (UUID).
- **program_guid** (string) - Required - Program Guid (UUID).
- **account_currencies** (array) - Optional - Currencies used in the wallet. Defaults to USD.

### Request Example
{
  "person_guid": "550e8400-e29b-41d4-a716-446655440000",
  "program_guid": "660e8400-e29b-41d4-a716-446655440001",
  "account_currencies": ["USD"]
}

### Response
#### Success Response (201)
- **wallet_guid** (string) - Unique identifier of the wallet.

#### Response Example
{
  "wallet_guid": "770e8400-e29b-41d4-a716-446655440002"
}
```

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

### GET /accounts/retrieve

Source: https://developer.huntington.com/enterprisepayments/reference/getaccountbyid

Retrieve a specific account's details using its unique account GUID.

```APIDOC
## GET /accounts/retrieve

### Description
Use this endpoint to retrieve a specific account based on the account guid.

### Method
GET

### Endpoint
https://agw-ext.huntington.com/connected-deposits/{version}/accounts/retrieve?account_guid={account_guid}

### Parameters
#### Path Parameters
- **version** (string) - Required - The API version (e.g., v1.0)

#### Query Parameters
- **account_guid** (string) - Required - The unique identifier for the account to retrieve

### Request Example
GET https://agw-ext.huntington.com/connected-deposits/v1.0/accounts/retrieve?account_guid=example-guid-123

### Response
#### Success Response (200)
- **account_details** (object) - The details of the requested account

#### Response Example
{
  "account_guid": "example-guid-123",
  "account_name": "Checking Account",
  "balance": 1000.00,
  "currency": "USD"
}
```

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

### Connect to SFTP Service via Command Line

Source: https://developer.huntington.com/enterprisepayments/docs/setting-up-sftp-connection

Establishes a secure connection to the SFTP server using the sftp command. Requires the server port, username, and server address provided by OpenText.

```Shell
$ sftp -P [port] [username]@[server address]
```

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

### GET /connected-deposits/{version}/account-instruments/retrieve

Source: https://developer.huntington.com/enterprisepayments/reference/getaccountinstrumentbyid

Retrieves or finds a specific account instrument using its unique GUID.

```APIDOC
## GET /connected-deposits/{version}/account-instruments/retrieve

### Description
Use this endpoint to retrieve or find a specific account instrument by its unique identifier (GUID).

### Method
GET

### Endpoint
https://agw-ext.huntington.com/connected-deposits/{version}/account-instruments/retrieve?account_instrument_guid={account_instrument_guid}

### Parameters
#### Path Parameters
- **version** (string) - Required - The API version (e.g., v1.0)

#### Query Parameters
- **account_instrument_guid** (string) - Required - The unique identifier for the account instrument.

### Request Example
GET /connected-deposits/v1.0/account-instruments/retrieve?account_instrument_guid=12345-abcde-67890

### Response
#### Success Response (200)
- **account_instrument** (object) - The details of the retrieved account instrument.

#### Response Example
{
  "account_instrument_guid": "12345-abcde-67890",
  "status": "active",
  "type": "checking"
}
```

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

### GET /connected-deposits/{version}/wallets/retrieve

Source: https://developer.huntington.com/enterprisepayments/openapi/CD-WALLETS.yaml

Retrieves the details of a specific wallet using its unique Wallet GUID.

```APIDOC
## GET /connected-deposits/{version}/wallets/retrieve

### Description
Use this endpoint to retrieve or find a specific wallet using Wallet GUID.

### Method
GET

### Endpoint
/connected-deposits/{version}/wallets/retrieve?wallet_guid={wallet_guid}

### Parameters
#### Path Parameters
- **version** (string) - Required - The API version.

#### Query Parameters
- **wallet_guid** (string) - Required - The unique identifier of the wallet (UUID).

### Response
#### Success Response (200)
- **wallet_guid** (string) - Unique identifier of the wallet.
- **person_guid** (string) - Person Guid.
- **account_status** (string) - Status of the account.

#### Response Example
{
  "wallet_guid": "770e8400-e29b-41d4-a716-446655440002",
  "person_guid": "550e8400-e29b-41d4-a716-446655440000",
  "account_status": "ACTIVE"
}
```

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

### BAI2 File Header Record Structure and Example

Source: https://developer.huntington.com/enterprisepayments/docs/bai2

Defines the structure and provides an example of the BAI2 File Header record. This record identifies the file and provides sender/receiver information, along with file creation timestamps.

```text
Record Code| Mandatory| 01| Identifies the record as a File Header.
Sender ID| Mandatory| 053200983| Transmitter of file.
Receiver ID| Mandatory| 053200983| Next recipient of file.
File Creation Date| Mandatory| —| YYMMDD format, sender date.
File Creation Time| Mandatory| —| HHMM format, military time.
File ID| Mandatory| 1| Defaults to 1 for previous day reporting.
Physical Record Length| Optional| 80| Not included.
Block Size| Optional| 1| Not included.
Version Number| Mandatory| 2| BAI version.
End of Record| Mandatory| /| Record terminator.

Example:
`01,053200983,053200983,241011,1024,1,,,2/`
```

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

### GET /connected-deposits/{version}/accounts/retrieve

Source: https://developer.huntington.com/enterprisepayments/openapi/CD_ACCOUNTS.yaml

Retrieves a specific account by its unique identifier (account GUID). Includes balance details.

```APIDOC
## GET /connected-deposits/{version}/accounts/retrieve

### Description
Use this endpoint to retrieve a specific account based on the account GUID.

### Method
GET

### Endpoint
/connected-deposits/{version}/accounts/retrieve

### Parameters
#### Path Parameters
- **version** (string) - Required - The API version.

#### Query Parameters
- **account_guid** (string) - Required - Account unique identifier on the platform.

### Response
#### Success Response (200)
- **account_instrument** (object) - Details about the account instrument.
- **account_guid** (string) - Unique identifier of the account on the platform.
- **wallet_guid** (string) - Unique identifier of the wallet on the platform.
- **balance** (object) - Details about the account balance.

#### Response Example
```json
{
  "account_instrument": {
    "account_guid": "f1e2d3c4-b5a6-7890-1234-567890abcdef",
    "wallet_guid": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
    "account_name": "My Checking Account",
    "account_currencies": [
      "USD"
    ]
  },
  "account_guid": "f1e2d3c4-b5a6-7890-1234-567890abcdef",
  "wallet_guid": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "balance": {
    "available_balance": "1000.00",
    "current_balance": "1050.00",
    "currency": "USD"
  }
}
```
```

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

### Create Wallet API Request (Ruby)

Source: https://developer.huntington.com/enterprisepayments/reference/createwallet

Example Ruby code to create a wallet using the 'net/http' library. This demonstrates making a POST request with JSON payload and headers.

```ruby
require 'net/http'
require 'uri'
require 'json'

def create_wallet(version, account_currencies, person_guid, program_guid, idempotency_key)
  uri = URI.parse("https://agw-ext.huntington.com/connected-deposits/#{version}/wallets/create")
  http = Net::HTTP.new(uri.host, uri.port)
  http.use_ssl = true

  request = Net::HTTP::Post.new(uri.request_uri)
  request['accept'] = 'application/json'
  request['content-type'] = 'application/json'
  request['IdempotencyKey'] = idempotency_key

  body = {
    account_currencies: account_currencies,
    person_guid: person_guid,
    program_guid: program_guid
  }.to_json
  request.body = body

  response = http.request(request)
  JSON.parse(response.body)
rescue => e
  puts "Error creating wallet: #{e.message}"
  nil
end

# Example usage:
# version = 'v1'
# account_currencies = ['USD']
# person_guid = 'some-person-guid'
# program_guid = 'some-program-guid'
# idempotency_key = 'some-idempotency-key'
# wallet = create_wallet(version, account_currencies, person_guid, program_guid, idempotency_key)
# puts "Wallet created: #{wallet.inspect}"
```

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

### POST /connected-deposits/{version}/persons/create

Source: https://developer.huntington.com/enterprisepayments/openapi/CD-PERSONS.yaml

Creates a new person on the Qolo platform. Requires person details and a program GUID. Optionally, an account can be created with specified currencies.

```APIDOC
## POST /connected-deposits/{version}/persons/create

### Description
This endpoint allows the creation of a new person on the Qolo platform. You can specify whether to create an account for the person and provide details for the person and any desired account currencies.

### Method
POST

### Endpoint
`/connected-deposits/{version}/persons/create`

### Parameters
#### Path Parameters
- **version** (string) - Required - The API version.

#### Header Parameters
- **IdempotencyKey** (string) - Required - A unique identifier to ensure idempotency of the request.

#### Request Body
- **create_account** (boolean) - Optional - Specify whether an account must be created for the person.
- **person_details** (object) - Required - Details of the person to be created. See `PersonCreateDTO` schema.
- **account_currencies** (array[string]) - Optional - List of currencies for account creation. Required if `create_account` is true.
  - Accepted values: USD, AED, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, FOK, GBP, GEL, GGP, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HTG, HUF, IDR, ILS, IMP, INR, IQD, ISK, JEP, JMD, JOD, JPY, KES, KGS, KHR, KID, KMF, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STN, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TVD, TWD, TZS, UAH, UGX, UYU, UZS, VES, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW, ZWL.
- **program_guid** (string) - Required - The GUID of the program associated with the person.

**PersonCreateDTO Schema:**
- **identifications** (array[object]) - Optional - List of identification details for the Person.
- **birth_date** (string) - Optional - Person’s date of birth. Accepted Format: yyyy-MM-dd.
- **email** (string) - Optional - Valid email address of the person.
- **first_name** (string) - Required - The first name of the person. Max length: 32.
- **last_name** (string) - Required - The last name of the person. Max length: 32.

### Request Example
```json
{
  "create_account": true,
  "person_details": {
    "first_name": "John",
    "last_name": "Doe",
    "email": "john.doe@example.com",
    "birth_date": "1990-05-15",
    "identifications": [
      {
        "type": "SSN",
        "value": "***-**-****"
      }
    ]
  },
  "account_currencies": [
    "USD",
    "EUR"
  ],
  "program_guid": "a1b2c3d4-e5f6-7890-1234-567890abcdef"
}
```

### Response
#### Success Response (201)
- **person** (object) - The newly created Person object. See `CreatePersonResponse` schema.

#### Response Example
```json
{
  "person": {
    "guid": "f1e2d3c4-b5a6-0987-6543-210fedcba987",
    "first_name": "John",
    "last_name": "Doe",
    "email": "john.doe@example.com",
    "birth_date": "1990-05-15",
    "created_at": "2023-10-27T10:00:00Z",
    "updated_at": "2023-10-27T10:00:00Z"
  }
}
```

#### Error Responses
- **400**: Bad request
- **401**: Unauthorized
- **404**: Program not found
- **500**: Server Error
```

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

### HTTP 200 OK Response for GET Operation

Source: https://developer.huntington.com/enterprisepayments/openapi/newURL-SANITIZED_TRANSACTIONS-App_CDAC-Transactions-1.0-SANITIZED.yaml

This describes the successful response (HTTP 200 OK) for a GET operation. It indicates that the operation was successful and the content is in JSON format, referencing a base response schema and various transaction examples.

```json
{
  "responses": {
    "HTTP_200_get": {
      "description": "OK - The operation was successful.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/base_get_response"
          },
          "examples": {
            "ACH": {"$ref": "#/components/examples/ACH"},
            "HIP": {"$ref": "#/components/examples/HIP"},
            "CHECK": {"$ref": "#/components/examples/CHECK"},
            "WIRES": {"$ref": "#/components/examples/WIRES"},
            "CASH": {"$ref": "#/components/examples/CASH"},
            "ACH_SUMMARY": {"$ref": "#/components/examples/ACH_SUMMARY"},
            "HIP_SUMMARY": {"$ref": "#/components/examples/HIP_SUMMARY"},
            "CHECK_SUMMARY": {"$ref": "#/components/examples/CHECK_SUMMARY"},
            "WIRES_SUMMARY": {"$ref": "#/components/examples/WIRES_SUMMARY"},
            "CASH_SUMMARY": {"$ref": "#/components/examples/CASH_SUMMARY"},
            "FEE_SUMMARY": {"$ref": "#/components/examples/FEE_SUMMARY"},
            "INVESTMENT_SUMMARY": {"$ref": "#/components/examples/INVESTMENT_SUMMARY"},
            "MISCELLANEOUS_SUMMARY": {"$ref": "#/components/examples/MISCELLANEOUS_SUMMARY"},
            "TRANSFER_SUMMARY": {"$ref": "#/components/examples/TRANSFER_SUMMARY"}
          }
        }
      },
      "headers": {
        "x-correlation-id": {"$ref": "#/components/headers/common_correlationId_responseHeader"}
      }
    }
  }
}
```

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

### GET /commercial/1.0/accounts

Source: https://developer.huntington.com/enterprisepayments/docs/accounts-api

Retrieves a list of all enterprise account profiles and metadata associated with the authenticated principal.

```APIDOC
## GET /commercial/1.0/accounts

### Description
Returns a list of accounts tied to the authenticated principal. Requires a valid Bearer token in the Authorization header.

### Method
GET

### Endpoint
https://localhost:8080/commercial/1.0/accounts

### Parameters
#### Headers
- **Authorization** (string) - Required - "Bearer [access_token]"

### Request Example
curl -X GET "https://localhost:8080/commercial/1.0/accounts" \
-H "Authorization: Bearer [access_token]"

### Response
#### Success Response (200)
- **accounts** (array) - List of account objects

#### Response Example
{
  "accounts": [
    {
      "account_id": "12345",
      "account_name": "Corporate Checking",
      "balance": 50000.00
    }
  ]
}
```

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

### Create Person API Request Examples

Source: https://developer.huntington.com/enterprisepayments/reference/createperson

Examples of how to call the Create Person API endpoint using various programming languages and cURL. These examples demonstrate the request structure, headers, and URL.

```shell
curl --request POST \
     --url https://agw-ext.huntington.com/connected-deposits/version/persons/create \
     --header 'accept: application/json' \
     --header 'content-type: application/json'
```

```javascript
const url = 'https://agw-ext.huntington.com/connected-deposits/version/persons/create';
const options = {
  method: 'POST',
  headers: {
    'accept': 'application/json',
    'content-type': 'application/json'
  }
};

fetch(url, options)
  .then(response => response.json())
  .then(data => console.log(data))
  .catch(error => console.error(error));
```

```python
import requests

url = 'https://agw-ext.huntington.com/connected-deposits/version/persons/create'
headers = {
    'accept': 'application/json',
    'content-type': 'application/json'
}

response = requests.post(url, headers=headers)
print(response.json())
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://agw-ext.huntington.com/connected-deposits/version/persons/create")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

response = http.request(request)
puts response.read_body
```

```php
<?php

$url = 'https://agw-ext.huntington.com/connected-deposits/version/persons/create';
$headers = array(
    'accept: application/json',
    'content-type: application/json'
);

$ch = curl_init($url);
c_setopt($ch, CURLOPT_RETURNTRANSFER, true);
c_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);

if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}

c_close($ch);

echo $response;

?>
```

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

### Create Account API Request (cURL)

Source: https://developer.huntington.com/enterprisepayments/reference/createaccount

Example cURL request to create an account. This demonstrates the HTTP method, URL, and required headers for the API call. Ensure to replace 'version' with the appropriate API version.

```shell
curl --request POST \
     --url https://agw-ext.huntington.com/connected-deposits/version/accounts/create \
     --header 'accept: application/json' \
     --header 'content-type: application/json'
```

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

### GET /reports

Source: https://developer.huntington.com/enterprisepayments/docs/reports

Initiates the generation of a specific report by providing the report name, program GUID, and date range.

```APIDOC
## GET /reports

### Description
Initiates the asynchronous generation of a report. Returns a reference_id used for polling and downloading.

### Method
GET

### Endpoint
/v1/reports

### Parameters
#### Query Parameters
- **report_name** (string) - Required - The name of the report to generate.
- **program_guid** (string) - Required - The unique identifier for your program.
- **date_from** (string) - Optional - Start date for the report (YYYY-MM-DD).
- **date_to** (string) - Optional - End date for the report (YYYY-MM-DD).

### Request Example
curl --location 'https://agw-ext.huntington.com/v1/reports?report_name=ActivityDetail&program_guid=YOUR_PROGRAM_GUID'

### Response
#### Success Response (200)
- **reference_id** (string) - Unique ID for the report request.
- **status** (string) - Current status (e.g., QUEUED).

#### Response Example
{
  "reference_id": "XXXXXXXXXXXXXXXXXXX",
  "status": "QUEUED"
}
```

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

### Get Access Token

Source: https://developer.huntington.com/enterprisepayments/docs/authentication-authorization

Requests an access token from the OAuth2 auth server using client credentials.

```APIDOC
## POST /1.0/oauth2/token

### Description
Requests an access token from the OAuth2 auth server. This token is required for authenticating subsequent API requests.

### Method
POST

### Endpoint
`https://localhost:8080/1.0/oauth2/token`

### Parameters
#### Query Parameters
- **grant_type** (string) - Required - Must be set to `client_credentials` for the Client Credentials flow.
- **client_id** (string) - Required - The unique identifier issued to your application during registration.
- **client_secret** (string) - Required - The secret key associated with your client ID. Keep this secure.

### Request Example
```javascript
const tokenResponse = await fetch('https://localhost:8080/1.0/oauth2/token', {
    method: 'POST',
    headers: {
        'Content-Type': 'application/x-www-form-urlencoded'
    },
    body: new URLSearchParams({
        grant_type: 'client_credentials',
        client_id: '[YOUR_CLIENT_ID]',
        client_secret: '[YOUR_CLIENT_SECRET]'
    })
});

const tokenData = await tokenResponse.json();
const accessToken = tokenData.access_token;
```

### Response
#### Success Response (200)
- **access_token** (string) - The obtained Bearer token.
- **expires_in** (integer) - The token's validity period in seconds.
- **token_type** (string) - The type of token, typically 'Bearer'.

#### Response Example
```json
{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "expires_in": 43200,
  "token_type": "Bearer"
}
```
```

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

### POST /connected-deposits/{version}/account-instruments/create

Source: https://developer.huntington.com/enterprisepayments/openapi/CD-ACCOUNT_INSTRUMENTS-renamed-url.yaml

Creates a new account instrument for an account on the Qolo platform.

```APIDOC
## POST /connected-deposits/{version}/account-instruments/create

### Description
Create a AccountInstrument for account on Qolo platform.

### Method
POST

### Endpoint
/connected-deposits/{version}/account-instruments/create

### Parameters
#### Path Parameters
- **version** (string) - Required - The API version.

#### Request Body
- **account_guid** (string) - Required - Unique identifier of the account on the platform.

### Request Example
{
  "account_guid": "550e8400-e29b-41d4-a716-446655440000"
}

### Response
#### Success Response (201)
- **account_instrument_guid** (string) - Unique id of instrument associated with account
- **account_guid** (string) - Unique identifier of the account

#### Response Example
{
  "account_instrument_guid": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "account_guid": "550e8400-e29b-41d4-a716-446655440000"
}
```