> ## Documentation Index
> Fetch the complete documentation index at: https://doc-test-my.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Payments Entity

> Know about payment entities and their description.

The Payments entity has the following parameters:

<ResponseExample>
  ```json Success theme={null}
  {
    "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
  }
  ```

  ```json Failure theme={null}
  {
    "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
  }
  ```
</ResponseExample>

<ResponseField name="id" type="string">
  Unique identifier of the payment.
</ResponseField>

<ResponseField name="entity" type="string">
  Indicates the type of entity.
</ResponseField>

<ResponseField name="amount" type="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.
</ResponseField>

<ResponseField name="currency" type="string">
  The currency in which the payment is made.
</ResponseField>

<ResponseField name="status" type="string">
  The status of the payment. Possible values:

  * `created`
  * `authorized`
  * `captured`
  * `refunded`
  * `failed`
</ResponseField>

<ResponseField name="method" type="string">
  The payment method used for making the payment. Possible values:

  * `card`
  * `fpx`
  * `wallet`
</ResponseField>

<ResponseField name="order_id" type="string">
  Order id, if provided. Know more about [Orders](/docs/payments/orders).
</ResponseField>

<ResponseField name="description" type="string">
  Description of the payment, if any.
</ResponseField>

<ResponseField name="international" type="boolean">
  Indicates whether the payment is done via an international card or a domestic one.
</ResponseField>

<ResponseField name="refund_status" type="string">
  The refund status of the payment. Possible values:

  * `null`
  * `partial`
  * `full`
</ResponseField>

<ResponseField name="amount_refunded" type="integer">
  The amount refunded in currency subunits. For example, if `amount_refunded = 100`, it is equal to ₹1.
</ResponseField>

<ResponseField name="captured" type="boolean">
  Indicates if the payment is captured.
</ResponseField>

<ResponseField name="email" type="string">
  Customer email address used for the payment.
</ResponseField>

<ResponseField name="contact" type="string">
  Customer contact number used for the payment.
</ResponseField>

<ResponseField name="fee" type="integer">
  Fee  charged by Razorpay.
</ResponseField>

<ResponseField name="tax" type="integer">
  Tax charged for the payment.
</ResponseField>

<ResponseField name="error_code" type="string">
  Error that occurred during payment. For example, `BAD_REQUEST_ERROR`.
</ResponseField>

<ResponseField name="error_description" type="string">
  Description of the error that occurred during payment. For example, `Payment processing failed because of incorrect OTP`.
</ResponseField>

<ResponseField name="error_source" type="string">
  The point of failure. For example, `customer`.
</ResponseField>

<ResponseField name="error_step" type="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`.
</ResponseField>

<ResponseField name="error_reason" type="string">
  The exact error reason. For example, `incorrect_otp`.
</ResponseField>

<ResponseField name="notes" type="json object">
  Contains user-defined fields, stored for reference purposes.
</ResponseField>

<ResponseField name="created_at" type="integer">
  Timestamp, in UNIX format, on which the payment was created.
</ResponseField>

<ResponseField name="card_id" type="string">
  The unique identifier of the card used by the customer to make the payment.
</ResponseField>

<ResponseField name="card" type="object">
  Details of the card used to make the payment.
</ResponseField>

<ResponseField name="id" type="string">
  The unique identifier of the card used by the customer to make the payment.
</ResponseField>

<ResponseField name="entity" type="string">
  The name of the entity. Here, it is `card`.
</ResponseField>

<ResponseField name="name" type="string">
  Name of the cardholder.
</ResponseField>

<ResponseField name="last4" type="integer">
  The last 4 digits of the card number.
</ResponseField>

<ResponseField name="network" type="string">
  The card network. Possible values:

  * `MasterCard`
  * `Visa`
</ResponseField>

<ResponseField name="type" type="string">
  The card type. Possible values:

  * `credit`
  * `debit`
  * `prepaid`
  * `unknown`
</ResponseField>

<ResponseField name="issuer" type="string">
  The card issuer. The 4-character code denotes the issuing bank. <br />

  <Info>
    **Handy Tips**

    This attribute will not be set for the card issued by a foreign bank.
  </Info>
</ResponseField>

<ResponseField name="sub_type" type="string">
  The sub-type of the customer's card. Possible values:

  * `customer`
  * `business`

  <Info>
    **Handy Tips**

    Know how to accept payments made by customers using [corporate cards](/docs/payments/payment-methods/cards/corporate-cards).
  </Info>
</ResponseField>

<ResponseField name="bank" type="string">
  The 4-character bank code which the customer's account is associated with.
</ResponseField>

<ResponseField name="wallet" type="string">
  The name of the wallet used by the customer to make the payment. For example, `grabpay`.
</ResponseField>

<ResponseField name="acquirer_data" type="array">
  A dynamic array consisting of a unique reference numbers.
</ResponseField>

<ResponseField name="rrn" type="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.
</ResponseField>

<ResponseField name="bank_transaction_id" type="string">
  A unique reference number provided by the banking partner in case of FPX payments.
</ResponseField>