Merchant Service Depot Issuing API

https://www.merchantservicedepot.com/issuing-api/
Admin
The Merchant Service Depot Issuing API provides a suite of endpoints for developers to integrate and...
Tokens:23,914
Snippets:71
Trust Score:6
Update:10 months ago
Show doc for...
Tokens:
Raw
### Create User Request Payload (JSON)

Source: https://www.merchantservicedepot.com/issuing-api/index

Example JSON payload for creating a new user. It includes authentication details, user information, and shipping/billing addresses. Ensure all required fields are populated correctly.

```json
{
	"api_username": "{Unique api username}",
	"api_key": "{Unique api_key}",
	"first_name": "firstname",
	"last_name": "lastname",
	"email": "example@example.com",
"phone_number": "4071234567",
	"employee_number": "999999999",
	"shipping_address1": "123 example street", 
	"shipping_address2": "apt 123", 
	"shipping_city": "example",
	"shipping_state": "TX",
	"shipping_zip": "12345",
"billing_address1": "123 example street", 
	"billing_address2": "apt 123", 
	"billing_city": "example",
	"billing_state": "TX",
	"billing_zip": "12345"
}
```

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

### Example Response for Analyst Access Retrieval

Source: https://www.merchantservicedepot.com/issuing-api/index

This JSON object shows a successful response when retrieving analyst access information. It includes a success message, code, and lists of associated cards and users.

```json
{ "message": "Access list successfully recieved",
  "code": 00,
  "cards": [
	"{unique id of card}",
	"{unique id of card}",
	"{unique id of card}"
  ],
  "users": [
	"{unique id of user}",
	"{unique id of user}"
  ]
}
```

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

### List Spending Profiles Against Account (GET)

Source: https://www.merchantservicedepot.com/issuing-api/index

Retrieves a list of all spending profiles associated with a given account. This API endpoint requires a GET request to the specified URL. The response includes a message and the profile data, if successful.

```JSON
{
	"message": "Spending profile list successfully recieved.",
	"data": {
    	"profiles": [
       {
       "spending_profile_details": {
		"spending_profile_uid": "{unique id of spending profile}",
    		"sp_name": "spending profile name",
		"cycle_type": "M",
		"cycle_reset_day": "23",
		"cycle_spending_limit": 10000,
		"daily_spending_limit": 2000,
		"max_amt_per_tran": 1000,
		"created_date": "0000-00-00 00:00:00",
		"modified_date": "0000-00-00 00:00:00",
		"deleted_date": "0000-00-00 00:00:00",
		"is_deleted": "NO"
        }
}
    	]
	}
}
```

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

### Example Response for Analyst Access Modification

Source: https://www.merchantservicedepot.com/issuing-api/index

This JSON object illustrates a successful response after modifying analyst access. It confirms the operation's success and lists the affected cards and users.

```json
{
  "message": "Access list successfully modified",
  "code": 00,
  "cards": [
	"{unique id of card}",
	"{unique id of card}",
	"{unique id of card}"
  ],
  "users": [
	"{unique id of user}",
	"{unique id of user}"
  ]
}
```

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

### Create User Response Payload (JSON)

Source: https://www.merchantservicedepot.com/issuing-api/index

Example JSON payload for a successful user creation response. It includes a success message, a status code, and the details of the created user, including their unique IDs.

```json
{
	"message": "User successfully created.",
    "code": 00,
	"data": {
		"user_uid": "{Unique ID of user}",
		"activation_code": "{Unique activation code needed to activate user}",
"first_name": "firstname", 
"last_name": "lastname", 
"email": "example@example.com", 
"phone_number": "4071234567", 
"employee_number": "999999999", 
"shipping_address1": "123 example street", 
"shipping_address2": "apt 123", 
"shipping_city": "example", 
"shipping_state": "TX", 
"shipping_zip": "12345", 
"billing_address1": "123 example street", 
"billing_address2": "apt 123", 
"billing_city": "example", 
"billing_state": "TX", 
"billing_zip": "12345"
"created_date": "2024-12-03 14:25:00"
}
}
```

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

### Add Spending Profile (GET with JSON Body)

Source: https://www.merchantservicedepot.com/issuing-api/index

Adds a new spending profile to be used for credit card limits. This API endpoint accepts a GET request with a JSON body containing profile details such as name, cycle type, reset day, and various spending limits. Requires authentication via api_username and api_key.

