This method is used to reject a refund which is in draft state.
Resource URL
Parameters
Name | Type | Description |
token | String | The token retrieved from the login method |
| refund_identifier (mandatory) | Refund identifier | The identifier of the refund that should be returned as a result. The allowed refund identifier fields are the following: Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the refund | number (semi-optional) | String | The number of the refund | reference_number (semi-optional) | String | The reference number of the refund | back_office_code (semi-optional) | String | The back office code of the refund |
|
rejection_reason_identifier (optional) | Rejection reason identifier | The reason that the refund is rejected. The allowed rejection reason identifier fields are the following: Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the rejection reason | name (semi-optional) | String | The name of the rejection reason | alternative_code (semi-optional) | String | The alternative code of the rejection reason |
|
fields_set (optional) | List of Strings, comma separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned |
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
refund object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved refund |
number | String | The number of the retrieved refund |
reference_number | String | The reference number of the retrieved refund |
life_cycle_state | String | The life cycle state of the refund. One of the following values is returned: DRAFT, REJECTED, POSTED, CANCELLED |
| issued_on | Date | The date that the refund was issued |
| posted_on | Date | The date that the refund was posted |
| refund_amount | Number | The amount that was refunded |
| currency_rate_period | Currency Rate Period | The currency rate period based on which the refund was created |
Referred Objects Response Data
currency rate period object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved currency rate period |
| rate | Number | The exchange rate of the currency rate period |
| inverse_rate | Number | The inverse exchange rate of the currency rate period |
| from_date | Date | The date from which the exchange rate is valid |
| to_date | Date | The date until which the exchange rate is valid |
| currency | Currency Object | The Currency with which the returned exchange rate information refers to |
Referred Objects Response Data
currency object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved currency |
| code | String | The code of the retrieved currency |
| prefix_symbol | String | The prefix symbol for the specified currency |
suffix_symbol | String | The suffix symbol for the specified currency |
| life_cycle_state | String | The life cycle state for the specified currency, which can be EFFECTIVE or NOT EFFECTIVE |
| integer_part_name | String | The integer part name for the specified currency |
| decimal_part_name | String | The decimal part name for the specified currency |
Examples
Example 1
HTTP Method: POST
Request:
Body:
{
"token": "E78968BE92E02C3FCCD2D671B9772EF9",
"refund_identifier":{"reference_number":"29"},
"rejection_reason_identifier":{"name":"Reject Due to Business Request"},
}
Response:
{
"status":
{
"message": null,
"description": null,
"code": "OK"
},
"data":
{
"issued_on": "2014-07-15T16:01:24",
"life_cycle_state": "REJECTED",
"number": null,
"id": "0FAE4317E8E46BC90490E7A031CE723A",
"reference_number": "29",
"posted_on": null,
"refund_amount": 150
}
}