Get submerchantIds

GET

/onboarding/v1/psp/submerchantIds

This endpoint allows Payment Service Providers (PSPs) to retrieve the submerchant IDs for all submerchants that have completed the onboarding process. It is useful for PSPs that need to programmatically list their active submerchants.

Only submerchants that have been approved and fully created will appear in the response.

Query Parameter: fullResponse
By default (fullResponse=false or omitted), the response returns a plain array of submerchant ID strings.

When fullResponse=true is sent, each element in submerchatIds is returned as an object containing both the id and the name of the submerchant. This is useful to identify submerchants by name without making an additional query.

Each item includes:

idPsp – The unique identifier of the submerchant.

submerchantsIds - An array with all the submerchantIds corresponding to the PSP.

Request

Query Params

Header Params

Responses

🟢200

application/json

Successful response

Bodyapplication/json

🟠403

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api-uat.kushkipagos.com/onboarding/v1/psp/submerchantIds?fullResponse=undefined' \
--header 'X-Api-Key;'

Response Example

200 - Example 1

{
    "idPsp": "122",
    "submerchatIds": [
        "20000000101933870000",
        "20000000106045330000",
        "20000000102324298000",
        "20000000100416365000",
        "20000000106241217000",
        "20000000100908143000"
    ]
}

Modified at 2026-08-05 17:00:16

Query submerchant status by requestId/submerchantId

Get credentials for submerchants