Object

Shown below is a sample response returned through our Refund API.

{
  "data": {
    "order_id": "v1-241010071949-aa-vcqtJY",
    "parent_order_id": "v1-241010055924-aa-AHbN0s",
    "merchant_order_reference": "e436fefa-f0e9-4b36-ac01-3d158c31726c",
    "type": "REFUND",
    "status": "PROCESSED",
    "merchant_id": "108272",
    "order_amount": {
      "value": 400,
      "currency": "INR"
    },
    "purchase_details": {
      "customer": {
        "email_id": "[email protected]",
        "first_name": "Kevin",
        "last_name": "Bob",
        "customer_id": "123456",
        "mobile_number": "9876543210",
        "billing_address": {
          "address1": "10 Downing Street Westminster London",
          "address2": "Oxford Street Westminster London",
          "address3": "Baker Street Westminster London",
          "pincode": "51524036",
          "city": "Westminster",
          "state": "Westminster",
          "country": "London"
        },
        "shipping_address": {
          "address1": "10 Downing Street Westminster London",
          "address2": "Oxford Street Westminster London",
          "address3": "Baker Street Westminster London",
          "pincode": "51524036",
          "city": "Westminster",
          "state": "Westminster",
          "country": "London"
        }
      },
      "merchant_metadata": {
        "key1": "XX",
        "key2": "DOF"
      }
    },
    "payments": [
      {
        "id": "v1-241010071949-aa-vcqtJY-cc-b",
        "status": "PROCESSED",
        "payment_amount": {
          "value": 400,
          "currency": "INR"
        },
        "payment_method": "CARD",
        "acquirer_data": {
          "approval_code": "",
          "acquirer_reference": "7285447904236780703954",
          "rrn": "",
          "is_aggregator": true
        },
        "created_at": "2024-10-10T07:19:49.423Z",
        "updated_at": "2024-10-10T07:19:51.205Z"
      }
    ],
    "created_at": "2024-10-10T07:19:49.424Z",
    "updated_at": "2024-10-10T07:19:51.205Z"
  }
}

The table below lists the various parameters returned in the orders response objects.

Parameter	Type	Description
order_id	`string`	Unique identifier of the order in the Plural database. Maximum length: 50 characters. Example: `v1-5757575757-aa-hU1rUd`
parent_order_id	`string`	Unique identifier of the parent order in the Plural database. Maximum length: 50 characters. Example: `v1-5757575757-aa-hU1rUd`
merchant_order_reference	`string`	Unique identifier entered while creating a refund. Minimum length: 1 character. Maximum length: 50 characters. Example: `82d57572-057c-4826-5775-385a52150554`
type	`string`	Payment type. Possible values: `CHARGE` `REFUND`
status	`string`	Order status. Possible values: `CREATED`: When the order is successfully created. `PENDING`: When the order is linked against a refund request. `PROCESSED`: When the refund is received successfully. `FAILED`: Refund acceptance failed for reasons such as cancel transactions, maximum retries for OTP verification etc.
merchant_id	`string`	Unique identifier of the merchant in the Plural database. Example: `123456`
order_amount	`object`	An object that contains the transaction amount details. Learn more about the `order_amount` child object.
purchase_details	`object`	An object that contains the purchase details. Learn more about the `purchase_details` child object. Note: The presence of the object key-values depends on the Input request.
payments	`array of objects`	An array of objects that contains the payment details. Learn more about the `payments` child object. Note: Payment object is returned only for the orders linked with a payment.
created_at	`string`	The ISO 8601 UTC Timestamp, when the create refund request was received by Plural. Example: `2024-07-09T07:57:08.022Z`
updated_at	`string`	The ISO 8601 UTC Timestamp, when the refund object is updated. Example: `2024-07-09T07:57:08.022Z`

Order Amount [Child Object]

The table below lists the various parameters in the order_amount child object. This object is part of the orders sample response object.

Parameter	Type	Description
value	`integer`	Transaction amount is Paisa. Minimum value: `100` (₹1) Maximum value: `100000000` (₹10 lakh). Example: `1000`
currency	`string`	Type of currency. Example: `INR`

Purchase Details [Child Object]

The table below lists the various parameters in the purchase_details child object. This object is part of the orders sample response object.

Parameter	Type	Description
customer	`Object`	An object that contains the customer details. Learn more about the `customer` child object.
merchant_metadata	`object`	An object of key-value pair that can be used to store additional information. Example: `"key1": "DD"`

Customer [Child Object]

The table below lists the various parameters in the customer child object. This is part of the purchase_details object.

