# API Parameters

## amount
- **Type**: integer  
- **Required**: Yes  
- **Description**: Amount (in cents) to authorize. Must be between 0 and 2000000000.

## descriptor
- **Type**: string  
- **Required**: Yes  
- **Description**: Merchant descriptor. Length must be between 1 and 25.

## pan
- **Type**: string  
- **Required**: Yes  
- **Description**: Sixteen digit card number. Must be exactly 16 digits long.

# Responses

## `201 OK`
- **Type**: object  
- **Fields**:  
  - **debugging_request_id**: uuid - A debugging request ID to share with the Lithic Support team.  
  - **token**: uuid - A unique token to reference this transaction.

## `400 Bad Request`
- **Description**: A parameter in the query given in the request does not match the valid queries for the endpoint.

## `401 Unauthorized`
| Error Type                                         | Description  |
|---------------------------------------------------|--------------|
| User has not been authenticated                    | Invalid or missing API key  |
| API key is not active                              | The API key used is no longer active  |
| Could not find API key                             | The API key provided is not associated with any user  |
| Please provide API key in Authorization header      | The Authorization header is not in the request  |
| Please provide API key in the form Authorization: [api-key] | The Authorization header is not formatted properly  |
| Insufficient privileges. Issuing API key required  | Write access requires an Issuing API key. Reach out at [lithic.com/contact](/content/contact/index.html)  |
| Insufficient privileges to create virtual cards.    | Creating virtual cards requires an additional privilege  |

## `429 Too Many Requests`
| Error Type                                         | Description |
|---------------------------------------------------|-------------|
| Rate limited, too many requests per second         | User has exceeded their per second rate limit  |
| Rate limited, reached daily limit                   | User has exceeded their daily rate limit  |
| Rate limited, too many keys tried                   | One IP has queried too many different API keys  |

# Example Request

```shell
curl --request POST \
     --url https://sandbox.lithic.com/v1/simulate/return \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '  
{  
  "amount": 3831,  
  "descriptor": "COFFEE SHOP",  
  "pan": "4111111289144142"  
}  
'  
```

# Example Response

```json
{  
  "debugging_request_id": "d31645af-da9e-4952-b7dc-3ffb06618b39",  
  "token": "fabd829d-7f7b-4432-a8f2-07ea4889aaac"  
}
```
