Update a Payment

Update a Payment using Razorpay Payments API.

PATCH /v1/payments/:id/

Curl

curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET]
-X PATCH https://api.razorpay.com/v1/payments/pay_CBYy6tLmJTzn3Q/
-d '{
	"notes": {
		"key1": "value1",
		"key2": "value2"
	}
}'

Success

{
  "id": "pay_KbCVlLqUbb3VhA",
  "entity": "payment",
  "amount": 400000,
  "currency": "INR",
  "status": "authorized",
  "order_id": null,
  "invoice_id": null,
  "international": false,
  "method": "emi",
  "amount_refunded": 0,
  "refund_status": null,
  "captured": false,
  "description": "Test Transaction",
  "card_id": "card_KbCVlPnxWRlOpH",
  "bank": "HDFC",
  "wallet": null,
  "vpa": null,
  "email": "[e-mail]",
  "contact": "[phone]",
  "notes": {
		"key1": "value1",
		"key2": "value2"
	},
  "fee": null,
  "tax": null,
  "error_code": null,
  "error_description": null,
  "error_source": null,
  "error_step": null,
  "error_reason": null,
  "acquirer_data": {
    "auth_code": "205480"
  },
  "emi_plan": {
    "issuer": "HDFC",
    "type": "credit",
    "rate": 1500,
    "duration": 24
  },
  "created_at": 1667398779,
  "upi": {
      "payer_account_type": "credit_card",
      "vpa": "gaurav.kumar@examplebank",
      "flow": "intent"
  }
}

Available in🇮🇳 India🇺🇸 United States

Use this endpoint to modify the notes field for a particular payment.

You can modify an existing payment to update the Notes field only. Notes can be used to record additional information about the payment. You can add up to 15 key-value pairs with each value of the key not exceeding 256 characters.

Curl

curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET]
-X PATCH https://api.razorpay.com/v1/payments/pay_CBYy6tLmJTzn3Q/
-d '{
	"notes": {
		"key1": "value1",
		"key2": "value2"
	}
}'

Success

{
  "id": "pay_KbCVlLqUbb3VhA",
  "entity": "payment",
  "amount": 400000,
  "currency": "INR",
  "status": "authorized",
  "order_id": null,
  "invoice_id": null,
  "international": false,
  "method": "emi",
  "amount_refunded": 0,
  "refund_status": null,
  "captured": false,
  "description": "Test Transaction",
  "card_id": "card_KbCVlPnxWRlOpH",
  "bank": "HDFC",
  "wallet": null,
  "vpa": null,
  "email": "[e-mail]",
  "contact": "[phone]",
  "notes": {
		"key1": "value1",
		"key2": "value2"
	},
  "fee": null,
  "tax": null,
  "error_code": null,
  "error_description": null,
  "error_source": null,
  "error_step": null,
  "error_reason": null,
  "acquirer_data": {
    "auth_code": "205480"
  },
  "emi_plan": {
    "issuer": "HDFC",
    "type": "credit",
    "rate": 1500,
    "duration": 24
  },
  "created_at": 1667398779,
  "upi": {
      "payer_account_type": "credit_card",
      "vpa": "gaurav.kumar@examplebank",
      "flow": "intent"
  }
}

Path Parameters

id · string · required

Unique identifier of the payment for which the Notes field should be updated.

Request Parameters

notes · json object · required

Contains user-defined fields and is stored for reference purposes. Know more about notes.

Response Parameters

id · string

Unique identifier of the payment.

entity · string

Indicates the type of entity.

amount · integer

The payment amount in currency subunits. For example, for an amount of ₹1 enter 100.

currency · string

The currency in which the payment is made. Refer to the list of international currencies that we support.

status · string

The status of the payment. Possible values:

• created
• authorized
• captured
• refunded
• failed

method · string

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

• card
• netbanking
• wallet
• emi
• upi

order_id · string

Order id, if provided. Know more about Orders.

description · string

Description of the payment, if any.

international · boolean

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

• true: Payment made using international card.
• false: Payment not made using international card.

refund_status · string

The refund status of the payment. Possible values:

• null
• partial
• full

amount_refunded · integer

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

captured · boolean

Indicates if the payment is captured. Possible values:

