Skip to main content
GET
/
gc
/
virtual-accounts
Get All Collection Accounts for Merchants
curl --request GET \
  --url https://sandbox.cashfree.com/gc/virtual-accounts \
  --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": {
    "totalPages": 1,
    "totalElements": 1,
    "first": true,
    "last": true,
    "vAccounts": [
      {
        "accountName": "John Doe",
        "accountNumber": "GB47TCCL12345648154924",
        "accountType": "iban",
        "paymentType": "priority",
        "bankName": "The Currency Cloud Limited",
        "bankAddress": "12 Steward Street, The Steward Building, London, E1 6FQ, GB",
        "bankCountry": "GB",
        "currency": "AUD",
        "routingCode": "TCCLGB3L",
        "routingCodeType": "bic_swift",
        "status": "ACTIVE",
        "addedOn": "2023-09-15 16:13:48",
        "vaccountId": "GB47T"
      }
    ]
  }
}
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

ā€‹
page
integer

Specify the page number you want to see. The default value is 0.

ā€‹
size
integer

Specify the page size, the default value is 20.

ā€‹
currency
string

Please mention the currency for which you want to view virtual account details.

Response

Successfully retrieved virtual accounts

ā€‹
status
string
Example:

"SUCCESS"

ā€‹
subCode
string
Example:

"200"

ā€‹
message
string
Example:

"success_message"

ā€‹
data
object