Every API response contains entities shared across different endpoints. There are some common attributes for every entity.
entity
string
Indicates the type of the entity.
id
integer
A unique identifier of the entity.
In an entity, the attributes can be used to make entity-specific API calls.
For example, you can fetch the payment ID from an order.paid
webhook and use it to initiate a refund for that payment.
Razorpay APIs also support returning multiple entities for a single request. This response also has another entity collection
. For the collection entity
, the following parameters are common.
entity
string
Indicates the type of the entity. For example, collection
.
count
integer
Indicates the number of items
are returned. For example, 2
.
items
array
The list of entities.