Payments Entity

The Payments entity has the following parameters:

{
  "id": "pay_L0nSsccovt6zyp",
  "entity": "payment",
  "amount": 9900,
  "currency": "MYR",
  "status": "captured",
  "order_id": "order_L0nS83FfCHaWqV",
  "invoice_id": "inv_L0nS7JIyuX6Lyb",
  "international": false,
  "method": "card",
  "amount_refunded": 0,
  "refund_status": null,
  "captured": true,
  "description": "#L0nS7JIyuX6Lyb",
  "card_id": "card_L0nSsfPv1LjA20",
  "card": {
    "id": "card_L0nSsfPv1LjA20",
    "entity": "card",
    "name": "",
    "last4": "0153",
    "network": "Visa",
    "type": "debit",
    "issuer": null,
    "international": false,
    "sub_type": "consumer",
    "token_iin": null
  },
  "bank": null,
  "wallet": null,
  "email": "<email>",
  "contact": "<phone>",
  "notes": [],
  "fee": 198,
  "tax": 0,
  "error_code": null,
  "error_description": null,
  "error_source": null,
  "error_step": null,
  "error_reason": null,
  "acquirer_data": {
    "auth_code": "299196"
  },
  "created_at": 1672987417
}

{
  "id": "pay_Kb8P4crStfXJea",
  "entity": "payment",
  "amount": 10000,
  "currency": "MYR",
  "status": "failed",
  "order_id": null,
  "invoice_id": null,
  "international": false,
  "method": "card",
  "amount_refunded": 0,
  "refund_status": null,
  "captured": false,
  "description": "Test Transaction",
  "card_id": "card_Kb8P4eO7zAsjQJ",
  "card": {
    "id": "card_Kb8P4eO7zAsjQJ",
    "entity": "card",
    "name": "",
    "last4": "0153",
    "network": "Visa",
    "type": "debit",
    "issuer": null,
    "international": false,
    "sub_type": "consumer",
    "token_iin": null
  },
  "bank": null,
  "wallet": null,
  "email": "<email>",
  "contact": "<phone>",
  "notes": {
    "address": "Corporate Office"
  },
  "fee": null,
  "tax": null,
  "error_code": "BAD_REQUEST_ERROR",
  "error_description": "Your payment has been cancelled. Try again or complete the payment later.",
  "error_source": "customer",
  "error_step": "payment_authentication",
  "error_reason": "payment_cancelled",
  "acquirer_data": {
    "auth_code": null
  },
  "created_at": 1667384312
}

string

Unique identifier of the payment.

string

Indicates the type of entity.

integer

Payment amount in the smallest currency sub-unit. For example, if the amount to be charged is ₹299, then pass 29900 in this field.

string

The currency in which the payment is made.

string

The status of the payment. Possible values:

created
authorized
captured
refunded
failed

string

The payment method used for making the payment. Possible values:

card
fpx
wallet

string

Order id, if provided. Know more about Orders.

string

Description of the payment, if any.

boolean

Indicates whether the payment is done via an international card or a domestic one.

string

The refund status of the payment. Possible values:

null
partial
full

integer

The amount refunded in currency subunits. For example, if amount_refunded = 100, it is equal to ₹1.

boolean

Indicates if the payment is captured.

string

Customer email address used for the payment.

string

Customer contact number used for the payment.

integer

Fee charged by Razorpay.

integer

Tax charged for the payment.

string

Error that occurred during payment. For example, BAD_REQUEST_ERROR.

string

Description of the error that occurred during payment. For example, Payment processing failed because of incorrect OTP.

string

The point of failure. For example, customer.

string

The stage where the transaction failure occurred. The stages can vary depending on the payment method used to complete the transaction. For example, payment_authentication.

string

The exact error reason. For example, incorrect_otp.

json object

Contains user-defined fields, stored for reference purposes.

integer

Timestamp, in UNIX format, on which the payment was created.

string

The unique identifier of the card used by the customer to make the payment.

object

Details of the card used to make the payment.

string

The unique identifier of the card used by the customer to make the payment.

string

The name of the entity. Here, it is card.

string

Name of the cardholder.

integer

The last 4 digits of the card number.

string

The card network. Possible values:

MasterCard
Visa

string

The card type. Possible values:

credit
debit
prepaid
unknown

string

The card issuer. The 4-character code denotes the issuing bank.

Handy TipsThis attribute will not be set for the card issued by a foreign bank.

string

The sub-type of the customer’s card. Possible values:

customer
business

Handy TipsKnow how to accept payments made by customers using corporate cards.

string

The 4-character bank code which the customer’s account is associated with.

string

The name of the wallet used by the customer to make the payment. For example, grabpay.

array

A dynamic array consisting of a unique reference numbers.

string

A unique bank reference number provided by the banking partner when a refund is processed. This reference number can be used by the customer to track the status of the refund with the bank.

string

A unique reference number provided by the banking partner in case of FPX payments.

Partners

Payout APIs