On This Page

Add a Processor Using the PECS API

This section shows you how to add a processor.

Endpoint

Production:

POST https://api.cybersource.com/products/v1/product-setups

Test:

POST https://apitest.cybersource.com/products/v1/product-setups

Required Fields for Adding a Processor Using the PECS API

Use these required fields to add an additional processor.

organizationId
payments.cardProcessing.configurationInformation.configurations.common.merchantCategoryCode
payments.cardProcessing.configurationInformation.configurations.common.merchantDescriptorInformation.city
payments.cardProcessing.configurationInformation.configurations.common.merchantDescriptorInformation.country
payments.cardProcessing.configurationInformation.configurations.common.merchantDescriptorInformation.name
payments.cardProcessing.configurationInformation.configurations.common.merchantDescriptorInformation.phone
payments.cardProcessing.configurationInformation.configurations.common.merchantDescriptorInformation.zip
payments.cardProcessing.configurationInformation.configurations.common.merchantDescriptorInformation.state
payments.cardProcessing.configurationInformation.configurations.common.merchantDescriptorInformation.street
payments.cardProcessing.configurationInformation.configurations.common. processors.[processorName].currencies.[currency].serviceEnablementNumber: Where
[processorName]
is the payment processor and
[currency]
is the currency.
payments.cardProcessing.configurationInformation.features.cardNotPresent. processors.[processorName]relaxAddressVerificationSystem: Where
[processorName]
is the payment processor.
payments.cardProcessing.configurationInformation.features.cardNotPresent. processors.[processorName]relaxAddressVerificationSystemAllowExpiredCard: Where
[processorName]
is the payment processor.
payments.cardProcessing.configurationInformation.features.cardNotPresent. processors.[processorName]relaxAddressVerificationSystemAllowZipWithoutCountry: Where
[processorName]
is the payment processor.
payments.cardProcessing.configurationInformation.templateId

payments.cardProcessing.subscriptionInformation.enabled

Example: Adding a Processor Using the PECS API

Request

{
  "organizationId": "cp_transacting1",
  "payments": {
    "cardProcessing": {
      "subscriptionInformation": {
        "enabled": true,
        "features": {
          "cardPresent": {
            "enabled": true
          }
        }
      },
      "configurationInformation": {
        "configurations": {
          "common": {
            "merchantCategoryCode": "5399",
            "merchantDescriptorInformation": {
              "city": "London",
              "country": "GBR",
              "name": "BCTest1",
              "phone": "1234567",
              "zip": "RG1 4BB",
              "state": "LN",
              "street": "Sample Street"
            },
            "processors": {
              "amexdirect": {
                "currencies": {
                  "GBP": {
                    "serviceEnablementNumber": "1234567891"
                  }
                }
              }
            }
          },
          "features": {
            "cardNotPresent": {
              "processors": {
                "amexdirect": {
                  "relaxAddressVerificationSystem": true,
                  "relaxAddressVerificationSystemAllowZipWithoutCountry": true,
                  "relaxAddressVerificationSystemAllowExpiredCard": true
                }
              }
            }
          }
        }
      }
    }
  }
}

Response to a Successful Request

{
    "setups": {
        "payments": {
            "cardProcessing": {
                "configurationStatus": {
                    "status": "SUCCESS",
                    "message": "Configuration Instance updated successfully"
                },
                "subscriptionStatus": {
                    "status": "SUCCESS",
                    "message": "success"
                }
            }
        }
    },
    "status": "PROCESSED",
    "submitTimeUtc": "2022-04-04T12:58:02+0000"
}