REST API for Oracle Commerce Cloud December 2017

updateGateway

put

/ccadmin/v1/merchant/paymentGateways

Update Gateway. Update the payment gateway setup based on request parameters.

Request

Supported Media Types

application/json

Body Parameter

Root Schema : updateGateway_request

Example


{
    "gatewayName":"cybersource",
    "merchantId":"CCommerce",
    "paymentGateway":{
        "firstname":"John",
        "sopCredentials":{
            "agent":{
                "secretKey":"asd234",
                "accessKey":"345hjx",
                "sopURL":"https://testsecureacceptance.cybersource.com/silent/pay",
                "profileId":"Test123",
                "repositoryId":"SOP-B",
                "applicationName":"agent",
                "expirationDate":"2016-08-14T11:54:30.207Z"
            },
            "storefront":{
                "secretKey":"asdfg",
                "accessKey":"rtyhj",
                "sopURL":"https://testsecureacceptance.cybersource.com/silent/pay",
                "profileId":"Test111",
                "repositoryId":"SOP-A",
                "applicationName":"storefront",
                "expirationDate":"2017-01-28T11:54:30.207Z"
            }
        },
        "soapCredential":{
            "transactionSecurityKey":"as23K9Iud0",
            "profileId":"admin1",
            "expirationDate":"2015-03-10T11:54:30.207Z"
        },
        "ignoreAVS":true,
        "enabled":true,
        "username":"JohnD",
        "lastname":"D"
    }
}

Properties

gatewayName: Type: string

Required: true

Gateway Name.
merchantId: Type: string

CyberSource Merchant ID.
paymentGateway: Type: object paymentGateway

Additional Properties Allowed:

Payment gateway details.

Nested Schema : paymentGateway

Type: object

Payment gateway details.

Properties

enabled: Type: boolean

Is the setup enabled?
firstname: Type: string

First Name.
ignoreAVS: Type: boolean

A flag to tell the Cybersource whether to ignore the AVS results.
lastname: Type: string

Last Name.
soapCredential: Type: object soapCredential

Additional Properties Allowed:

SOAP Credential information.
sopCredentials: Type: object sopCredentials

Additional Properties Allowed:

SOP credential information.
username: Type: string

CyberSource Username.

Nested Schema : soapCredential

Type: object

SOAP Credential information.

Properties

expirationDate: Type: string

Key expiration date.
hasTransactionSecurityKey: Type: boolean

A flag indicating if transaction security key is present to validate signature.
profileId: Type: string

SOAP Profile ID.
repositoryId: Type: string

ID for the SOAP Credential.
soapURL: Type: string

CyberSource SOAP URL.
transactionSecurityKey: Type: string

Transaction Security key.

Nested Schema : sopCredentials

Type: object

SOP credential information.

Properties

agent: Type: object agent

Additional Properties Allowed:

SOP credential information to be used by agent.
storefront: Type: object storefront

Additional Properties Allowed:

SOP credential information to be used by storefront.

Nested Schema : agent

Type: object

SOP credential information to be used by agent.

Properties

accessKey: Type: string

SOP access key for agent.
expirationDate: Type: string

Key expiration date for SOP Credentials of agent.
hasAccessKey: Type: boolean

A flag indicating if access key is present for agent.
hasSecretKey: Type: boolean

A flag indicating if secret key is present to generate signature for agent.
profileId: Type: string

SOP Profile ID to be used by agent.
repositoryId: Type: string

Repository ID of SOP Credential of agent.
secretKey: Type: string

SOP secret key for agent.
sopURL: Type: string

CyberSource SOP URL to be used by agent.

Nested Schema : storefront

Type: object

SOP credential information to be used by storefront.

Properties

accessKey: Type: string

SOP access key for storefront.
expirationDate: Type: string

Key expiration date for SOP Credentials of storefront.
hasAccessKey: Type: boolean

A flag indicating if access key is present for storefront.
hasSecretKey: Type: boolean

A flag indicating if secret key is present to generate signature for storefront.
profileId: Type: string

SOP Profile ID to be used by storefront.
repositoryId: Type: string

Repository ID of SOP Credential of storefront.
secretKey: Type: string

SOP secret key for storefront.
sopURL: Type: string

CyberSource SOP URL to be used by storefront.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : updateGateway_response

Properties

merchantId: Type: string