```JSON
{
	"api_username": "{Unique api username}",
	"api_key": "{Unique api_key}",
	"sp_name": "profile name",
	"cycle_type": "M",
	"cycle_reset_day": "23",
	"cycle_spending_limit": 10000,
	"daily_spending_limit": 2000,
	"max_amt_per_tran": 1000
}
```

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

### Example Request Payload for Analyst Access

Source: https://www.merchantservicedepot.com/issuing-api/index

This JSON object represents a sample request payload for modifying analyst access. It includes authentication details, user identifiers, card identifiers, and the desired operation type.

```json
{
  "api_username": "{Unique api username}",
  "api_key": "{Unique api_key}",
 "user_access_uid": "{unique id of user}",
  "card_uid": [
	"{unique id of card}",
	"{unique id of card}",
	"{unique id of card}"
  ],
  "user_uid": [
	"{unique id of user}",
	"{unique id of user}"
  ],
  "operation_type": "Add"
}
```

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

### GET /apis/cards/details

Source: https://www.merchantservicedepot.com/issuing-api/index

Retrieves detailed information for a specific card using its unique identifier.

```APIDOC
## GET /apis/cards/details

### Description
Retrieves detailed information for a specific card using its unique identifier.

### Method
GET

### Endpoint
https://issuing.merchantservicedepot.com/apis/cards/details

### Parameters
#### Query Parameters
- **card_uid** (string) - Required - Unique ID of the card being requested.

### Request Example
(GET requests typically do not have a request body, parameters are passed via query string)

### Response
#### Success Response (00)
- **message** (string) - Confirmation message.
- **code** (integer) - Response code, 00 for success.
- **data** (object) - Contains detailed card information.
  - **user_uid** (string) - Unique ID of the cardholder user.
  - **card_number** (string) - Encrypted card number.
  - **card_exp** (string) - Encrypted card expiration date.
  - **card_cvv** (string) - Encrypted card CVV.
  - **card_status** (string) - Status of the card.
  - **card_uid** (string) - Unique ID of the card.
  - **card_type** (string) - Type of the card.
  - **profile_flag** (boolean) - Flag indicating profile status.
  - **spending_profile_uid** (string) - Unique ID of the spending profile.
  - **sp_name** (string) - Name of the spending profile.
  - **cycle_type** (string) - Type of billing cycle.
  - **cycle_reset_day** (string) - Day of the month when the cycle resets.
  - **cycle_spending_limit** (integer) - Total spending limit for the cycle.
  - **daily_spending_limit** (integer) - Daily spending limit.
  - **max_amt_per_tran** (integer) - Maximum amount per transaction.
  - **max_number_of_trans** (integer) - Maximum number of transactions allowed.
  - **first_name** (string) - First name of the cardholder.
  - **last_name** (string) - Last name of the cardholder.
  - **address_type** (string) - Type of address.
  - **address1** (string) - Address line 1.
  - **address2** (string) - Address line 2.
  - **city** (string) - City.
  - **state** (string) - State.
  - **zip** (string) - ZIP code.
  - **created_date** (string) - Date the card was created.
  - **modified_date** (string) - Date the card was last modified.
  - **deleted_date** (string) - Date the card was deleted.

#### Response Example
```json
{
	"message": "Card details recieved successfully.",
	"code": 00,
	"data": {
		"user_uid": "{Unique ID of cardholder user}",
		"card_number": "1234 1234 1234 1234",
		"card_exp": "00/00",
		"card_cvv": "111",
		"card_status": "B",
		"card_uid": "{Unique id of card}",
		"card_type": "DIGITAL",
		"profile_flag": true,
		"spending_profile_uid": "{Unique id of spending profile}",
		"sp_name": "spending profile name",
		"cycle_type": "M",
		"cycle_reset_day": "23",
		"cycle_spending_limit": 10000,
		"daily_spending_limit": 2000,
		"max_amt_per_tran": 1000,
		"max_number_of_trans": 15,
		"first_name": "firstname",
		"last_name": "lastname",
		"address_type": "C",
		"address1": "1234 street example",
		"address2": "apt 123",
		"city": "austin",
		"state": "tx",
		"zip": "12345",
		"created_date": "0000-00-00 00:00:00",
		"modified_date": "0000-00-00 00:00:00",
		"deleted_date": "0000-00-00 00:00:00"
	}
}
```
```

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

### Create Card Request Payload

Source: https://www.merchantservicedepot.com/issuing-api/index

Example JSON payload for creating a new card. It includes user identification, card type, profile settings, and address details. Conditional fields depend on the card type and profile.

