GET
/
gc
/
transactions
curl --request GET \
  --url https://sandbox.cashfree.com/gc/transactions \
  --header 'x-api-version: <x-api-version>' \
  --header 'x-partner-api-key: <x-partner-api-key>' \
  --header 'x-partner-merchantid: <x-partner-merchantid>'
{
  "status": "SUCCESS",
  "subCode": "200",
  "message": "success_message",
  "data": {
    "payments": [
      {
        "amount": "4950.00",
        "currency": "USD",
        "paymentRail": "ACH",
        "paymentTime": "2023-05-03 15:05:03",
        "referenceId": 2125,
        "remarks": "successful transaction",
        "remitterAccount": "114015040938",
        "remitterAddress": "Wellington street, Oakridge",
        "remitterBic": "6789",
        "remitterCountry": "USA",
        "remitterName": "JANE",
        "remitterRoutingCode": "9089",
        "status": "READY_FOR_SETTLEMENT",
        "updatedStatusTime": "2022-04-21 04:34:04",
        "utr": "99105",
        "vAccountId": "DEMO2",
        "vAccountNumber": "CASHFREELGSH1234",
        "settlement": {
          "expectedSettlementDate": "2023-07-27",
          "firaFileDownloadUrl": "fileDownloadUrl",
          "id": "ae0b76a5-4edd-45f3-81f1-0cf099abe78a",
          "inrAmount": 16219.65,
          "status": "SETTLED",
          "utr": "URN1"
        }
      }
    ]
  }
}

Based on who you are, consider the below values in the API requests

Cashfree MerchantCashfree Partner
x-client-idx-partner-api-key
x-client-secretx-partner-merchantid

Headers

​
x-partner-api-key
string
required

Enter partner API keygit

​
x-partner-merchantid
string
required

Enter the merchant reference id used while creating merchant during onboarding

​
x-api-version
string
required

API version

Query Parameters

​
endDate
string
required

Date in YYYYMMDD or YYYY-MM-DD HH:MM:SS. Search till this date. Has to be greater than startDate.

​
startDate
string
required

Date in YYYYMMDD or YYYY-MM-DD HH:MM:SS. Search beginning from this date.

​
maxReturn
integer
required

Number (200 >= maxReturn > 0). For pagination support.

​
lastReturnId
integer
required

Number. For pagination support.

Response

200
application/json
Successfully retrieved transactions
​
status
string
Example:

"SUCCESS"

​
subCode
string
Example:

"200"

​
message
string
Example:

"success_message"

​
data
object

Was this page helpful?