Object

Overview of the authorize payment response object.

Shown below is a sample response returned through our Authorize Payment API.

{
  "data": {
    "order_id": "v1-251012055723-aa-Vhv53a",
    "merchant_order_reference": "3fb59787-c38b-4986-87da-39be0a585fae",
    "type": "CHARGE",
    "status": "PROCESSED",
    "callback_url": "https://simple-callback.onrender.com/payment/callback",
    "failure_callback_url": "",
    "merchant_id": "106974",
    "order_amount": {
      "value": 10000,
      "currency": "INR"
    },
    "pre_auth": false,
    "part_payment": false,
    "allowed_payment_methods": [
      "CARD",
      "WALLET"
    ],
    "purchase_details": {
      "customer": {
        "email_id": "[email protected]",
        "first_name": "joe",
        "last_name": "kumar",
        "mobile_number": "192192883",
        "country_code": "91",
        "billing_address": {
          "address1": "H.No 15, Sector 17",
          "pincode": "61232112",
          "city": "CHANDIGARH",
          "state": "PUNJAB",
          "country": "INDIA"
        },
        "shipping_address": {
          "address1": "H.No 15, Sector 17",
          "address2": "string",
          "address3": "string",
          "pincode": "144001123",
          "city": "CHANDIGARH",
          "state": "PUNJAB",
          "country": "INDIA"
        },
        "is_edit_customer_details_allowed": false
      },
      "merchant_metadata": {}
    },
    "payments": [
      {
        "id": "v1-251012055723-aa-Vhv53a-wa-a",
        "merchant_payment_reference": "def750b1-1c14-48fa-ad6e-98d42bdd7fba",
        "status": "PROCESSED",
        "payment_amount": {
          "value": 10000,
          "currency": "INR"
        },
        "payment_method": "WALLET",
        "payment_option": {
          "wallet_data": {
            "wallet_code": "APPLE_PAY",
            "wallet_card_data": {
              "card_type": "CREDIT",
              "network_name": "VISA",
              "issuer_name": "INTL HDQTRS-CENTER OWNED",
              "card_category": "Consumer",
              "country_code": "IND",
              "token_txn_type": "NETWORK_TOKEN",
              "save": false,
              "card_holder_name": "INDRANI DUTTA",
              "bin_min": "4386371130",
              "bin_max": "4386371139"
            }
          }
        },
        "acquirer_data": {
          "approval_code": "831000",
          "acquirer_reference": "19487181",
          "rrn": "515511988482",
          "is_aggregator": true,
          "acquirer_name": "Cyber_Source_AXIS"
        },
        "created_at": "2025-06-04T11:00:56.591Z",
        "updated_at": "2025-06-04T11:01:26.656Z"
      }
    ],
    "created_at": "2025-06-04T11:00:51.067Z",
    "updated_at": "2025-06-04T11:01:26.656Z",
    "integration_mode": "SEAMLESS"
  }
}

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

ParameterTypeDescription
order_idstringUnique identifier of the order in the Pine Labs Online database.

Example: v1-5757575757-aa-hU1rUd
merchant_order_referencestringUnique identifier entered while creating a order.
  • Minimum length: 1 character.
  • Maximum length: 50 characters.
Example: 82d57572-057c-4826-5775-385a52150554
typestringPayment type.

Possible values:
  • CHARGE
  • REFUND
statusstringOrder 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.
merchant_idstringUnique identifier of the merchant in Pine Labs Online database.

Example: 123456
order_amountobjectAn object that contains the transaction amount details.

Learn more about our order_amount child object.
pre_authbooleanThe 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..
allowed_payment_methodsarray of stringsThe type of payment methods you want to offer your customers to accept payments.

Accepted values:
  • CARD
  • UPI
  • POINTS
  • NETBANKING
  • WALLET
Example: CARD

Note: Before selecting a payment method, ensure it is configured for you.
notesstringThe note you want to show against an order.

Example: Order1
callback_urlstringUse this URL to redirect your customers to specific success or failure pages based on the order or product details.

Example: https://sample-callback-url
failure_callback_urlstringThe URL specifically used to redirect customers to a failure page based on the order or product details.

