On This Page

Add and Delete a Processor Using the PECS API

This section shows you how to soft-delete a processor and add a new processor. All configuration settings are preserved but the processor is no longer visible in the API or the Business Center.

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 and Deleting a Processor Using the PECS API

Use these required fields to delete a processor.

organizationId
payments.cardProcessing.configurationInformation.configurations. common.processors.[processorName].batchGroup: Where
[processorName]
is the payment processor.
payments.cardProcessing.configurationInformation.configurations. common.processors.[processorName].paymentTypes.[paymentType].enabled: Where
[processor]
is the payment processor and
[paymentTypes]
is the payment type.

Set to
false
.
IMPORTANT

You must include this field for all card types configured for the processor.
payments.cardProcessing.subscriptionInformation.enabled
payments.cardProcessing.subscriptionInformation.features.cardNotPresent.enabled
payments.cardProcessing.subscriptionInformation.features.cardPresent.enabled
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 and Deleting a Processor Using the PECS API

Request

{
    "payments": {
        "cardProcessing": {
            "subscriptionInformation": {
                "enabled": true,
                "features": {
                    "cardNotPresent": {
                        "enabled": true
                    },
                    "cardPresent": {
                        "enabled": false
                    }
                }
            },
            "configurationInformation": {
                "configurations": {
                    "common": {
                        "processors": {
                            "amexdirect": {
                                "paymentTypes": {
                                    "VISA": {
                                        "enabled": false
                                    },
                                     "MASTERCARD": {
                                        "enabled": false
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    },
    "organizationId": "amextestajtxmid1013"
}

Response to a Successful Request

{
  "setups": {
    "payments": {
      "cardProcessing": {
        "configurationStatus": {
          "status": "SUCCESS",
          "message": "Configuration Instance updated successfully"
        },
        "subscriptionStatus": {
          "status": "SUCCESS",
          "message": "success"
        }
      }
    }
  },
  "status": "PROCESSED",
  "submitTimeUtc": "2023-11-14T06:40:15+0000"
}