CyberSource Merchant ID.
paymentGateways: Type: array paymentGateways

Additional Properties Allowed:

Payment gateway details.
repositoryId: Type: string

repository ID of the Merchant.

Nested Schema : paymentGateways

Type: array

Payment gateway details.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

enabled: Type: boolean

Is the setup enabled?
firstname: Type: string

First Name.
ignoreAVS: Type: boolean

A flag to tell the Cybersource whether to ignore the AVS results.
lastname: Type: string

Last Name.
repositoryId: Type: string

Repository ID for the payment gateway.
soapCredential: Type: object soapCredential

Additional Properties Allowed:

SOAP Credential information.
sopCredentials: Type: object sopCredentials

Additional Properties Allowed:

SOP credential information.
type: Type: string

Type of the payment gateway.
username: Type: string

CyberSource Username.

Nested Schema : soapCredential

Type: object

SOAP Credential information.

Properties

expirationDate: Type: string

Key expiration date.
profileId: Type: string

SOAP Profile ID.
repositoryId: Type: string

ID for the SOAP Credential.
transactionSecurityKey: Type: string

Transaction Security key.

Nested Schema : sopCredentials

Type: object

SOP credential information.

Properties

agent: Type: object agent

Additional Properties Allowed:

SOP credential information for agent.
storefront: Type: object storefront

Additional Properties Allowed:

SOP credential information for storefront.

Nested Schema : agent

Type: object

SOP credential information for agent.

Properties

expirationDate: Type: string

Key expiration date.
hasAccessKey: Type: boolean

A flag indicating if access key is present.
hasSecretKey: Type: boolean

A flag indicating if secret key is present to generate signature.
profileId: Type: string

SOP Profile ID for agent profile.
repositoryId: Type: string

ID for the SOP Credential.
sopURL: Type: string

CyberSource SOP URL for agent.

Nested Schema : storefront

Type: object

SOP credential information for storefront.

Properties

expirationDate: Type: string

Key expiration date.
hasAccessKey: Type: boolean

A flag indicating if access key is present.
hasSecretKey: Type: boolean

A flag indicating if secret key is present to generate signature.
profileId: Type: string

SOP Profile ID for storefront profile.
repositoryId: Type: string

ID for the SOP Credential.
sopURL: Type: string

CyberSource SOP URL for storefront.

Example application/json


{
    "merchantId":"oraclecc",
    "paymentGateways":[
        {
            "clientId":"Test113",
            "production":false,
            "captureType":"PlaceOrder",
            "hasSecretKey":true,
            "repositoryId":"PP-A",
            "type":"PayPal",
            "supportedTypes":[
                "paypalCheckout"
            ],
            "enabled":true
        },
        {
            "firstname":"John",
            "sopCredentials":{
                "agent":{
                    "hasAccessKey":true,
                    "sopURL":"https://testsecureacceptance.cybersource.com/silent/pay",
                    "profileId":"Test123",
                    "hasSecretKey":true,
                    "repositoryId":"SOP-B",
                    "applicationName":"agent",
                    "expirationDate":"2016-08-14T11:54:30.207Z"
                },
                "storefront":{
                    "hasAccessKey":true,
                    "sopURL":"https://testsecureacceptance.cybersource.com/silent/pay",
                    "profileId":"Test111",
                    "hasSecretKey":true,
                    "repositoryId":"SOP-A",
                    "applicationName":"storefront",
                    "expirationDate":"2017-01-28T11:54:30.207Z"
                }
            },
            "soapCredential":{
                "transactionSecurityKey":"g9TNb1l8rlJnk+JJ/tqvVlUM5Xr76Rez2u81gzO0KasKwOfVdVeiwTDYa82bipayslV+tQaILGD74QqHyWWJWN1rVTMSgt3VzaRRTzX/5gF2S+qElnojrjXloEPXvML/weqDwqwic9IiiTlgyEmKWNsBpNokUkL2krQ9N4RimshVo3KNk9bSOzKMbKJoikNWVQzlevvpF7Pa7zWDM7QpqwrA59V1V6LBMNhrzZuKlrKyVX61BogsYPvhCofJZYlY3WtVMxKC3dXNpFFPNf/mAXZL6oSWeiOuNeWgQ9e8wv/B6oPCrCJz0iKJOWDISYpY2wGk2iRSQvaStD03hGKayA==",
                "profileId":"CS-A",
                "repositoryId":"SOAP-A",
                "expirationDate":"2020-05-20T11:54:30.207Z"
            },
            "repositoryId":"CS-A",
            "ignoreAVS":true,
            "type":"CyberSource",
            "supportedTypes":[
                "card"
            ],
            "enabled":true,
            "username":"UserA",
            "lastname":"X"
        }
    ],
    "repositoryId":"Merchant-A"
}

