Get Split Account Info

The Get Split Account Info API is used to fetch all valid split accounts which the merchant has created or onboarded. These accounts can be self-owned or linked to external vendors and are essential for distributing payments through the Split Settlement feature. The API returns key details like account name, account ID, and account type, helping manage and reference accounts effectively during transactions.

Environment

Environment	HTTP Method	API
`Sandbox`	`GET`	https://api-preprod.phonepe.com/apis/pg-sandbox/settlements/v1/linked-accounts
`Production`	`GET`	https://api.phonepe.com/apis/pg/settlements/v1/linked-accounts

Request

Header Name	Header Value
`Content-Type`	application/json
`Authorization`	O-Bearer <access_token>

⚠️ For Partner Integrations!

It is mandatory to include the X-MERCHANT-ID header with the MerchantID of the end merchant.

Response

Case 1: Success Response

{
    "accounts":
    [
        {
            "accountName": "MYACCOUNT123",  // Name given by the Merchant during account creation referring to this account
            "accountId": "B12345678",
            "accountType": "SELF"           // SELF or VENDOR
        },
        {
            "accountName": "VENDOR567",
            "accountId": "B9101112",
            "accountType": "VENDOR"
        }
    ]
}

Case 2: Bad Request

{
    "errorCode": "SPLIT_SETTLEMENT_NOT_ENABLED",
    "message": "Message"
}

Response Parameters

Parameter Name	Type	Description
`accounts`	Object	Contains information about all linked split accounts.
`accountName`	String	Name of the Account.
`accountId`	String	ID associated with the account.
`accountType`	Long	Indicates whether the account is owned by the merchant (SELF) or a third-party vendor (VENDOR).