• true: Payment has been captured.
• false: Payment has not been captured.

email · string

Customer email address used for the payment.

contact · string

Customer contact number used for the payment.

fee · integer

Fee (including GST) charged by Razorpay.

tax · integer

GST charged for the payment.

error_code · string

Error that occurred during payment. For example, BAD_REQUEST_ERROR.

error_description · string

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

error_source · string

The point of failure. For example, customer.

error_step · 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.

error_reason · string

The exact error reason. For example, incorrect_otp.

notes · json object

Contains user-defined fields, stored for reference purposes.

created_at · integer

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

card_id · string

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

card · object

Details of the card used to make the payment.

id · string

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

entity · string

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

name · string

Name of the cardholder.

last4 · integer

The last 4 digits of the card number.

network · string

The card network. Possible values:

• American Express
• Diners Club (Only available for private limited and registered businesses)
• Maestro
• MasterCard
• RuPay
• Unknown
• Visa

type · string

The card type. Possible values:

• credit
• debit
• prepaid
• unknown

issuer · string

The card issuer. The 4-character code denotes the issuing bank. This attribute will not be set for the card issued by a foreign bank.

emi · boolean

Indicates whether the card can be used for EMI payment method. Possible values:

• true: Card can be used for EMI payments.
• false: Card cannot be used for EMI payments.

sub_type · string

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

• customer
• business
  

Know how to accept payments made by customers using corporate cards.

upi · object

Details of the UPI payment received. Only applicable if method is upi.

payer_account_type · string

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

• bank_account
• credit_card
• wallet
• credit_line

vpa · string

The customer’s VPA (Virtual Payment Address) or UPI id used to make the payment. For example, gauravkumar@exampleupi.

flow · string

The type of UPI flow. Possible values:

• intent: When a UPI app is selected and user is redirected to it.
• collect: The user enters their UPI ID and receives a notification from the UPI app. They open the app and complete the payment.
• in_app: In case of Turbo UPI Payments.

bank · string

The 4-character bank code which the customer’s account is associated with. For example, UTIB for Axis Bank.

vpa · string

The customer’s VPA (Virtual Payment Address) or UPI id used to make the payment. For example, gauravkumar@exampleupi.

wallet · string

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

acquirer_data · object

An object containing unique reference numbers.

rrn · 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.

authentication_reference_number · string

A unique reference number generated for RuPay card payments.

bank_transaction_id · string

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

amount_captured · integer

The amount captured for this payment, in the smallest currency unit (paise for INR).

provider · string

The payment provider used for cardless EMI, PayLater, or app-based payment methods.

reward · object

Reward details applied to this payment, when an offer of type reward was redeemed.

invoice_id · string

Unique identifier of the invoice associated with this payment.

base_amount · integer

The base amount for this payment, in the smallest currency unit (paise for INR).

emi_plan · object

EMI plan details for this payment when it was made via EMI. Contains the issuer, duration, and rate.

Errors

The API {key/secret} provided is invalid.

Code: 4xx

The API credentials passed in the API call differ from the ones generated on the Dashboard.

Solution: The API keys must be active and entered correctly with no whitespace before or after.

amount is/are not required and should not be sent.

Code: 400

Fields other than notes (such as amount) were sent in the PATCH request body. The Update Payment endpoint only accepts the notes field.

Solution: Restrict the PATCH body to the notes object. Other fields on a payment are immutable after creation.

Notes value cannot be greater than 512 characters.

Code: 400

One of the values inside the notes object exceeds the 512-character limit per value.

Solution: Each value inside notes must be 512 characters or fewer. The object can hold up to 15 key-value pairs.

Notes key cannot be greater than 255 characters.

Code: 400

One of the keys inside the notes object exceeds the 255-character limit.

Solution: Keep each notes key under 256 characters.

Number of fields in notes should be less than or equal to 15.

Code: 400

The notes object contains more than 15 key-value pairs.

Solution: Limit notes to at most 15 key-value pairs.

Notes values themselves should not be an array.

Code: 400

A value inside notes was passed as a JSON array. Only scalar values (string, number, boolean) are accepted as values.

Solution: Convert array values into strings (for example, a comma-separated list) before sending.