1. REST API for Oracle Commerce Cloud 21C
  2. Tasks
  3. Admin
  4. Merchant Settings

updateGateway

put

/ccadmin/v1/merchant/paymentGateways

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

Request

Supported Media Types
Body ()
Root Schema : updateGateway_request
Type: object
Show Source
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"
    }
}
Nested Schema : paymentGateway
Type: object
Payment gateway details.
Show Source
Nested Schema : soapCredential
Type: object
SOAP Credential information.
Show Source
Nested Schema : sopCredentials
Type: object
SOP credential information.
Show Source
Nested Schema : agent
Type: object
SOP credential information to be used by agent.
Show Source
Nested Schema : storefront
Type: object
SOP credential information to be used by storefront.
Show Source
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : updateGateway_response
Type: object
Show Source
Nested Schema : paymentGateways
Type: array
Payment gateway details.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : soapCredential
Type: object
SOAP Credential information.
Show Source
Nested Schema : sopCredentials
Type: object
SOP credential information.
Show Source
Nested Schema : agent
Type: object
SOP credential information for agent.
Show Source
Nested Schema : storefront
Type: object
SOP credential information for storefront.
Show Source
Example Response (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
Show Source
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top