```json
{
	"api_username": "{Unique api username}",
	"api_key": "{Unique api_key}",
	"user_uid": "{Unique id of user}",
	"card_type": "DIGITAL",
	"profile": "Y",
	"spending_profile_uid": "null",
	"spending_limit": "1000"
	"shipping_address1": "123 Main St",
	"shipping_address2": "Apt 4B",
	"shipping_city": "Orlando",
	"shipping_state": "FL",
	"shipping_zip": "32829",
	"billing_address_type": "N",
	"billing_address1": "456 Elm St",
	"billing_address2": "Suite 101",
	"billing_city": "Austin",
	"billing_state": "TX",
	"billing_zip": "73301"
}
```

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

### GET /apis/account/funding

Source: https://www.merchantservicedepot.com/issuing-api/index

Retrieves balances related to account funding, including available funds and last funded amounts.

```APIDOC
## GET /apis/account/funding

### Description
Retrieves balances related to account funding, including available funds and last funded amounts.

### Method
GET

### Endpoint
https://issuing.merchantservicedepot.com/apis/account/funding

### Response
#### Success Response (200)
- **message** (String) - Confirmation message.
- **code** (Integer) - Response code, 00 for success.
- **data** (Object) - Contains account funding data.
  - **last_amount_requested** (String) - The last amount requested for funding.
  - **last_amount_funded** (String) - The last amount that was successfully funded.
  - **current_amount_available** (String) - The current amount of funds available in the account.
  - **transfer_amount_available** (String) - The amount available for transfer.
  - **last_funded_date** (String) - The timestamp of the last funding event.

#### Response Example
```json
{
  "message": "Balances successfully received.",
	"code": 00,
	"data": {
		"last_amount_requested" :"1000.00",
		"last_amount_funded": "1000.00", 
		"current_amount_available": "1000.00", 
		"transfer_amount_available": "1000.00",
		"last_funded_date":"2024-01-01 23:59:59"
   }
}
```
```

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

### Create Card Response Payload

Source: https://www.merchantservicedepot.com/issuing-api/index

Example JSON response for a successful card creation. It includes a success message, a status code, and detailed data about the newly created card, such as card number, expiration, and user details.

```json
{
  	"message": "Card successfully created.",
 	 "code": "00",
 	 "data": {
		"card_number": "1234 1234 1234 1234",  // (encrypted)
		"card_exp": "00/00", // (encrypted)
		"card_cvv": "111",// (encrypted)
	"card_uid": "Unique id of card",
	"card_type": "DIGITAL",
	"profile_flag": true,
	"spending_profile_uid": "null",
	"spending_limit": "1000",
		"first_name": "firstname",
		"last_name": "lastname",
		"address_type": "C",
		"address1": "1234 street example",
		"address2": "apt 123",
		"city": "Austin",
		"state": "TX",
		"zip": "12345",
		"created_date": "0000-00-00 00:00:00"
 	 }
}
```

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

### Get Card Details API Request

Source: https://www.merchantservicedepot.com/issuing-api/index

This snippet illustrates the JSON request payload for retrieving details of a specific card. It requires the card's unique identifier (card_uid) as a string. The endpoint for this request is a GET method.

```JSON
{
	"card_uid": "{Unique ID of card being requested (Must be valid card in system)}"
}
```

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

### GET /apis/cards/list

Source: https://www.merchantservicedepot.com/issuing-api/index

Retrieves a list of all cards associated with a specific user. Requires the user's UID.

