Skip to main content
POST
/
pg
/
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 '{
  "start_date": "1995-11-10 18:12:22",
  "end_date": "2023-11-10 12:10:10",
  "status": "SUCCESS",
  "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 id generated from the merchant dashboard

ā€‹
x-client-secret
string
required

client secret generated from 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 Payments.

Example:

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

Body

application/json

PG VBA Payment Details Request

ā€‹
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.

Response

Success Response.

ā€‹
cursor
string
Example:

"eyJzZWFyY2hBZnRlciI6eyJsaXN0IjpbMTg4NjcxNDVdLCJlbXB0eSI6ZmFsc2V9LCJyZWNvbkFQSVR5cGUiOiJMRURHRVIifQ=="

ā€‹
limit
string
Example:

"10"

ā€‹
payments
object

Payment Details