Payments Object

Shown below is a sample responses of a Create Payments API.

{
  "data": {
    "order_id": "v1-5206071124-aa-mpLhF3",
    "merchant_order_reference": "0342ef1e-4606-4c11-8640-705f4d415b6d",
    "type": "CHARGE",
    "status": "PROCESSED",
    "challenge_url": "https://api.pluralpay.in/web/auth/landing/?token=S50xnInJvpcftOzmuGWUqnLpIe694YPGJiKL%2FdBh5Yl%2Bwb8giJrl6HoTvcKljRVZa3H",
    "merchant_id": "104359",
    "order_amount": {
      "value": 1000,
      "currency": "INR"
    },
    "pre_auth": false,
    "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": "value1",
        "key2": "value2"
      }
    },
    "payments": [
      {
        "id": "v1-5206071124-aa-mpLhF3-cc-l",
        "status": "PROCESSED",
        "payment_amount": {
          "value": 1000,
          "currency": "INR"
        },
        "payment_method": "CARD",
        "payment_option": {
          "card_data": {
            "card_type": "CREDIT",
            "network_name": "MASTERCARD",
            "issuer_name": "HDFC",
            "card_category": "NONE",
            "country_code": "IND",
            "token_txn_type": "ALT_TOKEN"
          }
        },
        "acquirer_data": {
          "approval_code": "030376",
          "acquirer_reference": "202455840588334",
          "rrn": "419335023601"
        },
        "capture_data": []
      }
    ],
    "created_at": "2024-07-11T06:52:12.484105Z",
    "updated_at": "2024-07-11T06:59:38.260145Z"
  }
}

The table below lists the various parameters returned in the payments response object.

Parameter	Type	Description
order_id	`string`	Unique identifier of the order in the Plural database. Example: `v1-5757575757-aa-hU1rUd`
merchant_order_reference	`string`	Unique identifier entered while creating a order. 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 payment request. `PROCESSED`: When the payment is received successfully. `AUTHORIZED`: Only when `pre_auth` is `true`. When the payment is ready for authorization. `CANCELLED`: When the payment gets cancelled. `ATTEMPTED`: When the payment is unsuccessful due to incorrect OTP. You can retry OTP verification until the payment gets failed. `FAILED`: Payment acceptance failed for reasons such as cancel transactions, maximum retries for OTP verification etc. `FULLY_REFUNDED`: When the payment is completely refunded. `PARTIALLY_REFUNDED`: When the partial refund is successful.
challenge_url	`string`	Use the generated `challenge_url` URL to navigate your users the checkout page.
merchant_id	`string`	Unique identifier of the merchant in Plural database. Example: `123456`
order_amount	`object`	An object that contains the transaction amount details. Learn more about our `order_amount` child object.
pre_auth	`boolean`	The pre-authorization type. Possible values: `true`: When pre-authorization is needed. `false`: When pre-authorization is not required. Example: `false` Learn more about our pre-authorization..
purchase_details	`object`	An object that contains the purchase details. Learn more about our `purchase_details` child object. Note: The presence of the key-values pairs in this object depends on the Input request.
payments	`array of objects`	An array of object that contains the payment details. Learn more about our `payments` child object. Note: Payments response object can vary based on the payment methods and payment status.
created_at	`string`	The ISO 8601 UTC Timestamp, when the create payment request was received by Plural. Example: `2024-07-09T07:57:08.022056Z`
updated_at	`string`	The ISO 8601 UTC Timestamp, when the payment response object is updated. Example: `2024-07-09T07:57:08.022065Z`

Order Amount [Child Object]

The table below lists the various parameters in the order_amount child object. This object is part of the payments sample response 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`

Purchase Details [Child Object]

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

Parameter	Type	Description
customer	`Object`	An object that contains the customer details. Learn more about our `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 character. 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: 9 character. Maximum length: 20 characters. Example: `9876543210`
billing_address	`object`	An object that contains the details of the billing address. Learn more about our `customer` child object.
shipping_address	`object`	An object that contains the shipping address details. Learn more about our `customer` 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. Maximum length: 10 characters. Example: `51524036`
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. Maximum length: 10 characters. Example: `51524036`
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`
payment_option	`object`	An object that contains the details of the payment options. Learn more about our `payment_option` child object.
acquirer_data	`object`	An object that contains the details of the acquirer data. Learn more about our `acquirer_data` child object.
error_detail	`object`	An object that contains the error details. Learn more about our `error_detail` child object. Note: This object is returned only for the failed payment.
capture_data	`object`	An object that contains the details of the capture data. Learn more about our `capture_data` child object. Note: The presence of the key-value pairs against this object depends on the pre-authorization type.

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`