```APIDOC
## GET /apis/cards/list

### Description
Retrieves a list of all cards associated with a specific user. Requires the user's UID.

### Method
GET

### Endpoint
https://issuing.merchantservicedepot.com/apis/cards/list

### Parameters
#### Query Parameters
- **user_uid** (string) - Required - Unique ID associated with the user whose cards are to be listed.

### Request Example
(GET requests typically do not have a request body, parameters are passed via query string)

### Response
#### Success Response (00)
- **message** (string) - Confirmation message.
- **data** (object) - Contains user and card information.
  - **user_uid** (string) - Unique ID of the cardholder user.
  - **cards** (array) - An array of card objects associated with the user.
    - **card_details** (object) - Detailed information about each card.
      - **card_number** (string) - Encrypted card number.
      - **card_exp** (string) - Encrypted card expiration date.
      - **card_cvv** (string) - Encrypted card CVV.
      - **card_uid** (string) - Unique ID of the card.
      - **card_type** (string) - Type of the card.
      - **profile_flag** (boolean) - Flag indicating profile status.
      - **spending_profile_uid** (string) - Unique ID of the spending profile.
      - **sp_name** (string) - Name of the spending profile.
      - **cycle_type** (string) - Type of billing cycle.
      - **cycle_reset_day** (string) - Day of the month when the cycle resets.
      - **cycle_spending_limit** (integer) - Total spending limit for the cycle.
      - **daily_spending_limit** (integer) - Daily spending limit.
      - **max_amt_per_tran** (integer) - Maximum amount per transaction.
      - **max_number_of_trans** (integer) - Maximum number of transactions allowed.
      - **first_name** (string) - First name of the cardholder.
      - **last_name** (string) - Last name of the cardholder.
      - **address_type** (string) - Type of address.
      - **address1** (string) - Address line 1.
      - **address2** (string) - Address line 2.
      - **city** (string) - City.
      - **state** (string) - State.
      - **zip** (string) - ZIP code.
      - **created_date** (string) - Date the card was created.
      - **modified_date** (string) - Date the card was last modified.
      - **deleted_date** (string) - Date the card was deleted.

#### Response Example
```json
{
  "message": "Card list successfully received.",
  "data": {
	"user_uid": "{Unique id of cardholder user}",
	"cards": [
  	{
    		"card_details": {
      			"card_number": "1234 1234 1234 1234",
      			"card_exp": "00/00",
      			"card_cvv": "111",
      			"card_uid": "Unique id of card 1",
      			"card_type": "DIGITAL",
      			"profile_flag": true,
      			"spending_profile_uid": "Unique id of spending profile",
      			"sp_name": "Spending Profile Name 1",
      			"cycle_type": "M",
      			"cycle_reset_day": "23",
      			"cycle_spending_limit": 10000,
      			"daily_spending_limit": 2000,
      			"max_amt_per_tran": 1000,
      			"max_number_of_trans": 15,
      			"first_name": "FirstName1",
      			"last_name": "LastName1",
      			"address_type": "C",
      			"address1": "1234 Street Example 1",
      			"address2": "Apt 123",
      			"city": "Austin",
      			"state": "TX",
      			"zip": "12345",
      			"created_date": "0000-00-00 00:00:00",
				"modified_date": "0000-00-00 00:00:00",
				"deleted_date": "0000-00-00 00:00:00"

    		}
  	}
	]
  }
}
```
```

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

### List All Users Request Payload (JSON)

Source: https://www.merchantservicedepot.com/issuing-api/index

This JSON payload is used for the 'List All Users' API call. It specifies pagination and optional filtering parameters like start date, end date, and user type.

```json
{
	"message": "Users successfully received.",
	"code": 00,
	"current_page": 1,
	"total_pages": 1,
	"total_record_count": 1,
	"data": {
       	"users": [
        {
       "user_details": {
		"user_uid": "{Unique id of user}",
"first_name": "firstname", 
"last_name": "lastname", 
"email": "example@example.com", 
"phone_number": "4071234567", 
"user_type": "USER",
"employee_number": "999999999", 
"shipping_address1": "123 example street", 
"shipping_address2": "apt 123", 
"shipping_city": "example", 
"shipping_state": "TX", 
"shipping_zip": "12345", 
"billing_address1": "123 example street", 
"billing_address2": "apt 123", 
"billing_city": "example", 
"billing_state": "TX", 
"billing_zip": "12345"
"status": "active",
"created_date": "2024-01-01 23:59:59",
"modified_date": "2024-01-01 23:59:59",
"deleted_date": "2024-01-01 23:59:59",
"is_deleted": "1"
}
}
      	]
	}
}
```

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

### Get Card Details API Response

Source: https://www.merchantservicedepot.com/issuing-api/index

This snippet displays a successful JSON response containing detailed information about a specific card. It includes user identifiers, encrypted card number, expiration, and CVV, along with card status, type, spending profile details, address information, and timestamps for creation, modification, and deletion.

```JSON
{
	"message": "Card details recieved successfully.",
	"code": 00,
	"data": {
		"user_uid": "{Unique ID of cardholder user}",
		"card_number": "1234 1234 1234 1234",(encrypted)
		"card_exp": "00/00",(encrypted)
		"card_cvv": "111"(encrypted)
		"card_status": "B",
        		"card_uid": "{Unique id of card}",
       		"card_type": "DIGITAL",
       		"profile_flag": true,
		"spending_profile_uid": "{Unique id of spending profile}",
		"sp_name": "spending profile name",
		"cycle_type": "M",
		"cycle_reset_day": "23",
		"cycle_spending_limit": 10000,
		"daily_spending_limit": 2000,
		"max_amt_per_tran": 1000,
		"max_number_of_trans": 15,
		"first_name": "firstname",
		"last_name": "lastname",
		"address_type": "C",
		"address1": "1234 street example",
		"address2": "apt 123",
		"city": "austin",
		"state": "tx",
		"zip": "12345",
		"created_date": "0000-00-00 00:00:00",
		"modified_date": "0000-00-00 00:00:00",
		"deleted_date": "0000-00-00 00:00:00"
	}
}
```

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

