Sign in

v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Return Transaction

Lets you submit a return transaction of any transaction type.

post/add

Request body

transaction typestring

The type of transaction.

countrystring

The country in which the transaction took place.

numberstring

The unique identifier for the transaction.

not_interested_reasonstring

The reason provided for the return transaction.

return_typestring

The type of return.

parent_bill_numberstring

The original bill number associated with the transaction.

purchase_timestring

The date of the original purchase.

amountstring

The amount associated with the return.

billing_timestring

The time the bill was issued.

customer mobilestring

The mobile number of the customer.

customer emailstring

The email address of the customer.

customer external_idstring

An external identifier for the customer.

customer firstnamestring

The customer's first name.

customer lastnamestring

The customer's last name.

line_item serialstring

The serial number of the item.

line_item amountstring

The amount for the line item.

line_item descriptionstring

The description of the line item.

line_item item_codestring

The unique code associated with the line item.

line_item qtystring

The quantity of the line item.

line_item ratestring

The rate of the line item.

line_item valuestring

The value of the line item.

line_item attribute namestring

The attribute name of the line item.

line_item attribute valuestring

The attribute value of the line item.

custom_data_item field_namestring

The custom field name.

custom_data_item field_valuestring

The value associated with the custom field.

idinteger

Transaction ID of the transaction that needs to be returned.

Response

200

OR

Example response

{
  "response": {
    "status": {
      "success": "true",
      "code": 200,
      "message": "Success"
    }
  }
}