Example: https://sample-failure-callback-url

Note:
  • If the failure_callback_url is not provided, customers will be redirected to the callback_url for both successful and failed transactions.
  • If the failure_callback_url is provided, the callback_url will be used exclusively for successful transactions, while the failure_callback_url will be used for failed transactions.
  • If neither URL is provided, the default URL configured during merchant onboarding will be used.
part_paymentbooleanIndicates whether the transaction is processed as a part payment or for the full amount.

Possible values:
  • true: The transaction is processed as a part payment.
  • false: The transaction is processed for the full payment.
purchase_detailsobjectAn 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.
paymentsarray of objectsAn 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_atstringThe ISO 8601 UTC Timestamp, when the create order request was received by Pine Labs Online.

Example: 2024-07-09T07:57:08.022Z
updated_atstringThe ISO 8601 UTC Timestamp, when the order response 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 payments sample response object.

ParameterTypeDescription
valueintegerThe transaction amount is Paisa.
  • Minimum value: 100 (₹1)
  • Maximum value: 100000000 (₹10 lakh).
Example: 100
currencystringType 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.

ParameterTypeDescription
customerObjectAn object that contains the customer details.

Learn more about our customer child object.
merchant_metadataobjectAn 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.

ParameterTypeDescription
email_idstringCustomer's email address.
  • Minimum length: 1 character.
  • Maximum length: 50 character.
Example: [email protected]
first_namestringCustomer's first name.
  • Minimum length: 1 character.
  • Maximum length: 50 characters.
Example: Kevin
last_namestringCustomer's last name.
  • Minimum length: 1 character.
  • Maximum length: 50 characters.
Example: Bob
customer_idstringUnique identifier of the customer in the Pine Labs Online database.
  • Minimum length: 1 character.
  • Maximum length: 19 characters.
Example: 123456
mobile_numberstringCustomer's mobile number.
  • Minimum length: 10 character.
  • Maximum length: 20 characters.
Example: 9876543210

Supported characters: 0-9
country_codestringCountry code of the registered mobile number.
  • Maximum length: 5 characters.
Example: 91

Note: If the country code is not provided, it defaults to 91.
billing_addressobjectAn object that contains the details of the billing address.

Learn more about our billing_address child object.
shipping_addressobjectAn object that contains the shipping address details.

Learn more about our shipping_address child object.
is_edit_customer_details_allowedbooleanIndicates whether the customer has permission to edit customer details.

Possible values:
  • true: The customer is permitted to edit the customer details.
  • false: The customer is not permitted to edit the customer details.

Billing Address [Child Object]

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

ParameterTypeDescription
address1stringCustomer's billing address1.
  • Maximum length: 100 characters.
Example: 10 Downing Street Westminster London
address2stringCustomer's billing address2.
  • Maximum length: 100 characters.
Example: Oxford Street Westminster London
address3stringCustomer's billing address3.
  • Maximum length: 100 characters.
Example: Baker Street Westminster London
pincodestringPincode of the billing address.
  • Maximum length: 10 characters.
Example: 51524036
citystringCity of the billing address.
  • Maximum length: 50 characters.
Example: Westminster
statestringState of the billing address.
  • Maximum length: 50 characters.
Example: Westminster
countrystringCountry 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.

ParameterTypeDescription
address1stringCustomer's shipping address1.
  • Maximum length: 100 characters.
Example: 10 Downing Street Westminster London
address2stringCustomer's shipping address2.
  • Maximum length: 100 characters.
Example: Oxford Street Westminster London
address3stringCustomer's shipping address3.
  • Maximum length: 100 characters.
Example: Baker Street Westminster London
pincodestringPincode of the shipping address.
  • Maximum length: 10 characters.
Example: 51524036
citystringCity of the shipping address.
  • Maximum length: 50 characters.
Example: Westminster
statestringState of the shipping address.
  • Maximum length: 50 characters.
Example: Westminster
countrystringCountry 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.

ParameterTypeDescription
idstringUnique identifier of the payment in the Pine Labs Online database.
  • Maximum length: 50 characters.
Example: v1-5206071124-aa-mpLhF3-cc-l
merchant_payment_referencestringA unique Payment Reference id sent by merchant.