### Modify Card Status Response Payload

Source: https://www.merchantservicedepot.com/issuing-api/index

Example JSON response after successfully modifying a card's status. It confirms the action with a success message, status code, and the updated card UID and status.

```json
{
	"message": "Card details successfully modified.",
	"code": 00,
	"card_uid": "{Unique id of card}",
	"card_status": "B"
}
```

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

### List Cards by User API Request

Source: https://www.merchantservicedepot.com/issuing-api/index

This snippet shows the JSON request structure for retrieving a list of all cards associated with a specific user. It requires the user's unique identifier (user_uid) as a string. This endpoint uses the GET method.

```JSON
{
  "user_uid": "{Unique ID associated with user you want cards of}"
}
```

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

### Get Last 30 Days Transactions API Request

Source: https://www.merchantservicedepot.com/issuing-api/index

Retrieves transaction details for the past 30 days. Accepts optional parameters for transaction type, start date, and end date, along with pagination. Returns a list of transactions.

```JSON
{
	"message": "Transactions successfully received.",
	"data": {
	"current_page": 1,
	"total_pages": 1
    	"transactions": [
        	{
            	"transaction_details": {
                		"transaction_id": "{uid of transaction}",
                		"card_uid": "{uid of card performing transaction}",
				"card_last_four": "1234"
                		"amount": "500.00",
                		"status": "Approved",
                    	"merchant": "TCB PAY",
               	 	"approval_code": "011111"
               	 	"transaction_time_gmt": "2024-01-10 23:59:59",
                		"authorization_time_gmt": "2024-01-10 23:59:59",
                		"posted_time_gmt": "2024-01-10 23:59:59",
                		"void_time_gmt": null
            	}
        	}
    	]
	}
}
```

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

### POST /apis/users

Source: https://www.merchantservicedepot.com/issuing-api/index

Creates a new user with specified details, including contact information and shipping/billing addresses.

```APIDOC
## POST /apis/users

### Description
Creates a new user with specified details, including contact information and shipping/billing addresses.

### Method
POST

### Endpoint
/apis/users

### Parameters
#### Request Body
- **user_type** (String) - Required - Type of user ('ADMIN', 'USER', 'ANALYST').
- **first_name** (String) - Required - First name of the user.
- **last_name** (String) - Required - Last name of the user.
- **email** (String) - Required - Email address of the user.
- **phone_number** (Integer) - Required - 10-digit phone number.
- **employee_number** (Integer) - Required - 9-digit employee number.
- **shipping_address1** (String) - Conditional, required for physical cards - Primary street address for shipping.
- **shipping_address2** (String) - Optional - Secondary street address for shipping.
- **shipping_city** (String) - Conditional, required for physical cards - City for shipping address.
- **shipping_state** (String) - Conditional, required for physical cards - US State abbreviation for shipping address.
- **shipping_zip** (String) - Conditional, required for physical cards - 5-digit zip code for shipping address.
- **billing_address1** (String) - Required - Primary street address for billing.
- **billing_address2** (String) - Optional - Secondary street address for billing.
- **billing_city** (String) - Required - City for billing address.
- **billing_state** (String) - Required - US State abbreviation for billing address.
- **billing_zip** (String) - Required - 5-digit zip code for billing address.

### Request Example
```json
{
	"api_username": "{Unique api username}",
	"api_key": "{Unique api_key}",
	"first_name": "firstname",
	"last_name": "lastname",
	"email": "example@example.com",
    "phone_number": "4071234567",
	"employee_number": "999999999",
	"shipping_address1": "123 example street", 
	"shipping_address2": "apt 123", 
	"shipping_city": "example",
	"shipping_state": "TX",
	"shipping_zip": "12345",
    "billing_address1": "123 example street", 
	"billing_address2": "apt 123", 
	"billing_city": "example",
	"billing_state": "TX",
	"billing_zip": "12345"
}
```

### Response
#### Success Response (200)
- **message** (String) - Confirmation message.
- **code** (Integer) - Response code (00 for success).
- **data** (Object) - Contains user details.
  - **user_uid** (String) - Unique ID of the created user.
  - **activation_code** (String) - Activation code for the user.
  - **first_name** (String) - First name of the user.
  - **last_name** (String) - Last name of the user.
  - **email** (String) - Email address of the user.
  - **phone_number** (String) - Phone number of the user.
  - **employee_number** (String) - Employee number of the user.
  - **shipping_address1** (String) - Primary street address for shipping.
  - **shipping_address2** (String) - Secondary street address for shipping.
  - **shipping_city** (String) - City for shipping address.
  - **shipping_state** (String) - US State abbreviation for shipping address.
  - **shipping_zip** (String) - Zip code for shipping address.
  - **billing_address1** (String) - Primary street address for billing.
  - **billing_address2** (String) - Secondary street address for billing.
  - **billing_city** (String) - City for billing address.
  - **billing_state** (String) - US State abbreviation for billing address.
  - **billing_zip** (String) - Zip code for billing address.
  - **created_date** (String) - Date and time of user creation.

#### Response Example
```json
{
	"message": "User successfully created.",
    "code": 00,
	"data": {
		"user_uid": "{Unique ID of user}",
		"activation_code": "{Unique activation code needed to activate user}",
        "first_name": "firstname", 
        "last_name": "lastname", 
        "email": "example@example.com", 
        "phone_number": "4071234567", 
        "employee_number": "999999999", 
        "shipping_address1": "123 example street", 
        "shipping_address2": "apt 123", 
        "shipping_city": "example", 
        "shipping_state": "TX", 
        "shipping_zip": "12345", 
        "billing_address1": "123 example street", 
        "billing_address2": "apt 123", 
        "billing_city": "example", 
        "billing_state": "TX", 
        "billing_zip": "12345",
        "created_date": "2024-12-03 14:25:00"
    }
}
```

### Error Handling
- **01**: API Key is missing or invalid.
- **02**: Username is missing or invalid.
- **04**: User Type is missing or invalid.
- **07**: First/Last name is missing or invalid.
- **08**: Email is missing or invalid.
- **09**: Email already exists.
```

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

