Overview of the pay by points response object.
Shown below is a sample response of a Create Payments API through payment method as POINTS
.
{
"data": {
"order_id": "v1-240902072711-aa-KAw3iP",
"merchant_order_reference": "9bba427e-18c5-4645-9bd7-0cdb384371d7",
"type": "CHARGE",
"status": "PENDING",
"challenge_url": "https://pluraluat.v2.pinepg.in/web/auth/landing/?token=S50%2BoHJmZ8ftKIhAKv%2BqQws3%2FkfY39tiuaMcSY15i%2BWH%2Bx4N6I%2B7lrNWbcM4Dl72hU6",
"merchant_id": "109968",
"order_amount": {
"value": 5000,
"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": "DD",
"key2": "XOF"
}
},
"payments": [
{
"id": "v1-240902072711-aa-KAw3iP-cc-g",
"status": "PENDING",
"payment_amount": {
"value": 1500,
"currency": "INR"
},
"payment_method": "CARD",
"payment_option": {
"card_data": {
"card_type": "CREDIT",
"network_name": "VISA",
"issuer_name": "NONE",
"card_category": "CONSUMER",
"country_code": "IND",
"token_txn_type": "ALT_TOKEN"
}
},
"acquirer_data": {
"approval_code": "",
"acquirer_reference": "7252620755296724003954",
"rrn": ""
}
},
{
"id": "v1-240902072711-aa-KAw3iP-pt-P",
"status": "PENDING",
"payment_amount": {
"value": 3500,
"currency": "INR"
},
"payment_method": "POINTS",
"acquirer_data": {
"approval_code": "",
"acquirer_reference": "",
"rrn": ""
},
"created_at": "2024-09-02T07:27:11.240154Z",
"updated_at": "2024-09-02T07:27:52.950485Z"
}
],
"created_at": "2024-09-02T07:27:11.240136Z",
"updated_at": "2024-09-02T07:27:52.950481Z"
}
}
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.
82d57572-057c-4826-5775-385a52150554 |
type | string | Payment type. Possible values:
|
status | string | Order status. Possible values:
|
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:
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 order request was received by Plural. Example: 2024-07-09T07:57:08.022056Z |
updated_at | string | The ISO 8601 UTC Timestamp, when the order 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.
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.
[email protected] |
first_name | string | Customer's first name.
Kevin |
last_name | string | Customer's last name.
Bob |
customer_id | string | Unique identifier of the customer in the Plural database.
123456 |
mobile_number | string | Customer's mobile number.
9876543210 |
billing_address | object | An object that contains the details of the billing address. Learn more about our billing_address child object. |
shipping_address | object | An object that contains the shipping address details. Learn more about our 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.
10 Downing Street Westminster London |
address2 | string | Customer's billing address2.
Oxford Street Westminster London |
address3 | string | Customer's billing address3.
Baker Street Westminster London |
pincode | string | Pincode of the billing address.
51524036 |
city | string | City of the billing address.
Westminster |
state | string | State of the billing address.
Westminster |
country | string | Country of the billing address.
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.
10 Downing Street Westminster London |
address2 | string | Customer's shipping address2.
Oxford Street Westminster London |
address3 | string | Customer's shipping address3.
Baker Street Westminster London |
pincode | string | Pincode of the shipping address.
51524036 |
city | string | City of the shipping address.
Westminster |
state | string | State of the shipping address.
Westminster |
country | string | Country of the shipping address.
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.
v1-5206071124-aa-mpLhF3-cc-l |
status | string | Payment status. Possible values:
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 |
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. |
created_at | string | The ISO 8601 UTC Timestamp, when the create payment request was received by Plural. Example: 2024-09-02T07:27:11.240154Z |
updated_at | string | The ISO 8601 UTC Timestamp, when the payment response object is updated. Example: 2024-09-02T07:27:52.950485Z |
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.
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. |
points_card_details | object | An object that contains the point card details. Learn more about our points_card_details child object.Note:
|
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:
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:
|
country_code | string | Card issuers Country. Example: IND |
token_txn_type | string | Transaction token type. Possible values:
ALT_TOKEN |
Points Card Details [Child Object]
The table below lists the various parameters in the points_card_details
child object. This object is part of the payment_option
object.
Parameter | Type | Description |
---|---|---|
registered_mobile_number | string | Point card registered mobile number.
9876543210 Supported characters:
|
card_last4 | string | The last four digits of your card number. Has to be 4 digits. Example: 1234 Supported characters: 0-9 |
card_number | string | Card Number.
123456789012 Supported characters: 0-9 |
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.
100 |
currency | string | Type of currency. Example: INR |