Get credentials for submerchants

Allows a PSP (Payment Service Provider) to retrieve the transactional credentials (public and private keys) of one or more submerchants already created in Kushki.

This endpoint is authenticated using the PSP API Key, which is generated through the Appian portal. It is designed for PSPs managing multiple merchants under their ecosystem, enabling secure access to credential data per submerchant.

Important considerations

You can submit multiple merchantIds in a single request.

For successful responses, the returned publicCredential and privateCredential are the keys used for transactional operations such as charges and subscriptions.

This endpoint only returns credentials for submerchants associated with the authenticated PSP.

If a merchantId is not valid or does not meet the criteria, the API will return the submerchantId and a descriptive message.

The submerchant does not belong to the authenticated PSP: The ID is valid but belongs to a different PSP.

Submerchant not found: The ID does not exist in the system, or the onboarding process is not yet complete.

curl --location --request POST '/onboarding/v1/submerchants/credentials' \ --header 'X-Api-Key;' \ --header 'Content-Type: application/json' \ --data-raw '{ "submerchantIds": [ "20090200103691174000", "00000000108451820000", "80000000101279730000", "10000000103480033000" ] }'

{ "pspId": "138", "credentials": [ { "submerchantId": "20000000123456789000", "publicCredential": "a1b2c3d4e5f64718a9b01234abcd5678", "privateCredential": "f1e2d3c4b5a60987cdef1234abcd5678" }, { "submerchantId": "20000000987654321000", "publicCredential": "1234abcd5678ef9012bc3456de7890fa", "privateCredential": "abcd1234ef5612cd7890ab34cdef5678" }, { "submerchantId": "99999999123456780000", "message": "The submerchant does not belong to the authenticated PSP" } ] }

Important considerations

Request

Responses

Get credentials for submerchants

Important considerations#

Request

Responses

Important considerations