Merchant Configuration Callbacks

Configure your merchant instantly!

As you move from validating your integration, to boarding merchants, you should determine how you want to receive and configure your merchant’s API and public keys.

The easiest, most secure and reliable way is for the Clearent system to send them directly to your system. This removes human mistakes (i.e: copy and paste errors) . All you need to do is stand up an SSL endpoint and be able to accept the below payload. Then take the keys for each merchant account and push them into your system using the External Identifier from your system. The External Identifier will need to be added during boarding with Clearent. 

 

Your webhook listener should gracefully handle unfamiliar event types, in case we add any fields in the future.

 

Expected Payload

Example of callback using single product


{
    "externalIdentifier": "Unique identifier given from Partner",
    "merchantAccountNumber": "Merchant Number",
    "keys": [
        {
            "type": "cnp",
            "productName": "Your Product Name- CNP",
            "apiKey": "Merchant's Card Not Present API Key(32 digits- alphanumeric)",
            "terminalid": "11111234",
            "publicKey": "Merchant's Card Not Present Public Key(248 digits- alphanumeric)"
        }
    ]
}

Example of callback using multiple products


{
    "externalIdentifier": "Unique identifier given from Partner",
    "merchantAccountNumber": "Merchant Number",
    "keys": [
        {
            "type": "cnp",
            "productName": "Your Product Name- CNP",
            "apiKey": "Merchant's Card Not Present API Key(32 digits- alphanumeric)",
            "terminalid": "11111234",
            "publicKey": "Merchant's Card Not Present Public Key(248 digits- alphanumeric)"
        },
        {
            "type": "cp",
            "productName": "Your Product Name- CP",
            "apiKey": "Merchant's Card Present API Key(32 digits- alphanumeric)",
            "terminalid": "11111234",
            "publicKey": "Merchant's Card Present Public Key(248 digits- alphanumeric)"
        }
    ]
}