ikan Uploader :
Directory : /home/ni05r7l36tus/www/poojajewellersbbsr.com/src/documents/
Upload File : |
| Current File : //home/ni05r7l36tus/www/poojajewellersbbsr.com/src/documents/refund.md |
## Refunds
### Create a normal refund
```php
$api->payment->fetch($paymentId)->refund(array("amount"=> "100", "speed"=>"normal", "notes"=>array("notes_key_1"=>"Beam me up Scotty.", "notes_key_2"=>"Engage"), "receipt"=>"Receipt No. 31"));
```
**Parameters:**
| Name | Type | Description |
|---------------|-------------|---------------------------------------------|
| paymentId* | string | The id of the payment |
| amount | integer | The amount to be captured (should be equal to the authorized amount, in paise) | |
| speed | string | Here, it must be normal |
| notes | array | A key-value pair |
| receipt | string | A unique identifier provided by you for your internal reference. |
**Response:**
```json
{
"id": "rfnd_FP8QHiV938haTz",
"entity": "refund",
"amount": 500100,
"receipt": "Receipt No. 31",
"currency": "INR",
"payment_id": "pay_FCXKPFtYfPXJPy",
"notes": [],
"acquirer_data": {
"arn": null
},
"created_at": 1597078866,
"batch_id": null,
"status": "processed",
"speed_processed": "normal",
"speed_requested": "normal"
}
```
-------------------------------------------------------------------------------------------------------
### Create an instant refund
```php
$api->payment->fetch($paymentId)->refund(array("amount"=> "100","speed"=>"optimum","receipt"=>"Receipt No. 31"));
```
**Parameters:**
| Name | Type | Description |
|---------------|-------------|---------------------------------------------|
| paymentId* | string | The id of the payment |
| amount | integer | The amount to be captured (should be equal to the authorized amount, in paise) |
| speed* | string | Here, it must be optimum |
| receipt | string | A unique identifier provided by you for your internal reference. |
**Response:**
```json
{
"id": "rfnd_FP8R8EGjGbPkVb",
"entity": "refund",
"amount": 500100,
"currency": "INR",
"payment_id": "pay_FC8MmhMBZPKDHF",
"notes": {
"notes_key_1": "Tea, Earl Grey, Hot",
"notes_key_2": "Tea, Earl Grey… decaf."
},
"receipt": "Receipt No. 31",
"acquirer_data": {
"arn": null
},
"created_at": 1597078914,
"batch_id": null,
"status": "processed",
"speed_requested": "optimum"
}
```
-------------------------------------------------------------------------------------------------------
### Fetch multiple refunds for a payment
```php
$api->payment->fetch($paymentId)->fetchMultipleRefund($option);
```
**Parameters:**
| Name | Type | Description |
|-------|-----------|--------------------------------------------------|
| paymentId* | string | The id of the payment |
| from | timestamp | timestamp after which the payments were created |
| to | timestamp | timestamp before which the payments were created |
| count | integer | number of payments to fetch (default: 10) |
| skip | integer | number of payments to be skipped (default: 0) |
**Refund:**
```json
{
"entity": "collection",
"count": 1,
"items": [
{
"id": "rfnd_FP8DDKxqJif6ca",
"entity": "refund",
"amount": 300100,
"currency": "INR",
"payment_id": "pay_FIKOnlyii5QGNx",
"notes": {
"comment": "Comment for refund"
},
"receipt": null,
"acquirer_data": {
"arn": "10000000000000"
},
"created_at": 1597078124,
"batch_id": null,
"status": "processed",
"speed_processed": "normal",
"speed_requested": "optimum"
}
]
}
```
-------------------------------------------------------------------------------------------------------
### Fetch a specific refund for a payment
```php
$api->payment->fetch($paymentId)->fetchRefund($refundId);
```
**Parameters:**
| Name | Type | Description |
|---------------|-------------|---------------------------------------------|
| paymentId* | string | The id of the payment to be fetched |
| refundId* | string | The id of the refund to be fetched |
**Response:**
```json
{
"id": "rfnd_FP8DDKxqJif6ca",
"entity": "refund",
"amount": 300100,
"currency": "INR",
"payment_id": "pay_FIKOnlyii5QGNx",
"notes": {
"comment": "Comment for refund"
},
"receipt": null,
"acquirer_data": {
"arn": "10000000000000"
},
"created_at": 1597078124,
"batch_id": null,
"status": "processed",
"speed_processed": "normal",
"speed_requested": "optimum"
}
```
-------------------------------------------------------------------------------------------------------
### Fetch all refunds
```php
$options = array("count" => 2);
$api->refund->all($options);
```
**Parameters:**
| Name | Type | Description |
|-------|-----------|--------------------------------------------------|
| from | timestamp | timestamp after which the payments were created |
| to | timestamp | timestamp before which the payments were created |
| count | integer | number of payments to fetch (default: 10) |
| skip | integer | number of payments to be skipped (default: 0) |
**Response:**
```json
{
"entity": "collection",
"count": 2,
"items": [
{
"id": "rfnd_FFX6AnnIN3puqW",
"entity": "refund",
"amount": 88800,
"currency": "INR",
"payment_id": "pay_FFX5FdEYx8jPwA",
"notes": {
"comment": "Issuing an instant refund"
},
"receipt": null,
"acquirer_data": {},
"created_at": 1594982363,
"batch_id": null,
"status": "processed",
"speed_processed": "optimum",
"speed_requested": "optimum"
}
]
}
```
-------------------------------------------------------------------------------------------------------
### Fetch particular refund
```php
$api->refund->fetch($refundId);
```
**Parameters:**
| Name | Type | Description |
|---------------|-------------|---------------------------------------------|
| refundId* | string | The id of the refund to be fetched |
**Response:**
```json
{
"id": "rfnd_EqWThTE7dd7utf",
"entity": "refund",
"amount": 6000,
"currency": "INR",
"payment_id": "pay_EpkFDYRirena0f",
"notes": {
"comment": "Issuing an instant refund"
},
"receipt": null,
"acquirer_data": {
"arn": "10000000000000"
},
"created_at": 1589521675,
"batch_id": null,
"status": "processed",
"speed_processed": "optimum",
"speed_requested": "optimum"
}
```
-------------------------------------------------------------------------------------------------------
### Update the refund
```php
$api->refund->fetch($refundId)->edit(array('notes'=> array('notes_key_1'=>'Beam me up Scotty.', 'notes_key_2'=>'Engage')));
```
**Parameters:**
| Name | Type | Description |
|-------|-----------|--------------------------------------------------|
| refundId* | string | The id of the refund to be fetched |
| notes* | array | A key-value pair |
**Response:**
```json
{
"id": "rfnd_FP8DDKxqJif6ca",
"entity": "refund",
"amount": 300100,
"currency": "INR",
"payment_id": "pay_FIKOnlyii5QGNx",
"notes": {
"notes_key_1": "Beam me up Scotty.",
"notes_key_2": "Engage"
},
"receipt": null,
"acquirer_data": {
"arn": "10000000000000"
},
"created_at": 1597078124,
"batch_id": null,
"status": "processed",
"speed_processed": "normal",
"speed_requested": "optimum"
}
```
-------------------------------------------------------------------------------------------------------
**PN: * indicates mandatory fields**
<br>
<br>
**For reference click [here](https://razorpay.com/docs/api/refunds/)**
........