Appearance

List Payments ​

Endpoint ​

http
GET /unified/payment-gateway/payments
Integrations supported
  • Razorpay
  • Stripe

Query parameters ​

integrated_account_id
string · uuid
REQUIRED · The ID of the integrated account to use for the request.
Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
created_at
string
Date and time when the payment was created
Supported in
  • Razorpay
  • Stripe
customer_id
string
Unique identifier for the customer
Supported in
  • Stripe

Response Body ​

result
object[]
List of Payments
id
string
REQUIRED · Unique identifier for the payment
Supported in
  • Razorpay
  • Stripe
amount
string
Amount of the payment
Supported in
  • Razorpay
  • Stripe
currency
string
Currency of the payment
Supported in
  • Razorpay
  • Stripe
transaction_fee
string
Transaction fee on a payment
Supported in
  • Razorpay
  • Stripe
refund_amount
string
Refund amount of the payment
Supported in
  • Razorpay
  • Stripe
status
string
Status of the payment. In case there is no clear mapping, the raw status is passed.
All possible enum values:
  • pending
  • authorized
  • paid
  • partial
  • refunded
  • voided
  • cancelled
  • unknown
Supported in
  • Razorpay
  • Stripe
customer
object
Supported in
  • Razorpay
  • Stripe
id
string
Unique identifier for the customer
name
string
Name of the customer
email
string
Email of the customer
phone
string
Phone number of the customer
description
string
Description of the payment
Supported in
  • Razorpay
  • Stripe
payment_method
object
Supported in
  • Razorpay
  • Stripe
method
string
Method of payment
id
string
Unique identifier for the payment method
created_at
string
Date and time when the payment was created
Supported in
  • Razorpay
  • Stripe
expires_on
string
Date and time when the payment expires
reference_id
string
Reference ID of the payment. This can be used to lookup payments in the system.
order_id
string
Unique identifier for the order related to this payment.
Supported in
  • Razorpay
  • Stripe
metadata
object
Supported in
  • Razorpay
  • Stripe
remote_data
object
Raw data returned from the remote API call.
next_cursor
string
The cursor to use for the next page of results. Pass this value as `next_cursor` in the query parameter in the next request to get the next page of results.