Docs Logo

Payments

Capture a Payment

Fetch a Payment With ID

Fetch a Payment (With Expanded Card Details)

Fetch a Payment (With Expanded EMI Details)

Fetch a Payment (With Expanded Offer Details)

Fetch a Payment (With Expanded UPI Details)

Fetch All Payments

Fetch All Payments (With Expanded Card Details)

Fetch All Payments (With Expanded EMI Details)

Fetch Payments Based on Orders

Fetch Card Details of a Payment

Update a Payment

Docs Logo

API Test keys

Api

Payments

Fetch Payment Expanded Offers

API Test keys

Api

Payments

Fetch Payment Expanded Offers

Fetch a Payment (With Expanded Offers Details)

GET
/v1/payments/:id/?expand[]=offers

Click to copy

Use this endpoint to retrieve the details of all the payments that you created, with the offer parameter expanded in the payments object.

Watch Out!

Offer is not available in Malaysia.

Is this page helpful?

Curl

change language

change language

1
curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET]
2
-X GET https://api.razorpay.com/v1/payments/pay_Exez1iJzI3hqR5/?expand[]=offers

Success

1
{
2
  "id": "pay_G8VaL2Z68LRtDs",
3
  "entity": "payment",
4
  "amount": 900,
5
  "currency": "INR",
6
  "status": "captured",
7
  "order_id": "order_G8VXfKDWDEOHHd",
8
  "invoice_id": null,
9
  "international": false,
10
  "method": "netbanking",
11
  "amount_refunded": 0,
12
  "refund_status": null,
13
  "captured": true,
14
  "offers": {
15
    "entity": "collection",
16
    "count": 1,
17
    "items": [
18
      {
19
        "id": "offer_G8VXOp0qNuEXzh"
20
      }
21
    ]
22
  },
23
  "description": "Purchase Shoes",
24
  "card_id": null,
25
  "bank": "KKBK",
26
  "wallet": null,
27
  "vpa": null,
28
  "email": "gaurav.kumar@example.com",
29
  "contact": "+919000090000",
30
  "customer_id": "cust_DitrYCFtCIokBO",
31
  "notes": [],
32
  "fee": 22,
33
  "tax": 4,
34
  "error_code": null,
35
  "error_description": null,
36
  "error_source": null,
37
  "error_step": null,
38
  "error_reason": null,
39
  "acquirer_data": {
40
    "bank_transaction_id": "0125836177",
41
    "authentication_reference_number": "100222021120200000000742753928"
42
  },
43
  "created_at": 1606985740
44
}
Path Parameters
id

*

string

Unique identifier of the payment to be retrieved.

Query Parameters
expand[]=offers
string

Use to expand the offers applied to a payment, wherever applicable.

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 RM 1.00 enter 100.

currency
string

The currency in which the payment is made.

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
  • fpx
  • wallet

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 RM 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 tax) charged by Curlec.

tax
integer

Tax 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 (8)

bank
string

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

wallet
string

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

acquirer_data
array

A dynamic array consisting of a unique reference number.

Show child parameters (2)

Fetch a Payment (With Expanded Offers Details)

GET
/v1/payments/:id/?expand[]=offers

Click to copy

Use this endpoint to retrieve the details of all the payments that you created, with the offer parameter expanded in the payments object.

Watch Out!

Offer is not available in Malaysia.

Is this page helpful?

Path Parameters
id

*

string

Unique identifier of the payment to be retrieved.

Query Parameters
expand[]=offers
string

Use to expand the offers applied to a payment, wherever applicable.

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 RM 1.00 enter 100.

currency
string

The currency in which the payment is made.

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
  • fpx
  • wallet

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 RM 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 tax) charged by Curlec.

tax
integer

Tax 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 (8)

bank
string

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

wallet
string

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

acquirer_data
array

A dynamic array consisting of a unique reference number.

Show child parameters (2)

Curl

change language

change language

1
curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET]
2
-X GET https://api.razorpay.com/v1/payments/pay_Exez1iJzI3hqR5/?expand[]=offers

Success

1
{
2
  "id": "pay_G8VaL2Z68LRtDs",
3
  "entity": "payment",
4
  "amount": 900,
5
  "currency": "INR",
6
  "status": "captured",
7
  "order_id": "order_G8VXfKDWDEOHHd",
8
  "invoice_id": null,
9
  "international": false,
10
  "method": "netbanking",
11
  "amount_refunded": 0,
12
  "refund_status": null,
13
  "captured": true,
14
  "offers": {
15
    "entity": "collection",
16
    "count": 1,
17
    "items": [
18
      {
19
        "id": "offer_G8VXOp0qNuEXzh"
20
      }
21
    ]
22
  },
23
  "description": "Purchase Shoes",
24
  "card_id": null,
25
  "bank": "KKBK",
26
  "wallet": null,
27
  "vpa": null,
28
  "email": "gaurav.kumar@example.com",
29
  "contact": "+919000090000",
30
  "customer_id": "cust_DitrYCFtCIokBO",
31
  "notes": [],
32
  "fee": 22,
33
  "tax": 4,
34
  "error_code": null,
35
  "error_description": null,
36
  "error_source": null,
37
  "error_step": null,
38
  "error_reason": null,
39
  "acquirer_data": {
40
    "bank_transaction_id": "0125836177",
41
    "authentication_reference_number": "100222021120200000000742753928"
42
  },
43
  "created_at": 1606985740
44
}