Default Response

The error response

Body

Root Schema : errorModel

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
errors: Type: array errors

Additional Properties Allowed:

An optional list of errors if multiple errors were encountered
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code
type: Type: string

The URI to the HTTP state code definition

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code

Examples

Sample Request:

{
  "gatewayName": "cybersource",
  "merchantId": "CCommerce",
  "paymentGateway": {
    "firstname": "John",
    "sopCredentials": {
      "agent": {
        "secretKey": "asd234",
        "accessKey": "345hjx",
        "sopURL": "https://testsecureacceptance.cybersource.com/silent/pay",
        "profileId": "Test123",
        "repositoryId": "SOP-B",
        "applicationName": "agent",
        "expirationDate": "2016-08-14T11:54:30.207Z"
      },
      "storefront": {
        "secretKey": "asdfg",
        "accessKey": "rtyhj",
        "sopURL": "https://testsecureacceptance.cybersource.com/silent/pay",
        "profileId": "Test111",
        "repositoryId": "SOP-A",
        "applicationName": "storefront",
        "expirationDate": "2017-01-28T11:54:30.207Z"
      }
    },
    "soapCredential": {
      "transactionSecurityKey": "as23K9Iud0",
      "profileId": "admin1",
      "expirationDate": "2015-03-10T11:54:30.207Z"
    },
    "ignoreAVS": true,
    "enabled": true,
    "username": "JohnD",
    "lastname": "D"
  }
}

Sample Response Payload returned by endpoint:

{
  "merchantId": "oraclecc",
  "paymentGateways": [
    {
      "clientId": "Test113",
      "production": false,
      "captureType": "PlaceOrder",
      "hasSecretKey": true,
      "repositoryId": "PP-A",
      "type": "PayPal",
      "supportedTypes": ["paypalCheckout"],
      "enabled": true
    },
    {
      "firstname": "John",
      "sopCredentials": {
        "agent": {
          "hasAccessKey": true,
          "sopURL": "https://testsecureacceptance.cybersource.com/silent/pay",
          "profileId": "Test123",
          "hasSecretKey": true,
          "repositoryId": "SOP-B",
          "applicationName": "agent",
          "expirationDate": "2016-08-14T11:54:30.207Z"
        },
        "storefront": {
          "hasAccessKey": true,
          "sopURL": "https://testsecureacceptance.cybersource.com/silent/pay",
          "profileId": "Test111",
          "hasSecretKey": true,
          "repositoryId": "SOP-A",
          "applicationName": "storefront",
          "expirationDate": "2017-01-28T11:54:30.207Z"
        }
      },
      "soapCredential": {
        "transactionSecurityKey": "g9TNb1l8rlJnk+JJ/tqvVlUM5Xr76Rez2u81gzO0KasKwOfVdVeiwTDYa82bipayslV+tQaILGD74QqHyWWJWN1rVTMSgt3VzaRRTzX/5gF2S+qElnojrjXloEPXvML/weqDwqwic9IiiTlgyEmKWNsBpNokUkL2krQ9N4RimshVo3KNk9bSOzKMbKJoikNWVQzlevvpF7Pa7zWDM7QpqwrA59V1V6LBMNhrzZuKlrKyVX61BogsYPvhCofJZYlY3WtVMxKC3dXNpFFPNf/mAXZL6oSWeiOuNeWgQ9e8wv/B6oPCrCJz0iKJOWDISYpY2wGk2iRSQvaStD03hGKayA==",
        "profileId": "CS-A",
        "repositoryId": "SOAP-A",
        "expirationDate": "2020-05-20T11:54:30.207Z"
      },
      "repositoryId": "CS-A",
      "ignoreAVS": true,
      "type": "CyberSource",
      "supportedTypes": ["card"],
      "enabled": true,
      "username": "UserA",
      "lastname": "X"
    }
  ],
  "repositoryId": "Merchant-A"
}