Merchant Credentials

The Merchant Credentials API is a provides a secure mechanism for retrieving the credentials associated with registered merchants in our platform that has been onboarded to a partner gateway/processor relationship.

GET https://<Platform-host>/merchant/:id/credentials/:credentialId

Path Parameters

Name	Type	Description
id*	string	Merchant ID
credentialId	string	Credential ID. Typically returned with the merchant status change webhook

200: OK

If successfull, this will return a list of gateawy credentials or the one specified through credentialId paramter.

{
  "merchant_id": "d6399869-747c-4537-9c04-f81ce2a6c5eb",
  "credentials": [
    {
      credential_id: "03e675d2-ef81-4d1b-a236-cee7f6abee57"
      vendor: 'stripe',
      configuration: {
        account_type: 'custom',
        account_id: 'acct_1Lij4xPPz4rWmXkv',
        api_token: '<Stripe API Token>'
      }
    },

    {
      credential_id: "03e675d2-ef81-4d1b-a236-cee7f6abee57"
      vendor: 'nmi',
      configuration: {        
        gateway_id: '12345567',
        api_token: '<NMI API Token>',
        public_key: '<NMI API public key>'
      }
    }
  ]
}

Example API Response

The structure of the configuration object is contingent on the type of gateway or processor in use.

{
  "merchant_id": "d6399869-747c-4537-9c04-f81ce2a6c5eb",
  "credentials": [
    {
      credential_id: "03e675d2-ef81-4d1b-a236-cee7f6abee57"
      vendor: 'stripe',
      configuration: {
        account_type: 'custom',
        account_id: 'acct_1Lij4xPPz4rWmXkv',
        api_token: '<Stripe API Token>'
      }
    },

    {
      credential_id: "e858858f-8b13-41e8-a473-c26de14799cb"
      vendor: 'nmi',
      configuration: {        
        gateway_id: '12345567',
        api_token: '<NMI API Token>',
        public_key: '<NMI API public key>'
      }
    },
    
    {
      credential_id: "87a9560a-bc2a-4d34-860a-4e78d3c0ec4d"
      vendor: 'authorize.net',
      configuration: {        
        name: '<authorize.net provided name>',
        transactionkey: '<authorize.net transaction key>'
      }
    },
    
    {
      credential_id: "1458d4d9-75dd-455b-8b46-2f7a3b2cfeb5"
      vendor: 'elavon',
      configuration: {        
        bank_number: '<6 digit bank number>',
        terminal_id: '<16 digit terminal ID - typically starts with 000>',
        merchant_id: '<acc_xxx>'
      }
    },
    
    {
      credential_id: "ac60ec77-b7f4-45db-9e12-beeed6d0b46a"
      vendor: 'global',
      configuration: {        
        merchant_id: '<numeric merchant ID>',
        bank_id: '<6 digit bank id>',
        merchant_id: '<acc_xxx>'
      }
    }
  ]
}