Cashfree Payments Developer Documentation

Get Payment Details

curl --request POST \
  --url https://sandbox.cashfree.com/pg/vba/payments \
  --header 'Content-Type: application/json' \
  --header 'x-api-version: <x-api-version>' \
  --header 'x-client-id: <x-client-id>' \
  --header 'x-client-secret: <x-client-secret>' \
  --data '
{
  "status": "SUCCESS",
  "start_date": "1995-11-10 18:12:22",
  "end_date": "2023-11-10 12:10:10",
  "virtual_account_id": "User01",
  "pagination": {
    "cursor": ">- eyJzZWFyY2hBZnRlciI6eyJsaXN0IjpbMTg4NjcxNDVdLCJlbXB0eSI6ZmFsc2V9LCJyZWNvbkFQSVR5cGUiOiJMRURHRVIifQ==",
    "limit": 10
  }
}
'

{
  "cursor": "eyJzZWFyY2hBZnRlciI6eyJsaXN0IjpbMTg4NjcxNDVdLCJlbXB0eSI6ZmFsc2V9LCJyZWNvbkFQSVR5cGUiOiJMRURHRVIifQ==",
  "limit": "10",
  "payments": {
    "payment_details": [
      {
        "virtual_account_id": "User01",
        "utr": "912345678912",
        "remitter_account": "026291800001191",
        "remitter_name": "Doe John",
        "amount": "10",
        "reference_id": "001",
        "credit_ref_number": "2382053846",
        "txtime": "2007-06-28 15:28:08",
        "is_settled": "1",
        "txstatus": "SUCCESS"
      }
    ]
  }
}

POST

vba

payments

Get Payment Details

curl --request POST \
  --url https://sandbox.cashfree.com/pg/vba/payments \
  --header 'Content-Type: application/json' \
  --header 'x-api-version: <x-api-version>' \
  --header 'x-client-id: <x-client-id>' \
  --header 'x-client-secret: <x-client-secret>' \
  --data '
{
  "status": "SUCCESS",
  "start_date": "1995-11-10 18:12:22",
  "end_date": "2023-11-10 12:10:10",
  "virtual_account_id": "User01",
  "pagination": {
    "cursor": ">- eyJzZWFyY2hBZnRlciI6eyJsaXN0IjpbMTg4NjcxNDVdLCJlbXB0eSI6ZmFsc2V9LCJyZWNvbkFQSVR5cGUiOiJMRURHRVIifQ==",
    "limit": 10
  }
}
'

{
  "cursor": "eyJzZWFyY2hBZnRlciI6eyJsaXN0IjpbMTg4NjcxNDVdLCJlbXB0eSI6ZmFsc2V9LCJyZWNvbkFQSVR5cGUiOiJMRURHRVIifQ==",
  "limit": "10",
  "payments": {
    "payment_details": [
      {
        "virtual_account_id": "User01",
        "utr": "912345678912",
        "remitter_account": "026291800001191",
        "remitter_name": "Doe John",
        "amount": "10",
        "reference_id": "001",
        "credit_ref_number": "2382053846",
        "txtime": "2007-06-28 15:28:08",
        "is_settled": "1",
        "txstatus": "SUCCESS"
      }
    ]
  }
}

Headers

x-client-id

string

required

Client app ID. You can find your app id in the Merchant Dashboard.

x-client-secret

string

required

Client secret key. You can find your secret key in the Merchant Dashboard.

x-api-version

enum<string>

required

API version to be used. The accepted format is YYYY-MM-DD.

Available options:

2024-07-10T00:00:00.000Z

x-request-id

string

Request ID for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to Cashfree.

Example:

"4dfb9780-46fe-11ee-be56-0242ac120002"

Body

application/json

Request parameters for getting payment details of the virtual bank account.

status

enum<string>

required

It is the status of the payment.

Available options:

ALL,

SUCCESS,

REJECTED

Example:

"SUCCESS"

start_date

string

It is the specific start date and time to retrieve the payment details associated with the virtual bank account. Allowed format - YYYYY-MM-DD HH:MM:SS

Example:

"1995-11-10 18:12:22"

end_date

string

It is the specific end date and time to retrieve the payment details associated with the virtual bank account. Allowed format - YYYY-MM-DD HH:MM:SS

Example:

"2023-11-10 12:10:10"

virtual_account_id

string

It is the unique ID you created to identify the virtual bank account. The API retrieves all payment details with respect to this ID.

Example:

"User01"

pagination

object

It contains parameters to mange and control the retrieval of paginated data.

Show child attributes

pagination.cursor

string

It is the marker to a specific item in the dataset, facilitating navigation to subsequent pages of results.

Example:

">- eyJzZWFyY2hBZnRlciI6eyJsaXN0IjpbMTg4NjcxNDVdLCJlbXB0eSI6ZmFsc2V9LCJyZWNvbkFQSVR5cGUiOiJMRURHRVIifQ=="

pagination.limit

integer

It is the maximum number of items to be included in each page of results.

Example:

10

Response

Success response for getting payment details of the virtual bank account.

cursor

string

Example:

"eyJzZWFyY2hBZnRlciI6eyJsaXN0IjpbMTg4NjcxNDVdLCJlbXB0eSI6ZmFsc2V9LCJyZWNvbkFQSVR5cGUiOiJMRURHRVIifQ=="

limit

string

Example:

"10"

payments

object

Payment Details

Show child attributes

payments.payment_details

object[]

Show child attributes

payments.payment_details.virtual_account_id

string

It displays the unique ID you created to identify the virtual bank account.

Example:

"User01"

payments.payment_details.utr

string

It displays the unique transaction reference (UTR) number generated by the remitter's bank to identify the payment transfer.

Example:

"912345678912"

payments.payment_details.remitter_account

string

It displays the bank account number of the remitter account.

Example:

"026291800001191"

payments.payment_details.remitter_name

string

It displays the name of the remitter.

Example:

"Doe John"

payments.payment_details.amount

string

It displays the transfer amount.

Example:

"10"

payments.payment_details.reference_id

string

It displays the unique ID created by Cashfree Payments for reference purposes.

Example:

"001"

payments.payment_details.credit_ref_number

string

It displays the unique number generated by Cashfree Payments' partner bank for reference purposes.

Example:

"2382053846"

payments.payment_details.txtime

string

It displays the time of the transaction.

Example:

"2007-06-28 15:28:08"

payments.payment_details.is_settled

string

It displays whether the transaction is settled.

Example:

"1"

payments.payment_details.txstatus

string

It displays the status of the transaction. The different statuses are SUCCESS, REJECTED, WAITING_FOR_PAYMENT, FAILED.

Example:

"SUCCESS"

Get VBA Get VBA Payments By UTR

⌘I

Payments API

v2025-01-01

Other Versions

Get VBA Payments

Headers

Body

Response