### Account Funding API

Source: https://www.merchantservicedepot.com/issuing-api/index

Initiates funding for a user's account or card.

```APIDOC
## POST /apis/account/fund

### Description
Initiate funding for a user's account or card.

### Method
POST

### Endpoint
https://issuing.merchantservicedepot.com/apis/account/fund

### Parameters
#### Request Body
- **api_username** (String) - Required - Unique API username associated with the account
- **api_key** (String) - Required - Unique API key associated with the account
- **user_id** (String) - Required - The ID of the user whose account to fund
- **amount** (Number) - Required - The amount to fund
- **currency** (String) - Required - The currency of the funding amount (e.g., 'USD', 'EUR')
- **funding_source** (String) - Optional - The source of the funds (e.g., 'bank_account', 'credit_card')

### Request Example
{
  "api_username": "example_username",
  "api_key": "example_key",
  "user_id": "user123",
  "amount": 500.00,
  "currency": "USD",
  "funding_source": "bank_account"
}

### Response
#### Success Response (200)
- **transaction_id** (String) - The ID of the funding transaction.
- **message** (String) - Indicates the account funding was successful.

#### Response Example
{
  "transaction_id": "fund789",
  "message": "Account funding successful."
}
```

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

### Add User API

Source: https://www.merchantservicedepot.com/issuing-api/index

This API is responsible for creating new users in the system. It is compatible with both encrypted and plain credit card methods of transactions.

```APIDOC
## POST /apis/users/add

### Description
Add a new user to the system.

### Method
POST

### Endpoint
https://issuing.merchantservicedepot.com/apis/users/add

### Parameters
#### Request Body
- **api_username** (String) - Required - Unique API username associated with the account
- **api_key** (String) - Required - Unique API key associated with the account

### Request Example
{
  "api_username": "example_username",
  "api_key": "example_key"
}

### Response
#### Success Response (200)
- **message** (String) - Indicates the user was added successfully.

#### Response Example
{
  "message": "User added successfully."
}
```

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

### POST /apis/cards/create

Source: https://www.merchantservicedepot.com/issuing-api/index

Creates a new digital or physical card for a user. Supports both prepaid and credit card profiles with configurable spending limits and addresses.

