Appearance

Get Payments ​

Endpoint ​

http
GET /unified/payment-gateway/payments/{id}
Integrations supported
  • Checkout
  • Razorpay
  • Stripe

Path parameters ​

id
string
REQUIRED · The ID of the resource.
Example: 23423523

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

Response Body ​

id
string
REQUIRED · Unique identifier for the payment
Supported in
  • Checkout
  • Razorpay
  • Stripe
amount
string
Amount of the payment
Supported in
  • Checkout
  • Razorpay
  • Stripe
currency
string
Currency of the payment
Supported in
  • Checkout
  • 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
  • Checkout
  • Razorpay
  • Stripe
customer
object
Supported in
  • Checkout
  • 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
  • Checkout
  • Razorpay
  • Stripe
payment_method
object
Supported in
  • Checkout
  • 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
  • Checkout
  • Razorpay
  • Stripe
expires_on
string
Date and time when the payment expires
Supported in
  • Checkout
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
  • Checkout
  • Razorpay
  • Stripe
remote_data
object
Raw data returned from the remote API call.