Parameter	Type	Description
email_id	`string`	Customer's email address. Minimum length: 1 character. Maximum length: 50 characters. Example: `[email protected]`
first_name	`string`	Customer's first name. Minimum length: 1 character. Maximum length: 50 characters. Example: `Kevin`
last_name	`string`	Customer's last name. Minimum length: 1 character. Maximum length: 50 characters. Example: `Bob`
customer_id	`string`	Unique identifier of the customer in the Plural database. Minimum length: 1 character. Maximum length: 19 characters. Example: `123456`
mobile_number	`string`	Customer's mobile number. Minimum length: `10` character. Maximum length: `20` characters. Example: `9876543210` Supported characters: `0-9`
billing_address	`object`	An object that contains the details of the billing address. Learn more about the `billing_address` child object.
shipping_address	`object`	An object that contains the shipping address details. Learn more about the `shipping_address` child object.

Billing Address [Child Object]

The table below lists the various parameters in the billing_address child object. This is part of the customer object.

Parameter	Type	Description
address1	`string`	Customer's billing address1. Maximum length: 100 characters. Example: `10 Downing Street Westminster London`
address2	`string`	Customer's billing address2. Maximum length: 100 characters. Example: `Oxford Street Westminster London`
address3	`string`	Customer's billing address3. Maximum length: 100 characters. Example: `Baker Street Westminster London`
pincode	`string`	Pincode of the billing address. Minimum length: 6 characters. Maximum length: 10 characters. Example: `51524036` Supported characters: `0-9`
city	`string`	City of the billing address. Maximum length: 50 characters. Example: `Westminster`
state	`string`	State of the billing address. Maximum length: 50 characters. Example: `Westminster`
country	`string`	Country of the billing address. Maximum length: 50 characters. Example: `London`

Shipping Address [Child Object]

The table below lists the various parameters in the shipping_address child object. This is part of the customer object.

Parameter	Type	Description
address1	`string`	Customer's shipping address1. Maximum length: 100 characters. Example: `10 Downing Street Westminster London`
address2	`string`	Customer's shipping address2. Maximum length: 100 characters. Example: `Oxford Street Westminster London`
address3	`string`	Customer's shipping address3. Maximum length: 100 characters. Example: `Baker Street Westminster London`
pincode	`string`	Pincode of the shipping address. Minimum length: 6 characters. Maximum length: 10 characters. Example: `51524036` Supported characters: `0-9`
city	`string`	City of the shipping address. Maximum length: 50 characters. Example: `Westminster`
state	`string`	State of the shipping address. Maximum length: 50 characters. Example: `Westminster`
country	`string`	Country of the shipping address. Maximum length: 50 characters. Example: `London`

Payments [Child Object]

The table below lists the various parameters in the payments child object. This object is part of the payments sample response object.

Parameter	Type	Description
id	`string`	Unique identifier of the payment in the Plural database. Maximum length: 50 characters. Example: `v1-5206071124-aa-mpLhF3-cc-l`
status	`string`	Payment status. Possible values: `PENDING`: When the create payment API request is successfully received by Plural. `AUTHORIZED`: Only when `pre_auth` is `true`. When the payment is ready for authorization. `CANCELLED`: When the payment gets cancelled. `PROCESSED`: When the payment is successfully received by Plural. `FAILED`: When the payment fails, this can be for many reasons such as canceling payments, etc. Example: `PENDING`
payment_amount	`object`	An object that contains the details of the payment amount. Learn more about our `payment_amount` child object.
payment_method	`string`	Type of payment method. Accepted values: `CARD` `UPI` `POINTS` Example: `CARD`
acquirer_data	`object`	An object that contains the details of the acquirer data. Learn more about our `acquirer_data` child object.
created_at	`string`	The ISO 8601 UTC Timestamp, when the create payment request was received by Plural. Example: `2024-07-09T07:57:08.022Z`
updated_at	`string`	The ISO 8601 UTC Timestamp, when the payment object is updated. Example: `2024-07-09T07:57:08.022Z`

Payment Amount [Child Object]

The table below lists the various parameters in the payment_amount child object. This object is part of the payments object.

Parameter	Type	Description
value	`integer`	The transaction amount is Paisa. Minimum value: `100` (₹1). Maximum value: `100000000` (₹10 lakh). Example: `100`
currency	`string`	Type of currency. Example: `INR`

Acquirer Data [Child Object]

The table below lists the various parameters in the acquirer_data child object. This object is part of the payments object.

Parameter	Type	Description
approval_code	`string`	Authorization code returned from acquirer against the payment. Maximum length: 50 characters. Example: `030376`
acquirer_reference	`string`	Unique reference returned from acquirer for the payment. Maximum length: 50 characters. Example: `202455840588334`
rrn	`string`	Retrieval reference number returned from acquirer for the payment. Maximum length: 50 characters. Example: `419335023601`
is_aggregator	`boolean`	The selected aggregator model type. Accepted values: `true`: Plural is responsible for settling funds related to this payment. `false`: Plural is not responsible for settling funds related to this payment. Note: When the `is_aggregator` is set to true, Plural acts as the acquirer on behalf of merchants, receiving funds from banks into a designated "Nodal Account". When the `is_aggregator` is set to false, the Merchant has a direct relationship with the bank and the responsibility for settlement of funds lies with both of those parties.