```APIDOC
## POST /apis/cards/create

### Description
Creates a new digital or physical card. This endpoint allows for the creation of prepaid or credit cards, with options to set spending limits, associate spending profiles, and define shipping and billing addresses.

### Method
POST

### Endpoint
/apis/cards/create

### Parameters
#### Request Body
- **api_username** (String) - Required - Unique API username.
- **api_key** (String) - Required - Unique API key.
- **user_uid** (String) - Required - Unique ID of the user who will become the cardholder.
- **card_type** (String) - Required - Type of card to be created. Expected values: "DIGITAL", "PHYSICAL".
- **profile** (String) - Required - Specifies whether the card is prepaid or credit. Expected values: "N" for prepaid, "Y" for credit.
- **spending_profile_uid** (String) - Conditional - Unique ID of an existing preset spending profile. Required if `profile` is "Y".
- **spending_limit** (Integer) - Conditional - Specific amount the card will have to spend. Required if `profile` is "N".
- **shipping_address_type** (String) - Conditional - Specifies the address type for shipping. Required if `card_type` is "PHYSICAL". Expected values: "U" (User Shipping), "C" (Company).
- **billing_address_type** (String) - Required - Specifies the billing address type. Expected values: "U" (User shipping), "C" (Company), "B" (User billing), "N" (specific).
- **billing_address1** (String) - Conditional - Primary billing address for AVS. Required if `card_type` is "DIGITAL". Max 100 characters.
- **billing_address2** (String) - Optional - Secondary billing address for AVS.
- **billing_city** (String) - Conditional - Billing city for AVS. Required if `card_type` is "DIGITAL".
- **billing_state** (String) - Conditional - Billing state for AVS. Required if `card_type` is "DIGITAL".
- **billing_zip** (String) - Conditional - Billing zip code for AVS. Required if `card_type` is "DIGITAL".
- **shipping_address1** (String) - Optional - Primary shipping address. Used if `shipping_address_type` is "U" or "C".
- **shipping_address2** (String) - Optional - Secondary shipping address.
- **shipping_city** (String) - Optional - Shipping city. Used if `shipping_address_type` is "U" or "C".
- **shipping_state** (String) - Optional - Shipping state. Used if `shipping_address_type` is "U" or "C".
- **shipping_zip** (String) - Optional - Shipping zip code. Used if `shipping_address_type` is "U" or "C".

### Request Example
```json
{
	"api_username": "{Unique api username}",
	"api_key": "{Unique api_key}",
	"user_uid": "{Unique id of user}",
	"card_type": "DIGITAL",
	"profile": "Y",
	"spending_profile_uid": "null",
	"spending_limit": "1000",
	"shipping_address1": "123 Main St",
	"shipping_address2": "Apt 4B",
	"shipping_city": "Orlando",
	"shipping_state": "FL",
	"shipping_zip": "32829",
	"billing_address_type": "N",
	"billing_address1": "456 Elm St",
	"billing_address2": "Suite 101",
	"billing_city": "Austin",
	"billing_state": "TX",
	"billing_zip": "73301"
}
```

### Response
#### Success Response (00)
- **message** (String) - Success message.
- **code** (String) - Response code, "00" for success.
- **data** (Object) - Contains card details.
  - **card_number** (String) - Encrypted card number.
  - **card_exp** (String) - Encrypted card expiration date (MM/YY).
  - **card_cvv** (String) - Encrypted card CVV.
  - **card_uid** (String) - Unique ID of the created card.
  - **card_type** (String) - Type of the created card.
  - **profile_flag** (Boolean) - Indicates if the card is a credit card.
  - **spending_profile_uid** (String) - Associated spending profile UID, if any.
  - **spending_limit** (String) - Spending limit of the card.
  - **first_name** (String) - First name of the cardholder.
  - **last_name** (String) - Last name of the cardholder.
  - **address_type** (String) - Type of address used.
  - **address1** (String) - Primary address line.
  - **address2** (String) - Secondary address line.
  - **city** (String) - City of the address.
  - **state** (String) - State of the address.
  - **zip** (String) - Zip code of the address.
  - **created_date** (String) - Date and time the card was created.

#### Response Example
```json
{
  	"message": "Card successfully created.",
 	 "code": "00",
 	 "data": {
		"card_number": "1234 1234 1234 1234",
		"card_exp": "00/00",
		"card_cvv": "111",
		"card_uid": "Unique id of card",
		"card_type": "DIGITAL",
		"profile_flag": true,
		"spending_profile_uid": "null",
		"spending_limit": "1000",
		"first_name": "firstname",
		"last_name": "lastname",
		"address_type": "C",
		"address1": "1234 street example",
		"address2": "apt 123",
		"city": "Austin",
		"state": "TX",
		"zip": "12345",
		"created_date": "0000-00-00 00:00:00"
 	 }
}
```

### Error Handling
- **01**: API Key is missing or invalid.
- **02**: Username is missing or invalid.
- **03**: User uid is missing or invalid.
- **04**: User Type is missing or invalid.
- **07**: First/Last name is missing or invalid.
- **08**: Email is missing or invalid.
- **09**: Email already exists.
```

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

