File "document.md"
Full Path: /var/www/laravel_filter/vendor/razorpay/razorpay/documents/document.md
File size: 1.82 KB
MIME-type: text/plain
Charset: utf-8
## Document
### Create a Document
```php
$payload = array(
'file'=> '/Users/your_name/Downloads/sample_uploaded.pdf'
"purpose" => "dispute_evidence"
);
$api->document->create($payload);
```
**Parameters:**
| Name | Type | Description |
|-------|-----------|--------------------------------------------------|
| file* | string | The URL generated once the business proof document is uploaded. |
| purpose | string | Possible value is `dispute_evidence` |
**Response:**
```json
{
"id": "doc_EsyWjHrfzb59Re",
"entity": "document",
"purpose": "dispute_evidence",
"name": "doc_19_12_2020.jpg",
"mime_type": "image/png",
"size": 2863,
"created_at": 1590604200
}
```
-------------------------------------------------------------------------------------------------------
### Fetch Document Information
```php
$documentId = "";
$api->document->fetch($documentId);
```
**Parameters:**
| Name | Type | Description |
|-------|-----------|--------------------------------------------------|
| from | timestamp | timestamp after which the addons were created |
| to | timestamp | timestamp before which the addons were created |
| count | integer | number of addons to fetch (default: 10) |
| skip | integer | number of addons to be skipped (default: 0) |
**Response:**
```json
{
"entity": "document",
"id": "doc_00000000000000",
"purpose": "dispute_evidence",
"created_at": 1701701378,
"mime_type": "application/pdf",
"display_name": "ppm_00000000000000",
"size": 404678,
"url": ""
}
```
-------------------------------------------------------------------------------------------------------
**PN: * indicates mandatory fields**
<br>
<br>
**For reference click [here](https://razorpay.com/docs/api/documents)**