Payment Option [Child Object]

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

Parameter	Type	Description
card_data	`object`	An object that contains the card details. Learn more about our `card_data` child object.

Card Data [Child Object]

The table below lists the various parameters in the card_data child object. This object is part of the payment_option object.

Parameter	Type	Description
card_type	`string`	Type of card. Possible values: `DEBIT` `CREDIT` Example: `CREDIT`
network_name	`string`	Card network providers. Example: `VISA`
issuer_name	`string`	Card issuer entity. Example: `HDFC`
product_name	`string`	Card name. Example: `Visa Platinum`
card_category	`string`	The card category type. Possible values: `CONSUMER` `COMMERCIAL` `PREMIUM` `SUPER_PREMIUM` `PLATINUM` `OTHER` `BUSINESS` `GOVERNMENT_NOTES` `PAYOUTS` `ELITE` `STANDARD`
country_code	`string`	Card issuers Country. Example: `IND`
token_txn_type	`string`	Transaction token type. Possible values: `ALT_TOKEN` `NETWORK_TOKEN` `ISSUER_TOKEN` Example: `ALT_TOKEN`

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. Example: `030376`
acquirer_reference	`string`	Unique reference returned from acquirer for the payment. Example: `202455840588334`
rrn	`string`	Retrieval reference number returned from acquirer for the payment. Example: `419335023601`

Error Detail [Child Object]

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

Parameter	Type	Description
code	`string`	The error short Code. Example: `PAYMENT_DECLINED`
message	`string`	Error description explaining the why the error occured. Example: `Transaction declined due to insufficient balance`

Capture Data [Child Object]

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

Parameter	Type	Description
merchant_capture_reference	`string`	Unique identifier passed while creating the capture payment request. Example: `5742ef1e-4606-4c11-5757-705f4d415b6d`
capture_amount	`object`	An object that contains the capture amount details. Learn more about our `capture_amount` child object.
created_at	`string`	The ISO 8601 UTC Timestamp, when the amount captured. Example: `2024-07-11T11:52:12.484105Z`

Capture Amount [Child Object]

The table below lists the various parameters in the capture_amount child object. This object is part of the capture_data 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`

Refund Object

Overview of the refunds response object.

Shown below is a sample responses of a Create Refund API.

{
  "data": {
    "order_id": "v1-5757575757-aa-hU1rUd",
    "refunds": [
      {
        "merchant_refund_reference": "23242324232423",
        "refund_id": "v1-3314042524-ga-0Y129h",
        "status": "PROCESSED",
        "merchant_id": "123456",
        "refund_amount": {
          "value": 1100,
          "currency": "INR"
        },
        "created_at": "2024-04-30T08:01:32Z",
        "updated_at": "2024-04-30T08:01:32Z"
      }
    ]
  }
}

The table below lists the various parameters returned in the refund response object.

Parameter	Type	Description
order_id	`string`	Unique identifier of the order in the Plural database. Example: `v1-5757575757-aa-hU1rUd`
refunds	`object`	An object that contains the refund details. Learn more about our `refunds` child object.

Refunds [Child Object]

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

Parameter	Type	Description
merchant_refund_reference	`string`	Merchant unique identifier for the refund reference. Maximum length: 50 characters. Minimum length: 1 characters. Example: `23242324232423`
refund_id	`string`	Unique identifier of the refund in the Plural database. Example: `v1-3314042524-ga-0Y129h`
status	`string`	Refund statuses. Possible values: `CREATED`: When the refund is successfully created. `PENDING`: We have processed the refund and waiting for the response from the acquirer. `PROCESSED`: When the refund is successful. `FAILED`: When the refund gets failed this could be for many reasons such refund time expiry etc.
merchant_id	`string`	Unique identifier of the merchant in the Plural database. Example: `123456`
refund_amount	`object`	An object that contains the refund amount details. Learn more about our `refund_amount` child object.
created_at	`string`	Unix timestamp when the create refund request was received by Plural. Example: `2024-07-09T07:57:08.022056Z`
updated_at	`string`	Unix timestamp when the refund response object is updated. Example: `2024-07-09T07:57:08.022065Z`

Refund Amount [Child Object]

The table below lists the various parameters in the refund_amount child object. This object is part of the refunds object.

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