### GET /apis/transactions/report

Source: https://www.merchantservicedepot.com/issuing-api/index

Retrieves transaction details for the last 30 days. Supports filtering by transaction type and date range.

```APIDOC
## GET /apis/transactions/report

### Description
Retrieves transaction details for the last 30 days. Supports filtering by transaction type and date range.

### Method
GET

### Endpoint
https://issuing.merchantservicedepot.com/apis/transactions/report

### Parameters
#### Query Parameters
- **page_no** (INT) - Required - Specified page number (100 records per page).
- **transaction_type** (String) - Optional - Comma-separated string of transaction types (e.g., "Approved", "Declined", "Refund", "Pending", "Reversal").
- **start_date** (Date) - Optional - Start date based on the created date of a user.
- **end_date** (Date) - Optional - End date based on the created date of a user.

### Response
#### Success Response (200)
- **message** (String) - Confirmation message.
- **data** (Object) - Contains transaction data.
  - **current_page** (Integer) - The current page number.
  - **total_pages** (Integer) - The total number of pages available.
  - **transactions** (Array) - An array of transaction objects.
    - **transaction_details** (Object) - Details of a single transaction.
      - **transaction_id** (String) - Unique ID of the transaction.
      - **card_uid** (String) - Unique ID of the card performing the transaction.
      - **card_last_four** (String) - The last four digits of the card number.
      - **amount** (String) - The transaction amount.
      - **status** (String) - The status of the transaction (e.g., "Approved", "Declined").
      - **merchant** (String) - The name of the merchant.
      - **approval_code** (String) - The approval code for the transaction.
      - **transaction_time_gmt** (String) - The transaction time in GMT.
      - **authorization_time_gmt** (String) - The authorization time in GMT.
      - **posted_time_gmt** (String) - The posted time in GMT.
      - **void_time_gmt** (String/null) - The void time in GMT, or null if not voided.

#### Response Example
```json
{
	"message": "Transactions successfully received.",
	"data": {
		"current_page": 1,
		"total_pages": 1,
    	"transactions": [
        	{
            	"transaction_details": {
                		"transaction_id": "{uid of transaction}",
                		"card_uid": "{uid of card performing transaction}",
						"card_last_four": "1234",
                		"amount": "500.00",
                		"status": "Approved",
                    		"merchant": "TCB PAY",
               		 	"approval_code": "011111",
                		"transaction_time_gmt": "2024-01-10 23:59:59",
                		"authorization_time_gmt": "2024-01-10 23:59:59",
                		"posted_time_gmt": "2024-01-10 23:59:59",
                		"void_time_gmt": null
            	}
        	}
    	]
	}
}
```

### Error Handling
- **00**: Success
- **01**: API Key is missing or invalid.
- **02**: Username is missing or invalid.
- **03**: Start date is invalid date format.
- **04**: End date is invalid date format.
- **05**: Transaction type is missing or invalid.
- **06**: Page number is missing or invalid.
- **07**: No transactions on record.
```

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

### List All Users API

Source: https://www.merchantservicedepot.com/issuing-api/index

Retrieves a list of all users in the system.

```APIDOC
## GET /apis/users/list_all

### Description
Retrieve a list of all users in the system.

### Method
GET

### Endpoint
https://issuing.merchantservicedepot.com/apis/users/list_all

### Parameters
#### Query Parameters
- **api_username** (String) - Required - Unique API username associated with the account
- **api_key** (String) - Required - Unique API key associated with the account
- **page_size** (Integer) - Optional - Number of entries per page (default: 100)

### Request Example
GET https://issuing.merchantservicedepot.com/apis/users/list_all?api_username=example_username&api_key=example_key&page_size=50

### Response
#### Success Response (200)
- **users** (Array) - A list of user objects.
  - **user_id** (String) - The ID of the user.
  - **name** (String) - The name of the user.
  - **status** (String) - The current status of the user.

#### Response Example
{
  "users": [
    {
      "user_id": "user123",
      "name": "John Doe",
      "status": "active"
    },
    {
      "user_id": "user456",
      "name": "Jane Smith",
      "status": "inactive"
    }
  ]
}
```
Tokens:
Raw