API Test Keys

Update a Payment

PATCH

/v1/payments/:id/

Click to copy

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.

Is this page helpful?

Curl

change language

1curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET]
2-X PATCH https://api.razorpay.com/v1/payments/pay_CBYy6tLmJTzn3Q/
3-d '{
4	"notes": {
5		"key1": "value1",
6		"key2": "value2"
7	}
8}'

Success

Failure

1{
2  "id": "pay_KbCVlLqUbb3VhA",
3  "entity": "payment",
4  "amount": 400000,
5  "currency": "INR",
6  "status": "authorized",
7  "order_id": null,
8  "invoice_id": null,
9  "international": false,
10  "method": "emi",
11  "amount_refunded": 0,
12  "refund_status": null,
13  "captured": false,
14  "description": "Test Transaction",
15  "card_id": "card_KbCVlPnxWRlOpH",
16  "bank": "HDFC",
17  "wallet": null,
18  "vpa": null,
19  "email": "gaurav.kumar@example.com",
20  "contact": "+919000090000",
21  "notes": {
22		"key1": "value1",
23		"key2": "value2"
24	},
25  "fee": null,
26  "tax": null,
27  "error_code": null,
28  "error_description": null,
29  "error_source": null,
30  "error_step": null,
31  "error_reason": null,
32  "acquirer_data": {
33    "auth_code": "205480"
34  },
35  "emi_plan": {
36    "issuer": "HDFC",
37    "type": "credit",
38    "rate": 1500,
39    "duration": 24
40  },
41  "created_at": 1667398779
42}

Path Parameters

id

string

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

Request Parameters

notes

json object

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.00 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.

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.00.

captured

boolean

Indicates if the payment is 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.

Show child parameters (9)

upi

object

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

Show child parameters (3)

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

array

A dynamic array consisting of a unique reference numbers.

Show child parameters (3)

Errors

The API {key/secret} provided is invalid.

Error Status: 4xx

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

Solution

Update a Payment

PATCH

/v1/payments/:id/

Click to copy

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

Is this page helpful?

Path Parameters

id

string

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

Request Parameters

notes

json object

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.00 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.

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.00.

captured

boolean

Indicates if the payment is 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.

Show child parameters (9)

upi

object

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

Show child parameters (3)

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

array

A dynamic array consisting of a unique reference numbers.

Show child parameters (3)

Errors

The API {key/secret} provided is invalid.

Error Status: 4xx

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

Solution

Curl

change language

1curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET]
2-X PATCH https://api.razorpay.com/v1/payments/pay_CBYy6tLmJTzn3Q/
3-d '{
4	"notes": {
5		"key1": "value1",
6		"key2": "value2"
7	}
8}'

Success

Failure

1{
2  "id": "pay_KbCVlLqUbb3VhA",
3  "entity": "payment",
4  "amount": 400000,
5  "currency": "INR",
6  "status": "authorized",
7  "order_id": null,
8  "invoice_id": null,
9  "international": false,
10  "method": "emi",
11  "amount_refunded": 0,
12  "refund_status": null,
13  "captured": false,
14  "description": "Test Transaction",
15  "card_id": "card_KbCVlPnxWRlOpH",
16  "bank": "HDFC",
17  "wallet": null,
18  "vpa": null,
19  "email": "gaurav.kumar@example.com",
20  "contact": "+919000090000",
21  "notes": {
22		"key1": "value1",
23		"key2": "value2"
24	},
25  "fee": null,
26  "tax": null,
27  "error_code": null,
28  "error_description": null,
29  "error_source": null,
30  "error_step": null,
31  "error_reason": null,
32  "acquirer_data": {
33    "auth_code": "205480"
34  },
35  "emi_plan": {
36    "issuer": "HDFC",
37    "type": "credit",
38    "rate": 1500,
39    "duration": 24
40  },
41  "created_at": 1667398779
42}