Example: 008cf04b-a770-4777-854e-b1e6c1230609
statusstringPayment status.

Possible values:
  • PENDING: When the create payment API request is successfully received by Pine Labs Online.
  • 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 Pine Labs Online.
  • FAILED: When the payment fails, this can be for many reasons such as canceling payments, etc.
Example: PENDING
payment_amountobjectAn object that contains the details of the payment amount.

Learn more about our payment_amount child object.
payment_methodstringType of payment method.

Accepted values:
  • CARD
  • UPI
  • POINTS
Example: CARD
payment_optionobjectAn object that contains the details of the payment options.

Learn more about our payment_option child object.
acquirer_dataobjectAn object that contains the details of the acquirer data.

Learn more about our acquirer_data child object.
created_atstringThe ISO 8601 UTC Timestamp, when the create payment request was received by Pine Labs Online.

Example: 2024-07-11T06:52:12.484Z
updated_atstringThe ISO 8601 UTC Timestamp, when the payment response object is updated.

Example: 2024-07-11T06:59:38.260Z

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.

ParameterTypeDescription
valueintegerThe transaction amount is Paisa.
  • Minimum value: 100 (₹1).
  • Maximum value: 100000000 (₹10 lakh).
Example: 100
currencystringType 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.

ParameterTypeDescription
wallet_dataobjectAn object that contains the wallet details.

Learn more about our wallet_data child object.

Wallet Data [Child Object]

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

ParameterTypeDescription
wallet_codestring
wallet_card_datastringAn object that contains the wallet card details.

Learn more about our wallet_card_data child object.

Wallet Card Data [Child Object]

The table below lists the various parameters in the wallet_card_data child object. This object is part of the wallet_data object.

ParameterTypeDescription
card_typestringType of card.

Possible values:
  • DEBIT
  • CREDIT
Example: CREDIT
network_namestringCard network providers.

Example: VISA
issuer_namestringCard issuer entity.

Example: HDFC
card_categorystringThe card category type.

Possible values:
  • CONSUMER
  • COMMERCIAL
  • PREMIUM
  • SUPER_PREMIUM
  • PLATINUM
  • OTHER
  • BUSINESS
  • GOVERNMENT_NOTES
  • PAYOUTS
  • ELITE
  • STANDARD
country_codestringCard issuers Country.

Example: IND
token_txn_typestringTransaction token type.

Possible values:
  • ALT_TOKEN
  • NETWORK_TOKEN
  • ISSUER_TOKEN
Example: ALT_TOKEN
savebooleanIndicates the status of the customer's consent to save their card details for future transactions securely.

Possible values:
  • true: The customer's consent is received to save the card details securely..
  • false: The customer's consent is not received to save the card details.
card_holder_namestringName of the card holder.

Example: Kevin Bob
bin_minstringLower boundary of the BIN range used for card-type identification and eligibility checks.

Example: 4386371130
bin_maxstringUpper boundary of the BIN range used for card-type identification and eligibility checks.

Example: 4386371139

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.

ParameterTypeDescription
approval_codestringAuthorization code returned from acquirer against the payment.

Example: 030376
acquirer_referencestringUnique reference returned from acquirer for the payment.

Example: 202455840588334
rrnstringRetrieval reference number returned from acquirer for the payment.

Example: 419335023601
is_aggregatorbooleanThe selected aggregator model type.

Accepted values:
  • true: Pine Labs Online is responsible for settling funds related to this payment.
  • false: Pine Labs Online is not responsible for settling funds related to this payment.
Note:
  • When the is_aggregator is set to true, Pine Labs Online 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.
Ask AI
Assistant
Hourly Limit
0 / 20000 tokens used Resets in: 60m 0s
Order Lifecycle
Refunds
Settlements
Checkout
Dashboard
International Payments
How do I implement webhook notifications for payment status updates, and what's the recommended way to verify webhook authenticity?
How do I integrate Pine Labs payment gateway with my React Native mobile app and what are the required API credentials?
Can I customize the payment UI for card transactions, and what parameters can I pass to modify the checkout experience for my customers?
Assistant